Skip to content

Commit 932a7b6

Browse files
VlatombeVlatombe
committed
Round of review on the documentation
1 parent 32eb87d commit 932a7b6

14 files changed

+474
-365
lines changed

‎README.md

+222-118
Large diffs are not rendered by default.

‎examples/containerLog.groovy

+33-31
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
1-
podTemplate(yaml: """
2-
apiVersion: v1
3-
kind: Pod
4-
metadata:
5-
labels:
6-
some-label: some-label-value
7-
spec:
8-
containers:
9-
- name: maven
10-
image: maven:3.3.9-jdk-8-alpine
11-
command: ['cat']
12-
tty: true
13-
- name: mongo
14-
image: mongo
15-
"""
16-
) {
1+
podTemplate(yaml: '''
2+
apiVersion: v1
3+
kind: Pod
4+
metadata:
5+
labels:
6+
some-label: some-label-value
7+
spec:
8+
containers:
9+
- name: maven
10+
image: maven:3.8.1-jdk-8
11+
command:
12+
- sleep
13+
args:
14+
- 99d
15+
tty: true
16+
- name: mongo
17+
image: mongo
18+
'''.stripIndent()
19+
) {
20+
node(POD_LABEL) {
21+
stage('Integration Test') {
22+
try {
23+
container('maven') {
24+
sh 'nc -z localhost:27017 && echo "connected to mongo db"'
25+
// sh 'mvn -B clean failsafe:integration-test' // real integration test
1726

18-
node(POD_LABEL) {
19-
stage('Integration Test') {
20-
try {
21-
container('maven') {
22-
sh 'nc -z localhost:27017 && echo "connected to mongo db"'
23-
// sh 'mvn -B clean failsafe:integration-test' // real integration test
24-
25-
def mongoLog = containerLog(name: 'mongo', returnLog: true, tailingLines: 5, sinceSeconds: 20, limitBytes: 50000)
26-
assert mongoLog.contains('connection accepted from 127.0.0.1:')
27-
sh 'echo failing build; false'
28-
}
29-
} catch (Exception e) {
30-
containerLog 'mongo'
31-
throw e
32-
}
27+
def mongoLog = containerLog(name: 'mongo', returnLog: true, tailingLines: 5, sinceSeconds: 20, limitBytes: 50000)
28+
assert mongoLog.contains('connection accepted from 127.0.0.1:')
29+
sh 'echo failing build; false'
3330
}
31+
} catch (Exception e) {
32+
containerLog 'mongo'
33+
throw e
34+
}
3435
}
36+
}
3537
}

‎examples/declarative_from_yaml_file/KubernetesPod.yaml

+4-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ spec:
88
- name: CONTAINER_ENV_VAR
99
value: jnlp
1010
- name: maven
11-
image: maven:3.3.9-jdk-8-alpine
11+
image: maven:3.8.1-jdk-8
1212
command:
13-
- cat
14-
tty: true
13+
- sleep
14+
args:
15+
- 99d
1516
env:
1617
- name: CONTAINER_ENV_VAR
1718
value: maven

‎examples/dind.groovy

+29-29
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,34 @@ docker.sock does not need to be mounted as in dood.groovy.
77
May or may not work depending on cluster policy: https://kubernetes.io/docs/concepts/policy/pod-security-policy/
88
*/
99
podTemplate(yaml: '''
10-
apiVersion: v1
11-
kind: Pod
12-
spec:
13-
volumes:
14-
- name: docker-socket
15-
emptyDir: {}
16-
containers:
17-
- name: docker
18-
image: docker:19.03.1
19-
command:
20-
- sleep
21-
args:
22-
- 99d
23-
volumeMounts:
24-
- name: docker-socket
25-
mountPath: /var/run
26-
- name: docker-daemon
27-
image: docker:19.03.1-dind
28-
securityContext:
29-
privileged: true
30-
volumeMounts:
31-
- name: docker-socket
32-
mountPath: /var/run
33-
''') {
34-
node(POD_LABEL) {
35-
writeFile file: 'Dockerfile', text: 'FROM scratch'
36-
container('docker') {
37-
sh 'docker version && DOCKER_BUILDKIT=1 docker build --progress plain -t testing .'
38-
}
10+
apiVersion: v1
11+
kind: Pod
12+
spec:
13+
volumes:
14+
- name: docker-socket
15+
emptyDir: {}
16+
containers:
17+
- name: docker
18+
image: docker:19.03.1
19+
command:
20+
- sleep
21+
args:
22+
- 99d
23+
volumeMounts:
24+
- name: docker-socket
25+
mountPath: /var/run
26+
- name: docker-daemon
27+
image: docker:19.03.1-dind
28+
securityContext:
29+
privileged: true
30+
volumeMounts:
31+
- name: docker-socket
32+
mountPath: /var/run
33+
'''.stripIndent()) {
34+
node(POD_LABEL) {
35+
writeFile file: 'Dockerfile', text: 'FROM scratch'
36+
container('docker') {
37+
sh 'docker version && DOCKER_BUILDKIT=1 docker build --progress plain -t testing .'
3938
}
39+
}
4040
}

‎examples/dood.groovy

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
/*
22
“Docker-outside-of-Docker”: runs a Docker-based build by connecting a Docker client inside the pod to the host daemon.
33
*/
4-
podTemplate(yaml: """
5-
apiVersion: v1
6-
kind: Pod
7-
spec:
8-
containers:
9-
- name: docker
10-
image: docker:1.11
11-
command: ['cat']
12-
tty: true
13-
volumeMounts:
14-
- name: dockersock
15-
mountPath: /var/run/docker.sock
16-
volumes:
17-
- name: dockersock
18-
hostPath:
19-
path: /var/run/docker.sock
20-
"""
4+
podTemplate(yaml: '''
5+
apiVersion: v1
6+
kind: Pod
7+
spec:
8+
containers:
9+
- name: docker
10+
image: docker:19.03.1
11+
command:
12+
- sleep
13+
args:
14+
- 99d
15+
volumeMounts:
16+
- name: dockersock
17+
mountPath: /var/run/docker.sock
18+
volumes:
19+
- name: dockersock
20+
hostPath:
21+
path: /var/run/docker.sock
22+
'''.stripIndent()
2123
) {
2224

2325
def image = "jenkins/inbound-agent"

‎examples/kaniko-declarative.groovy

+24-24
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,30 @@ pipeline {
1616
kubernetes {
1717
//cloud 'kubernetes'
1818
defaultContainer 'kaniko'
19-
yaml """
20-
kind: Pod
21-
spec:
22-
containers:
23-
- name: kaniko
24-
image: gcr.io/kaniko-project/executor:debug-539ddefcae3fd6b411a95982a830d987f4214251
25-
imagePullPolicy: Always
26-
command:
27-
- sleep
28-
args:
29-
- 9999999
30-
volumeMounts:
31-
- name: jenkins-docker-cfg
32-
mountPath: /kaniko/.docker
33-
volumes:
34-
- name: jenkins-docker-cfg
35-
projected:
36-
sources:
37-
- secret:
38-
name: regcred
39-
items:
40-
- key: .dockerconfigjson
41-
path: config.json
42-
"""
19+
yaml '''
20+
kind: Pod
21+
spec:
22+
containers:
23+
- name: kaniko
24+
image: gcr.io/kaniko-project/executor:v1.6.0-debug
25+
imagePullPolicy: Always
26+
command:
27+
- sleep
28+
args:
29+
- 99d
30+
volumeMounts:
31+
- name: jenkins-docker-cfg
32+
mountPath: /kaniko/.docker
33+
volumes:
34+
- name: jenkins-docker-cfg
35+
projected:
36+
sources:
37+
- secret:
38+
name: regcred
39+
items:
40+
- key: .dockerconfigjson
41+
path: config.json
42+
'''.stripIndent()
4343
}
4444
}
4545
stages {

‎examples/kaniko-gcr.groovy

+22-22
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@
88
* kubectl create secret generic kaniko-secret --from-file=kaniko-secret.json
99
*/
1010

11-
podTemplate(yaml: """
12-
kind: Pod
13-
spec:
14-
containers:
15-
- name: kaniko
16-
image: gcr.io/kaniko-project/executor:debug
17-
imagePullPolicy: Always
18-
command:
19-
- sleep
20-
args:
21-
- 9999999
22-
volumeMounts:
23-
- name: kaniko-secret
24-
mountPath: /secret
25-
env:
26-
- name: GOOGLE_APPLICATION_CREDENTIALS
27-
value: /secret/kaniko-secret.json
28-
volumes:
29-
- name: kaniko-secret
30-
secret:
31-
secretName: kaniko-secret
32-
"""
11+
podTemplate(yaml: '''
12+
kind: Pod
13+
spec:
14+
containers:
15+
- name: kaniko
16+
image: gcr.io/kaniko-project/executor:debug
17+
imagePullPolicy: Always
18+
command:
19+
- sleep
20+
args:
21+
- 9999999
22+
volumeMounts:
23+
- name: kaniko-secret
24+
mountPath: /secret
25+
env:
26+
- name: GOOGLE_APPLICATION_CREDENTIALS
27+
value: /secret/kaniko-secret.json
28+
volumes:
29+
- name: kaniko-secret
30+
secret:
31+
secretName: kaniko-secret
32+
'''.stripIndent()
3333
) {
3434

3535
node(POD_LABEL) {

‎examples/kaniko.groovy

+24-23
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,30 @@
88
* https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-secret-in-the-cluster-that-holds-your-authorization-token
99
*/
1010

11-
podTemplate(yaml: """
12-
kind: Pod
13-
spec:
14-
containers:
15-
- name: kaniko
16-
image: gcr.io/kaniko-project/executor:debug-539ddefcae3fd6b411a95982a830d987f4214251
17-
imagePullPolicy: Always
18-
command:
19-
- /busybox/cat
20-
tty: true
21-
volumeMounts:
22-
- name: jenkins-docker-cfg
23-
mountPath: /kaniko/.docker
24-
volumes:
25-
- name: jenkins-docker-cfg
26-
projected:
27-
sources:
28-
- secret:
29-
name: regcred
30-
items:
31-
- key: .dockerconfigjson
32-
path: config.json
33-
"""
11+
podTemplate(yaml: '''
12+
kind: Pod
13+
spec:
14+
containers:
15+
- name: kaniko
16+
image: gcr.io/kaniko-project/executor:v1.6.0-debug
17+
imagePullPolicy: Always
18+
command:
19+
- sleep
20+
args:
21+
- 99d
22+
volumeMounts:
23+
- name: jenkins-docker-cfg
24+
mountPath: /kaniko/.docker
25+
volumes:
26+
- name: jenkins-docker-cfg
27+
projected:
28+
sources:
29+
- secret:
30+
name: regcred
31+
items:
32+
- key: .dockerconfigjson
33+
path: config.json
34+
'''.stripIndent()
3435
) {
3536

3637
node(POD_LABEL) {

‎examples/maven-with-cache-pvc.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
apiVersion: "v1"
3-
kind: "PersistentVolumeClaim"
2+
apiVersion: v1
3+
kind: PersistentVolumeClaim
44
metadata:
5-
name: "maven-repo"
6-
namespace: "kubernetes-plugin"
5+
name: maven-repo
6+
namespace: kubernetes-plugin
77
spec:
88
accessModes:
99
- ReadWriteOnce

‎examples/maven-with-cache.groovy

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*/
99

1010
podTemplate(containers: [
11-
containerTemplate(name: 'maven', image: 'maven:3.6.0-jdk-8-alpine', ttyEnabled: true, command: 'cat')
11+
containerTemplate(name: 'maven', image: 'maven:3.8.1-jdk-8', command: 'sleep', args: '99d')
1212
], volumes: [
1313
persistentVolumeClaim(mountPath: '/root/.m2/repository', claimName: 'maven-repo', readOnly: false)
1414
]) {
@@ -17,7 +17,7 @@ podTemplate(containers: [
1717
stage('Build a Maven project') {
1818
git 'https://github.com/jenkinsci/kubernetes-plugin.git'
1919
container('maven') {
20-
sh 'mvn -B clean package'
20+
sh 'mvn -B -ntp clean package -DskipTests'
2121
}
2222
}
2323
}

0 commit comments

Comments
 (0)