Universal Command Line Environment for Continous Delivery Pipeline on Gitlab-CI.
Usage:
cdp build [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
(--docker-image=<image_name>)
(--command=<cmd>)
[--simulate-merge-on=<branch_name>]
[--volume-from=<host_type>]
cdp maven [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
(--docker-version=<version>)
(--goals=<goals-opts>|--deploy=<type>)
[--maven-release-plugin=<version>]
[--simulate-merge-on=<branch_name>]
[--volume-from=<host_type>]
cdp sonar [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
(--preview | --publish)
(--codeclimate | --sast)
[--simulate-merge-on=<branch_name>]
cdp docker [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
[--use-docker | --use-docker-compose]
[--image-tag-branch-name] [--image-tag-latest] [--image-tag-sha1]
[--use-gitlab-registry | --use-aws-ecr | --use-custom-registry]
cdp artifactory [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
[--image-tag-branch-name] [--image-tag-latest] [--image-tag-sha1]
(--put=<file> | --delete=<file>)
cdp k8s [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
[--image-tag-branch-name | --image-tag-latest | --image-tag-sha1]
(--use-gitlab-registry | --use-aws-ecr | --use-custom-registry)
[--values=<files>]
[--delete-labels=<minutes>]
[--namespace-project-branch-name | --namespace-project-name]
[--create-default-helm] [--deploy-spec-dir=<dir>]
[--timeout=<timeout>]
cdp validator [(-v | --verbose | -q | --quiet)] [(-d | --dry-run)] [--sleep=<seconds>]
[--path=<path>]
[--block-provider | --block | --block-json]
[--namespace-project-branch-name | --namespace-project-name]
cdp (-h | --help | --version)
Options:
-h, --help Show this screen and exit.
-v, --verbose Make more noise.
-q, --quiet Make less noise.
-d, --dry-run Simulate execution.
--sleep=<seconds> Time to sleep int the end (for debbuging) in seconds [default: 0].
--docker-image=<image_name> Specify docker image name for build project.
--command=<cmd> Command to run in the docker image.
--simulate-merge-on=<branch_name> Build docker image with the merge current branch on specify branch (no commit).
--volume-from=<host_type> Volume type of sources - docker or k8s [default: k8s]
--docker-version=<version> Specify maven docker version [default: 3.5-jdk-8].
--goals=<goals-opts> Goals and args to pass maven command.
--deploy=<type> 'release' or 'snapshot' - Maven command to deploy artifact.
--maven-release-plugin=<version> Specify maven-release-plugin version [default: 2.5.3].
--preview Run issues mode (Preview).
--publish Run publish mode (Analyse).
--codeclimate Codeclimate mode.
--sast Static Application Security Testing mode.
--use-docker Use docker to build / push image [default].
--use-docker-compose Use docker-compose to build / push image.
--image-tag-branch-name Tag docker image with branch name or use it [default].
--image-tag-latest Tag docker image with 'latest' or use it.
--image-tag-sha1 Tag docker image with commit sha1 or use it.
--use-gitlab-registry Use gitlab registry for pull/push docker image [default].
--use-aws-ecr Use AWS ECR from k8s configuration for pull/push docker image.
--use-custom-registry Use custom registry for pull/push docker image.
--put=<file> Put file to artifactory.
--delete=<file> Delete file in artifactory.
--values=<files> Specify values in a YAML file (can specify multiple separate by comma). The priority will be given to the last (right-most) file specified.
--delete-labels=<minutes> Add namespace labels (deletable=true deletionTimestamp=now + minutes) for external cleanup.
--namespace-project-branch-name Use project and branch name to create k8s namespace or choice environment host [default].
--namespace-project-name Use project name to create k8s namespace or choice environment host.
--create-default-helm Create default helm for simple project (One docker image).
--deploy-spec-dir=<dir> k8s deployment files [default: charts].
--timeout=<timeout> Time in seconds to wait for any individual kubernetes operation [default: 300].
--path=<path> Path to validate [default: configurations].
--block-provider Valid BlockProviderConfig interface [default].
--block Valid BlockConfig interface.
--block-json Valid BlockJSON interface.
build|maven:
- CDP_SSH_PRIVATE_KEY – Copy private key (gitlab-ci user) in ~/.ssh/id_rsa file which push repository (Optional)
maven:
- MAVEN_OPTS – Add option for maven command (Optional)
--deploy=x:
- CDP_REPOSITORY_USERNAME – Username for read/write in maven repository
- CDP_REPOSITORY_PASSWORD – Password
- CDP_REPOSITORY_URL – URL of maven repository
--deploy=snapshot:
- CDP_REPOSITORY_MAVEN_SNAPSHOT – Repository for snapshot (example libs-snapshot-local)
--deploy=release:
- CDP_REPOSITORY_MAVEN_RELEASE – Repository for release (example libs-release-local)
sonar:
- CDP_SONAR_LOGIN – Sonar access token (scope Administer Quality Profiles / Administer Quality Gates).
- CDP_SONAR_URL – Sonar url access.
- GITLAB_USER_TOKEN – Gitlab access token (scope api).
- sonar-project.properties - Add this file to the root of the project. If not present, -Dsonar.projectKey=$CI_PROJECT_PATH and -Dsonar.sources=.
docker:
--use-docker:
- File Dockerfile required at the root of the project.
--use-docker-compose:
- File docker-compose.yml required at the root of the project.
k8s:
without: --create-default-helm:
- Helm and k8s files to configure the deployment. Must be present in the directory configured by the --deploy-spec-dir=<dir> option.
docker|k8s:
--use-aws-ecr:
- AWS_ACCESS_KEY_ID (Gitlab-runner env var) – AWS access key.
- AWS_SECRET_ACCESS_KEY (Gitlab-runner env var) – AWS secret key. Access and secret key variables override credentials stored in credential and config files.
- AWS_DEFAULT_REGION – The region to use. Overrides config/env settings.
--use-custom-registry:
- CDP_CUSTOM_REGISTRY (Gitlab-runner env var) – Custom docker registry (host:port).
- CDP_CUSTOM_REGISTRY_TOKEN (Gitlab-runner env var) – Access token used for authentication on custom docker registry.
- CDP_CUSTOM_REGISTRY_TOKEN_READ_ONLY (Gitlab-runner env var) – Read only access token used for authentication on custom docker registry.
- CDP_CUSTOM_REGISTRY_USER (Gitlab-runner env var) – User used for authentication on custom docker registry.
--use-gitlab-registry:
- CDP_GITLAB_REGISTRY_TOKEN_READ_ONLY (Gitlab-runner env var) – Read only access token used for authentication on gitlab docker registry.
artifactory:
--put=<file>|--delete=<file>:
- CDP_ARTIFACTORY_PATH (Gitlab-runner env var) – Repository path used for put or delete file.
- CDP_ARTIFACTORY_TOKEN (Gitlab-runner env var) – Access token used by X-JFrog-Art-Api header for autentication on artifactory.stages:
...
- build
- quality
- package
- deploy
...
build:
image: ouestfrance/cdp:latest
stage: build
script:
- cdp build --docker-image=maven:3.5-jdk-8 --command='mvn clean verify' --simulate-merge-on=develop
artifacts:
paths:
- target/*.jar
codeclimate:
image: ouestfrance/cdp:latest
stage: quality
script:
- cdp sonar --preview --codeclimate --simulate-merge-on=develop
artifacts:
paths:
- codeclimate.json
sast:
image: ouestfrance/cdp:latest
stage: quality
script:
- cdp sonar --preview --sast --simulate-merge-on=develop
artifacts:
paths:
- gl-sast-report.json
package:
image: ouestfrance/cdp:latest
stage: package
script:
- cdp docker --image-tag-branch-name --use-gitlab-registry
- cdp artifactory --image-tag-branch-name --put=conf/example.yaml
deploy:
variables:
DNS_SUBDOMAIN: { ingress.k8s }
image: ouestfrance/cdp:latest
stage: deploy
script:
- cdp k8s --use-gitlab-registry --namespace-project-branch-name --image-tag-branch-name --values=values.staging.yaml
environment:
name: review/$CI_COMMIT_REF_NAME
url: http://$CI_ENVIRONMENT_SLUG.$CI_PROJECT_NAME.$DNS_SUBDOMAINWhen you use the docker build --use-docker-compose command, you may need information from the CDP context. Below, the environment variables made available by the CDP for use in the docker-compose.yml.
CDP_REGISTRY: --use-gitlab-registry: env['CI_REGISTRY'] | --use-aws-ecr: result from 'aws ecr get-login ...' command | --use-custom-registry: env['CDP_CUSTOM_REGISTRY'] + '/' + env['CI_PROJECT_PATH'].lower()
CDP_TAG: --image-tag-branch-name: env['CI_COMMIT_REF_NAME'] | --image-tag-latest: 'latest'| --image-tag-sha1: env['CI_COMMIT_SHA']version: '3'
services:
nginx:
image: ${CDP_REGISTRY:-local}/my-nginx-project-name:${CDP_TAG:-latest}
...
php:
image: ${CDP_REGISTRY:-local}/my-php-project-name:${CDP_TAG:-latest}
...
...When you use the docker k8s command, you may need information from the CDP context. Below, the variables made available by the CDP for use in the helm context.
namespace: Name of kubernetes namespace, based on the following options: [ --namespace-project-branch-name | --namespace-project-name ]
ingress.host: Ingress, based on the following options : [ --namespace-project-branch-name | --namespace-project-name ]
image.commit.sha: First 8 characters of sha1 corresponding to the current commit.
image.registry: Docker image registry, based on the following options: [ --use-gitlab-registry | --use-aws-ecr | --use-custom-registry ]
image.repository: Name of the repository corresponding to the CI_PROJECT_PATH environment variable in lowercase.
image.tag: Docker image tag, based on the following options: [ --image-tag-branch | --image-tag-latest | --image-tag-sha1 ]apiVersion: extensions/v1beta1
kind: Deployment
spec:
template:
spec:
containers:
- name: {{ template "nginx.name" . }}-{{ .Values.image.commit.sha }}
image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}/my-nginx-project-name:{{ .Values.image.tag }}"
...
- name: {{ template "php.name" . }}-{{ .Values.image.commit.sha }}
image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}/my-php-project-name:{{ .Values.image.tag }}"
...
...- Not implemented :)
- python 2.7
- pip 2.7
python setup.py testpip install -r requirements.txt
sudo python setup.py install
cdp --helpVault usage for token and password storage