- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/about/index.html b/docs/about/index.html
index b5f36aaa..1879b321 100644
--- a/docs/about/index.html
+++ b/docs/about/index.html
@@ -58,7 +58,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -86,7 +86,7 @@
 	diff --git a/docs/blog/2018/01/04/another-great-release/index.html b/docs/blog/2018/01/04/another-great-release/index.html index 28f8b16a..001bb36c 100644 --- a/docs/blog/2018/01/04/another-great-release/index.html +++ b/docs/blog/2018/01/04/another-great-release/index.html @@ -70,7 +70,7 @@-jenkins-operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind. +Jenkins Operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind.- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/blog/2018/10/06/easy-documentation-with-docsy/index.html b/docs/blog/2018/10/06/easy-documentation-with-docsy/index.html
index 5ddc2eb0..0ee108da 100644
--- a/docs/blog/2018/10/06/easy-documentation-with-docsy/index.html
+++ b/docs/blog/2018/10/06/easy-documentation-with-docsy/index.html
@@ -68,7 +68,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/blog/2018/10/06/the-second-blog-post/index.html b/docs/blog/2018/10/06/the-second-blog-post/index.html
index a8d2b445..363f32f1 100644
--- a/docs/blog/2018/10/06/the-second-blog-post/index.html
+++ b/docs/blog/2018/10/06/the-second-blog-post/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/blog/index.html b/docs/blog/index.html
index bb9e6178..5bfbca9b 100644
--- a/docs/blog/index.html
+++ b/docs/blog/index.html
@@ -59,7 +59,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/blog/news/index.html b/docs/blog/news/index.html
index e19562cb..b15f7114 100644
--- a/docs/blog/news/index.html
+++ b/docs/blog/news/index.html
@@ -60,7 +60,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/blog/releases/index.html b/docs/blog/releases/index.html
index eb1e53f2..3158f5d9 100644
--- a/docs/blog/releases/index.html
+++ b/docs/blog/releases/index.html
@@ -60,7 +60,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/community/index.html b/docs/community/index.html
index 2abd12ad..50e4f18a 100644
--- a/docs/community/index.html
+++ b/docs/community/index.html
@@ -58,7 +58,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/developer-guide/index.html b/docs/docs/developer-guide/index.html
index 146d82e3..78adb6b0 100644
--- a/docs/docs/developer-guide/index.html
+++ b/docs/docs/developer-guide/index.html
@@ -63,7 +63,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/developer-guide/tools/index.html b/docs/docs/developer-guide/tools/index.html
index 75a872f8..f2c0c6f8 100644
--- a/docs/docs/developer-guide/tools/index.html
+++ b/docs/docs/developer-guide/tools/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/index.html b/docs/docs/getting-started/index.html
index c3cc5682..afc3452c 100644
--- a/docs/docs/getting-started/index.html
+++ b/docs/docs/getting-started/index.html
@@ -63,7 +63,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.1.1/aks/index.html b/docs/docs/getting-started/v0.1.1/aks/index.html
index 5f2f16cd..8218b479 100644
--- a/docs/docs/getting-started/v0.1.1/aks/index.html
+++ b/docs/docs/getting-started/v0.1.1/aks/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
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 57fe4b19..9aa41323 100644
--- a/docs/docs/getting-started/v0.1.1/configuration/index.html
+++ b/docs/docs/getting-started/v0.1.1/configuration/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
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 46f5d13c..da2a758a 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
@@ -21,7 +21,7 @@
 
 
 Configure backup and restore | Jenkins Operator - @@ -29,7 +29,7 @@ - @@ -42,7 +42,7 @@ - @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -455,7 +455,7 @@
             
 Configure backup and restore-Prevent job history loss+Prevent loss of job historyBackup and restore is done by container sidecar. 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 5f8020bc..cf2963df 100644 --- a/docs/docs/getting-started/v0.1.1/customization/index.html +++ b/docs/docs/getting-started/v0.1.1/customization/index.html @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.1.1/deploy-jenkins/index.html b/docs/docs/getting-started/v0.1.1/deploy-jenkins/index.html
index 90259a9c..9ccc3fab 100644
--- a/docs/docs/getting-started/v0.1.1/deploy-jenkins/index.html
+++ b/docs/docs/getting-started/v0.1.1/deploy-jenkins/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.1.1/diagnostics/index.html b/docs/docs/getting-started/v0.1.1/diagnostics/index.html
index 0587ee31..b24e43b4 100644
--- a/docs/docs/getting-started/v0.1.1/diagnostics/index.html
+++ b/docs/docs/getting-started/v0.1.1/diagnostics/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.1.1/index.html b/docs/docs/getting-started/v0.1.1/index.html
index 53d575d7..12b7f053 100644
--- a/docs/docs/getting-started/v0.1.1/index.html
+++ b/docs/docs/getting-started/v0.1.1/index.html
@@ -63,7 +63,7 @@
 	diff --git a/docs/docs/getting-started/v0.1.1/migration-guide-v1alpha1-to-v1alpha2/index.html b/docs/docs/getting-started/v0.1.1/migration-guide-v1alpha1-to-v1alpha2/index.html index 3f007328..ec7c76ec 100644 --- a/docs/docs/getting-started/v0.1.1/migration-guide-v1alpha1-to-v1alpha2/index.html +++ b/docs/docs/getting-started/v0.1.1/migration-guide-v1alpha1-to-v1alpha2/index.html @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -520,7 +520,7 @@ Once you have running Kubernetes cluster you can focus on installing jen
                     Configure backup and restore-Prevent job history loss + Prevent loss of job history 
 - - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.1.1/scheme/index.html b/docs/docs/getting-started/v0.1.1/scheme/index.html
index 6d2ae695..5853e28d 100644
--- a/docs/docs/getting-started/v0.1.1/scheme/index.html
+++ b/docs/docs/getting-started/v0.1.1/scheme/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.2.0/aks/index.html b/docs/docs/getting-started/v0.2.0/aks/index.html
index 96ee9983..548db739 100644
--- a/docs/docs/getting-started/v0.2.0/aks/index.html
+++ b/docs/docs/getting-started/v0.2.0/aks/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
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 b2f497d9..dc33e5fc 100644
--- a/docs/docs/getting-started/v0.2.0/configuration/index.html
+++ b/docs/docs/getting-started/v0.2.0/configuration/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
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 1f0125ef..3354ba45 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
@@ -21,7 +21,7 @@
 
 
 Configure backup and restore | Jenkins Operator - @@ -29,7 +29,7 @@ - @@ -42,7 +42,7 @@ - @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -455,7 +455,7 @@
             
 Configure backup and restore-Prevent job history loss+Prevent loss of job historyBackup and restore is done by container sidecar. 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 b6f716b9..adbf2f22 100644 --- a/docs/docs/getting-started/v0.2.0/customization/index.html +++ b/docs/docs/getting-started/v0.2.0/customization/index.html @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.2.0/deploy-jenkins/index.html b/docs/docs/getting-started/v0.2.0/deploy-jenkins/index.html
index 4586fd65..043bb53c 100644
--- a/docs/docs/getting-started/v0.2.0/deploy-jenkins/index.html
+++ b/docs/docs/getting-started/v0.2.0/deploy-jenkins/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.2.0/diagnostics/index.html b/docs/docs/getting-started/v0.2.0/diagnostics/index.html
index e9d0027b..aeb9a49b 100644
--- a/docs/docs/getting-started/v0.2.0/diagnostics/index.html
+++ b/docs/docs/getting-started/v0.2.0/diagnostics/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.2.0/index.html b/docs/docs/getting-started/v0.2.0/index.html
index 8098992d..a1e3c016 100644
--- a/docs/docs/getting-started/v0.2.0/index.html
+++ b/docs/docs/getting-started/v0.2.0/index.html
@@ -63,7 +63,7 @@
 	diff --git a/docs/docs/getting-started/v0.2.0/migration/index.html b/docs/docs/getting-started/v0.2.0/migration/index.html index 090afba1..c3811762 100644 --- a/docs/docs/getting-started/v0.2.0/migration/index.html +++ b/docs/docs/getting-started/v0.2.0/migration/index.html @@ -70,7 +70,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -522,7 +522,7 @@ Once you have running Kubernetes cluster you can focus on installing jen
                     Configure backup and restore-Prevent job history loss + Prevent loss of job history 
 - - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/getting-started/v0.2.0/scheme/index.html b/docs/docs/getting-started/v0.2.0/scheme/index.html
index 9e9ea3af..bc1db6f4 100644
--- a/docs/docs/getting-started/v0.2.0/scheme/index.html
+++ b/docs/docs/getting-started/v0.2.0/scheme/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/how-it-works/architecture-and-design/index.html b/docs/docs/how-it-works/architecture-and-design/index.html
index 089c8ec8..e4da9f32 100644
--- a/docs/docs/how-it-works/architecture-and-design/index.html
+++ b/docs/docs/how-it-works/architecture-and-design/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/how-it-works/index.html b/docs/docs/how-it-works/index.html
index 9d2137c4..f6e77dfe 100644
--- a/docs/docs/how-it-works/index.html
+++ b/docs/docs/how-it-works/index.html
@@ -63,7 +63,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/how-it-works/jenkins-docker-images/index.html b/docs/docs/how-it-works/jenkins-docker-images/index.html
index 56669523..b741720b 100644
--- a/docs/docs/how-it-works/jenkins-docker-images/index.html
+++ b/docs/docs/how-it-works/jenkins-docker-images/index.html
@@ -70,7 +70,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/index.html b/docs/docs/index.html
index f3f4751c..59542588 100644
--- a/docs/docs/index.html
+++ b/docs/docs/index.html
@@ -60,7 +60,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/docs/installation/index.html b/docs/docs/installation/index.html
index f84d2bc4..3756728a 100644
--- a/docs/docs/installation/index.html
+++ b/docs/docs/installation/index.html
@@ -63,7 +63,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -453,7 +453,7 @@
 
 Install Jenkins Custom Resource Definition: -kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/crds/jenkins_v1alpha2_jenkins_crd.yamlDeploy jenkins-operator+Deploy Jenkins OperatorApply Service Account and RBAC roles: diff --git a/docs/docs/security/index.html b/docs/docs/security/index.html index f6527e86..264180be 100644 --- a/docs/docs/security/index.html +++ b/docs/docs/security/index.html @@ -63,7 +63,7 @@kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yamldiff --git a/docs/search/index.html b/docs/search/index.html index dc264ee1..d4bd407e 100644 --- a/docs/search/index.html +++ b/docs/search/index.html @@ -64,7 +64,7 @@- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/docs/index.html b/docs/index.html
index bad87ae4..555294b6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -59,7 +59,7 @@
 	- - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
@@ -115,7 +115,7 @@
 
 It was built with immutability and declarative configuration as code in mind.
 Here are solved problems. + Jenkins operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind.
 
 Backup and restore for jobs history-Prevent job history loss +Prevent loss of job history 
 - - What's Jenkins Operator? + What's the Jenkins Operator?
- 
                 Documentation
diff --git a/documentation/developer-guide.md b/documentation/developer-guide.md
index d111f129..91f89a85 100644
--- a/documentation/developer-guide.md
+++ b/documentation/developer-guide.md
@@ -23,13 +23,13 @@ make go-dependencies
 
 ## Build and run with a minikube
 
-Build and run **jenkins-operator** locally:
+Build and run **Jenkins Operator** locally:
 
 ```bash
 make minikube-run EXTRA_ARGS='--minikube --local'
 ```
 
-Once minikube and **jenkins-operator** are up and running, apply Jenkins custom resource:
+Once minikube and **Jenkins Operator** are up and running, apply Jenkins custom resource:
 
 ```bash
 kubectl apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml
@@ -45,7 +45,7 @@ You can also run the controller locally and make it listen to a remote Kubernete
 make run NAMESPACE=default KUBECTL_CONTEXT=remote-k8s EXTRA_ARGS='--kubeconfig ~/.kube/config'
 ```
 
-Once minikube and **jenkins-operator** are up and running, apply Jenkins custom resource:
+Once minikube and **Jenkins Operator** are up and running, apply Jenkins custom resource:
 
 ```bash
 kubectl --context remote-k8s --namespace default apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml
@@ -90,7 +90,7 @@ Build Docker image inside provided Linux container by:
 $ make indocker
 ```
 
-Build **jenkins-operator** inside container using:
+Build **Jenkins Operator** inside container using:
 
 ```bash
 $ make build
diff --git a/documentation/how-it-works.md b/documentation/how-it-works.md
index 02a52cd5..f154772c 100644
--- a/documentation/how-it-works.md
+++ b/documentation/how-it-works.md
@@ -1,6 +1,6 @@
 # How it works
 
-This document describes a high level overview how **jenkins-operator** works. 
+This document describes a high level overview how **Jenkins Operator** works. 
 
 1. [Architecture and design](#architecture-and-design)
 2. [Operator State](#operator-state)
@@ -9,7 +9,7 @@ This document describes a high level overview how **jenkins-operator** works.
 
 ## Architecture and design
 
-The **jenkins-operator** design incorporates the following concepts:
+The **Jenkins Operator** design incorporates the following concepts:
 - watches any changes of manifests and maintain the desired state according to deployed custom resource manifest
 - implements the main reconciliation loop which consists of two smaller reconciliation loops - base and user 
 
@@ -48,5 +48,5 @@ Main assumptions are:
 
 ## Jenkins Docker Images
 
-**jenkins-operator** is fully compatible with **jenkins:lts** docker image and does not introduce any hidden changes there.
+**Jenkins Operator** is fully compatible with **jenkins:lts** docker image and does not introduce any hidden changes there.
 If needed, the docker image can easily be changed in custom resource manifest as long as it supports standard Jenkins file system structure.
diff --git a/documentation/installation.md b/documentation/installation.md
index 0ef00372..9118a357 100644
--- a/documentation/installation.md
+++ b/documentation/installation.md
@@ -1,11 +1,11 @@
 # Installation
 
-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)
 
 ## Requirements
  
-To run **jenkins-operator**, you will need:
+To run **Jenkins Operator**, you will need:
 - running Kubernetes cluster version 1.11+
 - kubectl version 1.11+
 
@@ -17,7 +17,7 @@ Install Jenkins Custom Resource Definition:
 kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/crds/jenkins_v1alpha2_jenkins_crd.yaml
 ```
 
-## Deploy jenkins-operator
+## Deploy Jenkins Operator
 
 Apply Service Account and RBAC roles:
 
@@ -25,13 +25,13 @@ Apply Service Account and RBAC roles:
 kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml
 ```
 
-Watch **jenkins-operator** instance being created:
+Watch **Jenkins Operator** instance being created:
 
 ```bash
 kubectl get pods -w
 ```
 
-Now **jenkins-operator** should be up and running in `default` namespace.
+Now **Jenkins Operator** should be up and running in `default` namespace.
 
 
 
diff --git a/documentation/security.md b/documentation/security.md
index 5ba2e20d..dbc750db 100644
--- a/documentation/security.md
+++ b/documentation/security.md
@@ -1,19 +1,19 @@
 # Jenkins Security
 
-By default **jenkins-operator** performs an initial security hardening of Jenkins instance via groovy scripts to prevent any security gaps.
+By default **Jenkins Operator** performs an initial security hardening of Jenkins instance via groovy scripts to prevent any security gaps.
 
 ## Jenkins Access Control
 
-Currently **jenkins-operator** generates a username and random password and stores them in a Kubernetes Secret.
+Currently **Jenkins Operator** generates a username and random password and stores them in a Kubernetes Secret.
 However any other authorization mechanisms are possible and can be done via groovy scripts or configuration as code plugin.
 For more information take a look at [getting-started#jenkins-customization](v0.1.1/getting-started.md#jenkins-customisation).
 
 Any change to Security Realm or Authorization requires that user called `jenkins-operator` must have admin rights 
-because **jenkins-operator** calls Jenkins API.
+because **Jenkins Operator** calls Jenkins API.
 
 ## Jenkins Hardening
 
-The list below describes all the default security setting configured by the **jenkins-operator**:
+The list below describes all the default security setting configured by the **Jenkins Operator**:
 - basic settings - use `Mode.EXCLUSIVE` - Jobs must specify that they want to run on master node
 - enable CSRF - Cross Site Request Forgery Protection is enabled
 - disable usage stats - Jenkins usage stats submitting is disabled
@@ -26,7 +26,7 @@ If you would like to dig a little bit into the code, take a look [here](../pkg/c
 
 ## Jenkins API
 
-The **jenkins-operator** generates and configures Basic Authentication token for Jenkins go client and stores it in a Kubernetes Secret.
+The **Jenkins Operator** generates and configures Basic Authentication token for Jenkins go client and stores it in a Kubernetes Secret.
 
 ## Kubernetes
 
@@ -34,25 +34,25 @@ Kubernetes API permissions are limited by the following roles:
 - [jenkins-operator role](../deploy/role.yaml)  
 - [Jenkins Master role](../pkg/controller/jenkins/configuration/base/resources/rbac.go)
 
-Since **jenkins-operator** must be able to grant permission for its' deployed Jenkins masters to spawn pods (the `Jenkins Master role` above), 
+Since **Jenkins Operator** must be able to grant permission for its' deployed Jenkins masters to spawn pods (the `Jenkins Master role` above), 
 the operator itself requires permission to create RBAC resources (the `jenkins-operator role` above). 
 Deployed this way, any subject which may create a Pod (including a Jenkins job) may 
 assume the `jenkins-operator` role by using its' ServiceAccount, create RBAC rules, and thus escape its granted permissions. 
 Any namespace to which the `jenkins-operator` is deployed must be considered to implicitly grant all 
 possible permissions to any subject which can create a Pod in that namespace.
 
-To mitigate this issue **jenkins-operator** should be deployed in one namespace and the Jenkins CR should be created in separate namespace. 
+To mitigate this issue **Jenkins Operator** should be deployed in one namespace and the Jenkins CR should be created in separate namespace. 
 To achieve it change watch namespace in https://github.com/jenkinsci/kubernetes-operator/blob/master/deploy/operator.yaml#L25
 
 ## Setup Jenkins Operator and Jenkins in separated namespaces
 
-You need to create two namespaces, for example we'll call them **jenkins** for Jenkins and **jenkins-operator** for Jenkins Operator.
+You need to create two namespaces, for example we'll call them **jenkins** for Jenkins and **Jenkins Operator** for Jenkins Operator.
 ```bash
 $ kubectl create ns jenkins-operator
 $ kubectl create ns jenkins
 ```
 
-Next, apply the RBAC manifests for **jenkins-operator** namespace
+Next, apply the RBAC manifests for **Jenkins Operator** namespace
 ```bash
 $ kubectl -n jenkins-operator apply -f deploy/service_account.yaml
 $ kubectl -n jenkins-operator apply -f deploy/role_binding.yaml
diff --git a/documentation/v0.1.1/getting-started.md b/documentation/v0.1.1/getting-started.md
index 5dd8c3ec..0f6ca8db 100644
--- a/documentation/v0.1.1/getting-started.md
+++ b/documentation/v0.1.1/getting-started.md
@@ -1,6 +1,6 @@
 # Getting Started
 
-This document describes a getting started guide for **jenkins-operator** and an additional configuration.
+This document describes a getting started guide for **Jenkins Operator** and an additional configuration.
 
 1. [First Steps](#first-steps)
 2. [Deploy Jenkins](#deploy-jenkins)
@@ -15,7 +15,7 @@ This document describes a getting started guide for **jenkins-operator** and an
 ## First Steps
 
 Prepare your Kubernetes cluster and set up access.
-Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](../installation.md) guide.
+Once you have running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](../installation.md) guide.
 
 ## Deploy Jenkins
 
@@ -213,7 +213,7 @@ 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 seed jobs.
 
 You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab.
 
@@ -327,9 +327,9 @@ stringData:
 ## Jenkins Customisation
 
 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**. +the **jenkins-operator-user-configuration- ** ConfigMap which is automatically created by **Jenkins Operator**. -**jenkins-operator** creates **jenkins-operator-user-configuration- ** secret where user can store sensitive +**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 Configuration as Plugin as `adminAddress: "${PASSWORD}"`. @@ -402,7 +402,7 @@ spec: version: 0.5.1 ``` -Then **jenkins-operator** will automatically install plugins after Jenkins master pod restart. +Then **Jenkins Operator** will automatically install plugins after Jenkins master pod restart. ## Configure backup and restore @@ -520,7 +520,7 @@ data: password: ``` -If needed **jenkins-operator** will restart Jenkins master pod and then you can login with the new user and password +If needed **Jenkins Operator** will restart Jenkins master pod and then you can login with the new user and password credentials. ## Override default Jenkins container command @@ -549,7 +549,7 @@ command: ## Debugging -Turn on debug in **jenkins-operator** deployment: +Turn on debug in **Jenkins Operator** deployment: ```bash sed -i 's|\(args:\).*|\1\ ["--debug"\]|' deploy/operator.yaml diff --git a/documentation/v0.2.0/getting-started.md b/documentation/v0.2.0/getting-started.md index ba43a6e1..390ecc3b 100644 --- a/documentation/v0.2.0/getting-started.md +++ b/documentation/v0.2.0/getting-started.md @@ -1,6 +1,6 @@ # Getting Started -This document describes a getting started guide for **jenkins-operator** and an additional configuration. +This document describes a getting started guide for **Jenkins Operator** and an additional configuration. 1. [First Steps](#first-steps) 2. [Deploy Jenkins](#deploy-jenkins) @@ -17,7 +17,7 @@ This document describes a getting started guide for **jenkins-operator** and an ## First Steps Prepare your Kubernetes cluster and set up access. -Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](../installation.md) guide. +Once you have running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](../installation.md) guide. ## Deploy Jenkins @@ -215,7 +215,7 @@ 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 seed jobs. You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab. @@ -456,7 +456,7 @@ data: * *.groovy is Groovy script configuration * *.yaml is configuration as code -If you want to correct your configuration you can edit it while **jenkins-operator** is running. +If you want to correct your configuration you can edit it while **Jenkins Operator** is running. Jenkins will reconcile and apply new configuration. ### Using secrets inside Groovy script @@ -547,7 +547,7 @@ spec: version: 0.5.1 ``` -Then **jenkins-operator** will automatically install plugins after Jenkins master pod restart. +Then **Jenkins Operator** will automatically install plugins after Jenkins master pod restart. ## Configure backup and restore @@ -665,7 +665,7 @@ data: password: ``` -If needed **jenkins-operator** will restart Jenkins master pod and then you can login with the new user and password +If needed **Jenkins Operator** will restart Jenkins master pod and then you can login with the new user and password credentials. ## Override default Jenkins container command @@ -694,7 +694,7 @@ command: ## Debugging -Turn on debug in **jenkins-operator** deployment: +Turn on debug in **Jenkins Operator** deployment: ```bash sed -i 's|\(args:\).*|\1\ ["--debug"\]|' deploy/operator.yaml diff --git a/website/content/en/_index.html b/website/content/en/_index.html index 29ef68fd..f942ac85 100644 --- a/website/content/en/_index.html +++ b/website/content/en/_index.html @@ -24,7 +24,7 @@ linkTitle = "Jenkins Kubernetes Operator" {{% /blocks/section %}} {{% blocks/lead color="primary" %}} -Jenkins operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes. 
 It was built with immutability and declarative configuration as code in mind.
 Here are solved problems. +Jenkins operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind.
 {{% /blocks/lead %}} {{< blocks/section color="dark" >}} @@ -51,7 +51,7 @@ Improve user experience by informing what has been done {{% /blocks/feature %}} {{% blocks/feature icon="fas fa-file-archive" title="Backup and restore for jobs history" %}} -Prevent job history loss +Prevent loss of job history {{% /blocks/feature %}} diff --git a/website/content/en/about/_index.html b/website/content/en/about/_index.html index 3f0f7550..3668f264 100644 --- a/website/content/en/about/_index.html +++ b/website/content/en/about/_index.html @@ -9,7 +9,7 @@ menu: {{% blocks/lead color="primary" %}}-jenkins-operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.{{% /blocks/lead %}} diff --git a/website/content/en/docs/Developer Guide/_index.md b/website/content/en/docs/Developer Guide/_index.md index 423f72ee..518fb855 100644 --- a/website/content/en/docs/Developer Guide/_index.md +++ b/website/content/en/docs/Developer Guide/_index.md @@ -32,13 +32,13 @@ make go-dependencies ## Build and run with a minikube -Build and run **jenkins-operator** locally: +Build and run **Jenkins Operator** locally: ```bash make minikube-run EXTRA_ARGS='--minikube --local' ``` -Once minikube and **jenkins-operator** are up and running, apply Jenkins custom resource: +Once minikube and **Jenkins Operator** are up and running, apply Jenkins custom resource: ```bash kubectl apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml @@ -54,7 +54,7 @@ You can also run the controller locally and make it listen to a remote Kubernete make run NAMESPACE=default KUBECTL_CONTEXT=remote-k8s EXTRA_ARGS='--kubeconfig ~/.kube/config' ``` -Once minikube and **jenkins-operator** are up and running, apply Jenkins custom resource: +Once minikube and **Jenkins Operator** are up and running, apply Jenkins custom resource: ```bash kubectl --context remote-k8s --namespace default apply -f deploy/crds/jenkins_v1alpha2_jenkins_cr.yaml @@ -99,7 +99,7 @@ Build Docker image inside provided Linux container by: $ make indocker ``` -Build **jenkins-operator** inside container using: +Build **Jenkins Operator** inside container using: ```bash diff --git a/website/content/en/docs/Getting Started/_index.md b/website/content/en/docs/Getting Started/_index.md index 984fbb1e..e4dce4dc 100644 --- a/website/content/en/docs/Getting Started/_index.md +++ b/website/content/en/docs/Getting Started/_index.md @@ -8,10 +8,10 @@ description: > --- {{% pageinfo %}} -This document describes a getting started guide for **jenkins-operator** +This document describes a getting started guide for **Jenkins Operator** {{% /pageinfo %}} ## First Steps Prepare your Kubernetes cluster and set up access. -Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](/docs/installation/) guide. +Once you have running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](/docs/installation/) guide. diff --git a/website/content/en/docs/Getting Started/v0.1.1/_index.md b/website/content/en/docs/Getting Started/v0.1.1/_index.md index bab3c10d..5945f9f1 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/_index.md +++ b/website/content/en/docs/Getting Started/v0.1.1/_index.md @@ -8,10 +8,10 @@ description: > --- {{% pageinfo %}} -This document describes a getting started guide for **jenkins-operator** `v0.1.1` and an additional configuration. +This document describes a getting started guide for **Jenkins Operator** `v0.1.1` and an additional configuration. {{% /pageinfo %}} ## First Steps Prepare your Kubernetes cluster and set up access. -Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](/docs/installation/) guide. +Once you have running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](/docs/installation/) guide. diff --git a/website/content/en/docs/Getting Started/v0.1.1/configuration.md b/website/content/en/docs/Getting Started/v0.1.1/configuration.md index 8968114f..b261b6b7 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/configuration.md +++ b/website/content/en/docs/Getting Started/v0.1.1/configuration.md @@ -118,7 +118,7 @@ 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 seed jobs. You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab. @@ -247,7 +247,7 @@ data: password:
 It was built with immutability and declarative configuration as code in mind. +Jenkins Operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes.
 It was built with immutability and declarative configuration as code in mind.``` -If needed **jenkins-operator** will restart Jenkins master pod and then you can login with the new user and password +If needed **Jenkins Operator** will restart Jenkins master pod and then you can login with the new user and password credentials. ## Override default Jenkins container command diff --git a/website/content/en/docs/Getting Started/v0.1.1/configure-backup-and-restore.md b/website/content/en/docs/Getting Started/v0.1.1/configure-backup-and-restore.md index aff579c4..194f8c0a 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/configure-backup-and-restore.md +++ b/website/content/en/docs/Getting Started/v0.1.1/configure-backup-and-restore.md @@ -4,7 +4,7 @@ linkTitle: "Configure backup and restore" weight: 10 date: 2019-08-05 description: > - Prevent job history loss + Prevent loss of job history --- Backup and restore is done by container sidecar. diff --git a/website/content/en/docs/Getting Started/v0.1.1/customization.md b/website/content/en/docs/Getting Started/v0.1.1/customization.md index d5d6ff17..b7594dde 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/customization.md +++ b/website/content/en/docs/Getting Started/v0.1.1/customization.md @@ -8,9 +8,9 @@ description: > --- 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**. +the **jenkins-operator-user-configuration- ** ConfigMap which is automatically created by **Jenkins Operator**. -**jenkins-operator** creates **jenkins-operator-user-configuration- ** secret where user can store sensitive +**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 Configuration as Plugin as `adminAddress: "${PASSWORD}"`. @@ -83,7 +83,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 valid **Jenkins Operator** work: ```yaml apiVersion: jenkins.io/v1alpha2 @@ -113,4 +113,4 @@ spec: You can change version of them. -Then **jenkins-operator** will automatically install plugins after Jenkins master pod restart. \ No newline at end of file +Then **Jenkins Operator** will automatically install plugins after Jenkins master pod restart. \ No newline at end of file diff --git a/website/content/en/docs/Getting Started/v0.1.1/diagnostics.md b/website/content/en/docs/Getting Started/v0.1.1/diagnostics.md index 8bc213d1..8282cae2 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/diagnostics.md +++ b/website/content/en/docs/Getting Started/v0.1.1/diagnostics.md @@ -8,7 +8,7 @@ description: > --- -Turn on debug in **jenkins-operator** deployment: +Turn on debug in **Jenkins Operator** deployment: ```bash sed -i 's|\(args:\).*|\1\ ["--debug"\]|' deploy/operator.yaml diff --git a/website/content/en/docs/Getting Started/v0.2.0/_index.md b/website/content/en/docs/Getting Started/v0.2.0/_index.md index 5106d0b3..ea03a683 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/_index.md +++ b/website/content/en/docs/Getting Started/v0.2.0/_index.md @@ -8,10 +8,10 @@ description: > --- {{% pageinfo %}} -This document describes a getting started guide for **jenkins-operator** `v0.2.0` and an additional configuration. +This document describes a getting started guide for **Jenkins Operator** `v0.2.0` and an additional configuration. {{% /pageinfo %}} ## First Steps Prepare your Kubernetes cluster and set up access. -Once you have running Kubernetes cluster you can focus on installing **jenkins-operator** according to the [Installation](/docs/installation/) guide. +Once you have running Kubernetes cluster you can focus on installing **Jenkins Operator** according to the [Installation](/docs/installation/) guide. diff --git a/website/content/en/docs/Getting Started/v0.2.0/configuration.md b/website/content/en/docs/Getting Started/v0.2.0/configuration.md index 092ea4fb..77548470 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/configuration.md +++ b/website/content/en/docs/Getting Started/v0.2.0/configuration.md @@ -120,7 +120,7 @@ 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 seed jobs. You can verify if deploy keys were successfully configured in Jenkins **Credentials** tab. diff --git a/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md b/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md index 7fb75008..3686aa99 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md +++ b/website/content/en/docs/Getting Started/v0.2.0/configure-backup-and-restore.md @@ -4,7 +4,7 @@ linkTitle: "Configure backup and restore" weight: 10 date: 2019-08-05 description: > - Prevent job history loss + Prevent loss of job history --- Backup and restore is done by container sidecar. diff --git a/website/content/en/docs/Getting Started/v0.2.0/customization.md b/website/content/en/docs/Getting Started/v0.2.0/customization.md index dc5b382f..4cda5bda 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/customization.md +++ b/website/content/en/docs/Getting Started/v0.2.0/customization.md @@ -62,7 +62,7 @@ data: * *.groovy is Groovy script configuration * *.yaml is configuration as code -If you want to correct your configuration you can edit it while **jenkins-operator** is running. +If you want to correct your configuration you can edit it while **Jenkins Operator** is running. Jenkins will reconcile and apply new configuration. ### Using secrets inside Groovy script @@ -153,7 +153,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 valid **Jenkins Operator** work: ```yaml apiVersion: jenkins.io/v1alpha2 @@ -183,4 +183,4 @@ spec: You can change version of them. -Then **jenkins-operator** will automatically install plugins after Jenkins master pod restart. +Then **Jenkins Operator** will automatically install plugins after Jenkins master pod restart. diff --git a/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md b/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md index 8bc213d1..8282cae2 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md +++ b/website/content/en/docs/Getting Started/v0.2.0/diagnostics.md @@ -8,7 +8,7 @@ description: > --- -Turn on debug in **jenkins-operator** deployment: +Turn on debug in **Jenkins Operator** deployment: ```bash sed -i 's|\(args:\).*|\1\ ["--debug"\]|' deploy/operator.yaml diff --git a/website/content/en/docs/Getting Started/v0.2.0/migration.md b/website/content/en/docs/Getting Started/v0.2.0/migration.md index a07ed8fb..94e5acb0 100644 --- a/website/content/en/docs/Getting Started/v0.2.0/migration.md +++ b/website/content/en/docs/Getting Started/v0.2.0/migration.md @@ -13,7 +13,7 @@ Now seed jobs are not built by master executors, but by dedicated agent deployed ### Apply Jenkins configuration via Groovy scripts instead of Jenkins jobs We have removed hardcoded configuration by **Jenkins** jobs. -In `v0.1.1` **jenkins-operator** configuration was stored in `jenkins-operator-user-configuration- ` +In `v0.1.1` **Jenkins Operator** configuration was stored in `jenkins-operator-user-configuration- ` If you want to use `v0.2.0` or newer you must simply write refer to old ConfigMap by modifying CR, for example: ```yaml diff --git a/website/content/en/docs/How it works/architecture-and-design.md b/website/content/en/docs/How it works/architecture-and-design.md index 6b933f0c..37c9b0c3 100644 --- a/website/content/en/docs/How it works/architecture-and-design.md +++ b/website/content/en/docs/How it works/architecture-and-design.md @@ -7,7 +7,7 @@ description: > Jenkins Operator fundamentals --- -The **jenkins-operator** design incorporates the following concepts: +The **Jenkins Operator** design incorporates the following concepts: - watches any changes of manifests and maintain the desired state according to deployed custom resource manifest - implements the main reconciliation loop which consists of two smaller reconciliation loops - base and user diff --git a/website/content/en/docs/How it works/jenkins-docker-images.md b/website/content/en/docs/How it works/jenkins-docker-images.md index c938cf1b..3fa3ba83 100644 --- a/website/content/en/docs/How it works/jenkins-docker-images.md +++ b/website/content/en/docs/How it works/jenkins-docker-images.md @@ -7,5 +7,5 @@ description: > Jenkins default image details --- -**jenkins-operator** is fully compatible with **jenkins:lts** docker image and does not introduce any hidden changes there. +**Jenkins Operator** is fully compatible with **jenkins:lts** docker image and does not introduce any hidden changes there. If needed, the docker image can easily be changed in custom resource manifest as long as it supports standard Jenkins file system structure. \ No newline at end of file diff --git a/website/content/en/docs/Installation/_index.md b/website/content/en/docs/Installation/_index.md index 1b04f8da..5578af8c 100644 --- a/website/content/en/docs/Installation/_index.md +++ b/website/content/en/docs/Installation/_index.md @@ -13,7 +13,7 @@ This document describes installation procedure for jenkins-operator. All contain ## Requirements -To run **jenkins-operator**, you will need: +To run **Jenkins Operator**, you will need: - running Kubernetes cluster version 1.11+ @@ -27,7 +27,7 @@ Install Jenkins Custom Resource Definition: kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/crds/jenkins_v1alpha2_jenkins_crd.yaml ``` -## Deploy jenkins-operator +## Deploy Jenkins Operator Apply Service Account and RBAC roles: @@ -35,10 +35,10 @@ Apply Service Account and RBAC roles: kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml ``` -Watch **jenkins-operator** instance being created: +Watch **Jenkins Operator** instance being created: ```bash kubectl get pods -w ``` -Now **jenkins-operator** should be up and running in `default` namespace. +Now **Jenkins Operator** should be up and running in `default` namespace. diff --git a/website/content/en/docs/Security/_index.md b/website/content/en/docs/Security/_index.md index 83908d98..f9642c11 100644 --- a/website/content/en/docs/Security/_index.md +++ b/website/content/en/docs/Security/_index.md @@ -7,20 +7,20 @@ description: > Jenkins security and hardening out of the box --- -By default **jenkins-operator** performs an initial security hardening of Jenkins instance via groovy scripts to prevent any security gaps. +By default **Jenkins Operator** performs an initial security hardening of Jenkins instance via groovy scripts to prevent any security gaps. ## Jenkins Access Control -Currently **jenkins-operator** generates a username and random password and stores them in a Kubernetes Secret. +Currently **Jenkins Operator** generates a username and random password and stores them in a Kubernetes Secret. However any other authorization mechanisms are possible and can be done via groovy scripts or configuration as code plugin. For more information take a look at [getting-started#jenkins-customization](v0.1.1/getting-started.md#jenkins-customisation). Any change to Security Realm or Authorization requires that user called `jenkins-operator` must have admin rights -because **jenkins-operator** calls Jenkins API. +because **Jenkins Operator** calls Jenkins API. ## Jenkins Hardening -The list below describes all the default security setting configured by the **jenkins-operator**: +The list below describes all the default security setting configured by the **Jenkins Operator**: - basic settings - use `Mode.EXCLUSIVE` - Jobs must specify that they want to run on master node - enable CSRF - Cross Site Request Forgery Protection is enabled - disable usage stats - Jenkins usage stats submitting is disabled @@ -33,7 +33,7 @@ If you would like to dig a little bit into the code, take a look [here](../pkg/c ## Jenkins API -The **jenkins-operator** generates and configures Basic Authentication token for Jenkins go client and stores it in a Kubernetes Secret. +The **Jenkins Operator** generates and configures Basic Authentication token for Jenkins go client and stores it in a Kubernetes Secret. ## Kubernetes @@ -41,25 +41,25 @@ Kubernetes API permissions are limited by the following roles: - [jenkins-operator role](../deploy/role.yaml) - [Jenkins Master role](../pkg/controller/jenkins/configuration/base/resources/rbac.go) -Since **jenkins-operator** must be able to grant permission for its' deployed Jenkins masters to spawn pods (the `Jenkins Master role` above), +Since **Jenkins Operator** must be able to grant permission for its' deployed Jenkins masters to spawn pods (the `Jenkins Master role` above), the operator itself requires permission to create RBAC resources (the `jenkins-operator role` above). Deployed this way, any subject which may create a Pod (including a Jenkins job) may assume the `jenkins-operator` role by using its' ServiceAccount, create RBAC rules, and thus escape its granted permissions. Any namespace to which the `jenkins-operator` is deployed must be considered to implicitly grant all possible permissions to any subject which can create a Pod in that namespace. -To mitigate this issue **jenkins-operator** should be deployed in one namespace and the Jenkins CR should be created in separate namespace. +To mitigate this issue **Jenkins Operator** should be deployed in one namespace and the Jenkins CR should be created in separate namespace. To achieve it change watch namespace in https://github.com/jenkinsci/kubernetes-operator/blob/master/deploy/operator.yaml#L25 ## Setup Jenkins Operator and Jenkins in separated namespaces -You need to create two namespaces, for example we'll call them **jenkins** for Jenkins and **jenkins-operator** for Jenkins Operator. +You need to create two namespaces, for example we'll call them **jenkins** for Jenkins and **Jenkins Operator** for Jenkins Operator. ```bash $ kubectl create ns jenkins-operator $ kubectl create ns jenkins ``` -Next, apply the RBAC manifests for **jenkins-operator** namespace +Next, apply the RBAC manifests for **Jenkins Operator** namespace ```bash $ kubectl -n jenkins-operator apply -f deploy/service_account.yaml $ kubectl -n jenkins-operator apply -f deploy/role_binding.yaml diff --git a/website/layouts/partials/navbar.html b/website/layouts/partials/navbar.html index 21347b81..0eed944e 100644 --- a/website/layouts/partials/navbar.html +++ b/website/layouts/partials/navbar.html @@ -6,7 +6,7 @@ - - What's Jenkins Operator? + What's the Jenkins Operator?
- Documentation diff --git a/website/themes/docsy/userguide/content/en/_index.html b/website/themes/docsy/userguide/content/en/_index.html index b7069c9a..3ed6ca83 100644 --- a/website/themes/docsy/userguide/content/en/_index.html +++ b/website/themes/docsy/userguide/content/en/_index.html @@ -32,7 +32,7 @@ As well as our example site, there's a growing number of projects using Docsy fo {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}} -We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome! +We develop with **GitHub**. A new [Pull Requests](https://github.com/jenkinsci/kubernetes-operator/pulls) are more than welcome! {{% /blocks/feature %}}