From fc7c75a8ca2e2cae04feee9b721b0fd66567e6fc Mon Sep 17 00:00:00 2001 From: Jakub Mikusek Date: Thu, 17 Jan 2019 11:17:00 +0100 Subject: [PATCH] Update docs --- README.md | 4 ++-- docs/how-it-works.md | 4 ++-- docs/security.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1a13c74c..2232e28a 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ ## What's Jenkins Operator? -Jenkins operator it's a Kubernetes native operator which fully manages Jenkins on Kubernetes. +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. -It provides out of the box: +Out of the box it provides: - integration with Kubernetes - pipelines as code - extensibility via groovy scripts or configuration as code plugin diff --git a/docs/how-it-works.md b/docs/how-it-works.md index 6c13f995..02a52cd5 100644 --- a/docs/how-it-works.md +++ b/docs/how-it-works.md @@ -48,5 +48,5 @@ Main assumptions are: ## Jenkins Docker Images -**jenkins-operator** is fully compatible with **jenkins:lts** docker image and does not introduce and hidden changes there. -In case of need docker image can be easily changed in custom resource manifest as long as it supports standard Jenkins file system structure. +**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/docs/security.md b/docs/security.md index 743ee3c8..d4fb742e 100644 --- a/docs/security.md +++ b/docs/security.md @@ -5,7 +5,7 @@ By default **jenkins-operator** performs an initial security hardening of Jenkin ## Jenkins Access Control Currently **jenkins-operator** generates a username and random password and stores them in a Kubernetes Secret. -However any other authorization mechanisms are possible an can be done via groovy scripts or configuration as code plugin. +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](getting-started.md#jenkins-customisation). ## Jenkins Hardening @@ -27,7 +27,7 @@ The **jenkins-operator** generates and configures Basic Authentication token for ## Kubernetes -Kubernetes API permissions are limited by the following RBAC roles: +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)