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

Regerate docs (#577) 

Co-authored-by: Sig00rd <sfugas@virtuslab.com>
This commit is contained in:
Szymon Fugas 2021-06-11 15:44:14 +02:00 committed by GitHub
parent 040fbbfea5
commit ec6e288673
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/getting-started/index.html
View File

@ -802,7 +802,7 @@
<p>Prepare your Kubernetes cluster and set up your <code>kubectl</code> access.</p> <p>Prepare your Kubernetes cluster and set up your <code>kubectl</code> access.</p>
<p>Once you have a running Kubernetes cluster you can focus on installing <strong>Jenkins Operator</strong> according to the <a href="/docs/installation/">Installation</a> guide.</p> <p>Once you have a running Kubernetes cluster you can focus on installing <strong>Jenkins Operator</strong> according to the <a href="/kubernetes-operator/docs/installation/">Installation</a> guide.</p>
<div class="section-index"> <div class="section-index">

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

@ -761,11 +761,9 @@
<li> <li>
<ul> <ul>
<li><a href="#requirements">Requirements</a></li> <li><a href="#requirements">Requirements</a></li>
<li><a href="#configure-custom-resource-definition">Configure Custom Resource Definition</a></li> <li><a href="#deploy-jenkins-operator-using-yaml-s">Deploy Jenkins Operator using YAML&rsquo;s</a></li>
<li><a href="#deploy-jenkins-operator">Deploy Jenkins Operator</a> <li><a href="#deploy-jenkins-operator-using-helm-chart">Deploy Jenkins Operator using Helm Chart</a>
<ul> <ul>
<li><a href="#using-yaml-s">Using YAML&rsquo;s</a></li>
<li><a href="#using-helm-chart">Using Helm Chart</a></li>
<li><a href="#configuring-operator-deployment">Configuring operator deployment</a></li> <li><a href="#configuring-operator-deployment">Configuring operator deployment</a></li>
</ul></li> </ul></li>
</ul></li> </ul></li>
@ -821,25 +819,22 @@ All container images can be found at <a href="https://hub.docker.com/r/virtuslab
- access to a Kubernetes cluster version <code>1.17+</code> - access to a Kubernetes cluster version <code>1.17+</code>
- <code>kubectl</code> version <code>1.17+</code></p> - <code>kubectl</code> version <code>1.17+</code></p>
<h2 id="configure-custom-resource-definition">Configure Custom Resource Definition</h2> <p>Listed below are the two ways to deploy Jenkins Operator. For details on how to customize your Jenkins instance, refer to <a href="/kubernetes-operator/docs/installation/">Getting Started</a></p>
<p>Install Jenkins Custom Resource Definition:</p> <h2 id="deploy-jenkins-operator-using-yaml-s">Deploy Jenkins Operator using YAML&rsquo;s</h2>
<p>First, install Jenkins Custom Resource Definition:</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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.yaml </code></pre></div>
<h2 id="deploy-jenkins-operator">Deploy Jenkins Operator</h2> <p>Then, apply the operator and other required resources:</p>
<p>There are two ways to deploy the Jenkins Operator.</p>
<h3 id="using-yaml-s">Using YAML&rsquo;s</h3>
<p>Apply Service Account and RBAC roles:</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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.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 apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml</code></pre></div>
<p>Watch <strong>Jenkins Operator</strong> instance being created:</p> <p>Watch <strong>Jenkins Operator</strong> 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> <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>Now <strong>Jenkins Operator</strong> should be up and running in the <code>default</code> namespace.</p> <p>Now <strong>Jenkins Operator</strong> should be up and running in the <code>default</code> namespace.
For deploying Jenkins, refer to <a href="/kubernetes-operator/docs/installation/latest/deploy-jenkins/">Deploy Jenkins section</a>.</p>
<h3 id="using-helm-chart">Using Helm Chart</h3> <h2 id="deploy-jenkins-operator-using-helm-chart">Deploy Jenkins Operator using Helm Chart</h2>
<p>There is an option to use Helm to install the operator. It requires the Helm 3+ for deployment.</p> <p>Alternatively, you can also use Helm to install the Operator (and optionally, by default, Jenkins). It requires the Helm 3+ for deployment.</p>
<p>Create a namespace for the operator:</p> <p>Create a namespace for the operator:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ kubectl create namespace &lt;your-namespace&gt;</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 create namespace &lt;your-namespace&gt;</code></pre></div>