Skip to content

setup.md

Latest commit

 

History

History
91 lines (70 loc) · 4.01 KB

setup.md

File metadata and controls

91 lines (70 loc) · 4.01 KB

Setup

Prerequisites

golang：1.6+
docker：(Suggested)1.10.0+(Has tested and verified with 1.10~1.11)
kubernetes：1.2+

Setup Instruction

There are two ways to set up Cyclone, either via Docker Compose or kubectl.

At first, you need to build Cyclone-server and Cyclone-worker docker images, by following these instructions:

git clone https://github.com/caicloud/cyclone
cd cyclone
./scripts/build-server.sh
./scripts/build-worker.sh
  • Using Docker Compose: Follow these instructions to bring up Cyclone with docker-compose (you can checkout the compose file for more details):
docker-compose -f docker-compose.yml up -d
  • Using Kubectl: this approach requires a few yaml files. You can read related files in cyclone/scripts/k8s for more details, and adjust the parameters before executing these instructions:
git clone https://github.com/caicloud/cyclone
cd cyclone/scripts/k8s
kubectl create namespace cyclone
kubectl --namespace=cyclone create -f mongo.yaml
kubectl --namespace=cyclone create -f mongo-svc.yaml
kubectl --namespace=cyclone create -f cyclone.yaml
kubectl --namespace=cyclone create -f cyclone-svc.yaml

Then Cyclone is started.

Other

Environment variables:

ENV Description
MONGODB_HOST The IP of mongodb, default is localhost.
REGISTRY_LOCATION The registry to push images, default is cargo.caicloud.io.
REGISTRY_USERNAME The default username for docker registry, default is null.
REGISTRY_PASSWORD The default password for docker registry, default is null.
LIMIT_MEMORY Same concept as kubernetes limits.memory, used for cyclone-worker, default is 1Gi
LIMIT_CPU Same concept as kubernetes limits.cpu, used for cyclone-worker, default is1
REQUEST_MEMORY Same concept as kubernetes requests.memory, used for cyclone-worker, default is 0.5Gi
REQUEST_CPU Same concept as kubernetes requests.cpu, used for cyclone-worker, default is 0.5
RECORD_ROTATION_THRESHOLD The number of pipeline records cyclone preserved, default is 50
CALLBACK_URL The URL used for webhook to callback, default is http://127.0.0.1:7099/v1/pipelines
CYCLONE_SERVER The host of Cyclone-Server, default is http://localhost:7099.
WORKER_IMAGE The image name of Cyclone-Worker container, default is cargo.caicloud.io/caicloud/cyclone-worker:latest.
NOTIFICATION_URL URL of notification, we will send notification after pipeline execution if the notification policy had been defined.
RECORD_WEB_URL_TEMPLATE URL template of pipeline record web page. Cyclone doesn't provide web UI component currently.

PS:

More About RECORD_WEB_URL_TEMPLATE

It usees go text/template style, we will use Event as the input parameter of the text/template's Execute func,so you can define {{.Pipeline.Name}} , {{.PipelineRecord.ID}} , {{.Project.Name}} and etc in your template.

. represents Event struct, Pipeline PipelineRecord Project are its fileds.

e.g. :

if

and

  • event.Pipeline.Name=project-test-1,
  • event.Pipeline.Name=pipeline-1,
  • event.PipelineRecord.ID=5b98850a1d74bd0001c17dcf,

the targetURL result will be: http://127.0.0.1:30000/devops/projects/project-test-1/pipelines/pipeline-1/records/5b98850a1d74bd0001c17dcf|

EventObject

type Event struct {
	Project        *Project
	Pipeline       *Pipeline
	PipelineRecord *PipelineRecord
}