mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
b335387eac
* Extends kubernetesDeploy step to support Helm 3 Currently, the kubernetesDeploy step has no support to Helm 3 due to the fact that: - the initialization command used works only for Helm 2 - the image used when running the helm CLI is based on Helm 2 The need for Helm 3 support comes from the fact that Helm 3 introduces major architectural changes, more specifically, the removal of its server-side agent called Tiller - thus, being incompatible with one another. This commit adds this support by introducing a new configuration field (helmVersion). By default, its values is set to 2 (Helm 2) to avoid breaking any existing functionalities. * Use deployTool field to decide between Helm 2 or 3 * Remove helm init and replace wait for atomic in v3 * Update cmd/kubernetesDeploy.go Nice catch! Co-Authored-By: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * Add documentation for kubernetesDeploy step * Add helm3 example for kubernetesDeploy step using mandatory fields * Add new line at the end of kubernetesDeploy documentation * Link kubernetesDeploy step with docs generator * Add possible values for deployTool in kubernetesDeploy * dummy change * Revert "dummy change" Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com> Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
239 lines
7.2 KiB
YAML
239 lines
7.2 KiB
YAML
metadata:
|
|
name: kubernetesDeploy
|
|
description: Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster.
|
|
longDescription: |-
|
|
Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster.
|
|
|
|
!!! note "Deployment supports multiple deployment tools"
|
|
Currently the following are supported:
|
|
|
|
* [Helm](https://helm.sh/) command line tool and [Helm Charts](https://docs.helm.sh/developing_charts/#charts).
|
|
* [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) and `kubectl apply` command.
|
|
|
|
## Helm
|
|
Following helm command will be executed by default:
|
|
|
|
```
|
|
helm upgrade <deploymentName> <chartPath> --install --force --namespace <namespace> --wait --timeout <helmDeployWaitSeconds> --set "image.repository=<yourRegistry>/<yourImageName>,image.tag=<yourImageTag>,secret.dockerconfigjson=<dockerSecret>,ingress.hosts[0]=<ingressHosts[0]>,,ingress.hosts[1]=<ingressHosts[1]>,...
|
|
```
|
|
|
|
* `yourRegistry` will be retrieved from `containerRegistryUrl`
|
|
* `yourImageName`, `yourImageTag` will be retrieved from `image`
|
|
* `dockerSecret` will be calculated with a call to `kubectl create secret docker-registry regsecret --docker-server=<yourRegistry> --docker-username=<containerRegistryUser> --docker-password=<containerRegistryPassword> --dry-run=true --output=json'`
|
|
spec:
|
|
inputs:
|
|
secrets:
|
|
- name: kubeConfigFileCredentialsId
|
|
type: jenkins
|
|
- name: kubeTokenCredentialsId
|
|
type: jenkins
|
|
- name: dockerCredentialsId
|
|
type: jenkins
|
|
resources:
|
|
- name: deployDescriptor
|
|
type: stash
|
|
params:
|
|
- name: additionalParameters
|
|
aliases:
|
|
- name: helmDeploymentParameters
|
|
type: '[]string'
|
|
description: Defines additional parameters for \"helm install\" or \"kubectl apply\" command.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: apiServer
|
|
aliases:
|
|
- name: k8sAPIServer
|
|
type: string
|
|
description: Defines the Url of the API Server of the Kubernetes cluster.
|
|
scope:
|
|
- GENERAL
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: appTemplate
|
|
aliases:
|
|
- name: k8sAppTemplate
|
|
type: string
|
|
description: Defines the filename for the kubernetes app template (e.g. k8s_apptemplate.yaml)
|
|
mandatory: false
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: chartPath
|
|
aliases:
|
|
- name: helmChartPath
|
|
type: string
|
|
description: Defines the chart path for deployments using helm.
|
|
mandatory: true
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: containerRegistryPassword
|
|
description: Password for container registry access - typically provided by the CI/CD environment.
|
|
type: string
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
secret: true
|
|
- name: containerRegistryUrl
|
|
aliases:
|
|
- name: dockerRegistryUrl
|
|
type: string
|
|
description: http(s) url of the Container registry.
|
|
scope:
|
|
- GENERAL
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
mandatory: true
|
|
- name: containerRegistryUser
|
|
description: Username for container registry access - typically provided by the CI/CD environment.
|
|
type: string
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
secret: true
|
|
- name: containerRegistrySecret
|
|
description: Name of the container registry secret used for pulling containers from the registry.
|
|
type: string
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: regsecret
|
|
secret: true
|
|
- name: createDockerRegistrySecret
|
|
type: bool
|
|
description: Toggle to turn on Regsecret creation with a \"deployTool:kubectl\" deployment.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: false
|
|
- name: deploymentName
|
|
aliases:
|
|
- name: helmDeploymentName
|
|
type: string
|
|
description: Defines the name of the deployment.
|
|
mandatory: true
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: deployTool
|
|
type: string
|
|
description: Defines the tool which should be used for deployment.
|
|
mandatory: true
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: kubectl
|
|
possibleValues:
|
|
- kubectl
|
|
- helm
|
|
- helm3
|
|
- name: helmDeployWaitSeconds
|
|
type: int
|
|
description: Number of seconds before helm deploy returns.
|
|
mandatory: false
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: 300
|
|
- name: image
|
|
aliases:
|
|
- name: deployImage
|
|
type: string
|
|
description: Full name of the image to be deployed.
|
|
resourceRef:
|
|
- name: commonPipelineEnvironment
|
|
param: container/image
|
|
mandatory: true
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: ingressHosts
|
|
type: '[]string'
|
|
description: List of ingress hosts to be exposed via helm deployment.
|
|
mandatory: false
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: kubeConfig
|
|
type: string
|
|
description: Defines the path to the \"kubeconfig\" file.
|
|
scope:
|
|
- GENERAL
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: kubeContext
|
|
type: string
|
|
description: Defines the context to use from the \"kubeconfig\" file.
|
|
mandatory: false
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
- name: kubeToken
|
|
type: string
|
|
description: Contains the id_token used by kubectl for authentication. Consider using kubeConfig parameter instead.
|
|
scope:
|
|
- GENERAL
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
secret: true
|
|
- name: namespace
|
|
aliases:
|
|
- name: helmDeploymentNamespace
|
|
- name: k8sDeploymentNamespace
|
|
type: string
|
|
description: Defines the target Kubernetes namespace for the deployment.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
default: default
|
|
- name: tillerNamespace
|
|
aliases:
|
|
- name: helmTillerNamespace
|
|
type: string
|
|
description: Defines optional tiller namespace for deployments using helm.
|
|
scope:
|
|
- PARAMETERS
|
|
- STAGES
|
|
- STEPS
|
|
containers:
|
|
- image: dtzar/helm-kubectl:3.1.2
|
|
workingDir: /config
|
|
conditions:
|
|
- conditionRef: strings-equal
|
|
params:
|
|
- name: deployTool
|
|
value: helm3
|
|
- image: dtzar/helm-kubectl:2.12.1
|
|
workingDir: /config
|
|
conditions:
|
|
- conditionRef: strings-equal
|
|
params:
|
|
- name: deployTool
|
|
value: helm
|
|
- image: dtzar/helm-kubectl:2.12.1
|
|
workingDir: /config
|
|
conditions:
|
|
- conditionRef: strings-equal
|
|
params:
|
|
- name: deployTool
|
|
value: kubectl
|