Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-hand/devops-service
DevOps Service is the core service of Choerodon. It integrated several open source tools to automate the DevOps process of planning, coding, building, testing, and deployment, operation, monitoring.
https://github.com/open-hand/devops-service
choerodon devops gitflow java spring spring-boot spring-cloud
Last synced: 5 days ago
JSON representation
DevOps Service is the core service of Choerodon. It integrated several open source tools to automate the DevOps process of planning, coding, building, testing, and deployment, operation, monitoring.
- Host: GitHub
- URL: https://github.com/open-hand/devops-service
- Owner: open-hand
- Created: 2018-05-19T06:14:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T06:44:48.000Z (2 months ago)
- Last Synced: 2024-12-29T23:37:26.460Z (12 days ago)
- Topics: choerodon, devops, gitflow, java, spring, spring-boot, spring-cloud
- Language: Java
- Homepage: http://choerodon.io
- Size: 66.2 MB
- Stars: 62
- Watchers: 10
- Forks: 77
- Open Issues: 10
-
Metadata Files:
- Readme: README.en_US.md
- Changelog: CHANGELOG.en-US.md
Awesome Lists containing this project
README
English | [简体中文](./README.md)
# DevOps Service
`DevOps Service` is the continuous delivery service of Choerodon. Current version: `1.1.0`
DevOps Service integrated several open source tools to automate the process of `planning`, `coding`, `building`, `testing`, `deployment`, `operation` and `monitoring`.
After a little simple configuration, you'll get the smoothest development experience.
> NOTICE: The previous front code was moved [here](https://github.com/open-hand/choerodon-front-devops)
## Feature
`DevOps Service` contains features as follows:
- `Application Service Management`: Manage the application service
- `Application service version management`: Manage the versions released during the `Continuous Integration` process of the services, which can be deployed directly in the `Kubernetes` cluster
- `Code management & version control`: Manage the code of the application service with version control
- `Branch management`: Able to operate the git branches of the application service
- `Code Quality Analysis`：data of code quality are collected during `CI`, `SonarQube` is integrated.
- `Continuous Integration Overview`: Glance at the `Continuous Integration` process
- `Deployment Management`: Deploy the versions from `CI` by `GitOps`
- `Continuous Deployment Pipeline Management`: Achieve the `Continuous Deployment` by workflow
- `Resource Management`: Manage the resource(e.g., secret)
- `Cluster Management`: Manage the cluster of `Kubernetes`
## Requirements
- [JAVA](https://www.java.com/en/): `DevOps Service` is based on java8
- [GitLab](https://about.gitlab.com/): `GitLab` is used as code repository. At the same time, `Continuous Integration` based on `GitLab Runner` is used to complete code compilation, unit test execution, code quality analysis, docker image generation, helm chart packaging, service version releasing and other automated processes
- [Harbor](https://vmware.github.io/harbor/cn/): Enterprise Docker registry service for hosting the docker images for the service versions
- [Kubernetes](https://kubernetes.io/): Container orchestration management tool for deploying the helm chart packages corresponding to the service versions
- [ChartMuseum](https://chartmuseum.com/): Helm Chart Repository server., which is used to store the helm chart package corresponding to the service versions
- [Sonarqube](https://www.sonarqube.org/): SonarQube empowers all developers to write cleaner and safer code for application services
- [MySQL](https://www.mysql.com): one of the most popular relational databases, for data persistence of `DevOps Service`
- [Redis](https://redis.io/): In-memory database for data caching and partial non-persistent data storage
## Dependencies
* `choerodon-register`: Register server, in place of `eureka-server`
* `choerodon-iam`：Iam service
* `choerodon-gateway`: Gateway service
* `choerodon-oauth`: Oauth service
* `choerodon-asgard` : Transaction consistency service
* `choerodon-message` : Notify service
* `gitlab-service`：Service to communicate with gitlab
* `workflow-service`：Workflow service
* `agile-service`：Agile service
## Service Configuration
* `bootstrap.yml`:
```yaml
server:
port: 8060
spring:
application:
name: devops-service
cloud:
config:
failFast: true
retry:
maxAttempts: 6
multiplier: 1.5
maxInterval: 2000
uri: localhost:8010
enabled: false
mvc:
static-path-pattern: /**
resources:
static-locations: classpath:/static,classpath:/public,classpath:/resources,classpath:/META-INF/resources,file:/dist
management:
server:
port: 8061
endpoints:
web:
exposure:
include: '*'
```
* `application.yml`:
```yaml
spring:
datasource:
url: jdbc:mysql://localhost/devops_service?useUnicode=true&characterEncoding=utf-8&useSSL=false
username: choerodon
password: choerodon
hikari:
maximum-pool-size: 15
redis:
host: localhost
database: ${SPRING_REDIS_DATABASE:1}
http:
encoding:
charset: UTF-8
force: true
enabled: true
services:
harbor:
baseUrl: "harbor.example.com" # harbor url
username: "123456" # harbor username
password: "123456" # password corresponding to harbor user
insecureSkipTlsVerify: false
gitlab:
url: "gitlab.example.com" # gitlab url
sshUrl: "gitlab.example.com" # gitlab url for ssh operations
projectLimit: 100 # the limit of the project number that a user can create
helm:
url: "helm.example.com" # the repository url to place helm charts
gateway:
url: "http://api.example.com" # the domain of the hzero gateway
hzero:
service:
platform:
name: choerodon-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
websocket:
# the path for websocket connection
websocket: /websocket
# consistent with the redis db above
redisDb: ${SPRING_REDIS_DATABASE:1}
# the secret for websocket
secretKey: devops_ws
choerodon:
saga:
consumer:
core-thread-num: 20
max-thread-num: 20 # consumer thread number
poll-interval: 3 # the interval for polling messages, default 1s
enabled: true # whether to enable consumer client
schedule:
consumer:
enabled: true # enable schedule consume
thread-num: 1 # thread number for consuming
poll-interval-ms: 1000 # the interval for polling messages, default 1000ms
resource:
jwt:
ignore: /workflow/**, /sonar/**, /ci, /sonar/info, /v2/api-docs, /agent/**, /ws/**, /gitlab/email, /webhook/**, /v2/choerodon/**, /choerodon/**, /actuator/**, /prometheus, /devops/**, /pre_stop, /websocket
agent:
version: "0.5.0" # expect choerodon-agent version for this devops-service version
serviceUrl: "agent.example.com" # url for choerodon-agent to connect devops-service
certManagerUrl: "agent.example.com" # the location to store the CertManager for installation
repoUrl: "helm.example.com" # the location to store the agent package itself for installation
mybatis:
mapperLocations: classpath*:/mapper/*.xml
configuration:
mapUnderscoreToCamelCase: true
feign:
hystrix:
shareSecurityContext: true
command:
default:
execution:
isolation:
thread:
timeoutInMilliseconds: 30000
ribbon:
ConnectTimeout: 50000
ReadTimeout: 50000
asgard-servie:
ribbon:
ConnectTimeout: 50000
ReadTimeout: 50000
# websocket max buffer size (byte)
websocket:
buffer:
maxTextMessageSize: 4194304
maxBinaryMessageSize: 4194304
devops:
ansible:
image: registry.cn-shanghai.aliyuncs.com/c7n/kubeadm-ha:0.1.0
# helm download url
helm:
download-url: https://file.choerodon.com.cn/kubernetes-helm/v3.2.4/helm-v3.2.4-linux-amd64.tar.gz
# The default runner mirror address in the Gitlab Ci file generated by ci pipeline
ci:
default:
image: registry.cn-shanghai.aliyuncs.com/c7n/cibase:0.9.1
pipeline:
sync:
executor:
corePoolSize: 5
maxPoolSize: 8
unterminated:
# The time threshold for data compensation of the ci pipeline to the unterminated pipeline, unit: milliseconds (default 600 seconds)
thresholdMilliSeconds: 600000
pending:
# The time threshold for the ci pipeline to compensate the pending pipeline, unit: milliseconds (default 600 seconds)
thresholdMilliSeconds: 600000
jobEmpty:
# threshold to complete data if non data for job, ms: (default 600seconds)
thresholdMilliSeconds: 600000
refresh:
# redisKey expiration, control the refresh period
periodSeconds: 60
# the size for max batch deployment
batch:
deployment:
maxSize: 20
```
## Installation and Getting Started
1. create database `devops_service`, create user `choerodon` and grant permission:
```sql
CREATE USER 'choerodon'@'%' IDENTIFIED BY "choerodon";
CREATE DATABASE devops_service DEFAULT CHARACTER SET utf8;
GRANT ALL PRIVILEGES ON devops_service.* TO choerodon@'%';
FLUSH PRIVILEGES;
```
2. pull source code of `DevOps Service`:
```sh
git clone https://github.com/choerodon/devops-service.git
```
3. Execute command in the project root directory: `mvn clean package spring-boot:repackage -Dmaven.test.skip=true && bash init-database.sh`
4. Run with the following commands or run `DevopsServiceApplication` directly in the integrated environment:
```sh
mvn clean spring-boot:run
```
## Links
[ChangeLog](./CHANGELOG.en-US.md)
## Reporting Issues
If you find any shortcomings or bugs, please describe them in the [issue](https://github.com/choerodon/devops-service/issues/new).
## How to Contribute
Pull requests are welcomed! [Follow](https://github.com/choerodon/choerodon/blob/master/CONTRIBUTING.md) to know for more information on how to contribute.