Skip to content

Commit 757584d

Browse files
author
egunyoa
committed
depercated, add new repo links
1 parent e209bf5 commit 757584d

File tree

1 file changed

+9
-100
lines changed

1 file changed

+9
-100
lines changed

README.md

Lines changed: 9 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,15 @@
1-
flow-platform
1+
flow-platform
22
============
33

4-
'flow-platform' is a backend project for flow.ci, it consist three main sub projects:
4+
[DEPRECATED]
55

6-
- api:
7-
- control-center: to handle agent status and dispatch task to agent
8-
- agent: running in the any where to receive task from control center
6+
The project has been moved to:
97

8+
- [flow-platform-x](https://github.com/FlowCI/flow-platform-x): core services
9+
- [flow-web-x](https://github.com/FlowCI/flow-web-x): web ui component
10+
- [flow-agent-x](https://github.com/FlowCI/flow-agent-x): worker to execute flow or pipeline
1011

11-
## Getting Start
12+
Getting Started
1213

13-
### Start with docker
14-
15-
首先 Docker pull flowci/flow-platform , 把对应的镜像拉下来
16-
17-
> 环境变量的设置:
18-
>
19-
> - `FLOW_API_DOMAIN`:部署的后端 API 域名地址 `必填`
20-
> - `FLOW_WEB_DOMAIN`:部署的前端 Web 页面的域名地址 `必填`
21-
> - `FLOW_SYS_EMAIL`:flowci 系统管理员账号 `必填`
22-
> - `FLOW_SYS_USERNAME`:flowci 系统管理员的用户名 `必填`
23-
> - `FLOW_SYS_PASSWORD`:flowci 系统管理员密码 `必填`
24-
> - `MYSQL_PASSWORD`:flowci MYSQL 数据库的密码 `必填`
25-
> - `MYSQL_HOST`:flowci MYSQL 数据库的 `HOST` `必填`
26-
> - `PORT`:外网访问的 API 端口,默认:8080 `选填`
27-
> - `MYSQL 的存储路径`: `~/flow-ci/db` `选填`
28-
29-
```
30-
docker run -it \
31-
-e MYSQL_HOST=127.0.0.1 \
32-
-e MYSQL_PASSWORD=123456 \
33-
34-
-e FLOW_SYS_USERNAME=admin \
35-
-e FLOW_SYS_PASSWORD=123456 \
36-
-e FLOW_API_DOMAIN=127.0.0.1 \
37-
-e FLOW_WEB_DOMAIN=127.0.0.1 \
38-
-p 8080:8080 \
39-
-v ~/flow-ci/data:/var/lib/mysql \
40-
flowci/flow-platform
41-
42-
```
43-
44-
### Build by maven
45-
46-
Using standard maven `mvn clean install -DskipTests=true` to generate packages
47-
48-
####Installation####
49-
50-
In build phase will generate three packages:
51-
52-
| project | package | container |
53-
|---------|---------|-----------|
54-
| api | flow-api.war | tomcat 8.5 |
55-
| control-center | flow-control-center.war | tomcat 8.5 |
56-
| agent | flow-agent-{version}.jar | |
57-
58-
**flow api**
59-
60-
Dependencies:
61-
62-
- Mysql 5.6
63-
64-
**flow control center**
65-
66-
Dependencies:
67-
68-
- Apache zookeeper 3.4.10
69-
- Mysql 5.6
70-
- RabbitMQ 3.6.10
71-
72-
**Configuration**
73-
74-
Configuration file can be loaded by sequence:
75-
- System envrionment variable: `FLOW_CONFIG_PATH`
76-
- System property: `-Dconfig.path`
77-
- Default directory: `/etc/flow.ci/config/app.properties`
78-
79-
The sample properites file in :
80-
81-
`platform-control-center/app-example.properties`
82-
83-
**Agent**
84-
85-
Start agent by following command:
86-
87-
`java -jar flow-platform-agent-{version}.jar {zookeeper address} {zone name} $HOSTNAME`
88-
89-
90-
### Build by docker
91-
92-
Run `./build-docker.sh` will generate required docker images `flow.ci.backend` for back-end and `flow.ci.agent` for agent.
93-
94-
**To start flow.ci backend services**
95-
96-
`docker-compose up`
97-
98-
**To start flow.ci agent**
99-
100-
`docker run --network=host -e FLOW_ZOOKEEPER_HOST=127.0.0.1:2181 -e FLOW_AGENT_ZONE=default -e FLOW_AGENT_NAME={agent name you want} flow.ci.agent`
101-
102-
103-
104-
## License
105-
flow-platform is an open source project, sponsored by [fir.im](https://www.fir.im)
106-
under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
14+
- [Start from docker](https://github.com/FlowCI/docker)
15+
- [Document](https://github.com/FlowCI/docs) For more detail

0 commit comments

Comments
 (0)