Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generated docs update #616

Merged
merged 1 commit into from
Aug 6, 2021
Merged

Auto-generated docs update #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/docs/getting-started/latest/index.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1679,7 +1679,12 @@ Values defined by an Env with a duplicate key will take precedence.</p>
</td>
<td>
<em>(Optional)</em>
<p>Pod volumes to mount into the container’s filesystem.</p>
<p>
Pod volumes to mount into the container’s filesystem. More info:
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts">
https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts
</a>
</p>
</td>
</tr>
<tr>
Expand Down
9 changes: 7 additions & 2 deletions docs/docs/getting-started/latest/schema/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
">
<meta itemprop="datePublished" content="2021-01-18T00:00:00&#43;00:00" />
<meta itemprop="dateModified" content="2021-01-18T00:00:00&#43;00:00" />
<meta itemprop="wordCount" content="2960">
<meta itemprop="wordCount" content="2963">



Expand Down Expand Up @@ -1471,7 +1471,12 @@ <h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Conta
</td>
<td>
<em>(Optional)</em>
<p>Pod volumes to mount into the container&rsquo;s filesystem.</p>
<p>
Pod volumes to mount into the container&rsquo;s filesystem. More info:
<a href="https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts">
https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts
</a>
</p>
</td>
</tr>
<tr>
Expand Down
7 changes: 6 additions & 1 deletion docs/docs/index.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6194,7 +6194,12 @@ Values defined by an Env with a duplicate key will take precedence.&lt;/p&gt;
&lt;/td&gt;
&lt;td&gt;
&lt;em&gt;(Optional)&lt;/em&gt;
&lt;p&gt;Pod volumes to mount into the container&amp;rsquo;s filesystem.&lt;/p&gt;
&lt;p&gt;
Pod volumes to mount into the container&amp;rsquo;s filesystem. More info:
&lt;a href=&#34;https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts&#34;&gt;
https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-restricted-jenkins-controller-pod-volumemounts
&lt;/a&gt;
&lt;/p&gt;
&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
Expand Down
22 changes: 18 additions & 4 deletions docs/docs/installation/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@
<li><a href="#configuring-operator-deployment">Configuring operator deployment</a></li>
</ul></li>
<li><a href="#note-on-operator-s-nightly-built-images">Note on Operator&rsquo;s nightly built images</a></li>
<li><a href="#note-on-jenkins-home-volume">Note on Jenkins home Volume</a></li>
<li><a href="#note-on-restricted-jenkins-controller-pod-volumemounts">Note on restricted Jenkins controller pod volumeMounts</a></li>
</ul></li>
</ul>
</nav>
Expand Down Expand Up @@ -1660,11 +1660,25 @@ <h2 id="note-on-operator-s-nightly-built-images">Note on Operator&rsquo;s nightl

<p>You can find nightly built images by heading to <a href="https://hub.docker.com/r/virtuslab/jenkins-operator">virtuslab/jenkins-operator</a> Docker Hub repository and looking for images with tag in the form of &ldquo;{git-hash}&rdquo;, {git-hash} being the hash of master branch commit that you want to use snapshot of.</p>

<h2 id="note-on-jenkins-home-volume">Note on Jenkins home Volume</h2>
<h2 id="note-on-restricted-jenkins-controller-pod-volumemounts">Note on restricted Jenkins controller pod volumeMounts</h2>

<p>Current design of the Operator puts an emphasis on creating a full GitOps flow of work for Jenkins users. One of the key points of this design is maintaining an immutable state of Jenkins.</p>
<p>Current design of the Operator puts an emphasis on creating a full GitOps flow of work for Jenkins users.
One of the key points of this design is maintaining an immutable state of Jenkins.</p>

<p>One of the prerequisites of this is an ephemeral Jenkins home directory. To achieve that, Operator mounts emptyDir Volume as Jenkins home directory. It is not possible to overwrite volumeMount and specify any other Volume for Jenkins home directory, as attempting to do so will result in Operator error.</p>
<p>One of the prerequisites of this is an ephemeral Jenkins home directory. To achieve that, Operator mounts emptyDir Volume
(jenkins-home) as Jenkins home directory.
It is not possible to overwrite volumeMount and specify any other Volume for Jenkins home directory,
as attempting to do so will result in Operator error.</p>

<p>jenkins-home is not the only Jenkins controller pod volumeMount that is non-configurable and managed by Operator,
below is the full list of those volumeMounts:</p>

<ul>
<li>jenkins-home</li>
<li>scripts</li>
<li>init-configuration</li>
<li>operator-credentials</li>
</ul>

<div class="section-index">

Expand Down
30 changes: 15 additions & 15 deletions website/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.