diff --git a/doc/getting-started.md b/doc/getting-started.md index ca3e980b..99aa72ff 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -1,16 +1,19 @@ # Getting Started -1. [First Steps]() -2. [Deploy Jenkins]() -3. [Configure Seed Jobs and Pipelines]() -4. [Install Plugins]() -5. [Configure Authorization]() -6. [Configure Backup & Restore]() -7. [Debugging]() +This document describes a getting started guide for Jenkins operator and an additional configuration. + +1. [First Steps](#first-steps) +2. [Deploy Jenkins](#deploy-jenkins) +3. [Configure Seed Jobs and Pipelines](#configure-seed-jobs-and-pipelines) +4. [Install Plugins](#install-plugins) +5. [Configure Authorization](#configure-authorization) +6. [Configure Backup & Restore](#configure-backup-&-restore) +7. [Debugging](#debugging) ## 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 diff --git a/doc/how-it-works.md b/doc/how-it-works.md index d8738374..066e92f7 100644 --- a/doc/how-it-works.md +++ b/doc/how-it-works.md @@ -2,6 +2,10 @@ 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 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 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: - do not block reconciliation loop