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

Add a bit of extra words to make complete sentences

This commit is contained in:
Jon Brohauge 2019-10-16 20:14:48 +02:00
parent 3a6c6b9fb0
commit 5d01ca0b9b
No known key found for this signature in database
GPG Key ID: 2402404D1764DBE8
1 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
website/content/en/docs/Getting Started/v0.1.1/scheme.md
View File

@ -19,7 +19,7 @@ This document contains API scheme for `jenkins-operator` manifest
</ul> </ul>
<h2 id="jenkins.io">jenkins.io</h2> <h2 id="jenkins.io">jenkins.io</h2>
<p> <p>
<p>Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group</p> <p>Package v1alpha2 contains the API Schema definitions for the jenkins.io v1alpha2 API group</p>
</p> </p>
Resource Types: Resource Types:
<ul><li> <ul><li>
@ -108,7 +108,7 @@ Every single change here requires a pod restart.</p>
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>SeedJobs defines list of Jenkins Seed Job configurations <p>SeedJobs defines a list of Jenkins Seed Job configurations
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p> More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-seed-jobs-and-pipelines</a></p>
</td> </td>
</tr> </tr>
@ -123,7 +123,7 @@ Service
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Service is Kubernetes service of Jenkins master HTTP pod <p>Service is the Kubernetes service of the Jenkins master HTTP pod
Defaults to : Defaults to :
port: 8080 port: 8080
type: ClusterIP</p> type: ClusterIP</p>
@ -140,7 +140,7 @@ Service
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Service is Kubernetes service of Jenkins slave pods <p>Service is the Kubernetes service of the Jenkins slave pods
Defaults to : Defaults to :
port: 50000 port: 50000
type: ClusterIP</p> type: ClusterIP</p>
@ -157,7 +157,7 @@ Backup
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Backup defines configuration of Jenkins backup <p>Backup defines the configuration of a Jenkins backup
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p> More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
</td> </td>
</tr> </tr>
@ -172,7 +172,7 @@ Restore
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Backup defines configuration of Jenkins backup restore <p>Backup defines the configuration of a Jenkins backup restore
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p> More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
</td> </td>
</tr> </tr>
@ -201,7 +201,7 @@ JenkinsStatus
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
</p> </p>
<p> <p>
<p>Backup defines configuration of Jenkins backup</p> <p>Backup defines the configuration of Jenkins backup</p>
</p> </p>
<table> <table>
<thead> <thead>
@ -232,7 +232,7 @@ Handler
</em> </em>
</td> </td>
<td> <td>
<p>Action defines action which performs backup in backup container sidecar</p> <p>Action defines the action which performs the backup in the backup container sidecar</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -243,7 +243,7 @@ uint64
</em> </em>
</td> </td>
<td> <td>
<p>Interval tells how often make backup in seconds <p>Interval tells you how often the backup is made in seconds
Defaults to 30.</p> Defaults to 30.</p>
</td> </td>
</tr> </tr>
@ -255,7 +255,7 @@ bool
</em> </em>
</td> </td>
<td> <td>
<p>MakeBackupBeforePodDeletion tells operator to make backup before Jenkins master pod deletion</p> <p>MakeBackupBeforePodDeletion tells the operator to make a backup before Jenkins master pod deletion</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -267,7 +267,7 @@ bool
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsStatus">JenkinsStatus</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsStatus">JenkinsStatus</a>)
</p> </p>
<p> <p>
<p>Build defines Jenkins Build status with corresponding metadata</p> <p>Build defines the Jenkins Build status with corresponding metadata</p>
</p> </p>
<table> <table>
<thead> <thead>
@ -320,7 +320,7 @@ BuildStatus
</em> </em>
</td> </td>
<td> <td>
<p>Status is the status of Jenkins build</p> <p>Status is the status of a Jenkins build</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -331,7 +331,7 @@ int
</em> </em>
</td> </td>
<td> <td>
<p>Retires is the amount of Jenkins job build retries</p> <p>Retires is the amount of times a Jenkins job build retries</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -369,7 +369,7 @@ Kubernetes meta/v1.Time
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Build">Build</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.Build">Build</a>)
</p> </p>
<p> <p>
<p>BuildStatus defines type of Jenkins build job status</p> <p>BuildStatus defines the type of Jenkins build job status</p>
</p> </p>
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Container">Container <h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Container">Container
</h3> </h3>
@ -378,7 +378,7 @@ Kubernetes meta/v1.Time
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsMaster">JenkinsMaster</a>)
</p> </p>
<p> <p>
<p>Container defines Kubernetes container attributes</p> <p>Container defines the Kubernetes container attributes</p>
</p> </p>
<table> <table>
<thead> <thead>
@ -568,7 +568,7 @@ Kubernetes core/v1.Probe
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Periodic probe of container liveness. <p>Periodic probe of container liveness.
Container will be restarted if the probe fails.</p> The container will be restarted if the probe fails.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -583,7 +583,7 @@ Kubernetes core/v1.Probe
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Periodic probe of container service readiness. <p>Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.</p> The container will be removed from service endpoints if the probe fails.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -658,7 +658,7 @@ Kubernetes core/v1.ExecAction
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.SeedJob">SeedJob</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.SeedJob">SeedJob</a>)
</p> </p>
<p> <p>
<p>JenkinsCredentialType defines type of Jenkins credential used to seed job mechanism</p> <p>JenkinsCredentialType defines type of Jenkins credential used in the seed job mechanism</p>
</p> </p>
<h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">JenkinsMaster <h3 id="github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.JenkinsMaster">JenkinsMaster
</h3> </h3>
@ -860,7 +860,7 @@ JenkinsMaster
</em> </em>
</td> </td>
<td> <td>
<p>Master represents Jenkins master pod properties and Jenkins plugins. <p>Master represents the Jenkins master pod properties and Jenkins plugins.
Every single change here requires a pod restart.</p> Every single change here requires a pod restart.</p>
</td> </td>
</tr> </tr>
@ -890,7 +890,7 @@ Service
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Service is Kubernetes service of Jenkins master HTTP pod <p>Service is the Kubernetes service of the Jenkins master HTTP pod
Defaults to : Defaults to :
port: 8080 port: 8080
type: ClusterIP</p> type: ClusterIP</p>
@ -907,7 +907,7 @@ Service
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Service is Kubernetes service of Jenkins slave pods <p>Service is the Kubernetes service of the Jenkins slave pods
Defaults to : Defaults to :
port: 50000 port: 50000
type: ClusterIP</p> type: ClusterIP</p>
@ -924,7 +924,7 @@ Backup
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Backup defines configuration of Jenkins backup <p>Backup defines the configuration of the Jenkins backup
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p> More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
</td> </td>
</tr> </tr>
@ -939,7 +939,7 @@ Restore
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Backup defines configuration of Jenkins backup restore <p>Backup defines the configuration of the Jenkins backup restore
More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p> More info: <a href="https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore">https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore</a></p>
</td> </td>
</tr> </tr>
@ -985,7 +985,7 @@ Kubernetes meta/v1.Time
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>ProvisionStartTime is a time when Jenkins master pod has been created</p> <p>ProvisionStartTime is a time when the Jenkins master pod has been created</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1027,7 +1027,7 @@ Kubernetes meta/v1.Time
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>Builds contains Jenkins builds statues</p> <p>Builds contains the Jenkins builds statues</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1039,7 +1039,7 @@ uint64
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>RestoredBackup is the restored backup number after Jenkins master pod restart</p> <p>RestoredBackup is the restored backup number after the Jenkins master pod restart</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1075,7 +1075,7 @@ bool
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>BackupDoneBeforePodDeletion tells if backup before pod deletion has been made</p> <p>BackupDoneBeforePodDeletion tells if a backup before pod deletion has been made</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1087,7 +1087,7 @@ string
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>UserAndPasswordHash is a SHA256 hash made from user and password</p> <p>UserAndPasswordHash is a SHA256 hash made from the username and password</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1099,7 +1099,7 @@ string
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>CreatedSeedJobs contains list of seed job id already created in Jenkins</p> <p>CreatedSeedJobs contains list of seed job ids already created in Jenkins</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -1129,7 +1129,7 @@ string
</em> </em>
</td> </td>
<td> <td>
<p>Name is the name of Jenkins plugin</p> <p>Name is the name of the Jenkins plugin</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1140,7 +1140,7 @@ string
</em> </em>
</td> </td>
<td> <td>
<p>Version is the version of Jenkins plugin</p> <p>Version is the version of the Jenkins plugin</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -1152,7 +1152,7 @@ string
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
</p> </p>
<p> <p>
<p>Restore defines configuration of Jenkins backup restore operation</p> <p>Restore defines the configuration of a Jenkins backup restore operation</p>
</p> </p>
<table> <table>
<thead> <thead>
@ -1170,7 +1170,7 @@ string
</em> </em>
</td> </td>
<td> <td>
<p>ContainerName is the container name responsible for restore backup operation</p> <p>ContainerName is the container name responsible for the restore backup operation</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1183,7 +1183,7 @@ Handler
</em> </em>
</td> </td>
<td> <td>
<p>Action defines action which performs restore backup in restore container sidecar</p> <p>Action defines action which performs the restore backup in a restore container sidecar</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1195,7 +1195,7 @@ uint64
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>RecoveryOnce if want to restore specific backup set this field and then Jenkins will be restarted and desired backup will be restored</p> <p>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</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -1260,7 +1260,7 @@ string
</em> </em>
</td> </td>
<td> <td>
<p>Targets is the repository path where are seed job definitions</p> <p>Targets is the repository path where the seed job definitions are</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1271,7 +1271,7 @@ string
</em> </em>
</td> </td>
<td> <td>
<p>RepositoryBranch is the repository branch where are seed job definitions</p> <p>RepositoryBranch is the repository branch where the seed job definitions are</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1308,7 +1308,7 @@ JenkinsCredentialType
<a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>) <a href="#github.com%2fjenkinsci%2fkubernetes-operator%2fpkg%2fapis%2fjenkins%2fv1alpha2.JenkinsSpec">JenkinsSpec</a>)
</p> </p>
<p> <p>
<p>Service defines Kubernetes service attributes</p> <p>Service defines the Kubernetes service attributes</p>
</p> </p>
<table> <table>
<thead> <thead>
@ -1384,7 +1384,7 @@ int32
</em> </em>
</td> </td>
<td> <td>
<p>The port that are exposed by this service. <p>The port that is exposed by this service.
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a></p> More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a></p>
</td> </td>
</tr> </tr>
@ -1398,8 +1398,8 @@ int32
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>The port on each node on which this service is exposed when type=NodePort or LoadBalancer. <p>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 Usually assigned by the system. If specified, it will be allocated to the service,
if unused or else creation of the service will fail. 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. Default is to auto-allocate a port if the ServiceType of this Service requires one.
More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport</a></p> More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport</a></p>
</td> </td>
@ -1413,8 +1413,8 @@ More info: <a href="https://kubernetes.io/docs/concepts/services-networking/serv
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>If specified and supported by the platform, this will restrict traffic through the cloud-provider <p>If specified and supported by the platform, this will restrict traffic through the cloud-provider.
load-balancer will be restricted to the specified client IPs. This field will be ignored if the The load-balancer will be restricted to the specified client IPs. This field will be ignored if the
cloud-provider does not support the feature.&rdquo; cloud-provider does not support the feature.&rdquo;
More info: <a href="https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/">https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/</a></p> More info: <a href="https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/">https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/</a></p>
</td> </td>