Table of Contents generated with DocToc
Once you have set up Cyclone, you have a CI/CD platform to ship your code from local development all the way to container engine. This section provides a brief overview of Cyclone operational processes.
Cyclone runs pipelines in cyclone-worker container, In order to build your pipeline, a cloud where cyclone-worker container runs on must be registered to cyclone-server.
# create a cloud.
curl -X POST -H "Content-Type: application/json" -d '{
"name": "myTestCloud",
"type": "Docker",
"docker": {
"host": "'$DOCKER_HOST'"
}
}' ''$HOST_URL'/api/v1/clouds'The command above would registry your local computer as a cloud, then you could set up the project.
A project represents a group to manage a set of related pipelines. project must have a credential to access your SCM(Source Code Management) repository, and now Cyclone supports three types of SCM: GitHub, GitLab and SVN.
you can create a project by:
# create a project.
curl -X POST -H "Content-Type: application/json" -d '{
"name": "myProject",
"description": "first test project",
"owner": "cyclone",
"scm": {
"type": "Github",
"server": "https://github.com/",
"authType": "Password",
"username": "'$USERNAME'",
"password": "'$PASSWORD'"
}
}' ''$HOST_URL'/api/v1/projects'Pipeline is a workflow that consists of a series of CI/CD stages. Cyclone supports 5 stages, among which
one of them is mandatory:
- codeCheckout
others are optional:
- package
- imageBuild
- integrationTest
- imageRelease
Here we will create a pipeline includes codeCheckout and package stages. Please see Pipelines APIs for more details.
# create a pipeline including CodeCheckout and Package.
curl -X POST -H "Content-Type: application/json" -d '{
"name": "myPipeline",
"description": "first test pipeline",
"owner": "cyclone",
"build": {
"builderImage": {
"image": "busybox"
},
"stages": {
"codeCheckout": {
"mainRepo": {
"type": "Github",
"github": {
"url": "'$YOUR_GITHUB_REPO_ADDRESS'",
"ref": "'$YOUR_BRANCH'"
}
}
},
"package": {
"command": [
"'$YOUR_COMMAND_1'",
"'$YOUR_COMMAND_2'"
]
}
}
}
}' ''$HOST_URL'/api/v1/projects/'$PROJECT_NAME'/pipelines'
That means checkout code from $YOUR_GITHUB_REPO_ADDRESS firstly, and then running a container which used busbox image to execute the commands we defined, which are $YOUR_COMMAND_1 and $YOUR_COMMAND_2.
After the pipeline is created successfully, you could create a recod to execute it.
# create a record.
curl -X POST -H "Content-Type: application/json" -d '{
"name": "v0.0.1",
"description": "first pipeline record",
"stages": ["codeCheckout", "package"]
}' ''$HOST_URL'/api/v1/projects/'$PROJECT_NAME'/pipelines/'$PIPELINE_NAME'/records'When creating the record, you could choose stages you have defined in pipeline to execute. codeCheckout and package are mandatory. If you have defined the optional stages, of course you can choose them as well.
After the record is created successfully, you could get the log generated when the version is being created.
If you want to get logs while the pipeline is running, please typing following instructions to send a websocket connection to cyclone-server:
# get package stage record log stream in the real time.
curl -v -S --no-buffer \
-H "Connection: Upgrade" \
-H "Upgrade: websocket" \
-H "Host: localhost:8080" \
-H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \
-H "Sec-WebSocket-Version: 13" \
''$HOST_URL'/api/v1/projects/'PROJECT_NAME'/pipelines/'$PIPELINE_NAME'/records/'$RECORD_ID'/logstream?stage=package'
At the end of the pipeline run successfully, you could get the logs by a HTTP GET request.
# get package stage record logs.
curl -v -S ''$HOST_URL'/api/v1/projects/'PROJECT_NAME'/pipelines/'$PIPELINE_NAME'/records/'$RECORD_ID'/logs?stage=package'The log would looks like:
Stage: Package status: start
$ echo $GOPATH
/go
$ export REPO_NAME=cyclone
$ export WORKDIR=$GOPATH/src/github.com/caicloud/$REPO_NAME
$ mkdir -p $GOPATH/src/github.com/caicloud/
$ ln -s `pwd` $WORKDIR
$ cd $WORKDIR
$ ls -la
total 88
drwxr-xr-x 17 root root 620 May 29 03:49 .
drwxrwxrwt 3 root root 18 May 29 04:00 ..
-rw-r--r-- 1 root root 12 May 29 03:49 .dockerignore
drwxr-xr-x 8 root root 280 May 29 03:49 .git
drwxr-xr-x 2 root root 80 May 29 03:49 .github
-rw-r--r-- 1 root root 374 May 29 03:49 .gitignore
-rw-r--r-- 1 root root 1338 May 29 03:49 .travis.yml
-rw-r--r-- 1 root root 16843 May 29 03:49 Gopkg.lock
-rw-r--r-- 1 root root 2716 May 29 03:49 Gopkg.toml
-rw-r--r-- 1 root root 7960 May 29 03:49 Jenkinsfile
-rw-r--r-- 1 root root 11357 May 29 03:49 LICENSE
-rw-r--r-- 1 root root 5370 May 29 03:49 Makefile
-rw-r--r-- 1 root root 151 May 29 03:49 OWNERS
-rw-r--r-- 1 root root 3285 May 29 03:49 README.md
-rw-r--r-- 1 root root 3363 May 29 03:49 README_zh-CN.md
drwxr-xr-x 4 root root 80 May 29 03:49 api
drwxr-xr-x 4 root root 80 May 29 03:49 build
-rw-r--r-- 1 root root 2140 May 29 03:49 caicloud_e2e-test.yml
-rw-r--r-- 1 root root 314 May 29 03:49 caicloud_unit-test.yml
drwxr-xr-x 2 root root 200 May 29 03:49 cloud
drwxr-xr-x 4 root root 80 May 29 03:49 cmd
-rw-r--r-- 1 root root 1313 May 29 03:49 docker-compose.yml
drwxr-xr-x 3 root root 520 May 29 03:49 docs
drwxr-xr-x 3 root root 100 May 29 03:49 http
drwxr-xr-x 3 root root 60 May 29 03:49 node_modules
drwxr-xr-x 3 root root 120 May 29 03:49 notify
drwxr-xr-x 17 root root 340 May 29 03:49 pkg
drwxr-xr-x 8 root root 280 May 29 03:49 scripts
drwxr-xr-x 8 root root 180 May 29 03:49 tests
drwxr-xr-x 2 root root 80 May 29 03:49 utils
drwxr-xr-x 7 root root 140 May 29 03:49 vendor
$ cd $WORKDIR
$ make build-local
github.com/caicloud/cyclone/pkg/register
github.com/caicloud/cyclone/vendor/github.com/docker/docker/api/types/blkiodev
...
...
github.com/caicloud/cyclone/pkg/worker
github.com/caicloud/cyclone/cmd/worker
Stage: Package status: finish