mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
20a54cf094
allow `dockerExecute` to pass on to dockerExecuteOnKubernetes * containerCommand * containerShell
133 lines
5.2 KiB
Markdown
133 lines
5.2 KiB
Markdown
# dockerExecuteOnKubernetes
|
|
|
|
## Description
|
|
|
|
Executes a closure inside a container in a kubernetes pod. Proxy environment variables defined on the Jenkins machine are also available in the container.
|
|
|
|
## Prerequisites
|
|
|
|
* The Jenkins should be running on kubernetes.
|
|
* An environment variable `ON_K8S` should be created on Jenkins and initialized to `true`. This could for example be done via _Jenkins_ - _Manage Jenkins_ - _Configure System_ - _Global properties_ - _Environment variables_
|
|
|
|
|
|
|
|
## Parameters
|
|
|
|
| parameter | mandatory | default | possible values |
|
|
| ----------|-----------|---------|-----------------|
|
|
|script|yes|||
|
|
|containerCommand|no|||
|
|
|containerCommands|no|||
|
|
|containerEnvVars|no|||
|
|
|containerMap|no|`[:]`||
|
|
|containerName|no|||
|
|
|containerPortMappings|no|||
|
|
|containerShell|no|||
|
|
|containerWorkspaces|no|||
|
|
|dockerEnvVars|no|`[:]`||
|
|
|dockerImage|yes|||
|
|
|dockerWorkspace|no|`''`||
|
|
|jenkinsKubernetes|no|`[jnlpAgent:s4sdk/jenkins-agent-k8s:latest]`||
|
|
|stashExcludes|no|`[workspace:nohup.out]`||
|
|
|stashIncludes|no|`[workspace:**/*.*]`||
|
|
|
|
* `script` defines the global script environment of the Jenkins file run. Typically `this` is passed to this parameter. This allows the function to access the [`commonPipelineEnvironment`](commonPipelineEnvironment.md) for storing the measured duration.
|
|
* `containerCommand`: allows to specify start command for container created with dockerImage parameter to overwrite Piper default (`/usr/bin/tail -f /dev/null`).
|
|
* `containerCommands` specifies start command for containers to overwrite Piper default (`/usr/bin/tail -f /dev/null`). If container's defaultstart command should be used provide empty string like: `['selenium/standalone-chrome': '']`.
|
|
* `containerEnvVars` specifies environment variables per container. If not provided `dockerEnvVars` will be used.
|
|
* `containerMap` A map of docker image to the name of the container. The pod will be created with all the images from this map and they are labled based on the value field of each map entry.
|
|
Example: `['maven:3.5-jdk-8-alpine': 'mavenExecute', 'selenium/standalone-chrome': 'selenium', 'famiko/jmeter-base': 'checkJMeter', 's4sdk/docker-cf-cli': 'cloudfoundry']`
|
|
* `containerName`: optional configuration in combination with containerMap to define the container where the commands should be executed in
|
|
* `containerPortMappings`: Map which defines per docker image the port mappings, like `containerPortMappings: ['selenium/standalone-chrome': [[name: 'selPort', containerPort: 4444, hostPort: 4444]]]`
|
|
* `containerShell` allows to specify the shell to be executed for container with containerName
|
|
* `containerWorkspaces` specifies workspace (=home directory of user) per container. If not provided `dockerWorkspace` will be used. If empty, home directory will not be set.
|
|
* `dockerImage` Name of the docker image that should be used. If empty, Docker is not used.
|
|
* `dockerEnvVars` Environment variables to set in the container, e.g. [http_proxy:'proxy:8080']
|
|
* `dockerWorkspace` Docker options to be set when starting the container. It can be a list or a string.
|
|
|
|
## Step configuration
|
|
|
|
We recommend to define values of step parameters via [config.yml file](../configuration.md).
|
|
|
|
In following sections the configuration is possible:
|
|
|
|
| parameter | general | step | stage |
|
|
| ----------|-----------|---------|-----------------|
|
|
|script||||
|
|
|containerCommands||X|X|
|
|
|containerEnvVars||X|X|
|
|
|containerMap||X|X|
|
|
|containerName||X|X|
|
|
|containerPortMappings||X|X|
|
|
|containerWorkspaces||X|X|
|
|
|dockerEnvVars||X|X|
|
|
|dockerImage||X|X|
|
|
|dockerWorkspace||X|X|
|
|
|jenkinsKubernetes|X|||
|
|
|stashExcludes||X|X|
|
|
|stashIncludes||X|X|
|
|
|
|
## Side effects
|
|
|
|
none
|
|
|
|
## Exceptions
|
|
|
|
none
|
|
|
|
## Example 1: Run a closure in a single container pod
|
|
|
|
```sh
|
|
# set environment variable
|
|
export ON_K8S=true"
|
|
```
|
|
|
|
```groovy
|
|
dockerExecuteOnKubernetes(script: script, dockerImage: 'maven:3.5-jdk-7'){
|
|
sh "mvn clean install"
|
|
}
|
|
```
|
|
|
|
In the above example, a pod will be created with a docker container of image `maven:3.5-jdk-7`. The closure will be then executed inside the container.
|
|
|
|
## Example 2: Run a closure in a multi-container pod
|
|
|
|
```sh
|
|
# set environment variable
|
|
export ON_K8S=true"
|
|
```
|
|
|
|
```groovy
|
|
dockerExecuteOnKubernetes(script: script, containerMap: ['maven:3.5-jdk-8-alpine': 'maven', 's4sdk/docker-cf-cli': 'cfcli']){
|
|
container('maven'){
|
|
sh "mvn clean install"
|
|
}
|
|
container('cfcli'){
|
|
sh "cf plugins"
|
|
}
|
|
}
|
|
```
|
|
|
|
In the above example, a pod will be created with multiple Docker containers that are passed as a `containerMap`. The containers can be chosen for executing by referring their labels as shown in the example.
|
|
|
|
## Example 3: Running a closure in a dedicated container of a multi-container pod
|
|
|
|
```sh
|
|
# set environment variable
|
|
export ON_K8S=true"
|
|
```
|
|
|
|
```groovy
|
|
dockerExecuteOnKubernetes(
|
|
script: script,
|
|
containerCommands: ['selenium/standalone-chrome': ''],
|
|
containerMap: ['maven:3.5-jdk-8-alpine': 'maven', 'selenium/standalone-chrome': 'selenium'],
|
|
containerName: 'maven',
|
|
containerPortMappings: ['selenium/standalone-chrome': [containerPort: 4444, hostPort: 4444]]
|
|
containerWorkspaces: ['selenium/standalone-chrome': '']
|
|
){
|
|
echo "Executing inside a Kubernetes Pod inside 'maven' container to run Selenium tests"
|
|
sh "mvn clean install"
|
|
}
|
|
```
|