2175 lines
133 KiB
XML
2175 lines
133 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||
<channel>
|
||
<title>Jenkins Operator – v0.2.0</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/</link>
|
||
<description>Recent Hugo news from gohugo.io</description>
|
||
<generator>Hugo -- gohugo.io</generator>
|
||
<lastBuildDate>Mon, 05 Aug 2019 00:00:00 +0000</lastBuildDate>
|
||
<image>
|
||
<url>https://jenkinsci.github.io/kubernetes-operator/img/hugo.png</url>
|
||
<title>GoHugo.io</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/</link>
|
||
</image>
|
||
|
||
<atom:link href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/index.xml" rel="self" type="application/rss+xml" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<item>
|
||
<title>Docs: Deploy Jenkins</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/deploy-jenkins/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/deploy-jenkins/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Once jenkins-operator is up and running let&rsquo;s deploy actual Jenkins instance.
|
||
Create manifest ie. <strong>jenkins_instance.yaml</strong> with following data and save it on drive.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">apiVersion: jenkins.io/v1alpha2
|
||
kind: Jenkins
|
||
metadata:
|
||
name: example
|
||
spec:
|
||
master:
|
||
containers:
|
||
- name: jenkins-master
|
||
image: jenkins/jenkins:lts
|
||
imagePullPolicy: Always
|
||
livenessProbe:
|
||
failureThreshold: <span style="color:#0000cf;font-weight:bold">12</span>
|
||
httpGet:
|
||
path: /login
|
||
port: http
|
||
scheme: HTTP
|
||
initialDelaySeconds: <span style="color:#0000cf;font-weight:bold">80</span>
|
||
periodSeconds: <span style="color:#0000cf;font-weight:bold">10</span>
|
||
successThreshold: <span style="color:#0000cf;font-weight:bold">1</span>
|
||
timeoutSeconds: <span style="color:#0000cf;font-weight:bold">5</span>
|
||
readinessProbe:
|
||
failureThreshold: <span style="color:#0000cf;font-weight:bold">3</span>
|
||
httpGet:
|
||
path: /login
|
||
port: http
|
||
scheme: HTTP
|
||
initialDelaySeconds: <span style="color:#0000cf;font-weight:bold">30</span>
|
||
periodSeconds: <span style="color:#0000cf;font-weight:bold">10</span>
|
||
successThreshold: <span style="color:#0000cf;font-weight:bold">1</span>
|
||
timeoutSeconds: <span style="color:#0000cf;font-weight:bold">1</span>
|
||
resources:
|
||
limits:
|
||
cpu: 1500m
|
||
memory: 3Gi
|
||
requests:
|
||
cpu: <span style="color:#4e9a06">&#34;1&#34;</span>
|
||
memory: 500Mi
|
||
seedJobs:
|
||
- id: jenkins-operator
|
||
targets: <span style="color:#4e9a06">&#34;cicd/jobs/*.jenkins&#34;</span>
|
||
description: <span style="color:#4e9a06">&#34;Jenkins Operator repository&#34;</span>
|
||
repositoryBranch: master
|
||
repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git</code></pre></div>
|
||
<p>Deploy Jenkins to K8s:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl create -f jenkins_instance.yaml</code></pre></div>
|
||
<p>Watch Jenkins instance being created:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl get pods -w</code></pre></div>
|
||
<p>Get Jenkins credentials:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl get secret jenkins-operator-credentials-&lt;cr_name&gt; -o <span style="color:#4e9a06">&#39;jsonpath={.data.user}&#39;</span> <span style="color:#000;font-weight:bold">|</span> base64 -d
|
||
kubectl get secret jenkins-operator-credentials-&lt;cr_name&gt; -o <span style="color:#4e9a06">&#39;jsonpath={.data.password}&#39;</span> <span style="color:#000;font-weight:bold">|</span> base64 -d</code></pre></div>
|
||
<p>Connect to Jenkins (minikube):</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">minikube service jenkins-operator-http-&lt;cr_name&gt; --url</code></pre></div>
|
||
<p>Connect to Jenkins (actual Kubernetes cluster):</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl port-forward jenkins-&lt;cr_name&gt; <span style="color:#0000cf;font-weight:bold">8080</span>:8080</code></pre></div>
|
||
<p>Then open browser with address <code>http://localhost:8080</code>.
|
||
<img src="https://jenkinsci.github.io/kubernetes-operator/img/jenkins.png" alt="jenkins" /></p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Configuration</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/configuration/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/configuration/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<h2 id="configure-seed-jobs-and-pipelines">Configure Seed Jobs and Pipelines</h2>
|
||
|
||
<p>Jenkins operator uses <a href="https://github.com/jenkinsci/job-dsl-plugin" target="_blank">job-dsl</a> and <a href="https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/" target="_blank">kubernetes-credentials-provider</a> plugins for configuring jobs
|
||
and deploy keys.</p>
|
||
|
||
<h2 id="prepare-job-definitions-and-pipelines">Prepare job definitions and pipelines</h2>
|
||
|
||
<p>First you have to prepare pipelines and job definition in your GitHub repository using the following structure:</p>
|
||
|
||
<pre><code>cicd/
|
||
├── jobs
|
||
│ └── build.jenkins
|
||
└── pipelines
|
||
└── build.jenkins
|
||
</code></pre>
|
||
|
||
<p><strong>cicd/jobs/build.jenkins</strong> it&rsquo;s a job definition:</p>
|
||
|
||
<pre><code>#!/usr/bin/env groovy
|
||
|
||
pipelineJob('build-jenkins-operator') {
|
||
displayName('Build jenkins-operator')
|
||
|
||
definition {
|
||
cpsScm {
|
||
scm {
|
||
git {
|
||
remote {
|
||
url('https://github.com/jenkinsci/kubernetes-operator.git')
|
||
credentials('jenkins-operator')
|
||
}
|
||
branches('*/master')
|
||
}
|
||
}
|
||
scriptPath('cicd/pipelines/build.jenkins')
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
|
||
<p><strong>cicd/jobs/build.jenkins</strong> it&rsquo;s an actual Jenkins pipeline:</p>
|
||
|
||
<pre><code>#!/usr/bin/env groovy
|
||
|
||
def label = &quot;build-jenkins-operator-${UUID.randomUUID().toString()}&quot;
|
||
def home = &quot;/home/jenkins&quot;
|
||
def workspace = &quot;${home}/workspace/build-jenkins-operator&quot;
|
||
def workdir = &quot;${workspace}/src/github.com/jenkinsci/kubernetes-operator/&quot;
|
||
|
||
podTemplate(label: label,
|
||
containers: [
|
||
containerTemplate(name: 'jnlp', image: 'jenkins/jnlp-slave:alpine'),
|
||
containerTemplate(name: 'go', image: 'golang:1-alpine', command: 'cat', ttyEnabled: true),
|
||
],
|
||
envVars: [
|
||
envVar(key: 'GOPATH', value: workspace),
|
||
],
|
||
) {
|
||
|
||
node(label) {
|
||
dir(workdir) {
|
||
stage('Init') {
|
||
timeout(time: 3, unit: 'MINUTES') {
|
||
checkout scm
|
||
}
|
||
container('go') {
|
||
sh 'apk --no-cache --update add make git gcc libc-dev'
|
||
}
|
||
}
|
||
|
||
stage('Dep') {
|
||
container('go') {
|
||
sh 'make dep'
|
||
}
|
||
}
|
||
|
||
stage('Test') {
|
||
container('go') {
|
||
sh 'make test'
|
||
}
|
||
}
|
||
|
||
stage('Build') {
|
||
container('go') {
|
||
sh 'make build'
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
|
||
<h2 id="configure-seed-jobs">Configure Seed Jobs</h2>
|
||
|
||
<p>Jenkins Seed Jobs are configured using <code>Jenkins.spec.seedJobs</code> section from your custom resource manifest:</p>
|
||
|
||
<pre><code>apiVersion: jenkins.io/v1alpha2
|
||
kind: Jenkins
|
||
metadata:
|
||
name: example
|
||
spec:
|
||
seedJobs:
|
||
- id: jenkins-operator
|
||
targets: &quot;cicd/jobs/*.jenkins&quot;
|
||
description: &quot;Jenkins Operator repository&quot;
|
||
repositoryBranch: master
|
||
repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
|
||
</code></pre>
|
||
|
||
<p><strong>jenkins-operator</strong> will automatically discover and configure all seed jobs.</p>
|
||
|
||
<p>You can verify if deploy keys were successfully configured in Jenkins <strong>Credentials</strong> tab.</p>
|
||
|
||
<p><img src="https://jenkinsci.github.io/kubernetes-operator/kubernetes-operator/img/jenkins-credentials.png" alt="jenkins" /></p>
|
||
|
||
<p>You can verify if your pipelines were successfully configured in Jenkins Seed Job console output.</p>
|
||
|
||
<p><img src="https://jenkinsci.github.io/kubernetes-operator/kubernetes-operator/img/jenkins-seed.png" alt="jenkins" /></p>
|
||
|
||
<p>If your GitHub repository is <strong>private</strong> you have to configure SSH or username/password authentication.</p>
|
||
|
||
<h3 id="ssh-authentication">SSH authentication</h3>
|
||
|
||
<h4 id="generate-ssh-keys">Generate SSH Keys</h4>
|
||
|
||
<p>There are two methods of SSH private key generation:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ openssl genrsa -out &lt;filename&gt; <span style="color:#0000cf;font-weight:bold">2048</span></code></pre></div>
|
||
<p>or</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ ssh-keygen -t rsa -b <span style="color:#0000cf;font-weight:bold">2048</span>
|
||
$ ssh-keygen -p -f &lt;filename&gt; -m pem</code></pre></div>
|
||
<p>Then copy content from generated file.</p>
|
||
|
||
<h4 id="public-key">Public key</h4>
|
||
|
||
<p>If you want to upload your public key to your Git server you need to extract it.</p>
|
||
|
||
<p>If key was generated by <code>openssl</code> then you need to type this to extract public key:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ openssl rsa -in &lt;filename&gt; -pubout &gt; &lt;filename&gt;.pub</code></pre></div>
|
||
<p>If key was generated by <code>ssh-keygen</code> the public key content is located in <filename>.pub and there is no need to extract public key</p>
|
||
|
||
<h4 id="configure-ssh-authentication">Configure SSH authentication</h4>
|
||
|
||
<p>Configure seed job like:</p>
|
||
|
||
<pre><code>apiVersion: jenkins.io/v1alpha2
|
||
kind: Jenkins
|
||
metadata:
|
||
name: example
|
||
spec:
|
||
seedJobs:
|
||
- id: jenkins-operator-ssh
|
||
credentialType: basicSSHUserPrivateKey
|
||
credentialID: k8s-ssh
|
||
targets: &quot;cicd/jobs/*.jenkins&quot;
|
||
description: &quot;Jenkins Operator repository&quot;
|
||
repositoryBranch: master
|
||
repositoryUrl: git@github.com:jenkinsci/kubernetes-operator.git
|
||
</code></pre>
|
||
|
||
<p>and create Kubernetes Secret(name of secret should be the same from <code>credentialID</code> field):</p>
|
||
|
||
<pre><code>apiVersion: v1
|
||
kind: Secret
|
||
metadata:
|
||
name: k8s-ssh
|
||
stringData:
|
||
privateKey: |
|
||
-----BEGIN RSA PRIVATE KEY-----
|
||
MIIJKAIBAAKCAgEAxxDpleJjMCN5nusfW/AtBAZhx8UVVlhhhIKXvQ+dFODQIdzO
|
||
oDXybs1zVHWOj31zqbbJnsfsVZ9Uf3p9k6xpJ3WFY9b85WasqTDN1xmSd6swD4N8
|
||
...
|
||
username: github_user_name
|
||
</code></pre>
|
||
|
||
<h3 id="username-password-authentication">Username &amp; password authentication</h3>
|
||
|
||
<p>Configure seed job like:</p>
|
||
|
||
<pre><code>apiVersion: jenkins.io/v1alpha2
|
||
kind: Jenkins
|
||
metadata:
|
||
name: example
|
||
spec:
|
||
seedJobs:
|
||
- id: jenkins-operator-user-pass
|
||
credentialType: usernamePassword
|
||
credentialID: k8s-user-pass
|
||
targets: &quot;cicd/jobs/*.jenkins&quot;
|
||
description: &quot;Jenkins Operator repository&quot;
|
||
repositoryBranch: master
|
||
repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
|
||
</code></pre>
|
||
|
||
<p>and create Kubernetes Secret(name of secret should be the same from <code>credentialID</code> field):</p>
|
||
|
||
<pre><code>apiVersion: v1
|
||
kind: Secret
|
||
metadata:
|
||
name: k8s-user-pass
|
||
stringData:
|
||
username: github_user_name
|
||
password: password_or_token
|
||
</code></pre>
|
||
|
||
<h2 id="pulling-docker-images-from-private-repositories">Pulling Docker images from private repositories</h2>
|
||
|
||
<p>To pull Docker Image from private repository you can use <code>imagePullSecrets</code>.</p>
|
||
|
||
<p>Please follow the instructions on <a href="https://kubernetes.io/docs/concepts/containers/images/?origin_team=T42NTAGHM#creating-a-secret-with-a-docker-config" target="_blank">creating a secret with a docker config</a>.</p>
|
||
|
||
<h3 id="docker-hub-configuration">Docker Hub Configuration</h3>
|
||
|
||
<p>To use Docker Hub additional steps are required.</p>
|
||
|
||
<p>Edit the previously created secret:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl -n &lt;namespace&gt; edit secret &lt;name&gt;</code></pre></div>
|
||
<p>The <code>.dockerconfigjson</code> key&rsquo;s value needs to be replaced with a modified version.</p>
|
||
|
||
<p>After modifications it needs to be encoded as Base64 value before setting the <code>.dockerconfigjson</code> key:q.</p>
|
||
|
||
<p>Example config file to modify and use:</p>
|
||
|
||
<pre><code>{
|
||
&quot;auths&quot;:{
|
||
&quot;https://index.docker.io/v1/&quot;:{
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;auth.docker.io&quot;:{
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;registry.docker.io&quot;:{
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;docker.io&quot;:{
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;https://registry-1.docker.io/v2/&quot;: {
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;registry-1.docker.io/v2/&quot;: {
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;registry-1.docker.io&quot;: {
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
},
|
||
&quot;https://registry-1.docker.io&quot;: {
|
||
&quot;username&quot;:&quot;user&quot;,
|
||
&quot;password&quot;:&quot;password&quot;,
|
||
&quot;email&quot;:&quot;yourdockeremail@gmail.com&quot;,
|
||
&quot;auth&quot;:&quot;base64 of string user:password&quot;
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Customization</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/customization/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/customization/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<p>Jenkins can be customized using groovy scripts or <a href="https://github.com/jenkinsci/configuration-as-code-plugin" target="_blank">configuration as code plugin</a>.
|
||
By using <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/" target="_blank">ConfigMap</a> you can create own <strong>Jenkins</strong> customized configuration.
|
||
Then you must reference the <em>ConfigMap</em> in <strong>Jenkins</strong> pod customization file in <code>spec.groovyScripts</code> or <code>spec.configurationAsCode</code></p>
|
||
|
||
<p>For example create <em>ConfigMap</em> with name <code>jenkins-operator-user-configuration</code>. Then, modify the <strong>Jenkins</strong> manifest to look like this:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.io/v1alpha2<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>example<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurationAsCode<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>groovyScripts<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration</code></pre></div>
|
||
<p>Here is example of <code>jenkins-operator-user-configuration</code>:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>v1<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigMap<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>data<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span>-configure-theme.groovy<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">|
|
||
</span><span style="color:#8f5902;font-style:italic"> import jenkins.*</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.model.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>hudson.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>hudson.model.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>org.jenkinsci.plugins.simpletheme.ThemeElement<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>org.jenkinsci.plugins.simpletheme.CssTextThemeElement<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>org.jenkinsci.plugins.simpletheme.CssUrlThemeElement<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins.getInstance()<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>def<span style="color:#f8f8f8;text-decoration:underline"> </span>decorator<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins.instance.getDescriptorByType(org.codefirst.SimpleThemeDecorator.class)<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>List&lt;ThemeElement&gt;<span style="color:#f8f8f8;text-decoration:underline"> </span>configElements<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>new<span style="color:#f8f8f8;text-decoration:underline"> </span>ArrayList&lt;&gt;();<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configElements.add(new<span style="color:#f8f8f8;text-decoration:underline"> </span>CssTextThemeElement(<span style="color:#4e9a06">&#34;DEFAULT&#34;</span>));<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configElements.add(new<span style="color:#f8f8f8;text-decoration:underline"> </span>CssUrlThemeElement(<span style="color:#4e9a06">&#34;https://cdn.rawgit.com/afonsof/jenkins-material-theme/gh-pages/dist/material-light-green.css&#34;</span>));<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>decorator.setElements(configElements);<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>decorator.save();<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.save()<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span>-system-message.yaml<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">|
|
||
</span><span style="color:#8f5902;font-style:italic"> jenkins:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>systemMessage<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;Configuration as Code integration works!!!&#34;</span></code></pre></div>
|
||
<ul>
|
||
<li>*.groovy is Groovy script configuration</li>
|
||
<li>*.yaml is configuration as code</li>
|
||
</ul>
|
||
|
||
<p>If you want to correct your configuration you can edit it while <strong>jenkins-operator</strong> is running.
|
||
Jenkins will reconcile and apply new configuration.</p>
|
||
|
||
<h3 id="using-secrets-inside-groovy-script">Using secrets inside Groovy script</h3>
|
||
|
||
<p>If you configured <code>spec.groovyScripts.secret.name</code>, then this secret is available to use inside map Groovy scripts.
|
||
The secrets are loaded to <code>secrets</code> map.</p>
|
||
|
||
<p>Create a <a href="https://kubernetes.io/docs/concepts/configuration/secret/" target="_blank">secret</a> with for eg. <code>jenkins-conf-secrets</code> name.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Secret<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>v1<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>type<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Opaque<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-conf-secrets<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>namespace<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>default<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>data<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SYSTEM_MESSAGE<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>SGVsbG8gd29ybGQ=</code></pre></div>
|
||
<p>Then modify the <strong>Jenkins</strong> pod manifest by changing <code>spec.groovyScripts.secret.name</code> to <code>jenkins-conf-secrets</code>.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.io/v1alpha2<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>example<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurationAsCode<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>secret<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-conf-secrets<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>groovyScripts<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>secret<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-conf-secrets</code></pre></div>
|
||
<p>Now you can test that the secret is mounted by applying this ConfigMap for Groovy script:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>v1<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigMap<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>data<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span>-system-message.groovy<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">|
|
||
</span><span style="color:#8f5902;font-style:italic"> import jenkins.*</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.model.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>hudson.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>import<span style="color:#f8f8f8;text-decoration:underline"> </span>hudson.model.*<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins<span style="color:#f8f8f8;text-decoration:underline"> </span>=<span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins.getInstance()<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.setSystemMessage(secrets<span style="color:#000;font-weight:bold">[</span><span style="color:#4e9a06">&#34;SYSTEM_MESSAGE&#34;</span><span style="color:#000;font-weight:bold">]</span>)<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.save()</code></pre></div>
|
||
<p>Or by applying configuration as code:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>v1<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>ConfigMap<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>data<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1</span>-system-message.yaml<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">|
|
||
</span><span style="color:#8f5902;font-style:italic"> jenkins:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>systemMessage<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>${SYSTEM_MESSAGE}</code></pre></div>
|
||
<p>After this, you should see the <code>Hello world</code> system message at <strong>Jenkins</strong> homepage.</p>
|
||
|
||
<h2 id="install-plugins">Install Plugins</h2>
|
||
|
||
<p>Edit CR under <code>spec.master.plugins</code>:</p>
|
||
|
||
<pre><code>apiVersion: jenkins.io/v1alpha2
|
||
kind: Jenkins
|
||
metadata:
|
||
name: example
|
||
spec:
|
||
master:
|
||
plugins:
|
||
- name: simple-theme-plugin
|
||
version: 0.5.1
|
||
</code></pre>
|
||
|
||
<p>Under <code>spec.master.basePlugins</code> you can find plugins for valid <strong>jenkins-operator</strong> work:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.io/v1alpha2<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>example<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>master<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>basePlugins<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>kubernetes<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1.18</span>.<span style="color:#0000cf;font-weight:bold">3</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>workflow-job<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;2.34&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>workflow-aggregator<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;2.6&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>git<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">3.12</span>.<span style="color:#0000cf;font-weight:bold">0</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>job-dsl<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;1.76&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configuration-as-code<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;1.29&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configuration-as-code-support<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;1.19&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>kubernetes-credentials-provider<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>version<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">0.12</span>.<span style="color:#0000cf;font-weight:bold">1</span></code></pre></div>
|
||
<p>You can change version of them.</p>
|
||
|
||
<p>Then <strong>jenkins-operator</strong> will automatically install plugins after Jenkins master pod restart.</p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: AKS</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/aks/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/aks/</guid>
|
||
<description>
|
||
|
||
|
||
<p>Azure AKS managed Kubernetes service adds to every pod the following envs:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>KUBERNETES_PORT_443_TCP_ADDR<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>KUBERNETES_PORT<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>tcp<span style="color:#000;font-weight:bold">:</span>//<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>KUBERNETES_PORT_443_TCP<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>tcp<span style="color:#000;font-weight:bold">:</span>//<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>KUBERNETES_SERVICE_HOST<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span></code></pre></div>
|
||
<p>The operator is aware of it and omits these envs when checking if Jenkins pod envs have been changed. It prevents
|
||
restart Jenkins pod over and over again.</p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Configure backup and restore</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/configure-backup-and-restore/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/configure-backup-and-restore/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<p>Backup and restore is done by container sidecar.</p>
|
||
|
||
<h3 id="pvc">PVC</h3>
|
||
|
||
<h4 id="create-pvc">Create PVC</h4>
|
||
|
||
<p>Save to file pvc.yaml:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>v1<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>PersistentVolumeClaim<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;pvc_name<span style="color:#8f5902;font-style:italic">&gt;
|
||
</span><span style="color:#8f5902;font-style:italic"> namespace: &lt;namesapce&gt;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>accessModes<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>ReadWriteOnce<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>resources<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>requests<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>storage<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>500Gi</code></pre></div>
|
||
<p>Run command:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ kubectl -n &lt;namesapce&gt; create -f pvc.yaml</code></pre></div>
|
||
<h4 id="configure-jenkins-cr">Configure Jenkins CR</h4>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.io/v1alpha2<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;cr_name<span style="color:#8f5902;font-style:italic">&gt;
|
||
</span><span style="color:#8f5902;font-style:italic"> namespace: &lt;namespace&gt;</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>master<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>securityContext<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>runAsUser<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>fsGroup<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">1000</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>containers<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-master<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>image<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins/jenkins<span style="color:#000;font-weight:bold">:</span>lts<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>backup<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># container responsible for backup and restore</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>env<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BACKUP_DIR<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>/backup<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>JENKINS_HOME<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>/jenkins-home<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>BACKUP_COUNT<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>value<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;3&#34;</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># keep only the 2 most recent backups</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>image<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>virtuslab/jenkins-operator-backup-pvc<span style="color:#000;font-weight:bold">:</span>v0.<span style="color:#0000cf;font-weight:bold">0.6</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># look at backup/pvc directory</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>imagePullPolicy<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>IfNotPresent<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>volumeMounts<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>mountPath<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>/jenkins-home<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># Jenkins home volume</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-home<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>mountPath<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>/backup<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># backup volume</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>backup<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>volumes<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>backup<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># PVC volume where backups will be stored</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>persistentVolumeClaim<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>claimName<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>&lt;pvc_name<span style="color:#8f5902;font-style:italic">&gt;
|
||
</span><span style="color:#8f5902;font-style:italic"> backup:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>containerName<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>backup<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># container name is responsible for backup</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>action<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>exec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>command<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>/home/user/bin/backup.sh<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># this command is invoked on &#34;backup&#34; container to make backup, for example /home/user/bin/backup.sh &lt;backup_number&gt;, &lt;backup_number&gt; is passed by operator</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>interval<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:bold">30</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># how often make backup in seconds</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>makeBackupBeforePodDeletion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">true</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># make backup before pod deletion</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>restore<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>containerName<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>backup<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># container name is responsible for restore backup</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>action<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>exec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>command<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>/home/user/bin/restore.sh<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic"># this command is invoked on &#34;backup&#34; container to make restore backup, for example /home/user/bin/restore.sh &lt;backup_number&gt;, &lt;backup_number&gt; is passed by operator</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#8f5902;font-style:italic">#recoveryOnce: &lt;backup_number&gt; # if want to restore specific backup configure this field and then Jenkins will be restarted and desired backup will be restored</span></code></pre></div>
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Migration from v0.1.1</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/migration/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/migration/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<h3 id="added-seed-job-agent">Added seed job agent</h3>
|
||
|
||
<p>Now seed jobs are not built by master executors, but by dedicated agent deployed into Kubernetes. We disabled master executors for security reasons.</p>
|
||
|
||
<h3 id="apply-jenkins-configuration-via-groovy-scripts-instead-of-jenkins-jobs">Apply Jenkins configuration via Groovy scripts instead of Jenkins jobs</h3>
|
||
|
||
<p>We have removed hardcoded configuration by <strong>Jenkins</strong> jobs.</p>
|
||
|
||
<p>In <code>v0.1.1</code> <strong>jenkins-operator</strong> configuration was stored in <code>jenkins-operator-user-configuration-&lt;cr_name&gt;</code>
|
||
If you want to use <code>v0.2.0</code> or newer you must simply write refer to old ConfigMap by modifying CR, for example:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml">apiVersion<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins.io/v1alpha2<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>kind<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>Jenkins<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>metadata<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>example<span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>spec<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurationAsCode<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration-&lt;cr_name<span style="color:#8f5902;font-style:italic">&gt;
|
||
</span><span style="color:#8f5902;font-style:italic"> groovyScripts:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>configurations<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline">
|
||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span>-<span style="color:#f8f8f8;text-decoration:underline"> </span>name<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>jenkins-operator-user-configuration-&lt;cr_name&gt;</code></pre></div>
|
||
<p><strong>Jenkins</strong> configuration jobs (<em>Configure Seed Jobs</em>, <em>jenkins-operator-base-configuration</em>, <em>jenkins-operator-user-configuration</em>) have been removed from <strong>Jenkins</strong>.</p>
|
||
|
||
<p>In <code>v0.1.1</code> you can see if configuration failed or successfully updated in <strong>Jenkins</strong> UI (job build logs).
|
||
Now, when Jenkins configuration jobs are removed, you must use this command to see if configuration was failed.</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ kubectl -n logs deployment/jenkins-operator</code></pre></div>
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Diagnostics</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/diagnostics/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/diagnostics/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<p>Turn on debug in <strong>jenkins-operator</strong> deployment:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">sed -i <span style="color:#4e9a06">&#39;s|\(args:\).*|\1\ [&#34;--debug&#34;\]|&#39;</span> deploy/operator.yaml
|
||
kubectl apply -f deploy/operator.yaml</code></pre></div>
|
||
<p>Watch Kubernetes events:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl get events --sort-by<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#4e9a06">&#39;{.lastTimestamp}&#39;</span></code></pre></div>
|
||
<p>Verify Jenkins master logs:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl logs -f jenkins-&lt;cr_name&gt;</code></pre></div>
|
||
<p>Verify jenkins-operator logs:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl logs deployment/jenkins-operator</code></pre></div>
|
||
<h2 id="troubleshooting">Troubleshooting</h2>
|
||
|
||
<p>Delete Jenkins master pod and wait for the new one to come up:</p>
|
||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">kubectl delete pod jenkins-&lt;cr_name&gt;</code></pre></div>
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>Docs: Scheme</title>
|
||
<link>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/scheme/</link>
|
||
<pubDate>Mon, 05 Aug 2019 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/v0.2.0/scheme/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
<div class="pageinfo pageinfo-primary">
|
||
<p>This document contains API scheme for <code>jenkins-operator</code> manifest</p>
|
||
|
||
</div>
|
||
|
||
|
||
<p>Packages:</p>
|
||
<ul>
|
||
<li>
|
||
<a href="#jenkins.io">jenkins.io</a>
|
||
</li>
|
||
</ul>
|
||
<h2 id="jenkins.io">jenkins.io</h2>
|
||
<p>
|
||
<p>Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Jenkins">Jenkins</a>
|
||
</li></ul>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Jenkins">Jenkins
|
||
</h3>
|
||
<p>
|
||
<p>Jenkins is the Schema for the jenkins API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code></br>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
jenkins.io/v1alpha2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code></br>
|
||
string
|
||
</td>
|
||
<td><code>Jenkins</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsSpec">
|
||
JenkinsSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Jenkins</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>master</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">
|
||
JenkinsMaster
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Master represents Jenkins master pod properties and Jenkins plugins.
|
||
Every single change here requires a pod restart.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>seedJobs</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.SeedJob">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.SeedJob
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SeedJobs defines list of Jenkins Seed Job configurations
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>service</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">
|
||
Service
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Service is Kubernetes service of Jenkins master HTTP pod
|
||
Defaults to :
|
||
port: 8080
|
||
type: ClusterIP</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>slaveService</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">
|
||
Service
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Service is Kubernetes service of Jenkins slave pods
|
||
Defaults to :
|
||
port: 50000
|
||
type: ClusterIP</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backup</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Backup">
|
||
Backup
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Backup defines configuration of Jenkins backup
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>restore</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Restore">
|
||
Restore
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Backup defines configuration of Jenkins backup restore
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsStatus">
|
||
JenkinsStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Status defines the observed state of Jenkins</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Backup">Backup
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>Backup defines configuration of Jenkins backup</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>containerName</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ContainerName is the container name responsible for backup operation</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>action</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Handler">
|
||
Handler
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Action defines action which performs backup in backup container sidecar</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>interval</code></br>
|
||
<em>
|
||
uint64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Interval tells how often make backup in seconds
|
||
Defaults to 30.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>makeBackupBeforePodDeletion</code></br>
|
||
<em>
|
||
bool
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Build">Build
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsStatus">JenkinsStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>Build defines Jenkins Build status with corresponding metadata</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>jobName</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>JobName is the Jenkins job name</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>hash</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Hash is the unique data identifier used in build</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>number</code></br>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Number is the Jenkins build number</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.BuildStatus">
|
||
BuildStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Status is the status of Jenkins build</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>retries</code></br>
|
||
<em>
|
||
int
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Retires is the amount of Jenkins job build retries</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>createTime</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#time-v1-meta">
|
||
Kubernetes meta/v1.Time
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>CreateTime is the time when the first build has been created</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>lastUpdateTime</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#time-v1-meta">
|
||
Kubernetes meta/v1.Time
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>LastUpdateTime is the last update status time</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.BuildStatus">BuildStatus
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Build">Build</a>)
|
||
</p>
|
||
<p>
|
||
<p>BuildStatus defines type of Jenkins build job status</p>
|
||
</p>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Container">Container
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>)
|
||
</p>
|
||
<p>
|
||
<p>Container defines Kubernetes container attributes</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>name</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Name of the container specified as a DNS_LABEL.
|
||
Each container in a pod must have a unique name (DNS_LABEL).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>image</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Docker image name.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/containers/images">https://kubernetes.io/docs/concepts/containers/images</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>imagePullPolicy</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#pullpolicy-v1-core">
|
||
Kubernetes core/v1.PullPolicy
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Image pull policy.
|
||
One of Always, Never, IfNotPresent.
|
||
Defaults to Always.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#resourcerequirements-v1-core">
|
||
Kubernetes core/v1.ResourceRequirements
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Compute Resources required by this container.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/">https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>command</code></br>
|
||
<em>
|
||
[]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Entrypoint array. Not executed within a shell.
|
||
The docker image&rsquo;s ENTRYPOINT is used if this is not provided.
|
||
Variable references $(VAR_NAME) are expanded using the container&rsquo;s environment. If a variable
|
||
cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
|
||
can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
|
||
regardless of whether the variable exists or not.
|
||
More info: <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell">https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>args</code></br>
|
||
<em>
|
||
[]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Arguments to the entrypoint.
|
||
The docker image&rsquo;s CMD is used if this is not provided.
|
||
Variable references $(VAR_NAME) are expanded using the container&rsquo;s environment. If a variable
|
||
cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
|
||
can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
|
||
regardless of whether the variable exists or not.
|
||
More info: <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell">https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>workingDir</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Container&rsquo;s working directory.
|
||
If not specified, the container runtime&rsquo;s default will be used, which
|
||
might be configured in the container image.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ports</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#containerport-v1-core">
|
||
[]Kubernetes core/v1.ContainerPort
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>List of ports to expose from the container. Exposing a port here gives
|
||
the system additional information about the network connections a
|
||
container uses, but is primarily informational. Not specifying a port here
|
||
DOES NOT prevent that port from being exposed. Any port which is
|
||
listening on the default &ldquo;0.0.0.0&rdquo; address inside a container will be
|
||
accessible from the network.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>envFrom</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#envfromsource-v1-core">
|
||
[]Kubernetes core/v1.EnvFromSource
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>List of sources to populate environment variables in the container.
|
||
The keys defined within a source must be a C_IDENTIFIER. All invalid keys
|
||
will be reported as an event when the container is starting. When a key exists in multiple
|
||
sources, the value associated with the last source will take precedence.
|
||
Values defined by an Env with a duplicate key will take precedence.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>env</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#envvar-v1-core">
|
||
[]Kubernetes core/v1.EnvVar
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>List of environment variables to set in the container.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>volumeMounts</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#volumemount-v1-core">
|
||
[]Kubernetes core/v1.VolumeMount
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Pod volumes to mount into the container&rsquo;s filesystem.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>livenessProbe</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#probe-v1-core">
|
||
Kubernetes core/v1.Probe
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Periodic probe of container liveness.
|
||
Container will be restarted if the probe fails.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>readinessProbe</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#probe-v1-core">
|
||
Kubernetes core/v1.Probe
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Periodic probe of container service readiness.
|
||
Container will be removed from service endpoints if the probe fails.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>lifecycle</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#lifecycle-v1-core">
|
||
Kubernetes core/v1.Lifecycle
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Actions that the management system should take in response to container lifecycle events.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>securityContext</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#securitycontext-v1-core">
|
||
Kubernetes core/v1.SecurityContext
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Security options the pod should run with.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/policy/security-context/">https://kubernetes.io/docs/concepts/policy/security-context/</a>
|
||
More info: <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">https://kubernetes.io/docs/tasks/configure-pod-container/security-context/</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Handler">Handler
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Backup">Backup</a>,
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Restore">Restore</a>)
|
||
</p>
|
||
<p>
|
||
<p>Handler defines a specific action that should be taken</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>exec</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#execaction-v1-core">
|
||
Kubernetes core/v1.ExecAction
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Exec specifies the action to take.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsCredentialType">JenkinsCredentialType
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.SeedJob">SeedJob</a>)
|
||
</p>
|
||
<p>
|
||
<p>JenkinsCredentialType defines type of Jenkins credential used to seed job mechanism</p>
|
||
</p>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">JenkinsMaster
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>JenkinsMaster defines the Jenkins master pod attributes and plugins,
|
||
every single change requires a Jenkins master pod restart</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>masterAnnotations</code></br>
|
||
<em>
|
||
map[string]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Annotations is an unstructured key value map stored with a resource that may be
|
||
set by external tools to store and retrieve arbitrary metadata. They are not
|
||
queryable and should be preserved when modifying objects.
|
||
More info: <a href="http://kubernetes.io/docs/user-guide/annotations">http://kubernetes.io/docs/user-guide/annotations</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>nodeSelector</code></br>
|
||
<em>
|
||
map[string]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>NodeSelector is a selector which must be true for the pod to fit on a node.
|
||
Selector which must match a node&rsquo;s labels for the pod to be scheduled on that node.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>securityContext</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#podsecuritycontext-v1-core">
|
||
Kubernetes core/v1.PodSecurityContext
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SecurityContext that applies to all the containers of the Jenkins
|
||
Master. As per kubernetes specification, it can be overridden
|
||
for each container individually.
|
||
Defaults to:
|
||
runAsUser: 1000
|
||
fsGroup: 1000</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>containers</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Container">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Container
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>List of containers belonging to the pod.
|
||
Containers cannot currently be added or removed.
|
||
There must be at least one container in a Pod.
|
||
Defaults to:
|
||
- image: jenkins/jenkins:lts
|
||
imagePullPolicy: Always
|
||
livenessProbe:
|
||
failureThreshold: 12
|
||
httpGet:
|
||
path: /login
|
||
port: http
|
||
scheme: HTTP
|
||
initialDelaySeconds: 80
|
||
periodSeconds: 10
|
||
successThreshold: 1
|
||
timeoutSeconds: 5
|
||
name: jenkins-master
|
||
readinessProbe:
|
||
failureThreshold: 3
|
||
httpGet:
|
||
path: /login
|
||
port: http
|
||
scheme: HTTP
|
||
initialDelaySeconds: 30
|
||
periodSeconds: 10
|
||
successThreshold: 1
|
||
timeoutSeconds: 1
|
||
resources:
|
||
limits:
|
||
cpu: 1500m
|
||
memory: 3Gi
|
||
requests:
|
||
cpu: &ldquo;1&rdquo;
|
||
memory: 600Mi</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>volumes</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#volume-v1-core">
|
||
[]Kubernetes core/v1.Volume
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>List of volumes that can be mounted by containers belonging to the pod.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/storage/volumes">https://kubernetes.io/docs/concepts/storage/volumes</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>basePlugins</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Plugin">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Plugin
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>BasePlugins contains plugins required by operator
|
||
Defaults to :
|
||
- name: kubernetes
|
||
version: 1.15.7
|
||
- name: workflow-job
|
||
version: &ldquo;2.32&rdquo;
|
||
- name: workflow-aggregator
|
||
version: &ldquo;2.6&rdquo;
|
||
- name: git
|
||
version: 3.10.0
|
||
- name: job-dsl
|
||
version: &ldquo;1.74&rdquo;
|
||
- name: configuration-as-code
|
||
version: &ldquo;1.19&rdquo;
|
||
- name: configuration-as-code-support
|
||
version: &ldquo;1.19&rdquo;
|
||
- name: kubernetes-credentials-provider
|
||
version: 0.12.1</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>plugins</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Plugin">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Plugin
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Plugins contains plugins required by user</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsSpec">JenkinsSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Jenkins">Jenkins</a>)
|
||
</p>
|
||
<p>
|
||
<p>JenkinsSpec defines the desired state of the Jenkins</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>master</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">
|
||
JenkinsMaster
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Master represents Jenkins master pod properties and Jenkins plugins.
|
||
Every single change here requires a pod restart.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>seedJobs</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.SeedJob">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.SeedJob
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SeedJobs defines list of Jenkins Seed Job configurations
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>service</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">
|
||
Service
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Service is Kubernetes service of Jenkins master HTTP pod
|
||
Defaults to :
|
||
port: 8080
|
||
type: ClusterIP</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>slaveService</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">
|
||
Service
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Service is Kubernetes service of Jenkins slave pods
|
||
Defaults to :
|
||
port: 50000
|
||
type: ClusterIP</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backup</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Backup">
|
||
Backup
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Backup defines configuration of Jenkins backup
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>restore</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Restore">
|
||
Restore
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Backup defines configuration of Jenkins backup restore
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsStatus">JenkinsStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Jenkins">Jenkins</a>)
|
||
</p>
|
||
<p>
|
||
<p>JenkinsStatus defines the observed state of Jenkins</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>operatorVersion</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>OperatorVersion is the operator version which manages this CR</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>provisionStartTime</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#time-v1-meta">
|
||
Kubernetes meta/v1.Time
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ProvisionStartTime is a time when Jenkins master pod has been created</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>baseConfigurationCompletedTime</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#time-v1-meta">
|
||
Kubernetes meta/v1.Time
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BaseConfigurationCompletedTime is a time when Jenkins base configuration phase has been completed</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>userConfigurationCompletedTime</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#time-v1-meta">
|
||
Kubernetes meta/v1.Time
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UserConfigurationCompletedTime is a time when Jenkins user configuration phase has been completed</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>builds</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Build">
|
||
[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Build
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Builds contains Jenkins builds statues</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>restoredBackup</code></br>
|
||
<em>
|
||
uint64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>RestoredBackup is the restored backup number after Jenkins master pod restart</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>lastBackup</code></br>
|
||
<em>
|
||
uint64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LastBackup is the latest backup number</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>pendingBackup</code></br>
|
||
<em>
|
||
uint64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>PendingBackup is the pending backup number</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backupDoneBeforePodDeletion</code></br>
|
||
<em>
|
||
bool
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BackupDoneBeforePodDeletion tells if backup before pod deletion has been made</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>userAndPasswordHash</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UserAndPasswordHash is a SHA256 hash made from user and password</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>createdSeedJobs</code></br>
|
||
<em>
|
||
[]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>CreatedSeedJobs contains list of seed job id already created in Jenkins</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Plugin">Plugin
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>)
|
||
</p>
|
||
<p>
|
||
<p>Plugin defines Jenkins plugin</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>name</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Name is the name of Jenkins plugin</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>version</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Version is the version of Jenkins plugin</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Restore">Restore
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>Restore defines configuration of Jenkins backup restore operation</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>containerName</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ContainerName is the container name responsible for restore backup operation</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>action</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Handler">
|
||
Handler
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Action defines action which performs restore backup in restore container sidecar</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>recoveryOnce</code></br>
|
||
<em>
|
||
uint64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>RecoveryOnce if want to restore specific backup set this field and then Jenkins will be restarted and desired backup will be restored</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.SeedJob">SeedJob
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>SeedJob defines configuration for seed job
|
||
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>id</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ID is the unique seed job name</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>credentialID</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>CredentialID is the Kubernetes secret name which stores repository access credentials</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>description</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Description is the description of the seed job</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>targets</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Targets is the repository path where are seed job definitions</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>repositoryBranch</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>RepositoryBranch is the repository branch where are seed job definitions</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>repositoryUrl</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>RepositoryURL is the repository access URL. Can be SSH or HTTPS.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>credentialType</code></br>
|
||
<em>
|
||
<a href="#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsCredentialType">
|
||
JenkinsCredentialType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>JenkinsCredentialType is the <a href="https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/">https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/</a> credential type</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">Service
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em>
|
||
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>Service defines Kubernetes service attributes</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>annotations</code></br>
|
||
<em>
|
||
map[string]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Annotations is an unstructured key value map stored with a resource that may be
|
||
set by external tools to store and retrieve arbitrary metadata. They are not
|
||
queryable and should be preserved when modifying objects.
|
||
More info: <a href="http://kubernetes.io/docs/user-guide/annotations">http://kubernetes.io/docs/user-guide/annotations</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>labels</code></br>
|
||
<em>
|
||
map[string]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Route service traffic to pods with label keys and values matching this
|
||
selector. If empty or not present, the service is assumed to have an
|
||
external process managing its endpoints, which Kubernetes will not
|
||
modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
|
||
Ignored if type is ExternalName.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/">https://kubernetes.io/docs/concepts/services-networking/service/</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>type</code></br>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#servicetype-v1-core">
|
||
Kubernetes core/v1.ServiceType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Type determines how the Service is exposed. Defaults to ClusterIP. Valid
|
||
options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
|
||
&ldquo;ExternalName&rdquo; maps to the specified externalName.
|
||
&ldquo;ClusterIP&rdquo; allocates a cluster-internal IP address for load-balancing to
|
||
endpoints. Endpoints are determined by the selector or if that is not
|
||
specified, by manual construction of an Endpoints object. If clusterIP is
|
||
&ldquo;None&rdquo;, no virtual IP is allocated and the endpoints are published as a
|
||
set of endpoints rather than a stable IP.
|
||
&ldquo;NodePort&rdquo; builds on ClusterIP and allocates a port on every node which
|
||
routes to the clusterIP.
|
||
&ldquo;LoadBalancer&rdquo; builds on NodePort and creates an
|
||
external load-balancer (if supported in the current cloud) which routes
|
||
to the clusterIP.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types">https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services&mdash;service-types</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>port</code></br>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>The port that are exposed by this service.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>nodePort</code></br>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>The port on each node on which this service is exposed when type=NodePort or LoadBalancer.
|
||
Usually assigned by the system. If specified, it will be allocated to the service
|
||
if unused or else creation of the service will fail.
|
||
Default is to auto-allocate a port if the ServiceType of this Service requires one.
|
||
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>loadBalancerSourceRanges</code></br>
|
||
<em>
|
||
[]string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>If specified and supported by the platform, this will restrict traffic through the cloud-provider
|
||
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
|
||
cloud-provider does not support the feature.&rdquo;
|
||
More info: <a href="https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/">https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>loadBalancerIP</code></br>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Only applies to Service Type: LoadBalancer
|
||
LoadBalancer will get created with the IP specified in this field.
|
||
This feature depends on whether the underlying cloud-provider supports specifying
|
||
the loadBalancerIP when a load balancer is created.
|
||
This field will be ignored if the cloud-provider does not support the feature.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<p><em>
|
||
Generated with <code>gen-crd-api-reference-docs</code>
|
||
on git commit <code>37e531a</code>.
|
||
</em></p>
|
||
|
||
</description>
|
||
</item>
|
||
|
||
</channel>
|
||
</rss> |