Skip to content

Commit

Permalink
Merge pull request #107 from superxi911/function-doc-English
Browse files Browse the repository at this point in the history
Add English functions introduction
  • Loading branch information
Superxi911 authored Dec 7, 2016
2 parents dba120b + 5781471 commit 8838ac7
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 6 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ Feel free to hack on cyclone! We have [instructions to help you get started cont
<img src="./docs/security.png" alt="Security Scanning" width="500">
</div>

Please watch the [Fuctions Introduction](./docs/functions.md) for more features.

## Roadmap

Please watch the [Github milestones](https://github.com/caicloud/cyclone/milestones) for our future plans.
73 changes: 73 additions & 0 deletions docs/functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Function Introduction

## Relating with VCS tools

Cyclone has been integrated with a variety of VCS tools, such as git, svn, etc. After OAuth, it can pull codes from repository and create webhook. Whenever the user commits, submits a pull request or releases a version to the repository, the webhook will trigger the CI/CD workflow.

- Creating a service relating with the VCS tools

<div align="center">
<img src="./create_service.png" alt="create_service" width="500">
</div>

- Listing all services

<div align="center">
<img src="./list_services.png" alt="list_services" width="500">
</div>

## Continus integration and security scanning

All of the processes in workflow are visible. "prebuild" compiles the executable files. "build" builds the published image. "integration" executes the integrated test. "publish" publishes the image and scans the vulnerabilities. "post build" does some relating operations after image published. "deploy" uses the published image to deploy a application to Kubernetes or any other container cloud platform. Cyclone would send email to notify the result of the workflow. All of the processes are shipped by container. It will wipe off the differences caused by environment.

- Log of the workflow

<div align="center">
<img src="./logs.png" alt="logs" width="500">
</div>

- Security scanning

<div align="center">
<img src="./security.png" alt="security" width="500">
</div>

- Sending the build log via email

<div align="center">
<img src="./pagging.png" alt="pagging" width="500">
</div>

## Resource management

Cyclone separates the logic of scheduling and the building workflow. It also supports to add user worker nodes and various quota plans.

- Setting of user resource configuration

<div align="center">
<img src="./quota.png" alt="quota" width="500">
</div>

- Resource quota of single building

<div align="center">
<img src="./create_version.png" alt="create_version" width="500">
</div>

## Union publishing and dependency management

Cyclone can manage multi-component united builds. It uses the graphical user interface to display and manage the dependency of the components.

<div align="center">
<img src="./dependency.png" alt="dependency" width="500">
</div>

## Continus delivery

Cyclone provides flexible and continuous deployment based on release policy and role control, provides upgrade and rollback policies based on container and image version control.

- various deploying plans

<div align="center">
<img src="./deployment.png" alt="deployment" width="500">
</div>
10 changes: 5 additions & 5 deletions docs/functions_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Cyclone 可以关联多种常用版本管理工具(git、svn等),通过 OAuth 授权后,拉取代码,建立 webhook。当用户向代码库中提交 commit、pull request 和 release 版本时自动触发 CI/CD 工作流水线。

- 创建与版本管理工具管理的服务
- 创建与版本管理工具关联的服务

<div align="center">
<img src="./create_service.png" alt="create_service" width="500">
Expand All @@ -18,7 +18,7 @@ Cyclone 可以关联多种常用版本管理工具(git、svn等),通过 OA

## 持续集成与安全扫描

全过程可视化的工作流水线:prebuild 编译可执行文件,build 构建发布镜像, integration 集成测试,publish 发布镜像并安全扫描,post build 镜像发布后的关联操作,deploy 使用发布镜像部署应用构建结果邮件通知。所有过程均以容器为载体,消除环境差异。
全过程可视化的工作流水线:"prebuild" 编译可执行文件,"build" 构建发布镜像, "integration" 集成测试,"publish" 发布镜像并安全扫描,"post build" 镜像发布后的关联操作,"deploy" 使用发布镜像部署应用构建结果邮件通知。所有过程均以容器为载体,消除环境差异。

- 工作流水线日志

Expand All @@ -40,7 +40,7 @@ Cyclone 可以关联多种常用版本管理工具(git、svn等),通过 OA

## 资源管理

任务调度逻辑与构建任务分离,支持添加用户工作节点。多样化的构建配额方案。
任务调度逻辑与构建任务分离。支持添加用户工作节点,多样化的构建配额方案。

- 用户资源设置

Expand All @@ -62,12 +62,12 @@ Cyclone 可以关联多种常用版本管理工具(git、svn等),通过 OA
<img src="./dependency.png" alt="dependency" width="500">
</div>

## 持续发布
## 持续交付

基于发布策略和角色控制功能,提供灵活的持续部署方式。基于容器和镜像的版本控制,提供多种升级回滚策略。

- 多种部署方案

<div align="center">
<img src="./deployment.png" alt="deployment" width="500">
</div>
</div>
2 changes: 1 addition & 1 deletion websocket/websocket_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestStartServer(t *testing.T) {
t.Errorf("Start websocket server error: %v.", err)
}
}()
time.Sleep(5 * time.Millisecond)
time.Sleep(time.Second)
}

// dialTestServer dail to local websocket test server, return websocket handler or err.
Expand Down

0 comments on commit 8838ac7

Please sign in to comment.