diff --git a/website/content/en/docs/Getting Started/v0.1.1/scheme.md b/website/content/en/docs/Getting Started/v0.1.1/scheme.md index 4bf11afd..fc5c3591 100644 --- a/website/content/en/docs/Getting Started/v0.1.1/scheme.md +++ b/website/content/en/docs/Getting Started/v0.1.1/scheme.md @@ -19,7 +19,7 @@ This document contains API scheme for `jenkins-operator` manifest
-
Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group
+Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group
Resource Types:SeedJobs defines list of Jenkins Seed Job configurations +
SeedJobs defines a list of Jenkins Seed Job configurations More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines
Service is Kubernetes service of Jenkins master HTTP pod +
Service is the Kubernetes service of the Jenkins master HTTP pod Defaults to : port: 8080 type: ClusterIP
@@ -140,7 +140,7 @@ ServiceService is Kubernetes service of Jenkins slave pods +
Service is the Kubernetes service of the Jenkins slave pods Defaults to : port: 50000 type: ClusterIP
@@ -157,7 +157,7 @@ BackupBackup defines configuration of Jenkins backup +
Backup defines the configuration of a Jenkins backup More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore
Backup defines configuration of Jenkins backup restore +
Backup defines the configuration of a Jenkins backup restore More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore
-
Backup defines configuration of Jenkins backup
+Backup defines the configuration of Jenkins backup
| - Action defines action which performs backup in backup container sidecar+ Action defines the action which performs the backup in the backup container sidecar | |||||||||||||||||||||
| - Interval tells how often make backup in seconds + Interval tells you how often the backup is made in seconds Defaults to 30. | - @@ -267,7 +267,7 @@ bool
 JenkinsStatus)MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion+ MakeBackupBeforePodDeletion tells the operator to make a backup before Jenkins master pod deletion | 
| - Status is the status of Jenkins build+ Status is the status of a Jenkins build | |||||||||||||||||||||
| - Retires is the amount of Jenkins job build retries+ Retires is the amount of times a Jenkins job build retries | |||||||||||||||||||||
| (Optional) Periodic probe of container liveness. -Container will be restarted if the probe fails.+The container will be restarted if the probe fails. | |
| (Optional) Periodic probe of container service readiness. -Container will be removed from service endpoints if the probe fails.+The container will be removed from service endpoints if the probe fails. | |
| - Master represents Jenkins master pod properties and Jenkins plugins. + Master represents the Jenkins master pod properties and Jenkins plugins. Every single change here requires a pod restart. | (Optional)
- Service is Kubernetes service of Jenkins master HTTP pod + Service is the Kubernetes service of the Jenkins master HTTP pod Defaults to : port: 8080 type: ClusterIP@@ -907,7 +907,7 @@ Service | (Optional)
- Service is Kubernetes service of Jenkins slave pods + Service is the Kubernetes service of the Jenkins slave pods Defaults to : port: 50000 type: ClusterIP@@ -924,7 +924,7 @@ Backup | (Optional)
- @@ -939,7 +939,7 @@ RestoreBackup defines configuration of Jenkins backup + Backup defines the configuration of the Jenkins backup More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore | (Optional)
- @@ -985,7 +985,7 @@ Kubernetes meta/v1.TimeBackup defines configuration of Jenkins backup restore + Backup defines the configuration of the Jenkins backup restore More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore | (Optional)
- ProvisionStartTime is a time when Jenkins master pod has been created+ ProvisionStartTime is a time when the Jenkins master pod has been created | 
| (Optional)
- Builds contains Jenkins builds statues+ Builds contains the Jenkins builds statues | |
| (Optional)
- RestoredBackup is the restored backup number after Jenkins master pod restart+ RestoredBackup is the restored backup number after the Jenkins master pod restart | |
| (Optional)
- BackupDoneBeforePodDeletion tells if backup before pod deletion has been made+ BackupDoneBeforePodDeletion tells if a backup before pod deletion has been made | |
| (Optional)
- UserAndPasswordHash is a SHA256 hash made from user and password+ UserAndPasswordHash is a SHA256 hash made from the username and password | |
| (Optional)
- CreatedSeedJobs contains list of seed job id already created in Jenkins+ CreatedSeedJobs contains list of seed job ids already created in Jenkins | - Name is the name of Jenkins plugin+ Name is the name of the Jenkins plugin | 
| - Version is the version of Jenkins plugin+ Version is the version of the Jenkins plugin | 
| - ContainerName is the container name responsible for restore backup operation+ ContainerName is the container name responsible for the restore backup operation | |
| - Action defines action which performs restore backup in restore container sidecar+ Action defines action which performs the restore backup in a restore container sidecar | |
| (Optional)
- RecoveryOnce if want to restore specific backup set this field and then Jenkins will be restarted and desired backup will be restored+ RecoveryOnce if you want to restore a specific backup, set this field, and then Jenkins will be restarted and the desired backup will be restored | - Targets is the repository path where are seed job definitions+ Targets is the repository path where the seed job definitions are | 
| - RepositoryBranch is the repository branch where are seed job definitions+ RepositoryBranch is the repository branch where the seed job definitions are | |
| - @@ -1398,8 +1398,8 @@ int32The port that are exposed by this service. + The port that is exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies | (Optional) @@ -1413,8 +1413,8 @@ More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/The port on each node on which this service is exposed when type=NodePort or LoadBalancer. -Usually assigned by the system. If specified, it will be allocated to the service -if unused or else creation of the service will fail. +Usually assigned by the system. If specified, it will be allocated to the service, +if unused, or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport |