From a5706885804ab060b0300654acb3fc4feef14147 Mon Sep 17 00:00:00 2001 From: Jakub Al-Khalili Date: Thu, 17 Oct 2019 16:20:36 +0200 Subject: [PATCH] Regenerate docs --- .../v0.1.1/configuration/index.html | 6 +- .../configure-backup-and-restore/index.html | 4 +- .../v0.1.1/customization/index.html | 20 +++--- docs/docs/getting-started/v0.1.1/index.xml | 26 ++++---- .../v0.2.0/configuration/index.html | 6 +- .../configure-backup-and-restore/index.html | 4 +- .../v0.2.0/customization/index.html | 32 +++++----- docs/docs/getting-started/v0.2.0/index.xml | 38 +++++------ docs/docs/index.xml | 64 +++++++++---------- ...a59390ea2e0f21481eafe4022de05a44eba88fc.js | 5 ++ 10 files changed, 105 insertions(+), 100 deletions(-) create mode 100644 docs/js/main.min.15ba3b50c3bd013e1b26793d1a59390ea2e0f21481eafe4022de05a44eba88fc.js diff --git a/docs/docs/getting-started/v0.1.1/configuration/index.html b/docs/docs/getting-started/v0.1.1/configuration/index.html index 8f524ac8..b8e15593 100644 --- a/docs/docs/getting-started/v0.1.1/configuration/index.html +++ b/docs/docs/getting-started/v0.1.1/configuration/index.html @@ -35,7 +35,7 @@ - + @@ -660,9 +660,9 @@ stringData: password: password_or_token -

HTTP Proxy

+

HTTP Proxy for downloading plugins

-

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

+

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

spec:
   master:
     containers:
diff --git a/docs/docs/getting-started/v0.1.1/configure-backup-and-restore/index.html b/docs/docs/getting-started/v0.1.1/configure-backup-and-restore/index.html
index da2a758a..844e795c 100644
--- a/docs/docs/getting-started/v0.1.1/configure-backup-and-restore/index.html
+++ b/docs/docs/getting-started/v0.1.1/configure-backup-and-restore/index.html
@@ -467,7 +467,7 @@
 kind: PersistentVolumeClaim
 metadata:
   name: <pvc_name>
-  namespace: <namesapce>
+  namespace: <namespace>
 spec:
   accessModes:
   - ReadWriteOnce
@@ -475,7 +475,7 @@
     requests:
       storage: 500Gi

Run command:

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

Configure Jenkins CR

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
diff --git a/docs/docs/getting-started/v0.1.1/customization/index.html b/docs/docs/getting-started/v0.1.1/customization/index.html
index 180b74b1..03510bce 100644
--- a/docs/docs/getting-started/v0.1.1/customization/index.html
+++ b/docs/docs/getting-started/v0.1.1/customization/index.html
@@ -35,7 +35,7 @@
 
 
 
-
+
 
 
 
@@ -458,11 +458,11 @@
 	
How to customize Jenkins
-

Jenkins can be customized using groovy scripts or configuration as code plugin. All custom configuration is stored in -the jenkins-operator-user-configuration- ConfigMap which is automatically created by Jenkins Operator.

+

Jenkins can be customized using groovy scripts or the configuration as code plugin. All custom configuration is stored in +the jenkins-operator-user-configuration- ConfigMap which is automatically created by the Jenkins Operator.

-

Jenkins Operator creates jenkins-operator-user-configuration- secret where user can store sensitive -information used for custom configuration. If you have entry in secret named PASSWORD then you can use it in +

The Jenkins Operator creates a jenkins-operator-user-configuration- secret where the user can store sensitive +information used for custom configuration. If you have an entry in the secret named PASSWORD then you can use it in the Configuration as Plugin as adminAddress: "${PASSWORD}".

kubectl get secret jenkins-operator-user-configuration-<cr_name> -o yaml
@@ -512,9 +512,9 @@ metadata:
   namespace: default
 
-

When jenkins-operator-user-configuration- ConfigMap is updated Jenkins automatically +

When the jenkins-operator-user-configuration- ConfigMap is updated Jenkins automatically runs the jenkins-operator-user-configuration Jenkins Job which executes all scripts then -runs the jenkins-operator-user-configuration-casc Jenkins Job which applies Configuration as Code configuration.

+runs the jenkins-operator-user-configuration-casc Jenkins Job which applies the Configuration as Code configuration.

Install Plugins

@@ -531,7 +531,7 @@ spec: version: 0.5.1
-

Under spec.master.basePlugins you can find plugins for valid Jenkins Operator work:

+

Under spec.master.basePlugins you can find plugins for a valid Jenkins Operator:

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
 metadata:
@@ -555,9 +555,9 @@ spec:
       version: "1.19"
     - name: kubernetes-credentials-provider
       version: 0.12.1
-

You can change version of them.

+

You can change their versions.

-

Then Jenkins Operator will automatically install plugins after Jenkins master pod restart.

+

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

diff --git a/docs/docs/getting-started/v0.1.1/index.xml b/docs/docs/getting-started/v0.1.1/index.xml index 3bc56d4a..ce567d82 100644 --- a/docs/docs/getting-started/v0.1.1/index.xml +++ b/docs/docs/getting-started/v0.1.1/index.xml @@ -307,9 +307,9 @@ stringData: password: password_or_token </code></pre> -<h2 id="http-proxy">HTTP Proxy</h2> +<h2 id="http-proxy-for-downloading-plugins">HTTP Proxy for downloading plugins</h2> -<p>To use forwarding proxy with operator you need to put environment var to Jenkins CR, for e.g.:</p> +<p>To use forwarding proxy with operator to downloading plugins you need to put environment var 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"> @@ -366,11 +366,11 @@ The <code>/sbin/tini -s -- /usr/local/bin/jenkins.sh</code> command -<p>Jenkins can be customized using groovy scripts or configuration as code plugin. All custom configuration is stored in -the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap which is automatically created by <strong>Jenkins Operator</strong>.</p> +<p>Jenkins can be customized using groovy scripts or the configuration as code plugin. All custom configuration is stored in +the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap which is automatically created by the <strong>Jenkins Operator</strong>.</p> -<p><strong>Jenkins Operator</strong> creates <strong>jenkins-operator-user-configuration-<cr_name></strong> secret where user can store sensitive -information used for custom configuration. If you have entry in secret named <code>PASSWORD</code> then you can use it in +<p>The <strong>Jenkins Operator</strong> creates a <strong>jenkins-operator-user-configuration-<cr_name></strong> secret where the user can store sensitive +information used for custom configuration. If you have an entry in the secret named <code>PASSWORD</code> then you can use it in the Configuration as Plugin as <code>adminAddress: &quot;${PASSWORD}&quot;</code>.</p> <pre><code>kubectl get secret jenkins-operator-user-configuration-&lt;cr_name&gt; -o yaml @@ -420,9 +420,9 @@ metadata: namespace: default </code></pre> -<p>When <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap is updated Jenkins automatically +<p>When the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap is updated Jenkins automatically runs the <strong>jenkins-operator-user-configuration</strong> Jenkins Job which executes all scripts then -runs the <strong>jenkins-operator-user-configuration-casc</strong> Jenkins Job which applies Configuration as Code configuration.</p> +runs the <strong>jenkins-operator-user-configuration-casc</strong> Jenkins Job which applies the Configuration as Code configuration.</p> <h2 id="install-plugins">Install Plugins</h2> @@ -439,7 +439,7 @@ spec: 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> +<p>Under <code>spec.master.basePlugins</code> you can find plugins for a valid <strong>Jenkins Operator</strong>:</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"> @@ -463,9 +463,9 @@ 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:#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>You can change their versions.</p> -<p>Then <strong>Jenkins Operator</strong> will automatically install plugins after Jenkins master pod restart.</p> +<p>Then the <strong>Jenkins Operator</strong> will automatically install those plugins after the Jenkins master pod restart.</p> @@ -514,7 +514,7 @@ restart Jenkins pod over and over again.</p> </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:#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>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"> @@ -522,7 +522,7 @@ restart Jenkins pod over and over again.</p> </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> +<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"> </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"> diff --git a/docs/docs/getting-started/v0.2.0/configuration/index.html b/docs/docs/getting-started/v0.2.0/configuration/index.html index 1837699e..5037685b 100644 --- a/docs/docs/getting-started/v0.2.0/configuration/index.html +++ b/docs/docs/getting-started/v0.2.0/configuration/index.html @@ -35,7 +35,7 @@ - + @@ -662,9 +662,9 @@ stringData: password: password_or_token -

HTTP Proxy

+

HTTP Proxy for downloading plugins

-

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

+

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

spec:
   master:
     containers:
diff --git a/docs/docs/getting-started/v0.2.0/configure-backup-and-restore/index.html b/docs/docs/getting-started/v0.2.0/configure-backup-and-restore/index.html
index 3354ba45..c46b9ffa 100644
--- a/docs/docs/getting-started/v0.2.0/configure-backup-and-restore/index.html
+++ b/docs/docs/getting-started/v0.2.0/configure-backup-and-restore/index.html
@@ -469,7 +469,7 @@
 kind: PersistentVolumeClaim
 metadata:
   name: <pvc_name>
-  namespace: <namesapce>
+  namespace: <namespace>
 spec:
   accessModes:
   - ReadWriteOnce
@@ -477,7 +477,7 @@
     requests:
       storage: 500Gi

Run command:

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

Configure Jenkins CR

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
diff --git a/docs/docs/getting-started/v0.2.0/customization/index.html b/docs/docs/getting-started/v0.2.0/customization/index.html
index 60dc223a..583a9f09 100644
--- a/docs/docs/getting-started/v0.2.0/customization/index.html
+++ b/docs/docs/getting-started/v0.2.0/customization/index.html
@@ -35,7 +35,7 @@
 
 
 
-
+
 
 
 
@@ -458,11 +458,11 @@
 	
How to customize Jenkins
-

Jenkins can be customized using groovy scripts or configuration as code plugin. -By using ConfigMap you can create own Jenkins customized configuration. -Then you must reference the ConfigMap in Jenkins pod customization file in spec.groovyScripts or spec.configurationAsCode

+

Jenkins can be customized using groovy scripts or the configuration as code plugin. +By using a ConfigMap you can create your own Jenkins customized configuration. +Then you must reference the ConfigMap in the Jenkins pod customization file in spec.groovyScripts or spec.configurationAsCode

-

For example create ConfigMap with name jenkins-operator-user-configuration. Then, modify the Jenkins manifest to look like this:

+

For example create a ConfigMap with name jenkins-operator-user-configuration. Then, modify the Jenkins manifest to look like this:

apiVersion: jenkins.io/v1alpha2
 kind: Jenkins
 metadata:
@@ -474,7 +474,7 @@ Then you must reference the ConfigMap in Jenkins pod c
   groovyScripts:
     configurations:
     - name: jenkins-operator-user-configuration
-

Here is example of jenkins-operator-user-configuration:

+

Here is an example of jenkins-operator-user-configuration:

apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -508,15 +508,15 @@ Then you must reference the ConfigMap in Jenkins pod c
 
  • *.yaml is configuration as code
  • -

    If you want to correct your configuration you can edit it while Jenkins Operator is running. -Jenkins will reconcile and apply new configuration.

    +

    If you want to correct your configuration you can edit it while the Jenkins Operator is running. +Jenkins will reconcile and apply the new configuration.

    -

    Using secrets inside Groovy script

    +

    Using secrets from a Groovy script

    -

    If you configured spec.groovyScripts.secret.name, then this secret is available to use inside map Groovy scripts. +

    If you configured spec.groovyScripts.secret.name, then this secret is available to use from map Groovy scripts. The secrets are loaded to secrets map.

    -

    Create a secret with for eg. jenkins-conf-secrets name.

    +

    Create a secret with for example the name jenkins-conf-secrets.

    kind: Secret
     apiVersion: v1
     type: Opaque
    @@ -556,7 +556,7 @@ The secrets are loaded to secrets map.

    jenkins.setSystemMessage(secrets["SYSTEM_MESSAGE"]) jenkins.save()
    -

    Or by applying configuration as code:

    +

    Or by applying this configuration as code:

    apiVersion: v1
     kind: ConfigMap
     metadata:
    @@ -565,7 +565,7 @@ The secrets are loaded to secrets map.

    1-system-message.yaml: | jenkins: systemMessage: ${SYSTEM_MESSAGE}
    -

    After this, you should see the Hello world system message at Jenkins homepage.

    +

    After this, you should see the Hello world system message from the Jenkins homepage.

    Install Plugins

    @@ -582,7 +582,7 @@ spec: version: 0.5.1
    -

    Under spec.master.basePlugins you can find plugins for valid Jenkins Operator work:

    +

    Under spec.master.basePlugins you can find plugins for a valid Jenkins Operator:

    apiVersion: jenkins.io/v1alpha2
     kind: Jenkins
     metadata:
    @@ -606,9 +606,9 @@ spec:
           version: "1.19"
         - name: kubernetes-credentials-provider
           version: 0.12.1
    -

    You can change version of them.

    +

    You can change their versions.

    -

    Then Jenkins Operator will automatically install plugins after Jenkins master pod restart.

    +

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

    diff --git a/docs/docs/getting-started/v0.2.0/index.xml b/docs/docs/getting-started/v0.2.0/index.xml index 1339689f..ae0e04a0 100644 --- a/docs/docs/getting-started/v0.2.0/index.xml +++ b/docs/docs/getting-started/v0.2.0/index.xml @@ -305,9 +305,9 @@ stringData: password: password_or_token </code></pre> -<h2 id="http-proxy">HTTP Proxy</h2> +<h2 id="http-proxy-for-downloading-plugins">HTTP Proxy for downloading plugins</h2> -<p>To use forwarding proxy with operator you need to put environment var to Jenkins CR, for e.g.:</p> +<p>To use forwarding proxy with operator to downloading plugins you need to put environment var 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"> @@ -403,11 +403,11 @@ stringData: -<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>Jenkins can be customized using groovy scripts or the <a href="https://github.com/jenkinsci/configuration-as-code-plugin" target="_blank">configuration as code plugin</a>. +By using a <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/" target="_blank">ConfigMap</a> you can create your own <strong>Jenkins</strong> customized configuration. +Then you must reference the <em>ConfigMap</em> in the <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> +<p>For example create a <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"> @@ -419,7 +419,7 @@ Then you must reference the <em>ConfigMap</em> in <strong>Jenk </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> +<p>Here is an 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"> @@ -453,15 +453,15 @@ Then you must reference the <em>ConfigMap</em> in <strong>Jenk <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> +<p>If you want to correct your configuration you can edit it while the <strong>Jenkins Operator</strong> is running. +Jenkins will reconcile and apply the new configuration.</p> -<h3 id="using-secrets-inside-groovy-script">Using secrets inside Groovy script</h3> +<h3 id="using-secrets-from-a-groovy-script">Using secrets from a Groovy script</h3> -<p>If you configured <code>spec.groovyScripts.secret.name</code>, then this secret is available to use inside map Groovy scripts. +<p>If you configured <code>spec.groovyScripts.secret.name</code>, then this secret is available to use from 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> +<p>Create a <a href="https://kubernetes.io/docs/concepts/configuration/secret/" target="_blank">secret</a> with for example the name <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">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"> @@ -501,7 +501,7 @@ The secrets are loaded to <code>secrets</code> map.</p> </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> +<p>Or by applying this 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"> @@ -510,7 +510,7 @@ The secrets are loaded to <code>secrets</code> map.</p> </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> +<p>After this, you should see the <code>Hello world</code> system message from the <strong>Jenkins</strong> homepage.</p> <h2 id="install-plugins">Install Plugins</h2> @@ -527,7 +527,7 @@ spec: 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> +<p>Under <code>spec.master.basePlugins</code> you can find plugins for a valid <strong>Jenkins Operator</strong>:</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"> @@ -551,9 +551,9 @@ 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:#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>You can change their versions.</p> -<p>Then <strong>Jenkins Operator</strong> will automatically install plugins after Jenkins master pod restart.</p> +<p>Then the <strong>Jenkins Operator</strong> will automatically install plugins after the Jenkins master pod restarts.</p> @@ -604,7 +604,7 @@ restart Jenkins pod over and over again.</p> </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:#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>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"> @@ -612,7 +612,7 @@ restart Jenkins pod over and over again.</p> </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> +<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"> </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"> diff --git a/docs/docs/index.xml b/docs/docs/index.xml index e0287314..161d3749 100644 --- a/docs/docs/index.xml +++ b/docs/docs/index.xml @@ -417,9 +417,9 @@ stringData: password: password_or_token </code></pre> -<h2 id="http-proxy">HTTP Proxy</h2> +<h2 id="http-proxy-for-downloading-plugins">HTTP Proxy for downloading plugins</h2> -<p>To use forwarding proxy with operator you need to put environment var to Jenkins CR, for e.g.:</p> +<p>To use forwarding proxy with operator to downloading plugins you need to put environment var 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"> @@ -680,9 +680,9 @@ stringData: password: password_or_token </code></pre> -<h2 id="http-proxy">HTTP Proxy</h2> +<h2 id="http-proxy-for-downloading-plugins">HTTP Proxy for downloading plugins</h2> -<p>To use forwarding proxy with operator you need to put environment var to Jenkins CR, for e.g.:</p> +<p>To use forwarding proxy with operator to downloading plugins you need to put environment var 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"> @@ -778,11 +778,11 @@ stringData: -<p>Jenkins can be customized using groovy scripts or configuration as code plugin. All custom configuration is stored in -the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap which is automatically created by <strong>Jenkins Operator</strong>.</p> +<p>Jenkins can be customized using groovy scripts or the configuration as code plugin. All custom configuration is stored in +the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap which is automatically created by the <strong>Jenkins Operator</strong>.</p> -<p><strong>Jenkins Operator</strong> creates <strong>jenkins-operator-user-configuration-<cr_name></strong> secret where user can store sensitive -information used for custom configuration. If you have entry in secret named <code>PASSWORD</code> then you can use it in +<p>The <strong>Jenkins Operator</strong> creates a <strong>jenkins-operator-user-configuration-<cr_name></strong> secret where the user can store sensitive +information used for custom configuration. If you have an entry in the secret named <code>PASSWORD</code> then you can use it in the Configuration as Plugin as <code>adminAddress: &quot;${PASSWORD}&quot;</code>.</p> <pre><code>kubectl get secret jenkins-operator-user-configuration-&lt;cr_name&gt; -o yaml @@ -832,9 +832,9 @@ metadata: namespace: default </code></pre> -<p>When <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap is updated Jenkins automatically +<p>When the <strong>jenkins-operator-user-configuration-<cr_name></strong> ConfigMap is updated Jenkins automatically runs the <strong>jenkins-operator-user-configuration</strong> Jenkins Job which executes all scripts then -runs the <strong>jenkins-operator-user-configuration-casc</strong> Jenkins Job which applies Configuration as Code configuration.</p> +runs the <strong>jenkins-operator-user-configuration-casc</strong> Jenkins Job which applies the Configuration as Code configuration.</p> <h2 id="install-plugins">Install Plugins</h2> @@ -851,7 +851,7 @@ spec: 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> +<p>Under <code>spec.master.basePlugins</code> you can find plugins for a valid <strong>Jenkins Operator</strong>:</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"> @@ -875,9 +875,9 @@ 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:#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>You can change their versions.</p> -<p>Then <strong>Jenkins Operator</strong> will automatically install plugins after Jenkins master pod restart.</p> +<p>Then the <strong>Jenkins Operator</strong> will automatically install those plugins after the Jenkins master pod restart.</p> @@ -893,11 +893,11 @@ spec: -<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>Jenkins can be customized using groovy scripts or the <a href="https://github.com/jenkinsci/configuration-as-code-plugin" target="_blank">configuration as code plugin</a>. +By using a <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/" target="_blank">ConfigMap</a> you can create your own <strong>Jenkins</strong> customized configuration. +Then you must reference the <em>ConfigMap</em> in the <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> +<p>For example create a <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"> @@ -909,7 +909,7 @@ Then you must reference the <em>ConfigMap</em> in <strong>Jenk </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> +<p>Here is an 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"> @@ -943,15 +943,15 @@ Then you must reference the <em>ConfigMap</em> in <strong>Jenk <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> +<p>If you want to correct your configuration you can edit it while the <strong>Jenkins Operator</strong> is running. +Jenkins will reconcile and apply the new configuration.</p> -<h3 id="using-secrets-inside-groovy-script">Using secrets inside Groovy script</h3> +<h3 id="using-secrets-from-a-groovy-script">Using secrets from a Groovy script</h3> -<p>If you configured <code>spec.groovyScripts.secret.name</code>, then this secret is available to use inside map Groovy scripts. +<p>If you configured <code>spec.groovyScripts.secret.name</code>, then this secret is available to use from 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> +<p>Create a <a href="https://kubernetes.io/docs/concepts/configuration/secret/" target="_blank">secret</a> with for example the name <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">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"> @@ -991,7 +991,7 @@ The secrets are loaded to <code>secrets</code> map.</p> </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> +<p>Or by applying this 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"> @@ -1000,7 +1000,7 @@ The secrets are loaded to <code>secrets</code> map.</p> </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> +<p>After this, you should see the <code>Hello world</code> system message from the <strong>Jenkins</strong> homepage.</p> <h2 id="install-plugins">Install Plugins</h2> @@ -1017,7 +1017,7 @@ spec: 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> +<p>Under <code>spec.master.basePlugins</code> you can find plugins for a valid <strong>Jenkins Operator</strong>:</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"> @@ -1041,9 +1041,9 @@ 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:#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>You can change their versions.</p> -<p>Then <strong>Jenkins Operator</strong> will automatically install plugins after Jenkins master pod restart.</p> +<p>Then the <strong>Jenkins Operator</strong> will automatically install plugins after the Jenkins master pod restarts.</p> @@ -1116,7 +1116,7 @@ restart Jenkins pod over and over again.</p> </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:#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>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"> @@ -1124,7 +1124,7 @@ restart Jenkins pod over and over again.</p> </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> +<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"> </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"> @@ -1198,7 +1198,7 @@ restart Jenkins pod over and over again.</p> </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:#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>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"> @@ -1206,7 +1206,7 @@ restart Jenkins pod over and over again.</p> </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> +<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"> </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"> diff --git a/docs/js/main.min.15ba3b50c3bd013e1b26793d1a59390ea2e0f21481eafe4022de05a44eba88fc.js b/docs/js/main.min.15ba3b50c3bd013e1b26793d1a59390ea2e0f21481eafe4022de05a44eba88fc.js new file mode 100644 index 00000000..947f3f26 --- /dev/null +++ b/docs/js/main.min.15ba3b50c3bd013e1b26793d1a59390ea2e0f21481eafe4022de05a44eba88fc.js @@ -0,0 +1,5 @@ +(function($){'use strict';$(function(){$('[data-toggle="tooltip"]').tooltip();$('[data-toggle="popover"]').popover();$('.popover-dismiss').popover({trigger:'focus'})});function bottomPos(element){return element.offset().top+element.outerHeight();} +$(function(){var promo=$(".js-td-cover");if(!promo.length){return} +var promoOffset=bottomPos(promo);var navbarOffset=$('.js-navbar-scroll').offset().top;var threshold=Math.ceil($('.js-navbar-scroll').outerHeight());if((promoOffset-navbarOffset)