# choerodon **Repository Path**: cglcoder/choerodon ## Basic Information - **Project Name**: choerodon - **Description**: Choerodon猪齿鱼开源多云集成平台，基于开源技术Kubernetes，Istio，knative，Gitlab和Spring Cloud来实现本地和云端环境的集成，实现企业多云/混合云应用环境的一致性。平台通过提供精益敏捷、持续交付、容器环境、微服务、DevOps等能力来帮助组织团队来完成软件的生命周期管理，从而更快、更频繁地交付更稳定的软件。 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://choerodon.io/zh/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 417 - **Created**: 2019-08-21 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [English](https://gitee.com/choerodon/choerodon/blob/master/README.md) | [官网](http://choerodon.io) | [文档](http://choerodon.io/zh/docs/) | [博客](http://choerodon.io/zh/blog/) | [社区](http://choerodon.io/zh/community/) · [论坛](http://forum.choerodon.io) | [案例](http://choerodon.io/zh/case-studies/) | [截图](https://gitee.com/choerodon/choerodon/blob/master/SCREENSHOT.md) | [路线图](https://gitee.com/choerodon/choerodon/blob/master/ROADMAP.md) | [版本更新](https://gitee.com/choerodon/choerodon/blob/master/changelogs/) 提示：我们十分欢迎您的参与！如果您有任何反馈，请在论坛上[提交问题](http://forum.choerodon.io/)。您还可以[注册Choerodon](https://choerodon.com.cn/#/organization/register-organization)，开始体验之旅。 # Choerodon - 开源多云集成平台 ![](img/choerodon-community.png) Choerodon猪齿鱼开源多云集成平台，基于开源技术[Kubernetes](https://kubernetes.io/)，[Istio](https://istio.io/)，[knative](https://pivotal.io/knative)，[Gitlab](https://about.gitlab.com/)和[Spring Cloud](https://spring.io/projects/spring-cloud)来实现本地和云端环境的集成，实现企业多云/混合云应用环境的一致性。平台通过提供精益敏捷、持续交付、容器环境、微服务、DevOps等能力来帮助组织团队来完成软件的生命周期管理，从而更快、更频繁地交付更稳定的软件。 Choerodon猪齿鱼主要包含: - 融合集成一整套Agile/DevOps的工具链，包括知识管理、敏捷管理、应用管理、开发流水线、测试管理、部署流水线和运营管理等。 - 一套基于Spring Cloud的微服务开发框架，帮助企业更快、更高效地进行微服务开发。 ## 特性 - [**知识管理**](http://choerodon.io/zh/docs/user-guide/wiki/) - 知识管理服务是一个轻量级的强大Wiki平台，允许用户根据自己的特定需求自定义Wiki，为企业、IT团队提供方便的项目协作平台和强大的项目内容管理平台，集中式管理产品相关内容、管理相关内容等，例如需求收集、架构设计、功能设计、开发规范、命名规范、会议记录、计划安排等。 - [**敏捷管理**](http://choerodon.io/zh/docs/user-guide/agile/) - 敏捷管理提供了一套工具来帮助用户通过敏捷的方式来管理用户价值的流动，使整个软件开发流程管理规范化。敏捷管理的核心是需求，计划和执行。即通过故事地图、用户故事来管理用户故事和发布计划，通过迭代来管理冲刺，最后通过看板来可视化冲刺的执行。 - [**应用管理**](http://choerodon.io/zh/docs/user-guide/application-management/) - 借助应用管理，开发人员可以方便地进行应用创建，进行灵活的应用版本控制，同时可以将开发的应用发布至其他项目使用，并且通过应用市场可以便捷地查看项目以及组织内部所有的应用，以及进行应用部署等。 - [**开发流水线**](http://choerodon.io/zh/docs/user-guide/development-pipeline/) - 以DevOps理念为指引，借助Gitlab CI作为持续集成工具，结合Gitlab的分支管理，提供持续集成的流水线，可以简化应用开发、应用生命周期，以及快速迭代，同时还能提高团队效率，保持高质量；并且高效频繁地将软件的新版本，交付给质量团队或者用户。 - [**测试管理**](http://choerodon.io/zh/docs/user-guide/test-management/) - 测试管理为用户提供敏捷化的持续测试工具，包括测试用例管理、测试循环、测试分析等，可以有效地提高软件测试的效率和质量，提高测试的灵活性和可视化水平，最终减少测试时间，让用户将主要精力放到软件功能构建上。 - [**部署流水线**](http://choerodon.io/zh/docs/user-guide/deployment-pipeline/) - 借助部署流水线，用户客户可以方便地管理各种使用Choerodon开发部署的应用服务，包括应用启停、状态监控，以及应用对应的版本控制、容器管理等，同时还包括应用涉及到的各种资源管理，例如网络、域名、数据库服务、缓存服务等。 - [**运营管理**](http://choerodon.io/zh/docs/user-guide/operating-manage/) - 借助运营管理工具，在软件交付生产的各个环节建立数据收集和度量，使得团队能够根据交付过程当中的瓶颈做出必要的改进，监控主要包含开发类指标、服务器日志，应用系统日志和微服务调用链等信息；同时，提供各种分析报告，帮助用户优化IT资源配置。 - [**微服务开发**](http://choerodon.io/zh/docs/development-guide/) - 一套完整的基于Spring Cloud的微服务应用开发框架。借助微服务开发架构，以及容器为微服务提供的轻量级、面向应用的虚拟化运行环境和理想载体，并以Kubernetes作为容器编排工具，帮助企业方便快捷的构建应用服务。 同时，可以通过[系统截图](SCREENSHOT.md)对Choerodon有一个更加直观的认识和理解，也可以访问Choerodon的[官网](http://choerodon.io/)，获得更详细的信息。 ## 安装与部署 可以访问官网的[安装文档](http://choerodon.io/zh/docs/installation-configuration/)，获得详细的安装说明。 ## 开始使用Choerodon 在开始使用 Choerodon 之前，请阅读[快速入门手册](http://choerodon.io/zh/docs/quick-start/). 关于操作手册，请阅读文件[ 用户手册 ](http://choerodon.io/zh/docs/user-guide/). ## 使用 Choerodon 进行开发 Choerodon 的微服务开发框架由微服务后端和前端两个部分组成。 如果你想对微服务后端进行开发，请参考[后端开发手册](http://choerodon.io/zh/docs/development-guide/backend/)。 此外，在[前端开发手册](http://choerodon.io/zh/docs/development-guide/front/) 的帮助下，你能尽快熟悉Choerodon的前端开发流程。 如果你有任何问题，都可以在[论坛](http://forum.choerodon.io/)中提出。 ## Choerodon的组件 这个仓库包含了Choerodon文档的源代码，如果您想要寻找单个的组件，可以在对应的各个仓库中找到。 - [choerodon-starter](https://gitee.com/choerodon/choerodon-starters.git) - 是Choerodon开发的工具包，提供了一些开发过程中使用的基本依赖项。 - [choerodon-framework](https://gitee.com/choerodon/choerodon-framework.git) - 是Choerodon微服务框架。 - [api-gateway](https://gitee.com/choerodon/api-gateway.git) - Choerodon的网关服务负责发送指定请求到实际的服务器。 - [config-server](https://gitee.com/choerodon/config-server.git) - Choerodon的配置服务是用于统一管理服务配置文件的配置中心。 - [manager-service](https://gitee.com/choerodon/manager-service.git) - 该服务是Choerodon微服务开发框架的管理中心，它的主要功能包括配置管理、交付管理和 swagger 管理。 - [gateway-helper](https://gitee.com/choerodon/gateway-helper.git) - 验证和限制 API 网关的请求, 创建 JWT 并返回到 API 网关。 - [oauth-server](https://gitee.com/choerodon/oauth-server.git) - 该服务是 Choerodon 微服务架构的授权认证中心, 主要负责用户权限设置和授权。 - [go-register-server](https://gitee.com/choerodon/go-register-server.git) - 使用Go语言实现的注册服务，`go-register-server`与K8s紧密集成，可以监控集群中POD的状态，并可以统计注册服务客户端的信息。 - [iam-service](https://gitee.com/choerodon/iam-service.git) - Choerodon的核心后端服务，具有用户、角色、权限、组织、项目、密码策略、快速代码、客户端、菜单、图标、多语言等管理功能，支持通过LDAP导入第三方用户。 - [asgard-service](https://gitee.com/choerodon/asgard-service.git) - 分布式定时任务及分布式事务管理服务。 - [file-service](https://gitee.com/choerodon/file-service.git) - 文件服务构建在minio服务器上，我们可以使用minio客户端上传和删除文件。 - [choerodon-ui](https://gitee.com/choerodon/choerodon-ui.git) - 基于 Ant Design Components 实现谷歌的 Material Design 的 React 组件，用于开发和服务于企业级后台产品。 - [choerodon-front](https://gitee.com/choerodon/choerodon-front.git) - 这个前端服务是一个联合体，包含了choerodon-front-iam、choerodon-front-agile、choerodon-front-devops、choerodon-front-wiki、choerodon-front-test-manager等前端服务。 - [choerodon-front-boot](https://gitee.com/choerodon/choerodon-front-boot.git) - 是前端脚手架，负责前端包的管理、启动、编译。 - [choerodon-front-iam](https://gitee.com/choerodon/choerodon-front-iam.git) - 是IAM的整体前端服务，包含Choerodon的组织管理、用户管理、权限管理等功能。 - [choerodon-front-agile](https://gitee.com/choerodon/choerodon-front-agile.git) - 是敏捷管理的前端服务，该服务包含所有敏捷管理相关的页面，并通过丰富的交互显为用户提供更好的敏捷流程服务。 - [agile-service](https://gitee.com/choerodon/agile-service.git) - 是敏捷管理的后端服务。该服务负责敏捷流程管理，包括问题管理、待办事项、发布版本、活跃冲刺、模块管理、报告。 - [choerodon-front-devops](https://gitee.com/choerodon/choerodon-front-devops.git) - DevOps Front是Choerodon的核心前端服务，该服务包含所有持续交付相关的页面，并通过丰富的交互显为用户提供更好的DevOps流程服务。 - [devops-service](https://gitee.com/choerodon/devops-service.git) - DevOps服务是Choerodon的核心服务。该服务集成了几个开源工具来实现自动化规划、编码、构建、测试，以及部署、操作、监控等过程。 - [gitlab-service](https://gitee.com/choerodon/gitlab-service.git) - Gitlab服务负责与Gitlab建立沟通，处理Gitlab相关逻辑，例如，创建分支、合并分支、读取Gitlab库相关信息等，并将其转接给其他服务。 - [choerodon-agent](https://gitee.com/choerodon/choerodon-agent.git) - 是猪齿鱼持续交付部分的一个核心组件，通过主动连接部署服务，并与Kubernetes集群进行直接交互，例如集群状态检查，应用环境状态检查、更新等。 - [wiki-service](https://gitee.com/choerodon/wiki-service.git) - 是知识管理的后端服务。知识管理是便捷的项目协作平台和强大的项目内容管理平台。 - [choerodon-front-wiki](https://gitee.com/choerodon/choerodon-front-wiki.git) - 是知识管理的前端服务，包含了知识管理相关的组件和页面。 - [test-manager-service](https://gitee.com/choerodon/test-manager-service.git) - 是测试管理后端服务。敏捷化的持续测试工具，可以有效地提高软件测试的效率和质量。 - [choerodon-front-test-manager](https://gitee.com/choerodon/choerodon-front-test-manager.git) - 是测试管理的前端服务，包含了测试管理相关的组件和页面。 - [issue-service](https://gitee.com/choerodon/issue-service) - 是一个用于管理issue属性设置的服务，通过方案的形式管理包括问题类型，状态，优先级在内的issue属性。 - [state-machine-service](https://gitee.com/choerodon/state-machine-service) - 是一个管理issue状态流转的服务，包括状态转换前后的校验，转换前后的自动化任务执行等。 - [choerodon-front-issue](https://gitee.com/choerodon/choerodon-front-issue.git) - 该服务负责问题和状态机进程管理，并通过丰富的显示为用户提供更好的用户体验。 ## 贡献 我们十分欢迎您的参与！如果您有任何反馈，请在论坛上[提交问题](http://forum.choerodon.io/)。如果您想参与开发，请阅读[贡献文档](CONTRIBUTING.md)并提交拉取请求。 ## 支持 如果您有任何问题，需要我们的支持，[可以通过这些方式联系我们](http://choerodon.io/zh/community/)。