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

Update how-it-works.md and getting-started.md

This commit is contained in:
antoniaklja 2019-01-05 20:42:41 +01:00
parent 5164fbc3e4
commit f7456ea8ce
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/getting-started.md
View File

@ -1,16 +1,19 @@
# Getting Started # Getting Started
1. [First Steps]() This document describes a getting started guide for Jenkins operator and an additional configuration.
2. [Deploy Jenkins]()
3. [Configure Seed Jobs and Pipelines]() 1. [First Steps](#first-steps)
4. [Install Plugins]() 2. [Deploy Jenkins](#deploy-jenkins)
5. [Configure Authorization]() 3. [Configure Seed Jobs and Pipelines](#configure-seed-jobs-and-pipelines)
6. [Configure Backup & Restore]() 4. [Install Plugins](#install-plugins)
7. [Debugging]() 5. [Configure Authorization](#configure-authorization)
6. [Configure Backup & Restore](#configure-backup-&-restore)
7. [Debugging](#debugging)
## First Steps ## First Steps
// TODO install operator etc. 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.
## Deploy Jenkins ## Deploy Jenkins

6
doc/how-it-works.md
View File

@ -2,6 +2,10 @@
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)
3. [System Jenkins Jobs](#system-jenkins-jobs)
## Architecture and design ## Architecture and design
The Jenkins operator design incorporates the following concepts: The Jenkins operator design incorporates the following concepts:
@ -32,7 +36,7 @@ It helps to maintain or recover desired state even after operator or Jenkins res
## System Jenkins Jobs ## System Jenkins Jobs
The operator or Jenkins instance can be restarted at any time and any operation should not block the reconciliation loop so we implemented The operator or Jenkins instance can be restarted at any time and any operation should not block the reconciliation loop so we implemented
custom jobs API for executing and verifying status of them according to operator lifecycle. custom jobs API for executing system jobs (seed jobs, groovy scripts, etc.) according to the operator lifecycle.
Main assumptions are: Main assumptions are:
- do not block reconciliation loop - do not block reconciliation loop