@choerodon/prod-repo

简体中文 | English

Usage no npm install needed!

<script type="module">
  import choerodonProdRepo from 'https://cdn.skypack.dev/@choerodon/prod-repo';
</script>

README

简体中文 | English

prod-repo-service

prod-repo-service prod-repo-service是Choerodon平台管理制品库的基础. 当前版本为: 0.23.0

prod-repo-service通过整合nexus、harbor，提供管理maven包、npm包、docker镜像等功能。

特性

prod-repo-service 含有以下功能:

  • 自定义nexus服务 ：maven、npm制品库的创建可以使用默认的nexus服务，也可添加自己的nexus服务
  • 创建制品库 ：创建/更新maven、npm、docker制品仓库
  • 镜像/包管理：查看仓库下发布的制品列表、发布制品指引
  • 用户权限：分配项目成员的权限
  • 权限管理：分配权限、更新权限、删除权限
  • 操作日志：记录了权限分配/镜像操作的操作日志

前置要求

  • JAVA：prod-repo-service基于Java8进行开发
  • GitLab：prod-repo-service使用GitLab进行代码的托管。同时，通过基于GitLab Runner实现持续集成以完成代码编译，单元测试执行，代码质量分析，docker镜像生成，helm chart打包，服务版本发布等自动化过程
  • Harbor：企业级Docker registry 服务，用于存放服务版本所对应的docker镜像
  • Kubernetes：容器编排管理工具，用于部署服务版本所对应的helm chart包
  • ChartMuseum：Helm Chart仓库，用于存放服务版本所对应的helm chart包
  • Sonarqube：管理代码质量的开放平台，用于管理服务的代码质量
  • MySQL：主流数据库之一，用于数据持久化
  • Redis：内存数据库，用于数据缓存和部分非持久化数据存储
  • Nexus：Sonatype Nexus OSS是一个自由开源的仓库管理系统。
  • Harbor：Harbor是一个企业级DockerRegistry管理系统

服务依赖

  • choerodon-register: 注册中心，在线上环境代替本地的eureka-server
  • choerodon-platform：平台服务
  • choerodon-iam: 用户服务，与用户有关的操作依赖与此服务
  • choerodon-gateway: 网关服务
  • choerodon-oauth: 授权服务
  • choerodon-asgard : 事务一致性服务
  • choerodon-file : 文件服务

服务配置

  • bootstrap.yml:

      server:
    port: 7144
  management:
    server: 
      port: 7145
    endpoints:
      web:
        exposure:
          include: '*'

  spring:
    profiles:
      active: default
    cloud:
      config:
        fail-fast: false
        # 是否启用配置中心
        enabled: ${SPRING_CLOUD_CONFIG_ENABLED:false}
        # 配置中心地址
        uri: ${SPRING_CLOUD_CONFIG_URI:http://dev.hzero.org:8010}
        retry:
          # 最大重试次数
          maxAttempts: 6
          multiplier: 1.1
          # 重试间隔时间
          maxInterval: 2000
        # 标签
        label: ${SPRING_CLOUD_CONFIG_LABEL:}

  eureka:
    instance:
      # 以IP注册到注册中心
      preferIpAddress: ${EUREKA_INSTANCE_PREFER_IP_ADDRESS:true}
      leaseRenewalIntervalInSeconds: 10
      leaseExpirationDurationInSeconds: 30
      # 服务的一些元数据信息
      metadata-map:
        VERSION: 1.2.0.RELEASE
    client:
      serviceUrl:
        # 注册中心地址
        defaultZone: ${EUREKA_DEFAULT_ZONE:http://hzero-register.staging.saas.hand-china.com/}
      registryFetchIntervalSeconds: 10
      disable-delta: true

  • application.yml:

      spring:
    application:
      name: prod-repo-service
    datasource:
      url: ${SPRING_DATASOURCE_URL:jdbc:mysql://db.hzero.org:3306/hrds_prod_repo?useUnicode=true&characterEncoding=utf-8&useSSL=false}
      username:  ${SPRING_DATASOURCE_USERNAME:root}
      password: ${SPRING_DATASOURCE_PASSWORD:handhand}
      hikari:
        # 连接池最小空闲连接数
        minimum-idle: ${SPRING_DATASOURCE_MINIMUM_IDLE:20}
        # 连接池允许的最大连接数
        maximum-pool-size: ${SPRING_DATASOURCE_MAXIMUM_POOL_SIZE:200}
        # 等待连接池分配连接的最大时长（毫秒）
        connection-timeout: ${SPRING_DATASOURCE_CONNECTION_TIMEOUT:30000}
    redis:
      host: redis.hzero.org
      port: 6379
      database: 1
      jedis:
        pool:
          # 资源池中最大连接数
          # 默认8，-1表示无限制；可根据服务并发redis情况及服务端的支持上限调整
          max-active: ${SPRING_REDIS_POOL_MAX_ACTIVE:50}
          # 资源池运行最大空闲的连接数
          # 默认8，-1表示无限制；可根据服务并发redis情况及服务端的支持上限调整，一般建议和max-active保持一致，避免资源伸缩带来的开销
          max-idle: ${SPRING_REDIS_POOL_MAX_IDLE:50}
          # 当资源池连接用尽后，调用者的最大等待时间(单位为毫秒)
          # 默认 -1 表示永不超时，设置5秒
          max-wait: ${SPRING_REDIS_POOL_MAX_WAIT:5000}
    resources:
      # 资源缓存时间，单位秒
      cache.period: 3600
      # 开启gzip压缩
      chain.gzipped: true
      # 启用缓存
      chain.cache: true
  
  server: 
    undertow:
      # 设置IO线程数, 它主要执行非阻塞的任务,它们会负责多个连接
      # 默认值为8，建议设置每个CPU核心一个线程
      io-threads: ${SERVER_UNDERTOW_IO_THREADS:4}
      # 阻塞任务线程池, 当执行类似servlet请求阻塞操作, undertow会从这个线程池中取得线程
      # 默认等于 io-threads*8，它的值设置取决于系统的负载，可适当调大该值
      worker-threads: ${SERVER_UNDERTOW_WORKER_THREADS:128}
      # 每块buffer的空间大小，越小空间被利用越充分
      # 不要设置太大，以免影响其他应用，合适即可
      buffer-size: ${SERVER_UNDERTOW_BUFFER_SIZE:1024}
      # 是否分配的直接内存(NIO直接分配的堆外内存)
      # 默认false
      direct-buffers: true
      # HTTP POST请求最大的大小
      # 默认0，无限制，可设置10M
      max-http-post-size: 10485760
      allow-unescaped-characters-in-url: true
  
  feign:
    hystrix:
      enabled: true
  
  hystrix:
    threadpool:
      default:
        # 执行命令线程池的核心线程数，也是命令执行的最大并发量
        # 默认10
        coreSize: 1000
        # 最大执行线程数
        maximumSize: 1000
    command:
      default:
        execution:
          isolation:
            thread:
              # HystrixCommand 执行的超时时间，超时后进入降级处理逻辑。一个接口，理论的最佳响应速度应该在200ms以内，或者慢点的接口就几百毫秒。
              # 默认 1000 毫秒，最高设置 2000足矣。如果超时，首先看能不能优化接口相关业务、SQL查询等，不要盲目加大超时时间，否则会导致线程堆积过多，hystrix 线程池卡死，最终服务不可用。
              timeoutInMilliseconds: ${HYSTRIX_COMMAND_TIMEOUT_IN_MILLISECONDS:40000}
  
  ribbon:
    # 客户端读取超时时间，超时时间要小于Hystrix的超时时间，否则重试机制就无意义了
    ReadTimeout: ${RIBBON_READ_TIMEOUT:30000}
    # 客户端连接超时时间
    ConnectTimeout: ${RIBBON_CONNECT_TIMEOUT:3000}
    # 访问实例失败(超时)，允许自动重试，设置重试次数，失败后会更换实例访问，请一定确保接口的幂等性，否则重试可能导致数据异常。
    OkToRetryOnAllOperations: true
    MaxAutoRetries: 1
    MaxAutoRetriesNextServer: 1
  
  mybatis:
    mapperLocations: classpath*:/mapper/*.xml
    configuration:
      mapUnderscoreToCamelCase: true
      key-generator: snowflake
      snowflake:
        start-timestamp: 1577808000000
        meta-provider: redis
        meta-provider-redis-db: 1
        meta-provider-redis-refresh-interval: 540000
        meta-provider-redis-expire: 600000
        data-center-id: 1
        worker-id: 1

  
  
  logging:
    level:
      org.apache.ibatis: ${LOGGING_LEVEL:debug}
      io.choerodon: ${LOGGING_LEVEL:debug}
      org.hzero: ${LOGGING_LEVEL:debug}
      org.hrds.rdupm: ${LOGGING_LEVEL:debug}
  
  hzero:
    scheduler:
      autoRegister: false
    lock:
      pattern: single
      single-server:
        address: ${SPRING_REDIS_HOST:localhost}
        port: ${SPRING_REDIS_PORT:6379}
    service:
      platform:
        name: cherodon-platform
      oauth:
        name: choerodon-oauth
      iam:
        name: choerodon-iam
      file:
        name: choerodon-file
      message:
        name: choerodon-message
      admin:
        name: choerodon-admin
      swagger:
        name: choerodon-swagger
      gateway:
        name: choerodon-gateway
      monitor:
        name: choerodon-monitor
  choerodon:
    category:
      enabled: true # 是否开启项目/组织类型控制
    devops:
      message: true
    eureka:
      event:
        max-cache-size: 300
        retry-time: 5
        retry-interval: 3
        skip-services: config**, **register-server, **gateway**, zipkin**, hystrix**, oauth**
    saga:
      service: choerodon-asgard
      consumer:
        enabled: true # 启动消费端
        thread-num: 2 # saga消息消费线程池大小
        max-poll-size: 200 # 每次拉取消息最大数量
        poll-interval-ms: 1000 # 拉取间隔，默认1000毫秒
    schedule:
      consumer:
        enabled: true # 启用任务调度消费端
        thread-num: 1 # 任务调度消费线程数
        poll-interval-ms: 1000 # 拉取间隔，默认1000毫秒
    cleanPermission: false
  
  harbor:
    baseUrl: ${HARBOR_BASE_URL:https://hzero.org}
    username: ${HARBOR_USER_NAME:xxx}
    password: ${HARBOR_PASSWORD:xxx}
    init:
      defaultRepoUrl: ${HARBOR_INIT_DEFAULT_REPO_URL:jdbc:mysql://db.hzero.org:3306/hzero_platform?useUnicode=true&characterEncoding=utf-8&useSSL=false}
      defaultRepoUsername: ${HARBOR_INIT_DEFAULT_REPO_USERNAME:xxx}
      defaultRepoPassword: ${HARBOR_INIT_DEFAULT_REPO_PASSWORD:xxx}
      customRepoUrl: ${HARBOR_INIT_CUSTOM_REPO_URL:jdbc:mysql://db.hzero.org:3306/devops_service?useUnicode=true&characterEncoding=utf-8&useSSL=false}
      customRepoUsername: ${HARBOR_INIT_CUSTOM_REPO_USERNAME:xxx}
      customRepoPassword: ${HARBOR_INIT_CUSTOM_REPO_PASSWORD:xxx}
  nexus:
    default:
      #系统默认nexus服务地址
      serverUrl: ${NEXUS_DEFAULT_BASE_URL:https://localhost}
      #系统默认nexus服务，超级管理员用户
      username: ${NEXUS_DEFAULT_USER_NAME:admin}
      #系统默认nexus服务，超级管理员用户密码
      password: ${NEXUS_DEFAULT_PASSWORD:admin}
      #系统默认nexus服务，是否启用仓库级的匿名访问控制。 1:启用  0:不启用。
      enableAnonymousFlag: ${NEXUS_DEFAULT_ENABLE_ANONYMOUS_FLAG:0}
      #系统默认nexus服务，启用仓库级的匿名访问控制时需要配置该值(即enableAnonymousFlag==1时)。 nexus服务开启全局匿名访问时，配置的用户
      anonymousUser: ${NEXUS_DEFAULT_ANONYMOUS_USER:test}
      #系统默认nexus服务，启用仓库级的匿名访问控制时需要配置该值(即enableAnonymousFlag==1时)。 nexus服务开启全局匿名访问时，配置的用户对应的角色
      anonymousRole: ${NEXUS_DEFAULT_ANONYMOUS_ROLE:test}
  DesEncrypt:
    # 制品库密码， 加解密密钥
    desKey: ${DES_ENCRYPT_DES_KEY:xxx}
    # 长度：8位
    desIV: ${DES_ENCRYPT_DES_IV:xxxxxxxx}

安装和启动步骤

  1. 创建数据库hrds_prod_repo，创建用户choerodon，并为用户分配权限：

    CREATE USER 'choerodon'@'%' IDENTIFIED BY "choerodon";
CREATE DATABASE hrds_prod_repo DEFAULT CHARACTER SET utf8;
GRANT ALL PRIVILEGES ON hrds_prod_repo.* TO choerodon@'%';
FLUSH PRIVILEGES;

  2. 拉取prod-repo-service代码到本地：

    git clone https://github.com/choerodon/prod-repo-service.git

  3. 在项目根目录执行命令： sh init-database.sh

  4. 使用下列命令运行或直接在集成环境中运行 RdudmApplication

    mvn clean spring-boot:run

链接

更新日志

反馈途径

如果您发现任何缺陷或bug，请及时 issue告知我们 。

如何参与

欢迎参与我们的项目，了解更多有关如何参与贡献的信息。