diff --git a/docs/docs/getting-started/latest/aks/index.html b/docs/docs/getting-started/latest/aks/index.html index 0b2861e7..1633f115 100644 --- a/docs/docs/getting-started/latest/aks/index.html +++ b/docs/docs/getting-started/latest/aks/index.html @@ -35,7 +35,7 @@ - + @@ -485,7 +485,7 @@

AKS

Additional configuration for Azure Kubernetes Service
-

Azure AKS managed Kubernetes service adds to every pod the following envs:

+

Azure AKS managed Kubernetes service adds to every pod the following environment variables:

- name: KUBERNETES_PORT_443_TCP_ADDR
   value:
 - name: KUBERNETES_PORT
@@ -494,8 +494,8 @@
   value: tcp://
 - name: KUBERNETES_SERVICE_HOST
   value:
-

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.

+

The operator is aware of it and omits these environment variables when checking if a Jenkins pod environment has been changed. It prevents the +restart of a Jenkins pod over and over again.

diff --git a/docs/docs/getting-started/latest/configuration/index.html b/docs/docs/getting-started/latest/configuration/index.html index a04d2e75..a61dada1 100644 --- a/docs/docs/getting-started/latest/configuration/index.html +++ b/docs/docs/getting-started/latest/configuration/index.html @@ -35,7 +35,7 @@ - + @@ -530,7 +530,7 @@ and deploy keys.

└── build.jenkins -

cicd/jobs/build.jenkins it’s a job definition:

+

cicd/jobs/build.jenkins is a job definition:

#!/usr/bin/env groovy
 
@@ -554,7 +554,7 @@ pipelineJob('build-jenkins-operator') {
 }
 
-

cicd/pipelines/build.jenkins it’s an actual Jenkins pipeline:

+

cicd/pipelines/build.jenkins is an actual Jenkins pipeline:

#!/usr/bin/env groovy
 
@@ -623,13 +623,13 @@ spec:
     repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
 
-

Jenkins Operator will automatically discover and configure all seed jobs.

+

Jenkins Operator will automatically discover and configure all the seed jobs.

-

You can verify if deploy keys were successfully configured in Jenkins Credentials tab.

+

You can verify if deploy keys were successfully configured in the Jenkins Credentials tab.

jenkins

-

You can verify if your pipelines were successfully configured in Jenkins Seed Job console output.

+

You can verify if your pipelines were successfully configured in the Jenkins Seed Job console output.

jenkins

@@ -656,7 +656,7 @@ $ ssh-keygen -p -f <filename> -m pem

Configure SSH authentication

-

Configure seed job like:

+

Configure a seed job like this:

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
@@ -673,7 +673,7 @@ spec:
     repositoryUrl: git@github.com:jenkinsci/kubernetes-operator.git
 
-

and create Kubernetes Secret(name of secret should be the same from credentialID field):

+

and create a Kubernetes Secret (name of secret should be the same from credentialID field):

apiVersion: v1
 kind: Secret
@@ -690,7 +690,7 @@ stringData:
 
 

Username & password authentication

-

Configure seed job like:

+

Configure the seed job like:

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
@@ -707,7 +707,7 @@ spec:
     repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
 
-

and create Kubernetes Secret(name of secret should be the same from credentialID field):

+

and create a Kubernetes Secret (name of secret should be the same from credentialID field):

apiVersion: v1
 kind: Secret
@@ -720,7 +720,7 @@ stringData:
 
 

HTTP Proxy for downloading plugins

-

To use forwarding proxy with operator to downloading plugins you need to put environment var to Jenkins CR, for e.g.:

+

To use forwarding proxy with an operator to download plugins you need to add the following environment variable to Jenkins CR, for e.g.:

spec:
   master:
     containers:
@@ -732,7 +732,7 @@ stringData:
 
 

Pulling Docker images from private repositories

-

To pull Docker Image from private repository you can use imagePullSecrets.

+

To pull a Docker Image from private repository you can use imagePullSecrets.

Please follow the instructions on creating a secret with a docker config.

@@ -744,7 +744,7 @@ stringData:
kubectl -n <namespace> edit secret <name>

The .dockerconfigjson key’s value needs to be replaced with a modified version.

-

After modifications it needs to be encoded as Base64 value before setting the .dockerconfigjson key:q.

+

After modifications, it needs to be encoded as a Base64 value before setting the .dockerconfigjson key:q.

Example config file to modify and use:

diff --git a/docs/docs/getting-started/latest/configure-backup-and-restore/index.html b/docs/docs/getting-started/latest/configure-backup-and-restore/index.html index 8e4ff210..4759483f 100644 --- a/docs/docs/getting-started/latest/configure-backup-and-restore/index.html +++ b/docs/docs/getting-started/latest/configure-backup-and-restore/index.html @@ -35,7 +35,7 @@ - + @@ -505,13 +505,13 @@
Prevent loss of job history
-

Backup and restore is done by container sidecar.

+

Backup and restore is done by a container sidecar.

PVC

Create PVC

-

Save to file pvc.yaml:

+

Save to the file named pvc.yaml:

apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
@@ -523,7 +523,7 @@
   resources:
     requests:
       storage: 500Gi
-

Run command:

+

Run the following command:

$ kubectl -n <namespace> create -f pvc.yaml

Configure Jenkins CR

apiVersion: jenkins.io/v1alpha2
@@ -539,7 +539,7 @@
     containers:
     - name: jenkins-master
       image: jenkins/jenkins:lts
-    - name: backup # container responsible for backup and restore
+    - name: backup # container responsible for the backup and restore
       env:
       - name: BACKUP_DIR
         value: /backup
@@ -565,7 +565,7 @@
         command:
         - /home/user/bin/backup.sh # this command is invoked on "backup" container to make backup, for example /home/user/bin/backup.sh <backup_number>, <backup_number> is passed by operator
     interval: 30 # how often make backup in seconds
-    makeBackupBeforePodDeletion: true # make backup before pod deletion
+    makeBackupBeforePodDeletion: true # make a backup before pod deletion
   restore:
     containerName: backup # container name is responsible for restore backup
     action:
diff --git a/docs/docs/getting-started/latest/customization/index.html b/docs/docs/getting-started/latest/customization/index.html
index d7db7497..e48f91bb 100644
--- a/docs/docs/getting-started/latest/customization/index.html
+++ b/docs/docs/getting-started/latest/customization/index.html
@@ -652,7 +652,7 @@ spec:
       version: 0.12.1

You can change their versions.

-

Then the Jenkins Operator will automatically install plugins after the Jenkins master pod restarts.

+

The Jenkins Operator will then automatically install plugins after the Jenkins master pod restarts.

diff --git a/docs/docs/getting-started/latest/deploy-jenkins/index.html b/docs/docs/getting-started/latest/deploy-jenkins/index.html index ce658603..e74a2305 100644 --- a/docs/docs/getting-started/latest/deploy-jenkins/index.html +++ b/docs/docs/getting-started/latest/deploy-jenkins/index.html @@ -35,7 +35,7 @@ - + @@ -530,16 +530,16 @@ spec: description: "Jenkins Operator repository" repositoryBranch: master repositoryUrl: https://github.com/jenkinsci/kubernetes-operator.git
-

Deploy Jenkins to K8s:

+

Deploy a Jenkins to K8s:

kubectl create -f jenkins_instance.yaml
-

Watch Jenkins instance being created:

+

Watch the Jenkins instance being created:

kubectl get pods -w
-

Get Jenkins credentials:

+

Get the Jenkins credentials:

kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.user}' | base64 -d
 kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.password}' | base64 -d
-

Connect to Jenkins (minikube):

+

Connect to the Jenkins instance (minikube):

minikube service jenkins-operator-http-<cr_name> --url
-

Connect to Jenkins (actual Kubernetes cluster):

+

Connect to the Jenkins instance (actual Kubernetes cluster):

kubectl port-forward jenkins-<cr_name> 8080:8080

Then open browser with address http://localhost:8080. jenkins

diff --git a/docs/docs/getting-started/latest/diagnostics/index.html b/docs/docs/getting-started/latest/diagnostics/index.html index 26ae401b..d86fcf14 100644 --- a/docs/docs/getting-started/latest/diagnostics/index.html +++ b/docs/docs/getting-started/latest/diagnostics/index.html @@ -35,7 +35,7 @@ - + @@ -500,7 +500,7 @@ kubectl apply -f deploy/operator.yaml
kubectl logs deployment/jenkins-operator

Troubleshooting

-

Delete Jenkins master pod and wait for the new one to come up:

+

Delete the Jenkins master pod and wait for the new one to come up:

kubectl delete pod jenkins-<cr_name>
diff --git a/docs/docs/getting-started/latest/index.xml b/docs/docs/getting-started/latest/index.xml index 1e721427..3a5919ed 100644 --- a/docs/docs/getting-started/latest/index.xml +++ b/docs/docs/getting-started/latest/index.xml @@ -73,16 +73,16 @@ spec: 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> +<p>Deploy a 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> +<p>Watch the 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> +<p>Get the 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> +<p>Connect to the Jenkins instance (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> +<p>Connect to the Jenkins instance (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> @@ -117,7 +117,7 @@ and deploy keys.</p> └── build.jenkins </code></pre> -<p><strong>cicd/jobs/build.jenkins</strong> it&rsquo;s a job definition:</p> +<p><strong>cicd/jobs/build.jenkins</strong> is a job definition:</p> <pre><code>#!/usr/bin/env groovy @@ -141,7 +141,7 @@ pipelineJob('build-jenkins-operator') { } </code></pre> -<p><strong>cicd/pipelines/build.jenkins</strong> it&rsquo;s an actual Jenkins pipeline:</p> +<p><strong>cicd/pipelines/build.jenkins</strong> is an actual Jenkins pipeline:</p> <pre><code>#!/usr/bin/env groovy @@ -210,13 +210,13 @@ spec: 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><strong>Jenkins Operator</strong> will automatically discover and configure all the seed jobs.</p> -<p>You can verify if deploy keys were successfully configured in Jenkins <strong>Credentials</strong> tab.</p> +<p>You can verify if deploy keys were successfully configured in the 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>You can verify if your pipelines were successfully configured in the Jenkins Seed Job console output.</p> <p><img src="https://jenkinsci.github.io/kubernetes-operator/kubernetes-operator/img/jenkins-seed.png" alt="jenkins" /></p> @@ -243,7 +243,7 @@ $ ssh-keygen -p -f &lt;filename&gt; -m pem</code></pre></ <h4 id="configure-ssh-authentication">Configure SSH authentication</h4> -<p>Configure seed job like:</p> +<p>Configure a seed job like this:</p> <pre><code>apiVersion: jenkins.io/v1alpha2 kind: Jenkins @@ -260,7 +260,7 @@ spec: 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> +<p>and create a Kubernetes Secret (name of secret should be the same from <code>credentialID</code> field):</p> <pre><code>apiVersion: v1 kind: Secret @@ -277,7 +277,7 @@ stringData: <h3 id="username-password-authentication">Username &amp; password authentication</h3> -<p>Configure seed job like:</p> +<p>Configure the seed job like:</p> <pre><code>apiVersion: jenkins.io/v1alpha2 kind: Jenkins @@ -294,7 +294,7 @@ spec: 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> +<p>and create a Kubernetes Secret (name of secret should be the same from <code>credentialID</code> field):</p> <pre><code>apiVersion: v1 kind: Secret @@ -307,7 +307,7 @@ stringData: <h2 id="http-proxy-for-downloading-plugins">HTTP Proxy for downloading plugins</h2> -<p>To use forwarding proxy with operator to downloading plugins you need to put environment var to Jenkins CR, for e.g.:</p> +<p>To use forwarding proxy with an operator to download plugins you need to add the following environment variable to Jenkins CR, for 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-yaml" data-lang="yaml">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>containers<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> @@ -319,7 +319,7 @@ stringData: <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>To pull a 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> @@ -331,7 +331,7 @@ stringData: <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>After modifications, it needs to be encoded as a Base64 value before setting the <code>.dockerconfigjson</code> key:q.</p> <p>Example config file to modify and use:</p> @@ -553,7 +553,7 @@ spec: </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 their versions.</p> -<p>Then the <strong>Jenkins Operator</strong> will automatically install plugins after the Jenkins master pod restarts.</p> +<p>The <strong>Jenkins Operator</strong> will then automatically install plugins after the Jenkins master pod restarts.</p> @@ -567,7 +567,7 @@ spec: - <p>Azure AKS managed Kubernetes service adds to every pod the following envs:</p> + <p>Azure AKS managed Kubernetes service adds to every pod the following environment variables:</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"> @@ -576,8 +576,8 @@ spec: </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> +<p>The operator is aware of it and omits these environment variables when checking if a Jenkins pod environment has been changed. It prevents the +restart of a Jenkins pod over and over again.</p> @@ -593,13 +593,13 @@ restart Jenkins pod over and over again.</p> -<p>Backup and restore is done by container sidecar.</p> +<p>Backup and restore is done by a container sidecar.</p> <h3 id="pvc">PVC</h3> <h4 id="create-pvc">Create PVC</h4> -<p>Save to file pvc.yaml:</p> +<p>Save to the file named 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"> @@ -611,7 +611,7 @@ restart Jenkins pod over and over again.</p> </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> +<p>Run the following 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;namespace&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"> @@ -627,7 +627,7 @@ restart Jenkins pod over and over again.</p> </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>-<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 the 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"> @@ -653,7 +653,7 @@ restart Jenkins pod over and over again.</p> </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>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 a 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"> @@ -854,14 +854,14 @@ the number of backups under control, e.g. Cloud Formation fragment:</p> <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> +<p>Seed jobs are not built by master executors, but by dedicated agents 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>We have removed the 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> +If you want to use <code>v0.2.0</code> or newer you must simply write refererences 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"> @@ -879,8 +879,8 @@ If you want to use <code>v0.2.0</code> or newer you must simply writ </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> +<p>In <code>v0.1.1</code> you can see if the configuration failed or successfully updated in <strong>Jenkins</strong> UI (job build logs). +When Jenkins configuration jobs are removed, you must use the following 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> @@ -907,7 +907,7 @@ kubectl apply -f deploy/operator.yaml</code></pre></div> <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> +<p>Delete the 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> @@ -937,7 +937,7 @@ kubectl apply -f deploy/operator.yaml</code></pre></div> </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>Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group</p> </p> Resource Types: <ul><li> @@ -1026,7 +1026,7 @@ Every single change here requires a pod restart.</p> </td> <td> <em>(Optional)</em> -<p>SeedJobs defines list of Jenkins Seed Job configurations +<p>SeedJobs defines a 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> @@ -1041,7 +1041,7 @@ Service </td> <td> <em>(Optional)</em> -<p>Service is Kubernetes service of Jenkins master HTTP pod +<p>Service is the Kubernetes service of the Jenkins master HTTP pod Defaults to : port: 8080 type: ClusterIP</p> @@ -1058,7 +1058,7 @@ Service </td> <td> <em>(Optional)</em> -<p>Service is Kubernetes service of Jenkins slave pods +<p>Service is the Kubernetes service of the Jenkins slave pods Defaults to : port: 50000 type: ClusterIP</p> @@ -1075,7 +1075,7 @@ Backup </td> <td> <em>(Optional)</em> -<p>Backup defines configuration of Jenkins backup +<p>Backup defines the configuration of a 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> @@ -1090,7 +1090,7 @@ Restore </td> <td> <em>(Optional)</em> -<p>Backup defines configuration of Jenkins backup restore +<p>Backup defines the configuration of a 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> @@ -1105,7 +1105,7 @@ GroovyScripts </td> <td> <em>(Optional)</em> -<p>GroovyScripts defines configuration of Jenkins customization via groovy scripts</p> +<p>GroovyScripts defines the configuration of Jenkins customization via groovy scripts</p> </td> </tr> <tr> @@ -1119,7 +1119,7 @@ ConfigurationAsCode </td> <td> <em>(Optional)</em> -<p>ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin</p> +<p>ConfigurationAsCode defines the configuration of Jenkins customization via the Configuration as Code Jenkins plugin</p> </td> </tr> </table> @@ -1210,7 +1210,7 @@ string <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>Backup defines the configuration of a Jenkins backup</p> </p> <table> <thead> @@ -1241,7 +1241,7 @@ Handler </em> </td> <td> -<p>Action defines action which performs backup in backup container sidecar</p> +<p>Action defines the action which performs the backup in the backup container sidecar</p> </td> </tr> <tr> @@ -1252,7 +1252,7 @@ uint64 </em> </td> <td> -<p>Interval tells how often make backup in seconds +<p>Interval tells you how often the backup is made in seconds Defaults to 30.</p> </td> </tr> @@ -1264,7 +1264,7 @@ bool </em> </td> <td> -<p>MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion</p> +<p>MakeBackupBeforePodDeletion tells the operator to make a backup before Jenkins master pod deletion</p> </td> </tr> </tbody> @@ -1276,7 +1276,7 @@ bool <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Customization">Customization</a>) </p> <p> -<p>ConfigMapRef is reference to Kubernetes ConfigMap</p> +<p>ConfigMapRef is the reference to Kubernetes ConfigMap</p> </p> <table> <thead> @@ -1305,7 +1305,7 @@ string <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) </p> <p> -<p>ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin</p> +<p>ConfigurationAsCode defines configuration of Jenkins customization via the Configuration as Code Jenkins plugin</p> </p> <table> <thead> @@ -1336,7 +1336,7 @@ Customization <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>) </p> <p> -<p>Container defines Kubernetes container attributes</p> +<p>Container defines the Kubernetes container attributes</p> </p> <table> <thead> @@ -1691,7 +1691,7 @@ Kubernetes core/v1.ExecAction <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>JenkinsCredentialType defines the type of Jenkins credential used in the seed job mechanism</p> </p> <h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">JenkinsMaster </h3> @@ -2151,7 +2151,7 @@ string </td> <td> <em>(Optional)</em> -<p>UserAndPasswordHash is a SHA256 hash made from user and password</p> +<p>UserAndPasswordHash is a SHA256 hash made from the username and password</p> </td> </tr> <tr> @@ -2163,7 +2163,7 @@ string </td> <td> <em>(Optional)</em> -<p>CreatedSeedJobs contains list of seed job id already created in Jenkins</p> +<p>CreatedSeedJobs contains list of seed job ids already created in Jenkins</p> </td> </tr> <tr> @@ -2597,7 +2597,7 @@ string </em> </td> <td> -<p>Targets is the repository path where are seed job definitions</p> +<p>Targets is the repository path where the seed job definitions are</p> </td> </tr> <tr> @@ -2608,7 +2608,7 @@ string </em> </td> <td> -<p>RepositoryBranch is the repository branch where are seed job definitions</p> +<p>RepositoryBranch is the repository branch where the seed job definitions are</p> </td> </tr> <tr> @@ -2805,7 +2805,7 @@ int32 </em> </td> <td> -<p>The port that are exposed by this service. +<p>The port that is 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> @@ -2820,7 +2820,7 @@ int32 <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. +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> @@ -2835,7 +2835,7 @@ More info: <a href="https://kubernetes.io/docs/concepts/services-networki <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 +the 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> diff --git a/docs/docs/getting-started/latest/migration/index.html b/docs/docs/getting-started/latest/migration/index.html index dc1b0d23..517bbad4 100644 --- a/docs/docs/getting-started/latest/migration/index.html +++ b/docs/docs/getting-started/latest/migration/index.html @@ -35,7 +35,7 @@ - + @@ -504,14 +504,14 @@

Added seed job agent

-

Now seed jobs are not built by master executors, but by dedicated agent deployed into Kubernetes. We disabled master executors for security reasons.

+

Seed jobs are not built by master executors, but by dedicated agents deployed into Kubernetes. We disabled master executors for security reasons.

Apply Jenkins configuration via Groovy scripts instead of Jenkins jobs

-

We have removed hardcoded configuration by Jenkins jobs.

+

We have removed the hardcoded configuration by Jenkins jobs.

In v0.1.1 Jenkins Operator configuration was stored in jenkins-operator-user-configuration-<cr_name> -If you want to use v0.2.0 or newer you must simply write refer to old ConfigMap by modifying CR, for example:

+If you want to use v0.2.0 or newer you must simply write refererences to old ConfigMap by modifying CR, for example:

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
 metadata:
@@ -529,8 +529,8 @@ If you want to use v0.2.0 or newer you must simply write refer to o
       name: jenkins-operator-user-configuration-<cr_name>

Jenkins configuration jobs (Configure Seed Jobs, jenkins-operator-base-configuration, jenkins-operator-user-configuration) have been removed from Jenkins.

-

In v0.1.1 you can see if configuration failed or successfully updated in Jenkins UI (job build logs). -Now, when Jenkins configuration jobs are removed, you must use this command to see if configuration was failed.

+

In v0.1.1 you can see if the configuration failed or successfully updated in Jenkins UI (job build logs). +When Jenkins configuration jobs are removed, you must use the following command to see if configuration was failed.

$ kubectl -n logs deployment/jenkins-operator
diff --git a/docs/docs/getting-started/latest/scheme/index.html b/docs/docs/getting-started/latest/scheme/index.html index 39c98c85..45cb1cf5 100644 --- a/docs/docs/getting-started/latest/scheme/index.html +++ b/docs/docs/getting-started/latest/scheme/index.html @@ -35,7 +35,7 @@ - + @@ -501,7 +501,7 @@

jenkins.io

-

Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group

+

Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group

Resource Types: