From 25074bdbb82e0b4c31bd64aeb15ad0823f0e80ca Mon Sep 17 00:00:00 2001 From: Sylwia Brant Date: Mon, 5 Oct 2020 12:26:10 +0200 Subject: [PATCH] Fixed docs Added helm installation section in Installation Guide. --- docs/docs/installation/index.html | 763 +++++++++++++++++- .../content/en/docs/Installation/_index.md | 463 ++++++----- 2 files changed, 991 insertions(+), 235 deletions(-) diff --git a/docs/docs/installation/index.html b/docs/docs/installation/index.html index 168dd20e..09406a09 100644 --- a/docs/docs/installation/index.html +++ b/docs/docs/installation/index.html @@ -600,6 +600,7 @@ @@ -678,9 +679,769 @@ All container images can be found at 
$ kubectl create -n <your-namespace>

To install, you need only to type these commands:

$ helm repo add jenkins https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/chart
-$ helm install jenkins/jenkins-operator
+$ 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.:

+
$ 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: +

Jenkins instance configuration +

+ + + + + + + + + + + + + + + + + +
FieldDefault valueDescription
+jenkins + +

operator is section for configuring operator deployment

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+enabled + +true + +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. +
+apiVersion +jenkins.io/v1alpha2 +Version of the CR manifest. The recommended and default value is jenkins.io/v1alpha2. +More info +
+name + +jenkins + +Name of resource. The pod name will be jenkins-<name> (name will be set as suffix). +
+namespace + +default + +Namespace the resources will be deployed to. It's not recommended to use default namespace. +Create new namespace for jenkins (e.g. kubectl create -n jenkins) +
+labels + +{} + +Labels are injected into metadata labels field. +
+annotations + +{} + +Annotations are injected into metadata annotations field. +
+image + +jenkins/jenkins:lts + +Image is the name (and tag) of the Jenkins instance. +It's recommended to use LTS (tag: "lts") version. +
+env + +[] + +Env contains jenkins container environment variables. +
+imagePullPolicy + +Always + +Defines policy for pulling images +
+priorityClassName + +"" + +PriorityClassName indicates the importance of a Pod relative to other Pods. +More info +
+disableCSRFProtection + +false + +disableCSRFProtection can enable or disable operator built-in CSRF protection. +Set it to true if you are using OpenShift Jenkins Plugin. +More info +
+imagePullSecrets + +[] + +Used if you want to pull images from private repository +More info +
+notifications + +[] + +Notifications is feature that notify user about Jenkins reconcilation status +More info +
+basePlugins + +
+- 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"
+
+		 +Plugins installed and required by the operator +shouldn't contain plugins defined by user +You can change their versions here +More info +
+plugins + +[] + +Plugins required by the user. You can define plugins here. +More info +Example: +
+plugins:
+ - name: simple-theme-plugin
+   version: 0.5.1
+
+
+seedJobs + +[] + +Placeholder for jenkins seed jobs +For seed job creation tutorial, check:
Prepare seed jobs +
Configure seed jobs +
Example: + +
+seedJobs:
+- id: jenkins-operator
+  targets: "cicd/jobs/*.jenkins"
+  description: "Jenkins Operator repository"
+  repositoryBranch: master
+  repositoryUrl: 
+  - https://github.com/jenkinsci/kubernetes-operator.git
+
+ +
+resources + +
+limits:
+  cpu: 1500m
+  memory: 3Gi
+requests:
+  cpu: 1
+  memory: 500M
+
+		 +Resource limit/request for Jenkins +More info +
+volumes + +
+- name: backup
+  persistentVolumeClaim:
+    claimName: jenkins-backup
+
+		 +Volumes used by Jenkins +By default, we are only using PVC volume for storing backups. +
+volumeMounts + +[] + +volumeMounts are mounts for Jenkins pod. +
+securityContext + +runAsUser: 1000 +fsGroup: 1000 + +SecurityContext for pod. +
+ +backup + +

+ + +Backup + + +

+		 + +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: Configure backup and restore +For customization tips see Custom backup and restore +
+configuration +

+ + +Configuration + + +

+		 +Section where we can configure Jenkins instance. +See Customization for details +
+
+ +

Configuring operator deployment

+ + + + + + + + + + + + + + + + + +
FieldDefault valueDescription
+ operator + +

operator is section for configuring operator deployment

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ replicaCount
+ 		+ 1 + + Number of Replicas. +
+ image + + virtuslab/jenkins-operator:v0.4.0 + + Name (and tag) of the Jenkins Operator image. +
+ imagePullPolicy + + IfNotPresent + + Defines policy for pulling images. +
+ imagePullSecrets + + [] + + Used if you want to pull images from private repository. +
+ nameOverride + + "" + + nameOverride overrides the app name. +
+ fullnameOverride + + "" + + fullnameOverride overrides the deployment name +
+ resources + + {} + +
+ nodeSelector + + {} + +
+ tolerations + + {} + +
+ affinity + + {} + +
+
+ +

Backup +

+

+(Appears on: +JenkinsConfiguration) +

+

+Backup defines configuration of Jenkins backup. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDefault valueDescription
+ enabled + + true + + Enabled is enable/disable switch for backup feature. +
+ image + + virtuslab/jenkins-operator-backup-pvc:v0.0.8 + + Image used by backup feature. +
+ containerName + + backup + + Backup container name. +
+ interval + + 30 + + Defines how often make backup in seconds. +
+ makeBackupBeforePodDeletion + + true + + When enabled will make backup before pod deletion. +
+ backupCommand + + /home/user/bin/backup.sh + + Backup container command. +
+ restoreCommand + + /home/user/bin/restore.sh + + Backup restore command. +
+ pvc + +

Persistent Volume Claim Kubernetes resource

+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ enabled + + true + + Enable/disable switch for PVC +
+ enabled + + true + + Enable/disable switch for PVC +
+ size + + 5Gi + + Size of PVC +
+ className + + "" + + StorageClassName for PVC + More info +
+
+ env + +
+- name: BACKUP_DIR
+  value: /backup
+- name: JENKINS_HOME
+  value: /jenkins-home
+- name: BACKUP_COUNT
+  value: "3"
+
+ 		+ Contains container environment variables. + PVC backup provider handles these variables:
+ BACKUP_DIR - path for storing backup files (default: "/backup")
+ JENKINS_HOME - path to jenkins home (default: "/jenkins-home")
+ BACKUP_COUNT - define how much recent backups will be kept
+
+ volumeMounts + +
+- name: jenkins-home
+  mountPath: /jenkins-home
+- mountPath: /backup
+  name: backup
+
+ 		+ Holds the mount points for volumes. +
+ + +

Configuration +

+

+ (Appears on: + Jenkins instance configuration) +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDefault valueDescription
+ configurationAsCode + + {} + + ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin. +Example:
+
+- configMapName: jenkins-casc
+  content: {}
+
+
+ groovyScripts + + {} + + GroovyScripts defines configuration of Jenkins customization via groovy scripts. + Example:
+
+- configMapName: jenkins-gs
+  content: {}
+
+
+ secretRefName + + “” + + secretRefName of existing secret (previously created). +
+ secretData + + {} + + If secretRefName is empty, secretData creates new secret and fills with data provided in secretData. +

+ +

# See https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service for details + #service: + # slave Jenkins service + # See https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/schema/#github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Service for details + #slaveService:

+
diff --git a/website/content/en/docs/Installation/_index.md b/website/content/en/docs/Installation/_index.md index 44b134ca..7de00dcd 100644 --- a/website/content/en/docs/Installation/_index.md +++ b/website/content/en/docs/Installation/_index.md @@ -68,14 +68,15 @@ $ helm install jenkins/jenkins-operator -n To add custom labels and annotations, you can use `values.yaml` file or pass them into `helm install` command, e.g.: ```bash -$ helm install jenkins/jenkins-operator --set jenkins.labels.LabelKey=LabelValue,jenkins.annotations.AnnotationKey=AnnotationValue +$ helm install jenkins/jenkins-operator -n --set jenkins.labels.LabelKey=LabelValue,jenkins.annotations.AnnotationKey=AnnotationValue ``` You can further customize Jenkins using `values.yaml`: +

Jenkins instance configuration +

+### -## Jenkins instance configuration - - - +
+ @@ -83,21 +84,18 @@ You can further customize Jenkins using `values.yaml`: - + + - - - - + +
FieldDescription
+ jenkins - - - +

operator is section for configuring operator deployment

+ - - - - @@ -144,7 +139,6 @@ Create new namespace for jenkins (e.g. kubectl create -n jenkins) - @@ -156,7 +150,6 @@ Labels are injected into metadata labels field. - @@ -168,7 +161,6 @@ Annotations are injected into metadata annotations field. - @@ -181,7 +173,6 @@ It's recommended to use LTS (tag: "lts") version. - @@ -193,7 +184,6 @@ Env contains jenkins container environment variables. - @@ -205,7 +195,6 @@ Defines policy for pulling images - @@ -218,7 +207,6 @@ PriorityClassName indicates the importance of a Pod relative to other Pods. - @@ -232,7 +220,6 @@ Set it to true if you are using OpenShift Jenkins Plugin. - @@ -245,7 +232,6 @@ Used if you want to pull images from private repository - @@ -258,7 +244,6 @@ Notifications is feature that notify user about Jenkins reconcilation status - @@ -289,7 +274,6 @@ You can change their versions here - @@ -308,7 +292,6 @@ plugins: - @@ -334,7 +317,6 @@ seedJobs: - @@ -354,7 +336,6 @@ Resource limit/request for Jenkins - @@ -371,7 +352,6 @@ By default, we are only using PVC volume for storing backups. - @@ -383,7 +363,6 @@ volumeMounts are mounts for Jenkins pod. - @@ -396,11 +375,17 @@ SecurityContext for pod. - @@ -413,159 +398,166 @@ For customization tips see +Configuration + + +

- + +
-enabled
+enabled 		true @@ -108,9 +106,8 @@ Set to false if you have configured CR already and/or you want to deploy an oper
-apiVersion
+apiVersion 		jenkins.io/v1alpha2 @@ -119,9 +116,8 @@ Version of the CR manifest. The recommended and default value is jenkins.i
-name
+name 		jenkins @@ -131,7 +127,6 @@ Name of resource. The pod name will be jenkins-<name> (name w
namespace
labels
annotations
image
env
imagePullPolicy
priorityClassName
disableCSRFProtection
imagePullSecrets
notifications
basePlugins
plugins
seedJobs
resources
volumes
volumeMounts
securityContext
backup +

+ + +Backup + + +

 - Section where we can configure Jenkins instance. See Customization for details
+
### Configuring operator deployment - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
FieldDefault valueDescription
-operator - -

operator is section for configuring operator deployment

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-replicaCount
-		 -1 - -Number of Replicas. -
-image - -virtuslab/jenkins-operator:v0.4.0 - -Name (and tag) of the Jenkins Operator image. -
-imagePullPolicy - -IfNotPresent - -Defines policy for pulling images. -
-imagePullSecrets - -[] - -Used if you want to pull images from private repository. -
-nameOverride - -"" - -nameOverride overrides the app name. -
-fullnameOverride - -"" - -fullnameOverride overrides the deployment name -
- resources - - {} - -
- nodeSelector - - {} - -
- tolerations - - {} - -
- affinity - - {} - -
-
FieldDefault valueDescription
+ operator + +

operator is section for configuring operator deployment

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ replicaCount
+ 		+ 1 + + Number of Replicas. +
+ image + + virtuslab/jenkins-operator:v0.4.0 + + Name (and tag) of the Jenkins Operator image. +
+ imagePullPolicy + + IfNotPresent + + Defines policy for pulling images. +
+ imagePullSecrets + + [] + + Used if you want to pull images from private repository. +
+ nameOverride + + "" + + nameOverride overrides the app name. +
+ fullnameOverride + + "" + + fullnameOverride overrides the deployment name +
+ resources + + {} + +
+ nodeSelector + + {} + +
+ tolerations + + {} + +
+ affinity + + {} + +
+
-

Backup +

Backup

(Appears on: -JenkinsSpec) +JenkinsConfiguration)

Backup defines configuration of Jenkins backup. @@ -575,7 +567,7 @@ Backup defines configuration of Jenkins backup. Field -Default value +Default value Description @@ -584,7 +576,7 @@ Backup defines configuration of Jenkins backup. enabled - + true @@ -595,7 +587,7 @@ Backup defines configuration of Jenkins backup. image - + virtuslab/jenkins-operator-backup-pvc:v0.0.8 @@ -606,7 +598,7 @@ Backup defines configuration of Jenkins backup. containerName - + backup @@ -617,7 +609,7 @@ Backup defines configuration of Jenkins backup. interval - + 30 @@ -628,7 +620,7 @@ Backup defines configuration of Jenkins backup. makeBackupBeforePodDeletion - + true @@ -639,7 +631,7 @@ Backup defines configuration of Jenkins backup. backupCommand - + /home/user/bin/backup.sh @@ -649,69 +641,77 @@ Backup defines configuration of Jenkins backup. restoreCommand - + + /home/user/bin/restore.sh - + Backup restore command. pvc - - - - - - - Persistent Volume Claim Kubernetes resource - - - - - - - enabled - - - true - - - - Enable/disable switch for PVC - - - - - - size - - - 5Gi - - - Size of PVC - - - - - - className - - - "" - - - StorageClassName for PVC - More info + + +

Persistent Volume Claim Kubernetes resource

+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ enabled + + true + + Enable/disable switch for PVC +
+ enabled + + true + + Enable/disable switch for PVC +
+ size + + 5Gi + + Size of PVC +
+ className + + "" + + StorageClassName for PVC + More info +
env - + 
 - name: BACKUP_DIR
   value: /backup
@@ -734,7 +734,7 @@ Backup defines configuration of Jenkins backup.
         
             volumeMounts
         
-        
+        
 
 - name: jenkins-home
   mountPath: /jenkins-home
@@ -749,17 +749,12 @@ Backup defines configuration of Jenkins backup.
     
 
  
- 
- 
Configuration
+ 
Configuration
  

  

  (Appears on:
- JenkinsSpec)
+ Jenkins instance configuration)
  

- 

-Configuration is section where we can configure Jenkins instance
- 

-