README_zh.md

简体中文 | English | 官网 | 文档 | 博客 | 社区 · 论坛 | 案例 | Screenshots | Roadmap | changelog

猪齿鱼Choerodon-数智化开发管理平台

猪齿鱼Choerodon数智化开发管理平台，提供体系化方法论和协作、测试、DevOps及容器工具，帮助企业拉通需求、设计、开发、部署、测试和运营流程，一站式提高管理效率和质量。从团队协同到DevOps工具链、从平台工具到体系化方法论，猪齿鱼全面满足协同管理与工程效率需求，贯穿端到端全流程，助力团队效能更快更强更稳定。

猪齿鱼是基于开源技术Kubernetes，Istio，knative，Gitlab，Spring Cloud来实现本地和云端环境的集成，实现企业多云/混合云应用环境的一致性。

猪齿鱼 2.0：开源全新能力，更高可用性与稳定性！猪齿鱼2.0带来了开源代码管理、制品库管理、CI/CD流水线、容器集群、环境资源、应用部署等全新能力，以提供更高的可用性和稳定性。尽管本次版本不包含项目管理、测试管理、知识库等功能，但您可以注册试用环境，亲身体验项目协作管理特性。

需要注意的是，猪齿鱼开源2.0版本不支持由v1.1的平滑升级。然而，我们鼓励您尝试下载升级至2.0，亲自感受猪齿鱼2.0带来的卓越性能和功能。期待您的参与和反馈！ 猪齿鱼2.0，为您带来全新的开源体验！

Choerodon的特征

• 协作(商业版) -结合精益敏捷对业务需求、工作任务进行管理，打造高效协作生态。提供工作列表、故事地图、知识管理等协作工具，是贯穿开发、测试、部署的价值链，促进团队成员沟通交流，降低项目管理成本，提高沟通协作效率。

• 项目群(商业版) -在规模化敏捷管理中，主要应用了SAFe的团队层和项目群层概念进行规模化敏捷实践。我们将多个敏捷团队组建成一个项目群，由项目群的所有者统一管理并规划。制定开发节奏（迭代周期）、开发内容等，项目群中的任何项目都在同一个节奏上进行，从而提升产品开发交付周期。

• 开发 -提供迭代规划和持续集成的流水线，帮助规范应用服务开发，实现快速迭代。以DevOps理念为指引，结合精益看板和Gitlab的分支管理，提供持续集成的流水线，缩短应用服务开发周期，同时提高团队效率，高效频繁向测试团队或者用户交付软件新版本。

• 部署 -流水线式多环境一键部署。用户客户可以方便地使用部署功能管理各种使用猪齿鱼开发部署的应用服务，包括应用启停、状态监控，以及应用服务对应的版本控制、容器管理等，同时还包括应用服务涉及到的各种资源管理，例如网络、域名、数据库服务、缓存服务等。

• 测试(商业版) -敏捷化的持续测试工具，可以有效地提高软件测试的效率和质量。测试管理为用户提供敏捷化的持续测试工具，包括测试用例管理、测试计划管理、测试执行管理、缺陷管理、测试报告管理，支持手工测试并提供API测试、性能测试、流量回归测试、UI测试等自动化测试能力，测试任务还可嵌入开发流水线，持续测试有效保障产品质量。

• 运营 -汇集辅助项目进行管理的各种报表，多维度展示项目进展详情和问题。包含了敏捷报表（累积流量图、燃尽图等）、DevOps报表（代码提交图、代码质量图等）、测试报表。

• 微服务框架 - 基于汉得微服务技术平台HZERO的微服务架构，使用此开发框架，用户可以轻松构建应用服务。

另外，您可以查看猪齿鱼的屏幕快照以最直观地了解猪齿鱼，还可以访问猪齿鱼的网站。

组件关系列表

└─ choerodon-parent                                CHOERODON父依赖
    ├─ choerodon-register                                注册中心服务
    ├─ choerodon-gateway                                 网关服务
    ├─ choerodon-swagger                                 swagger服务
    ├─ choerodon-admin                                   平台治理服务
    ├─ choerodon-oauth                                   认证服务
    ├─ choerodon-iam                                     IAM服务
    ├─ choerodon-platform                                平台管理服务
    ├─ choerodon-file                                    文件服务
    ├─ choerodon-monitor                                 监控服务
    ├─ choerodon-message                                 消息服务
    ├─ devops-service-business                           devops服务
    ├─ workflow-service                                  工作流服务
    ├─ gitlab-service                                    gitlab服务
    ├─ hrds-prod-repo                                    制品库服务
    ├─ hrds-code-repo                                    代码库服务
    ├─ hzero-parent                                      HZERO父依赖
    └─ choerodon-starter-parent                          通用开发父组件
        ├─ choerodon-gitlab4j-api                             gitlab api组件
        ├─ choerodon-tool-liquibase                           liquibase初始化组件 
        │  └─ hzero-installer                                 hzero初始化工具 
        ├─ choerodon-starter-core                             辅助核心开发组件 
        └─ choerodon-starter-asgard                           asgard分布式事务组件

欲获取HZERO-PARENT详细的组件信息，可参考HZERO

安装

请遵循安装文档以安装猪齿鱼。

开始使用猪齿鱼

有关操作手册，请阅读文档。

如有任何疑问，您可以在论坛中发帖。

开始开发

猪齿鱼微服务开发框架的开发流程。

基础开发手册 介绍了使用猪齿鱼使用到的基础组件，包括如何从使用Kubernetes的yaml部署转型到使用helm chart 进行部署等一系列入门教程。

前端开发手册 介绍如何开发新的页面，如何建立并开发新的模块和系统平台的相关配置项。

后端开发手册 介绍基于开发的基本工具与其具体安装配置。通过此章节，用户可完成基本开发环境的搭建。

猪齿鱼的组成

该存储库包含猪齿鱼文档的源代码。如果您要查找单个组件，则它们位于自己的存储库中。

• choerodon-starter [GitHub]|[Gitee] - 是Choerodon开发的工具包，提供了一些开发过程中使用的基本依赖项。

• choerodon-framework [GitHub]|[Gitee] - 是Choerodon微服务框架。

• choerodon-register [GitHub]|[Gitee] - 该服务Choerodon的基于Eureka的平台注册中心服务。

• choerodon-platform [GitHub]|[Gitee]  - 该服务是Choerodon作为平台的基础管理服务，主要为平台提供一些基础能力，如系统配置、开发配置等。

• choerodon-oauth [GitHub]|[Gitee]  - 该服务是Choerodon微服务架构的授权认证中心, 主要负责用户权限设置和授权。

• choerodon-swagger [GitHub]|[Gitee]  - 该服务是Choerodon的api文档管理服务，主要负责接口文档，平台开发测试的API文档和调试管理。

• choerodon-gateway [GitHub]|[Gitee]  - 该服务是Choerodon基于Spring Cloud Gateway的微服务网关服务。

• choerodon-file [GitHub]|[Gitee]  - 该服务是Choerodon文件管理，为平台提供文件存储服务。

• choerodon-message [GitHub]|[Gitee]  - 该服务是Choerodon消息管理，平台统一的消息推送入口。

• choerodon-admin [GitHub]|[Gitee]  - 该服务是Choerodon的平台治理服务，提供自动化的路由刷新、权限刷新、swagger信息刷新功能。

• choerodon-iam [GitHub]|[Gitee]  - 该服务是Choerodon的核心后端服务，具有用户、角色、权限、组织、项目、密码策略、客户端、菜单、图标、多语言等管理功能，支持通过LDAP导入第三方用户。

• choerodon-asgard [GitHub]|[Gitee]  - 该服务是Choerodon的分布式定时任务及分布式事务管理服务。

• choerodon-monitor [GitHub]|[Gitee]  - 该服务是Choerodon的审计监控服务，提供监控审计功能，包括数据审计和操作审计。

• devops-service-business [GitHub]|[Gitee] - DevOps Service是 Choerodon的核心服务。集成了多个开源工具，以此形成了计划、编码、测试、部署、运维以及监控的DevOps闭环。

• gitlab-service [GitHub]|[Gitee] - 该服务通过引入外部java客户端与Gitlab进行交互。该客户端通过直接调用Gitlab提供的api，处理来自其他服务的Gitlab请求。

• workflow-service [GitHub]|[Gitee] - 该服务是基于Activiti7搭建的工作流服务，支持动态灵活地创建流程，启动流程、监控流程以及管理流程

• code-repo-service [GitHub]|[Gitee] - 该服务是代码库管理模块，通过与Gitlab集成, 提供权限管理等功能, 通过在Choerodon平台一站式管理代码库。

• prod-repo-service [GitHub]|[Gitee] - 该服务是制品库模块，通过整合nexus、harbor，提供管理maven包、npm包、docker镜像等功能。

• choerodon-ui [GitHub]|[Gitee]  - 基于 Ant Design Components 实现谷歌的 Material Design 的 React 组件，用于开发和服务于企业级后台产品。

• choerodon-front [GitHub]|[Gitee]  - 这个前端服务是一个联合体，包含了choerodon-front-base、choerodon-front-agile、choerodon-front-devops、choerodon-front-test-manager等前端服务。

• choerodon-front-hzero [GitHub]|[Gitee]  - 这个前端服务是choerodon与hzero融合后，部分功能移植到hzero系统的前端服务，包含了用户管理、接口、API测试等功能。

• choerodon-cluster-agent [GitHub]|[Gitee] - Choerodon的持续交付，通过活动连接的部署管道以及与Kubernetes集群直接交互（例如集群状态检查，应用程序环境状态检查，更新等）的核心组件。

演示环境

您还可以体验猪齿鱼的演示环境。

参与贡献

我们欢迎您的参与产品设计和社区生态建设，如果您有任何反馈意见，可直接至论坛发帖。如果您想参与开发，请阅读贡献文档并提交请求请求。

支持

如果您有任何疑问并需要我们的支持，可以以这些方式与我们联系。