ahoowang/cosky-rest-api

CoSky：高性能、低成本的微服务治理平台（服务发现与配置服务）

https://github.com/Ahoo-Wang/CoSky/blob/main/README.zh-CN.md

https://github.com/Ahoo-Wang/CoSky 是一款轻量级、低成本的服务注册、服务发现和配置服务SDK。通过利用现有基础设施中的Redis（相信您已部署Redis），无需为运维部署带来额外成本和负担。借助Redis的高性能，CoSky 提供超高TPS&QPS（100,000+/s JMH基准测试）。CoSky 结合进程缓存策略 + Redis PubSub 实现实时进程缓存刷新，具备无与伦比的QPS性能（70,000,000+/s JMH基准测试）及进程缓存与Redis的实时一致性。

核心功能和特性

服务发现

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/CoSky-Discovery.png

配置管理

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/CoSky-Configuration.png

CoSky-Mirror（服务实例变更状态实时同步）

CoSky-Mirror 如同置于Nacos与CoSky之间的镜像，用于构建统一的服务发现平台。

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/CoSky-Mirror.png

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/CoSky-Mirror-Unified.png

使用场景和适用范围

适用于需要轻量级、低成本微服务治理的场景，尤其适合已部署Redis基础设施的团队。可用于微服务架构中的服务注册与发现、配置管理，支持跨平台服务治理，以及需要高并发、实时一致性的服务场景。

使用示例

https://github.com/Ahoo-Wang/CoSky/tree/main/examples

安装与配置

Gradle（Kotlin DSL）

kotlin
    val coskyVersion = "1.2.10";
    implementation("me.ahoo.cosky:spring-cloud-starter-cosky-config:${coskyVersion}")
    implementation("me.ahoo.cosky:spring-cloud-starter-cosky-discovery:${coskyVersion}")
    implementation("org.springframework.cloud:spring-cloud-starter-loadbalancer:3.0.3")

Maven

xml
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <artifactId>demo</artifactId>
    <properties>
        <cosky.version>1.2.10</cosky.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>me.ahoo.cosky</groupId>
            <artifactId>spring-cloud-starter-cosky-config</artifactId>
            <version>${cosky.version}</version>
        </dependency>
        <dependency>
            <groupId>me.ahoo.cosky</groupId>
            <artifactId>spring-cloud-starter-cosky-discovery</artifactId>
            <version>${cosky.version}</version>
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-loadbalancer</artifactId>
          <version>3.0.3</version>
        </dependency>
    </dependencies>

</project>

bootstrap.yaml（Spring-Cloud-Config）

yaml
spring:
  application:
    name: ${service.name:cosky-rest-api}
  cloud:
    cosky:
      namespace: ${cosky.namespace:cosky-{system}}
      config:
        config-id: ${spring.application.name}.yaml
      redis:
        mode: ${cosky.redis.mode:standalone}
        url: ${cosky.redis.uri:redis://localhost:6379}
logging:
  file:
    name: logs/${spring.application.name}.log

REST-API 服务器（可选）

安装 REST-API 服务器

选项 1：下载可执行文件

下载 https://github.com/Ahoo-Wang/cosky/releases/download/1.2.10/cosky-rest-api-1.2.10.tar

解压 cosky-rest-api-1.2.10.tar

shell
cd cosky-rest-api-1.2.10
# 工作目录：cosky-rest-api-1.2.10
bin/cosky-rest-api --server.port=8080 --cosky.redis.uri=redis://localhost:6379

选项 2：Docker 运行

shell
docker pull ahoowang/cosky-rest-api:1.2.10
docker run --name cosky-rest-api -d -p 8080:8080 --link redis -e COSKY_REDIS_URI=redis://redis:6379  ahoowang/cosky-rest-api:1.2.10

选项 3：Kubernetes 运行

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: cosky-rest-api
  labels:
    app: cosky-rest-api
spec:
  replicas: 1
  selector:
    matchLabels:
      app: cosky-rest-api
  template:
    metadata:
      labels:
        app: cosky-rest-api
    spec:
      containers:
        - env:
            - name: COSKY_REDIS_MODE
              value: standalone
            - name: COSKY_REDIS_URI
              value: redis://redis-uri:6379
          image: ahoowang/cosky-rest-api:1.2.10
          name: cosky-rest-api
          ports:
            - containerPort: 8080
              protocol: TCP
          resources:
            limits:
              cpu: "1"
              memory: 1280Mi
            requests:
              cpu: 250m
              memory: 1024Mi
          volumeMounts:
            - mountPath: /etc/localtime
              name: volume-localtime
      volumes:
        - hostPath:
            path: /etc/localtime
            type: ""
          name: volume-localtime

---
apiVersion: v1
kind: Service
metadata:
  name: cosky-rest-api
  labels:
    app: cosky-rest-api
spec:
  selector:
    app: cosky-rest-api
  ports:
    - name: rest
      port: 80
      protocol: TCP
      targetPort: 8080

控制台

http://localhost:8080/dashboard

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-dashboard.png

服务依赖拓扑

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-topology.png

基于角色的访问控制（RBAC）

• cosky：保留用户名，超级用户，拥有最高权限。首次启动应用时，超级用户（cosky）密码会初始化并打印在控制台。若忘记密码，可配置enforce-init-super-user: true，CoSky 将重新初始化密码并打印在控制台。

log
----------------  CoSky -  init super user:[cosky] password:[6TrmOux4Oj]  ----------------

• admin：保留角色，超级管理员角色，拥有所有权限。一个用户可绑定多个角色，一个角色可绑定多个资源操作权限。
• 权限控制粒度为命名空间、读写操作。

角色权限

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-role.png

添加角色

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-role-add.png

用户管理

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-user.png

添加用户

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-user-add.png

审计日志

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-audit-log.png

命名空间

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-namespace.png

配置管理

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-config.png

编辑配置

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-config-edit.png

回滚配置

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-config-rollback.png

从Nacos导入配置

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-config-import.gif

服务管理

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-service.png

编辑服务实例

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/dashboard-service-edit.png

REST-API

http://localhost:8080/swagger-ui/index.html#/

命名空间

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/rest-api-namespace.png

• /v1/namespaces
  • GET
• /v1/namespaces/{namespace}
  • PUT
  • GET
• /v1/namespaces/current
  • GET
• /v1/namespaces/current/{namespace}
  • PUT

配置

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/rest-api-config.png

• /v1/namespaces/{namespace}/configs
  • GET
• /v1/namespaces/{namespace}/configs/{configId}
  • GET
  • PUT
  • DELETE
• /v1/namespaces/{namespace}/configs/{configId}/versions
  • GET
• /v1/namespaces/{namespace}/configs/{configId}/versions/{version}
  • GET
• /v1/namespaces/{namespace}/configs/{configId}/to/{targetVersion}
  • PUT

服务

!https://github.com/Ahoo-Wang/CoSky/raw/main/docs/rest-api-service.png

• /v1/namespaces/{namespace}/services/
  • GET
• /v1/namespaces/{namespace}/services/{serviceId}/instances
  • GET
  • PUT
• /v1/namespaces/{namespace}/services/{serviceId}/instances/{instanceId}
  • DELETE
• /v1/namespaces/{namespace}/services/{serviceId}/instances/{instanceId}/metadata
  • PUT
• /v1/namespaces/{namespace}/services/{serviceId}/lb
  • GET

JMH基准测试

• 开发笔记本：MacBook Pro (M1)
• 所有基准测试均在开发笔记本上进行。
• Redis部署在开发笔记本上。

配置服务

shell
gradle cosky-config:jmh
# 或
java -jar cosky-config/build/libs/cosky-config-1.2.10-jmh.jar -bm thrpt -t 25 -wi 1 -rf json -f 1

Benchmark                                          Mode  Cnt          Score   Error  Units
ConsistencyRedisConfigServiceBenchmark.getConfig  thrpt       256733987.827          ops/s
RedisConfigServiceBenchmark.getConfig             thrpt          241787.679          ops/s
RedisConfigServiceBenchmark.setConfig             thrpt          140461.112          ops/s

服务发现

shell
gradle cosky-discovery:jmh
# 或
java -jar cosky-discovery/build/libs/cosky-discovery-1.2.10-jmh.jar -bm thrpt -t 25 -wi 1 -rf json -f 1

Benchmark                                                Mode  Cnt          Score   Error  Units
ConsistencyRedisServiceDiscoveryBenchmark.getInstances  thrpt        76621729.048          ops/s
ConsistencyRedisServiceDiscoveryBenchmark.getServices   thrpt       455760632.346          ops/s
RedisServiceDiscoveryBenchmark.getInstances             thrpt          226909.985          ops/s
RedisServiceDiscoveryBenchmark.getServices              thrpt          304979.150          ops/s
RedisServiceRegistryBenchmark.deregister                thrpt          255305.648          ops/s
RedisServiceRegistryBenchmark.register                  thrpt          ***.160          ops/s
RedisServiceRegistryBenchmark.renew                     thrpt          210960.325          ops/s