public_git
/
kubernetes-operator
mirror of https://github.com/jenkinsci/kubernetes-operator.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fixed docs 

Added helm installation section in Installation Guide.
This commit is contained in:
Sylwia Brant 2020-10-05 12:26:10 +02:00
parent 65539dc79c
commit 25074bdbb8
2 changed files with 991 additions and 235 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

763
docs/docs/installation/index.html
View File

@ -600,6 +600,7 @@
<ul> <ul>
<li><a href="#using-yaml-s">Using YAML&rsquo;s</a></li> <li><a href="#using-yaml-s">Using YAML&rsquo;s</a></li>
<li><a href="#using-helm-chart">Using Helm Chart</a></li> <li><a href="#using-helm-chart">Using Helm Chart</a></li>
<li><a href="#configuring-operator-deployment">Configuring operator deployment</a></li>
</ul></li> </ul></li>
</ul></li> </ul></li>
</ul> </ul>
@ -678,9 +679,769 @@ All container images can be found at <a href="https://hub.docker.com/r/virtuslab
<p>There is a option to use Helm to install the operator. It requires the Helm 3+ for deployment.</p> <p>There is a option to use Helm to install the operator. It requires the Helm 3+ for deployment.</p>
<p>Create a namespace for the operator:</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 -n &lt;your-namespace&gt;</code></pre></div>
<p>To install, you need only to type these commands:</p> <p>To install, you need only to type these commands:</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">$ helm repo add jenkins https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/chart <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">$ helm repo add jenkins https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/chart
$ helm install jenkins/jenkins-operator</code></pre></div> $ helm install &lt;name&gt; jenkins/jenkins-operator -n &lt;your-namespace&gt;</code></pre></div>
<p>To add custom labels and annotations, you can use <code>values.yaml</code> file or pass them into <code>helm install</code> command, e.g.:</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">$ helm install &lt;name&gt; jenkins/jenkins-operator -n &lt;your-namespace&gt; --set jenkins.labels.LabelKey<span style="color:#ce5c00;font-weight:bold">=</span>LabelValue,jenkins.annotations.AnnotationKey<span style="color:#ce5c00;font-weight:bold">=</span>AnnotationValue</code></pre></div>
<p>You can further customize Jenkins using <code>values.yaml</code>:
<h3 id="JenkinsConfiguration">Jenkins instance configuration
</h3></p>
<table aria-colspan="4">
<thead aria-colspan="4">
<tr>
<th></th>
<th>Field</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody aria-colspan="4">
<tr></tr>
<tr>
<td colspan="1">
<code>jenkins</code>
</td>
<td colspan="3">
<p>operator is section for configuring operator deployment</p>
<table>
<tr>
<td>
<code>enabled</code>
</td>
<td>
true
</td>
<td>
Enabled can enable or disable the Jenkins instance.
Set to false if you have configured CR already and/or you want to deploy an operator only.
</td>
</tr>
<tr>
<td>
<code>apiVersion</code>
</td>
<td>jenkins.io/v1alpha2</td>
<td>
Version of the CR manifest. The recommended and default value is <code>jenkins.io/v1alpha2</code>.
<a href="#github.io/kubernetes-operator/docs/getting-started/v0.1.x/migration-guide-v1alpha1-to-v1alpha2/">More info</a>
</td>
</tr>
<tr>
<td>
<code>name</code>
</td>
<td>
jenkins
</td>
<td>
Name of resource. The pod name will be <code>jenkins-&lt;name&gt;</code> (name will be set as suffix).
</td>
</tr>
<tr>
<td>
<code>namespace</code>
</td>
<td>
default
</td>
<td>
Namespace the resources will be deployed to. It's not recommended to use default namespace.
Create new namespace for jenkins (e.g. <code>kubectl create -n jenkins</code>)
</td>
</tr>
<tr>
<td>
<code>labels</code>
</td>
<td>
{}
</td>
<td>
Labels are injected into metadata labels field.
</td>
</tr>
<tr>
<td>
<code>annotations</code>
</td>
<td>
{}
</td>
<td>
Annotations are injected into metadata annotations field.
</td>
</tr>
<tr>
<td>
<code>image</code>
</td>
<td>
jenkins/jenkins:lts
</td>
<td>
Image is the name (and tag) of the Jenkins instance.
It's recommended to use LTS (tag: "lts") version.
</td>
</tr>
<tr>
<td>
<code>env</code>
</td>
<td>
[]
</td>
<td>
Env contains jenkins container environment variables.
</td>
</tr>
<tr>
<td>
<code>imagePullPolicy</code>
</td>
<td>
Always
</td>
<td>
Defines policy for pulling images
</td>
</tr>
<tr>
<td>
<code>priorityClassName</code>
</td>
<td>
""
</td>
<td>
PriorityClassName indicates the importance of a Pod relative to other Pods.
<a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">More info</a>
</td>
</tr>
<tr>
<td>
<code>disableCSRFProtection</code>
</td>
<td>
false
</td>
<td>
disableCSRFProtection can enable or disable operator built-in CSRF protection.
Set it to true if you are using OpenShift Jenkins Plugin.
<a href="https://github.com/jenkinsci/kubernetes-operator/pull/193">More info</a>
</td>
</tr>
<tr>
<td>
<code>imagePullSecrets</code>
</td>
<td>
[]
</td>
<td>
Used if you want to pull images from private repository
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration/#pulling-docker-images-from-private-repositories">More info</a>
</td>
</tr>
<tr>
<td>
<code>notifications</code>
</td>
<td>
[]
</td>
<td>
Notifications is feature that notify user about Jenkins reconcilation status
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/notifications/">More info</a>
</td>
</tr>
<tr>
<td>
<code>basePlugins</code>
</td>
<td>
<pre>
- name: kubernetes
version: "1.25.2"
- name: workflow-job
version: "2.39"
- name: workflow-aggregator
version: "2.6"
- name: git
version: "4.2.2"
- name: job-dsl
version: "1.77"
- name: configuration-as-code
version: "1.38"
- name: kubernetes-credentials
-provider
version: "0.13"
</pre>
</td>
<td>
Plugins installed and required by the operator
shouldn't contain plugins defined by user
You can change their versions here
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/#install-plugins">More info</a>
</td>
</tr>
<tr>
<td>
<code>plugins</code>
</td>
<td>
[]
</td>
<td>
Plugins required by the user. You can define plugins here.
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/#install-plugins">More info</a>
Example:
<pre>
plugins:
- name: simple-theme-plugin
version: 0.5.1
</pre>
</td>
</tr>
<tr>
<td>
<code>seedJobs</code>
</td>
<td>
[]
</td>
<td>
Placeholder for jenkins seed jobs
For seed job creation tutorial, check:<br /> <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration/#prepare-job-definitions-and-pipelines">Prepare seed jobs</a>
<br /><a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration/#configure-seed-jobs">Configure seed jobs</a>
<br />Example:
<code>
<pre>
seedJobs:
- id: jenkins-operator
targets: "cicd/jobs/*.jenkins"
description: "Jenkins Operator repository"
repositoryBranch: master
repositoryUrl:
- https://github.com/jenkinsci/kubernetes-operator.git
</pre>
</code>
</td>
</tr>
<tr>
<td>
<code>resources</code>
</td>
<td>
<pre>
limits:
cpu: 1500m
memory: 3Gi
requests:
cpu: 1
memory: 500M
</pre>
</td>
<td>
Resource limit/request for Jenkins
<a href="https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container">More info</a>
</td>
</tr>
<tr>
<td>
<code>volumes</code>
</td>
<td>
<pre>
- name: backup
persistentVolumeClaim:
claimName: jenkins-backup
</pre>
</td>
<td>
Volumes used by Jenkins
By default, we are only using PVC volume for storing backups.
</td>
</tr>
<tr>
<td>
<code>volumeMounts</code>
</td>
<td>
[]
</td>
<td>
volumeMounts are mounts for Jenkins pod.
</td>
</tr>
<tr>
<td>
<code>securityContext</code>
</td>
<td>
runAsUser: 1000
fsGroup: 1000
</td>
<td>
SecurityContext for pod.
</td>
</tr>
<tr>
<td>
<code>
backup
</code>
<p>
<em>
<a href="#Backup">
Backup
</a>
</em>
</p>
</td>
<td>
</td>
<td>
Backup is section for configuring operator's backup feature
By default backup feature is enabled and pre-configured
This section simplifies the configuration described here: <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configure-backup-and-restore/">Configure backup and restore</a>
For customization tips see <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/custom-backup-and-restore/">Custom backup and restore</a>
</td>
</tr>
<tr>
<td>
<code>configuration</code>
<p>
<em>
<a href="#Configuration">
Configuration
</a>
</em>
</p>
</td>
<td></td>
<td>
Section where we can configure Jenkins instance.
See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/">Customization</a> for details
</td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
<h3 id="configuring-operator-deployment">Configuring operator deployment</h3>
<table aria-colspan="4">
<thead aria-colspan="4">
<tr>
<th></th>
<th>Field</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody aria-colspan="4">
<tr></tr>
<tr>
<td colspan="1">
<code>operator</code>
</td>
<td colspan="3">
<p>operator is section for configuring operator deployment</p>
<table>
<tr>
<td>
<code>replicaCount</code></br>
</td>
<td>
1
</td>
<td>
Number of Replicas.
</td>
</tr>
<tr>
<td>
<code>image</code>
</td>
<td>
virtuslab/jenkins-operator:v0.4.0
</td>
<td>
Name (and tag) of the Jenkins Operator image.
</td>
</tr>
<tr>
<td>
<code>imagePullPolicy</code>
</td>
<td>
IfNotPresent
</td>
<td>
Defines policy for pulling images.
</td>
</tr>
<tr>
<td>
imagePullSecrets
</td>
<td>
[]
</td>
<td>
Used if you want to pull images from private repository.
</td>
</tr>
<tr>
<td>
<code>nameOverride</code>
</td>
<td>
""
</td>
<td>
nameOverride overrides the app name.
</td>
</tr>
<tr>
<td>
fullnameOverride
</td>
<td>
""
</td>
<td>
fullnameOverride overrides the deployment name
</td>
</tr>
<tr>
<td>
resources
</td>
<td>
{}
</td>
<td>
</td>
</tr>
<tr>
<td>
nodeSelector
</td>
<td>
{}
</td>
<td>
</td>
</tr>
<tr>
<td>
tolerations
</td>
<td>
{}
</td>
<td>
</td>
</tr>
<tr>
<td>
affinity
</td>
<td>
{}
</td>
<td>
</td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
<p><h3 id="Backup">Backup
</h3>
<p>
(<em>Appears on:</em>
<a href="#JenkinsConfiguration">JenkinsConfiguration</a>)
</p>
<p>
Backup defines configuration of Jenkins backup.
</p></p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>enabled</code>
</td>
<td>
true
</td>
<td>
Enabled is enable/disable switch for backup feature.
</td>
</tr>
<tr>
<td>
<code>image</code>
</td>
<td>
virtuslab/jenkins-operator-backup-pvc:v0.0.8
</td>
<td>
Image used by backup feature.
</td>
</tr>
<tr>
<td>
<code>containerName</code>
</td>
<td>
backup
</td>
<td>
Backup container name.
</td>
</tr>
<tr>
<td>
<code>interval</code>
</td>
<td>
30
</td>
<td>
Defines how often make backup in seconds.
</td>
</tr>
<tr>
<td>
<code>makeBackupBeforePodDeletion</code>
</td>
<td>
true
</td>
<td>
When enabled will make backup before pod deletion.
</td>
</tr>
<tr>
<td>
<code>backupCommand</code>
</td>
<td>
/home/user/bin/backup.sh
</td>
<td>
Backup container command.
</td>
</tr>
<tr>
<td>
<code>restoreCommand</code>
</td>
<td>
/home/user/bin/restore.sh
</td>
<td>
Backup restore command.
</td>
</tr>
<tr>
<td>
<code>pvc</code>
</td>
<td colspan="2">
<p>Persistent Volume Claim Kubernetes resource</p>
<br/>
<table colspan="2" style="width:100%">
<tbody>
<tr>
<td>
<code>enabled</code>
</td>
<td>
true
</td>
<td>
Enable/disable switch for PVC
</td>
</tr>
<tr>
<td>
<code>enabled</code>
</td>
<td>
true
</td>
<td>
Enable/disable switch for PVC
</td>
</tr>
<tr>
<td>
<code>size</code>
</td>
<td>
5Gi
</td>
<td>
Size of PVC
</td>
</tr>
<tr>
<td>
<code>className</code>
</td>
<td>
""
</td>
<td>
StorageClassName for PVC
<a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class-1">More info</a>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<code>env</code>
</td>
<td>
<pre>
- name: BACKUP_DIR
value: /backup
- name: JENKINS_HOME
value: /jenkins-home
- name: BACKUP_COUNT
value: "3"
</pre>
</td>
<td>
Contains container environment variables.
PVC backup provider handles these variables:<br />
BACKUP_DIR - path for storing backup files (default: "/backup")<br />
JENKINS_HOME - path to jenkins home (default: "/jenkins-home")<br />
BACKUP_COUNT - define how much recent backups will be kept<br />
</td>
</td>
</tr>
<tr>
<td>
volumeMounts
</td>
<td>
<pre>
- name: jenkins-home
mountPath: /jenkins-home
- mountPath: /backup
name: backup
</pre>
</td>
<td>
Holds the mount points for volumes.
</td>
</tr>
</tbody>
</table>
<p><h4 id="Configuration">Configuration
</h3>
<p>
(<em>Appears on:</em>
<a href="#JenkinsConfiguration">Jenkins instance configuration</a>)
</p></p>
<p><table>
<thead>
<tr>
<th>Field</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>configurationAsCode</code>
</td>
<td>
{}
</td>
<td>
ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin.
Example:<br />
<pre>
- configMapName: jenkins-casc
content: {}
</pre>
</td>
</tr>
<tr>
<td>
<code>groovyScripts</code>
</td>
<td>
{}
</td>
<td>
GroovyScripts defines configuration of Jenkins customization via groovy scripts.
Example:<br />
<pre>
- configMapName: jenkins-gs
content: {}
</pre>
</td>
</tr>
<tr>
<td>
<code>secretRefName</code>
</td>
<td>
&ldquo;&rdquo;
</td>
<td>
secretRefName of existing secret (previously created).
</td>
</tr>
<tr>
<td>
<code>secretData</code>
</td>
<td>
{}
</td>
<td>
If secretRefName is empty, secretData creates new secret and fills with data provided in secretData.
</td>
</tr>
</tbody>
</table></p>
<p># See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service</a> for details
#service:
# slave Jenkins service
# See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service">https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service</a> for details
#slaveService:</p>
<div class="section-index"> <div class="section-index">

141
website/content/en/docs/Installation/_index.md
View File

@ -68,14 +68,15 @@ $ helm install <name> jenkins/jenkins-operator -n <your-namespace>
To add custom labels and annotations, you can use `values.yaml` file or pass them into `helm install` command, e.g.: To add custom labels and annotations, you can use `values.yaml` file or pass them into `helm install` command, e.g.:
```bash ```bash
$ helm install <name> jenkins/jenkins-operator --set jenkins.labels.LabelKey=LabelValue,jenkins.annotations.AnnotationKey=AnnotationValue $ helm install <name> jenkins/jenkins-operator -n <your-namespace> --set jenkins.labels.LabelKey=LabelValue,jenkins.annotations.AnnotationKey=AnnotationValue
``` ```
You can further customize Jenkins using `values.yaml`: You can further customize Jenkins using `values.yaml`:
<h3 id="JenkinsConfiguration">Jenkins instance configuration
</h3>
###
## Jenkins instance configuration <table aria-colspan="4">
<thead aria-colspan="4">
<table>
<thead>
<tr> <tr>
<th></th> <th></th>
<th>Field</th> <th>Field</th>
@ -83,21 +84,18 @@ You can further customize Jenkins using `values.yaml`:
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody aria-colspan="4">
<tr></tr>
<tr> <tr>
<td> <td colspan="1">
<code>jenkins</code> <code>jenkins</code>
</td> </td>
<td> <td colspan="3">
</td> <p>operator is section for configuring operator deployment</p>
<td> <table>
</td>
<td>
</td>
<tr> <tr>
<td></td>
<td> <td>
<code>enabled</code></br> <code>enabled</code>
</td> </td>
<td> <td>
true true
@ -108,9 +106,8 @@ Set to false if you have configured CR already and/or you want to deploy an oper
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>apiVersion</code></br> <code>apiVersion</code>
</td> </td>
<td>jenkins.io/v1alpha2</td> <td>jenkins.io/v1alpha2</td>
<td> <td>
@ -119,9 +116,8 @@ Version of the CR manifest. The recommended and default value is <code>jenkins.i
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>name</code></br> <code>name</code>
</td> </td>
<td> <td>
jenkins jenkins
@ -131,7 +127,6 @@ Name of resource. The pod name will be <code>jenkins-&lt;name&gt;</code> (name w
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>namespace</code> <code>namespace</code>
</td> </td>
@ -144,7 +139,6 @@ Create new namespace for jenkins (e.g. <code>kubectl create -n jenkins</code>)
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>labels</code> <code>labels</code>
</td> </td>
@ -156,7 +150,6 @@ Labels are injected into metadata labels field.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>annotations</code> <code>annotations</code>
</td> </td>
@ -168,7 +161,6 @@ Annotations are injected into metadata annotations field.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>image</code> <code>image</code>
</td> </td>
@ -181,7 +173,6 @@ It's recommended to use LTS (tag: "lts") version.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>env</code> <code>env</code>
</td> </td>
@ -193,7 +184,6 @@ Env contains jenkins container environment variables.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>imagePullPolicy</code> <code>imagePullPolicy</code>
</td> </td>
@ -205,7 +195,6 @@ Defines policy for pulling images
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>priorityClassName</code> <code>priorityClassName</code>
</td> </td>
@ -218,7 +207,6 @@ PriorityClassName indicates the importance of a Pod relative to other Pods.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>disableCSRFProtection</code> <code>disableCSRFProtection</code>
</td> </td>
@ -232,7 +220,6 @@ Set it to true if you are using OpenShift Jenkins Plugin.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>imagePullSecrets</code> <code>imagePullSecrets</code>
</td> </td>
@ -245,7 +232,6 @@ Used if you want to pull images from private repository
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>notifications</code> <code>notifications</code>
</td> </td>
@ -258,7 +244,6 @@ Notifications is feature that notify user about Jenkins reconcilation status
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>basePlugins</code> <code>basePlugins</code>
</td> </td>
@ -289,7 +274,6 @@ You can change their versions here
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>plugins</code> <code>plugins</code>
</td> </td>
@ -308,7 +292,6 @@ plugins:
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>seedJobs</code> <code>seedJobs</code>
</td> </td>
@ -334,7 +317,6 @@ seedJobs:
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>resources</code> <code>resources</code>
</td> </td>
@ -354,7 +336,6 @@ Resource limit/request for Jenkins
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>volumes</code> <code>volumes</code>
</td> </td>
@ -371,7 +352,6 @@ By default, we are only using PVC volume for storing backups.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>volumeMounts</code> <code>volumeMounts</code>
</td> </td>
@ -383,7 +363,6 @@ volumeMounts are mounts for Jenkins pod.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>securityContext</code> <code>securityContext</code>
</td> </td>
@ -396,11 +375,17 @@ SecurityContext for pod.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code> <code>
backup backup
</code> </code>
<p>
<em>
<a href="#Backup">
Backup
</a>
</em>
</p>
</td> </td>
<td> <td>
</td> </td>
@ -413,17 +398,24 @@ For customization tips see <a href="https://jenkinsci.github.io/kubernetes-opera
</tr> </tr>
<tr> <tr>
<td> <td>
</td>
<td>
<code>configuration</code> <code>configuration</code>
<p>
<em>
<a href="#Configuration">
Configuration
</a>
</em>
</p>
</td> </td>
<td> <td></td>
</td>
<td> <td>
Section where we can configure Jenkins instance. Section where we can configure Jenkins instance.
See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/">Customization</a> for details See <a href="https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/">Customization</a> for details
</td> </td>
</tr> </tr>
</table>
</td>
</tr>
</tbody> </tbody>
</table> </table>
@ -561,11 +553,11 @@ fullnameOverride overrides the deployment name
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Backup">Backup <h3 id="Backup">Backup
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) <a href="#JenkinsConfiguration">JenkinsConfiguration</a>)
</p> </p>
<p> <p>
Backup defines configuration of Jenkins backup. Backup defines configuration of Jenkins backup.
@ -575,7 +567,7 @@ Backup defines configuration of Jenkins backup.
<thead> <thead>
<tr> <tr>
<th>Field</th> <th>Field</th>
<th colspan="2">Default value</th> <th>Default value</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
</thead> </thead>
@ -584,7 +576,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>enabled</code> <code>enabled</code>
</td> </td>
<td colspan="2"> <td>
true true
</td> </td>
<td> <td>
@ -595,7 +587,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>image</code> <code>image</code>
</td> </td>
<td colspan="2"> <td>
virtuslab/jenkins-operator-backup-pvc:v0.0.8 virtuslab/jenkins-operator-backup-pvc:v0.0.8
</td> </td>
<td> <td>
@ -606,7 +598,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>containerName</code> <code>containerName</code>
</td> </td>
<td colspan="2"> <td>
backup backup
</td> </td>
<td> <td>
@ -617,7 +609,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>interval</code> <code>interval</code>
</td> </td>
<td colspan="2"> <td>
30 30
</td> </td>
<td> <td>
@ -628,7 +620,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>makeBackupBeforePodDeletion</code> <code>makeBackupBeforePodDeletion</code>
</td> </td>
<td colspan="2"> <td>
true true
</td> </td>
<td> <td>
@ -639,7 +631,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>backupCommand</code> <code>backupCommand</code>
</td> </td>
<td colspan="2"> <td>
/home/user/bin/backup.sh /home/user/bin/backup.sh
</td> </td>
<td> <td>
@ -649,10 +641,11 @@ Backup defines configuration of Jenkins backup.
<tr> <tr>
<td> <td>
<code>restoreCommand</code> <code>restoreCommand</code>
<td colspan="2"> </td>
<td>
/home/user/bin/restore.sh /home/user/bin/restore.sh
</td> </td>
<td colspan="2"> <td>
Backup restore command. Backup restore command.
</td> </td>
</tr> </tr>
@ -660,30 +653,34 @@ Backup defines configuration of Jenkins backup.
<td> <td>
<code>pvc</code> <code>pvc</code>
</td> </td>
<td> <td colspan="2">
</td> <p>Persistent Volume Claim Kubernetes resource</p>
<td> <br/>
</td> <table colspan="2" style="width:100%">
<td> <tbody>
Persistent Volume Claim Kubernetes resource
</td>
</tr>
<tr> <tr>
<td>
</td>
<td> <td>
<code>enabled</code> <code>enabled</code>
</td> </td>
<td> <td>
true true
</td> </td>
<td>
Enable/disable switch for PVC
</td>
</tr>
<tr>
<td>
<code>enabled</code>
</td>
<td>
true
</td> </td>
<td> <td>
Enable/disable switch for PVC Enable/disable switch for PVC
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>size</code> <code>size</code>
</td> </td>
@ -695,7 +692,6 @@ Backup defines configuration of Jenkins backup.
</td> </td>
</tr> </tr>
<tr> <tr>
<td></td>
<td> <td>
<code>className</code> <code>className</code>
</td> </td>
@ -706,12 +702,16 @@ Backup defines configuration of Jenkins backup.
StorageClassName for PVC StorageClassName for PVC
<a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class-1">More info</a> <a href="https://kubernetes.io/docs/concepts/storage/persistent-volumes/#class-1">More info</a>
</td> </td>
</tr>
</tbody>
</table>
</td>
</tr> </tr>
<tr> <tr>
<td> <td>
<code>env</code> <code>env</code>
</td> </td>
<td colspan="2"> <td>
<pre> <pre>
- name: BACKUP_DIR - name: BACKUP_DIR
value: /backup value: /backup
@ -734,7 +734,7 @@ Backup defines configuration of Jenkins backup.
<td> <td>
volumeMounts volumeMounts
</td> </td>
<td colspan="2"> <td>
<pre> <pre>
- name: jenkins-home - name: jenkins-home
mountPath: /jenkins-home mountPath: /jenkins-home
@ -749,17 +749,12 @@ Backup defines configuration of Jenkins backup.
</tbody> </tbody>
</table> </table>
<h4 id="Configuration">Configuration
<h4 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Configuration">Configuration
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) <a href="#JenkinsConfiguration">Jenkins instance configuration</a>)
</p> </p>
<p>
Configuration is section where we can configure Jenkins instance
</p>
<table> <table>
<thead> <thead>