From 040fbbfea587eab538ff0c925f2b43917837b59d Mon Sep 17 00:00:00 2001 From: Szymon Fugas Date: Fri, 11 Jun 2021 15:34:02 +0200 Subject: [PATCH] Separate instructions on YAML vs Helm installation in docs (#576) * Fix link to Installation on Getting started index * Separate instructions on installing via YAML and Helm more clearly * Link deploy jenkins section in instructions on installing via YAML Co-authored-by: Sig00rd --- .../content/en/docs/Getting Started/_index.md | 2 +- .../content/en/docs/Installation/_index.md | 22 +++++++++---------- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/website/content/en/docs/Getting Started/_index.md b/website/content/en/docs/Getting Started/_index.md index 3bed2fcc..8a61c895 100644 --- a/website/content/en/docs/Getting Started/_index.md +++ b/website/content/en/docs/Getting Started/_index.md @@ -15,4 +15,4 @@ This document describes a getting started guide for **Jenkins Operator** Prepare your Kubernetes cluster and set up your `kubectl` access. -Once you have a running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](/docs/installation/) guide. +Once you have a running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](/kubernetes-operator/docs/installation/) guide. diff --git a/website/content/en/docs/Installation/_index.md b/website/content/en/docs/Installation/_index.md index 2a536528..6d4d8d27 100644 --- a/website/content/en/docs/Installation/_index.md +++ b/website/content/en/docs/Installation/_index.md @@ -8,7 +8,7 @@ description: > --- {{% pageinfo %}} -This document describes installation procedure for **Jenkins Operator**. +This document describes installation procedure for **Jenkins Operator**. All container images can be found at [virtuslab/jenkins-operator](https://hub.docker.com/r/virtuslab/jenkins-operator) {{% /pageinfo %}} @@ -18,21 +18,18 @@ To run **Jenkins Operator**, you will need: - access to a Kubernetes cluster version `1.17+` - `kubectl` version `1.17+` -## Configure Custom Resource Definition -Install Jenkins Custom Resource Definition: +Listed below are the two ways to deploy Jenkins Operator. For details on how to customize your Jenkins instance, refer to [Getting Started](/kubernetes-operator/docs/installation/) + +## Deploy Jenkins Operator using YAML's + +First, install Jenkins Custom Resource Definition: ```bash kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.yaml ``` -## Deploy Jenkins Operator - -There are two ways to deploy the Jenkins Operator. - -### Using YAML's - -Apply Service Account and RBAC roles: +Then, apply the operator and other required resources: ```bash kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml @@ -45,10 +42,11 @@ kubectl get pods -w ``` Now **Jenkins Operator** should be up and running in the `default` namespace. +For deploying Jenkins, refer to [Deploy Jenkins section](/kubernetes-operator/docs/installation/latest/deploy-jenkins/). -### Using Helm Chart +## Deploy Jenkins Operator using Helm Chart -There is an option to use Helm to install the operator. It requires the Helm 3+ for deployment. +Alternatively, you can also use Helm to install the Operator (and optionally, by default, Jenkins). It requires the Helm 3+ for deployment. Create a namespace for the operator: