This Hello World application uses Docker with Node.js and includes a DevOps toolchain that is pre-configured for continuous delivery with Vulnerability Advisor, source control, issue tracking, and online editing, and deployment to the IBM Kubernetes Service.
Application code is stored in source control, along with its Dockerfile and its Kubernetes deployment script. The target cluster is configured during toolchain setup (using an IBM Cloud API key and cluster name). You can later change these by altering the Delivery Pipeline configuration. Any code change to the Git repo will automatically be built, validated and deployed into the Kubernetes cluster.
It implements the following best practices:
- seperate Continuous Integration(CI) and Continuous Delivery(CD) pipelines.
- different deployment strategies (Rolling, Blue/Green and Canary)
- sanity check the Dockerfile prior to attempting creating the image,
- build container image on every Git commit, setting a tag based on build number, timestamp and commit id for traceability
- use a private image registry to store the built image, automatically configure access permissions for target cluster deployment using API tokens than can be revoked,
- check container image for security vulnerabilities,
- insert the built image tag into the deployment manifest automatically,
- use an explicit namespace in cluster to insulate each deployment (and make it easy to clear, by "kubectl delete namespace"),
-
Toolchain Name - Unique name to identify your toolchain
-
Region - Select the region where toolchain is to be deployed (Ex: us-south).
- Provide your application repo details or go with default provided repo.
-
Inventory repo is used to capture the build and artifact metadata.
-
A successful CI build uploads the artifact to IBM Container registry(ICR) and commits the build metadata in JSON Format to the Inventory Repository. The CD Pipeline listens for changes in the inventory and triggers a pipeline run to fetch the artifact from IBM Container Registry and deploys that artifact to your instances.
Kindly refer Secrets Manager in Detail
- Identify your secrets store.
- Select the secrets store instance which you want to use in the toolchain.
Select the IBM Kubernetes cluster on which you want to deploy your application.
Select the Deployment Strategy for releasing your application to IBM Kubernetes cluster. Kindly refer Deployment Strategies in Detail
Select the optional tools as required in your toolchain.
This section will list if there are any issues in the inputs that are provided in previous steps.
Several tools in this toolchain, and possibly in your customizable scripts, require secrets to access privileged resources. An IBM Cloud API key is an example of such a secret. These secrets must be securely stored within an IBM-recommended secrets management tool, such as IBM Key Protect for IBM Cloud, IBM Cloud Secrets Manager, or Hashicorp Vault. The secrets management tool can be integrated into the toolchain so that you can easily reference the secrets in your Tekton pipeline.
key-protect :- Key Protect is a cloud-based security service that provides life cycle management for encryption keys that are used in IBM Cloud services or customer-built applications
secrets-manager :- With Secrets Manager you can create, lease, and centrally manage secrets that are used in IBM Cloud services or your custom-built applications.
In Kubernetes there are a few different ways to release an application, it is necessary to choose the right strategy to make your infrastructure reliable during an application update.
These are the different deployment strategies that are supported by the toolchain.
Rolling updates allow deployments update to take place with zero downtime by incrementally updating pods instances with new ones. The new pods will be scheduled on nodes with available resources. Similar to application Scaling, if a deployment is exposed publicly, the service will load-balance the traffic only to available pods during the update. An available pod is an instance that is available to the users of the application.
Rolling updates allow the following actions:
- Promote an application from one environment to another (via container image updates)
- Rollback to previous versions
- Continuous Integration and Continuous Delivery of applications with zero downtime
For the first deployment:-
1. Check if the Ingress controller exists
2. If not, update the current deployment as blue and perform deployment.
For the subsequent deployment:-
1. Identify the service where the ingress controller is pointing.
2. If it is pointing to blue service, then we will create a deployment name as green deployment, else if it is pointing to green, then we will create a deployment name as blue deployment.
3. Perform the new deployment. (This will update the old deployment if older version exists)
4. Perform acceptance test on latest deployment.
5. If acceptance test fails on latest deployment, then fail the pipeline. Developer can debug the latest deployment as live traffic is not affected.
6. If acceptance test passes, then point the ingress controller to new deployment.
7. Old deployment will stay as is for backup/debug purpose.
For the first deployment:-
1. Check if the Ingress controller exists
2. If not, update the current deployment as prod and perform deployment.
For the subsequent deployment:-
1. Deploy the latest deployment as canary deployment.
2. A percentage(`step-size`) of incoming traffic will be routed to canary deployment, A tests will be performed against the canary deployment.
3. If the test passes, then we can increase the `step-size` which will increase the incoming traffic to canary deployment.
4. Once the step-size is 100 percent and all the tests are passed, existing production deployment will be updated with latest changes which are tested in canary deployment.
5. Now canary deployment will be removed and incoming traffic will be routed back to production.
This pipeline and relevant trigger(s) can be configured using the properties described below.
See https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines&interface=ui#configure_tekton_pipeline for more information.
EventListeners:
- manual-run - manual run listener
- github-ent-commit - github enterprise commit push event listener
- github-commit - github commit push event listener
- grit-or-gitlab-commit - GRIT/gitlab commit push event listener
- bitbucket-commit - bitbucket commit push event listener
- github-pr-listener - github pull-request listener
- gitlab-pr-listener - GRIT/gitlab merge-request listener
EventListener: manual-run - manual run listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
dockerfile |
The name of the Dockerfile to use for building the image | Dockerfile |
No | string |
fail-on-lint-errors |
force failure of task when docker lint errors are found | true |
No | string |
fail-on-scanned-issues |
force failure of task when vulnerability advisor scan issues are found | true |
No | string |
git-token |
access token for the git repo | `` | No | string |
image-name |
image name | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
path-to-context |
the path to the context that is used for the build (. meaning current directory) |
. |
No | string |
path-to-dockerfile |
the path to the Dockerfile that is used for the build (. meaning current directory) |
. |
No | string |
pipeline-debug |
Pipeline debug mode. Value can be 0 or 1. | 0 |
No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
registry-namespace |
container registry namespace | - | Yes | string |
registry-region |
The IBM Cloud region for image registry | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: github-ent-commit - github enterprise commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
- | $(event.repository.pushed_at) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
dockerfile |
The name of the Dockerfile to use for building the image | Dockerfile |
No | string |
fail-on-lint-errors |
force failure of task when docker lint errors are found | true |
No | string |
fail-on-scanned-issues |
force failure of task when vulnerability advisor scan issues are found | true |
No | string |
git-token |
access token for the git repo | `` | No | string |
image-name |
image name | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
path-to-context |
the path to the context that is used for the build (. meaning current directory) |
. |
No | string |
path-to-dockerfile |
the path to the Dockerfile that is used for the build (. meaning current directory) |
. |
No | string |
pipeline-debug |
Pipeline debug mode. Value can be 0 or 1. | 0 |
No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
registry-namespace |
container registry namespace | - | Yes | string |
registry-region |
The IBM Cloud region for image registry | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
- | github-ent |
No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: github-commit - github commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
- | $(event.repository.updated_at) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
dockerfile |
The name of the Dockerfile to use for building the image | Dockerfile |
No | string |
fail-on-lint-errors |
force failure of task when docker lint errors are found | true |
No | string |
fail-on-scanned-issues |
force failure of task when vulnerability advisor scan issues are found | true |
No | string |
git-token |
access token for the git repo | `` | No | string |
image-name |
image name | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
path-to-context |
the path to the context that is used for the build (. meaning current directory) |
. |
No | string |
path-to-dockerfile |
the path to the Dockerfile that is used for the build (. meaning current directory) |
. |
No | string |
pipeline-debug |
Pipeline debug mode. Value can be 0 or 1. | 0 |
No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
registry-namespace |
container registry namespace | - | Yes | string |
registry-region |
The IBM Cloud region for image registry | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
- | github |
No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: grit-or-gitlab-commit - GRIT/gitlab commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
- | $(event.checkout_sha) |
No | string |
commit-timestamp |
- | $(event.commits[0].timestamp) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
dockerfile |
The name of the Dockerfile to use for building the image | Dockerfile |
No | string |
fail-on-lint-errors |
force failure of task when docker lint errors are found | true |
No | string |
fail-on-scanned-issues |
force failure of task when vulnerability advisor scan issues are found | true |
No | string |
git-token |
access token for the git repo | `` | No | string |
image-name |
image name | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
path-to-context |
the path to the context that is used for the build (. meaning current directory) |
. |
No | string |
path-to-dockerfile |
the path to the Dockerfile that is used for the build (. meaning current directory) |
. |
No | string |
pipeline-debug |
Pipeline debug mode. Value can be 0 or 1. | 0 |
No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
registry-namespace |
container registry namespace | - | Yes | string |
registry-region |
The IBM Cloud region for image registry | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.project.http_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
- | gitlab |
No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: bitbucket-commit - bitbucket commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.push.changes[0].new.name) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
- | $(event.pull_request.head.sha) |
No | string |
commit-timestamp |
- | $(event.pull_request.head.repo.pushed_at) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
dockerfile |
The name of the Dockerfile to use for building the image | Dockerfile |
No | string |
fail-on-lint-errors |
force failure of task when docker lint errors are found | true |
No | string |
fail-on-scanned-issues |
force failure of task when vulnerability advisor scan issues are found | true |
No | string |
git-token |
access token for the git repo | `` | No | string |
image-name |
image name | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
path-to-context |
the path to the context that is used for the build (. meaning current directory) |
. |
No | string |
path-to-dockerfile |
the path to the Dockerfile that is used for the build (. meaning current directory) |
. |
No | string |
pipeline-debug |
Pipeline debug mode. Value can be 0 or 1. | 0 |
No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
registry-namespace |
container registry namespace | - | Yes | string |
registry-region |
The IBM Cloud region for image registry | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.links.html.href) |
No | string |
revision |
the git revision/commit for the git repo | $(event.push.changes[0].new.target.hash) |
No | string |
scm-type |
- | bitbucket |
No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: github-pr-listener - github pull-request listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey |
The ibmcloud api key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
branch |
The git branch | $(event.pull_request.base.ref) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
commit id | $(event.after) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
git-token |
access token for the git repo | `` | No | string |
ibmcloud-api |
The ibmcloud api | https://cloud.ibm.com |
No | string |
ibmcloud-region |
(Optional) ibmcloud region to use | `` | No | string |
pipeline-debug |
Toggles debug mode for the pipeline | 0 |
No | string |
pr-branch |
The branch in the forked git repo from where the PR is made | $(event.pull_request.head.ref) |
No | string |
pr-repository |
The forked git repo from where the PR is made | $(event.pull_request.head.repo.html_url) |
No | string |
registry-region |
(Optional) The ibmcloud container registry region | `` | No | string |
repository |
The git repo | $(event.repository.html_url) |
No | string |
resource-group |
(Optional) Target resource group (name or id) for the ibmcloud login operation | `` | No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
EventListener: gitlab-pr-listener - GRIT/gitlab merge-request listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
apikey |
The ibmcloud api key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
branch |
The git branch | $(event.object_attributes.target_branch) |
No | string |
build-script |
The command(s) to run the build in run-build step. It will override the default commands | `` | No | string |
commit-id |
commit id | $(event.object_attributes.last_commit.id) |
No | string |
custom-image-registry-dockerconfigjson |
dockerconfigjson for custom images used in pipeline tasks. See https://cloud.ibm.com/docs/devsecops?topic=devsecops-troubleshoot-devsecops#troubleshoot-pipe-abort-early | eyJhdXRocyI6e319 |
No | string |
git-token |
access token for the git repo | `` | No | string |
ibmcloud-api |
The ibmcloud api | https://cloud.ibm.com |
No | string |
ibmcloud-region |
(Optional) ibmcloud region to use | `` | No | string |
pipeline-debug |
Toggles debug mode for the pipeline | 0 |
No | string |
pr-branch |
The branch in the forked git repo from where the PR is made | $(event.object_attributes.source_branch) |
No | string |
pr-repository |
The forked git repo from where the PR is made | $(event.object_attributes.source.http_url) |
No | string |
registry-region |
(Optional) The ibmcloud container registry region | `` | No | string |
repository |
The git repo | $(event.project.http_url) |
No | string |
resource-group |
(Optional) Target resource group (name or id) for the ibmcloud login operation | `` | No | string |
tester-tests-image |
Image to use for unit-test task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
toolchain-build-image |
Image to use for build task |
icr.io/continuous-delivery/pipeline/pipeline-base-ubi:3.72 |
No | string |
git-commit-inventory-repo-task task
- repository: The Git Repository for the Application Source Code. If empty, the Repository url will be found from toolchain (default to
repository) - appname [required]: The name of the application passed as environment variable
- commitid [required]: The commit id of the Application Source Code Repository that triggered the build.
- image-url [required]: The name of the binary artifact generated by the build
- image-digest [required]: The checksum of the binary artifact generated by the build
- shuttle-properties-file [required]:
- artifacts: A workspace to store the output of intermittent steps
- output: A workspace to store the output of intermittent steps
This pipeline and relevant trigger(s) can be configured using the properties described below.
See https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines&interface=ui#configure_tekton_pipeline for more information.
EventListeners:
- manual-run - manual run listener
- github-ent-commit - github enterprise commit push event listener
- github-commit - github commit push event listener
- grit-or-gitlab-commit - GRIT/gitlab commit push event listener
- bitbucket-commit - bitbucket commit push event listener
EventListener: manual-run - manual run listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
EventListener: github-ent-commit - github enterprise commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github-ent |
No | string |
EventListener: github-commit - github commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.updated_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github |
No | string |
EventListener: grit-or-gitlab-commit - GRIT/gitlab commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.checkout_sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.commits[0].timestamp) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.project.http_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | gitlab |
No | string |
EventListener: bitbucket-commit - bitbucket commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.push.changes[0].new.name) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.pull_request.head.sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.pull_request.head.repo.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.links.html.href) |
No | string |
revision |
the git revision/commit for the git repo | $(event.push.changes[0].new.target.hash) |
No | string |
scm-type |
source code type used (github, github-ent, gitlab) | bitbucket |
No | string |
download-artifacts task
- api: the IBM Cloud api endpoint (default to
https://cloud.ibm.com) - apikey [required]: The IBM Cloud API Key
- shuttle-properties-file [required]: The name of the build artifact as retrieved from the build metadata
- output: A workspace
- artifacts-downloaded: The variable indicating whether artifact is downloaded or not
- build_number: The variable storing build number as retrieved from the build metadata
- objectname: The name of the build artifact as retrieved from the build metadata
This pipeline and relevant trigger(s) can be configured using the properties described below.
See https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines&interface=ui#configure_tekton_pipeline for more information.
EventListeners:
- blue-green-manual-run
- switch-blue-green
- blue-green-github-ent-commit
- blue-green-github-commit
- blue-green-grit-or-gitlab-commit
- blue-green-bitbucket-commit
EventListener: blue-green-manual-run
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
EventListener: switch-blue-green
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
EventListener: blue-green-github-ent-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github-ent |
No | string |
EventListener: blue-green-github-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.updated_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github |
No | string |
EventListener: blue-green-grit-or-gitlab-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.checkout_sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.commits[0].timestamp) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.project.http_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | gitlab |
No | string |
EventListener: blue-green-bitbucket-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.push.changes[0].new.name) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.pull_request.head.sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.pull_request.head.repo.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.links.html.href) |
No | string |
revision |
the git revision/commit for the git repo | $(event.push.changes[0].new.target.hash) |
No | string |
scm-type |
source code type used (github, github-ent, gitlab) | bitbucket |
No | string |
download-artifacts task
- api: the IBM Cloud api endpoint (default to
https://cloud.ibm.com) - apikey [required]: The IBM Cloud API Key
- shuttle-properties-file [required]: The name of the build artifact as retrieved from the build metadata
- output: A workspace
- artifacts-downloaded: The variable indicating whether artifact is downloaded or not
- build_number: The variable storing build number as retrieved from the build metadata
- objectname: The name of the build artifact as retrieved from the build metadata
This pipeline and relevant trigger(s) can be configured using the properties described below.
See https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines&interface=ui#configure_tekton_pipeline for more information.
EventListeners:
- canary-manual-run
- canary-github-ent-commit
- canary-github-commit
- canary-grit-or-gitlab-commit
- canary-bitbucket-commit
- abort-canary
EventListener: canary-manual-run
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
EventListener: canary-github-ent-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github-ent |
No | string |
EventListener: canary-github-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.updated_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | github |
No | string |
EventListener: canary-grit-or-gitlab-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.checkout_sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.commits[0].timestamp) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.project.http_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | gitlab |
No | string |
EventListener: canary-bitbucket-commit
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.push.changes[0].new.name) |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.pull_request.head.sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.pull_request.head.repo.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.links.html.href) |
No | string |
revision |
the git revision/commit for the git repo | $(event.push.changes[0].new.target.hash) |
No | string |
scm-type |
source code type used (github, github-ent, gitlab) | bitbucket |
No | string |
EventListener: abort-canary
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
canary-step-interval |
Defines duration of each test performed against canary deployment | - | Yes | string |
canary-step-size |
Defines number of tests should be performed against canary deployment | - | Yes | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-cluster-namespace |
the namespace | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
pr-url |
pr url | - | Yes | string |
project-id |
project id | `` | No | string |
registry-create-namespace |
create container registry namespace if it doesn't already exists | true |
No | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
download-artifacts task
- api: the IBM Cloud api endpoint (default to
https://cloud.ibm.com) - apikey [required]: The IBM Cloud API Key
- shuttle-properties-file [required]: The name of the build artifact as retrieved from the build metadata
- output: A workspace
- artifacts-downloaded: The variable indicating whether artifact is downloaded or not
- build_number: The variable storing build number as retrieved from the build metadata
- objectname: The name of the build artifact as retrieved from the build metadata
This pipeline and relevant trigger(s) can be configured using the properties described below.
See https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-tekton-pipelines&interface=ui#configure_tekton_pipeline for more information.
EventListeners:
- manual-run - manual run listener
- github-ent-commit - github enterprise commit push event listener
- github-commit - github commit push event listener
- grit-or-gitlab-commit - GRIT/gitlab commit push event listener
- bitbucket-commit - bitbucket commit push event listener
EventListener: manual-run - manual run listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | master |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-timestamp |
commit timestamp | - | Yes | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
project-id |
project id | `` | No | string |
registry-region |
- | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | `` | No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
satellite-cluster-group |
Satelite Cluster Group | - | Yes | string |
satellite-cluster-group-namespace |
the namespace | - | Yes | string |
scm-type |
source code type used (github, github-ent, gitlab) | - | Yes | string |
EventListener: github-ent-commit - github enterprise commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
project-id |
project id | `` | No | string |
registry-region |
- | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
satellite-cluster-group |
Satelite Cluster Group | - | Yes | string |
satellite-cluster-group-namespace |
the namespace | - | Yes | string |
scm-type |
source code type used (github, github-ent, gitlab) | github-ent |
No | string |
EventListener: github-commit - github commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.after) |
No | string |
commit-timestamp |
commit timestamp | $(event.repository.updated_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
project-id |
project id | `` | No | string |
registry-region |
- | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.html_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
satellite-cluster-group |
Satelite Cluster Group | - | Yes | string |
satellite-cluster-group-namespace |
the namespace | - | Yes | string |
scm-type |
source code type used (github, github-ent, gitlab) | github |
No | string |
EventListener: grit-or-gitlab-commit - GRIT/gitlab commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.ref) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.checkout_sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.commits[0].timestamp) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
project-id |
project id | `` | No | string |
registry-region |
- | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.project.http_url) |
No | string |
revision |
the git revision/commit for the git repo | `` | No | string |
satellite-cluster-group |
Satelite Cluster Group | - | Yes | string |
satellite-cluster-group-namespace |
the namespace | - | Yes | string |
scm-type |
source code type used (github, github-ent, gitlab) | gitlab |
No | string |
EventListener: bitbucket-commit - bitbucket commit push event listener
| Properties | Description | Default | Required | Type |
|---|---|---|---|---|
api |
The IBM Cloud API Endpoint | https://cloud.ibm.com |
No | string |
apikey |
The IBM Cloud API Key | - | Yes | string |
apikey (secured property) |
IBM Cloud Api Key used to access to the toolchain (and git intergation toolcard like Git Repos and Issue Tracking service if used). |
- | Yes | secret |
app-name |
application name | - | Yes | string |
branch |
the branch for the git repo | $(event.push.changes[0].new.name) |
No | string |
cluster-name |
the name of the cluster to target | - | Yes | string |
commit-id |
- | $(event.pull_request.head.sha) |
No | string |
commit-timestamp |
commit timestamp | $(event.pull_request.head.repo.pushed_at) |
No | string |
commons-hosted-region |
- | https://raw.githubusercontent.com/open-toolchain/commons/master |
No | string |
deployment-file |
file containing the kubernetes deployment definition | deployment.yml |
No | string |
deployment-strategy |
kubernetes deployment-strategy | - | Yes | string |
dev-region |
- | - | Yes | string |
dev-resource-group |
- | - | Yes | string |
git-token |
access token for the git repo | `` | No | string |
inventoryRepo |
The variable storing git integration for the repository storing build inventory with the toolchain | - | Yes | string |
keep-ingress-custom-domain |
force keep of ingress custom domain in deployment-file if any (true | false) | false |
No |
pipeline-debug |
- | 0 |
No | string |
project-id |
project id | `` | No | string |
registry-region |
- | - | Yes | string |
repository |
the git repo containing source code. If empty, the repository url will be found from toolchain | $(event.repository.links.html.href) |
No | string |
revision |
the git revision/commit for the git repo | $(event.push.changes[0].new.target.hash) |
No | string |
satellite-cluster-group |
Satelite Cluster Group | - | Yes | string |
satellite-cluster-group-namespace |
the namespace | - | Yes | string |
scm-type |
source code type used (github, github-ent, gitlab) | bitbucket |
No | string |
download-artifacts task
- api: the IBM Cloud api endpoint (default to
https://cloud.ibm.com) - apikey [required]: The IBM Cloud API Key
- shuttle-properties-file [required]: The name of the build artifact as retrieved from the build metadata
- output: A workspace
- artifacts-downloaded: The variable indicating whether artifact is downloaded or not
- build_number: The variable storing build number as retrieved from the build metadata
- objectname: The name of the build artifact as retrieved from the build metadata