Commit 6e0aa36e authored by Edmund Ochieng's avatar Edmund Ochieng

update kubectl explain output for runner

parent f38e7235
......@@ -22,23 +22,26 @@ import (
// RunnerSpec defines the desired state of Runner
type RunnerSpec struct {
// GitlabResource represents a Gitlab custom resource. Should
// only be used to reference Gitlab instance created by the operator
Gitlab GitlabInstanceSpec `json:"gitlab,omitempty"`
// gitlab specifies the GitLab instance the GitLab Runner
// will register against
Gitlab GitlabInstanceSpec `json:"gitlab"`
//Name of secret containing the runner-registration-token key used to register the runner
//Name of secret containing the 'runner-registration-token' key used to register the runner
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Registration Token",xDescriptors="urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret"
RegistrationToken string `json:"token,omitempty"`
// List of comma separated tags to be applied to the runner
// More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Tags",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
Tags string `json:"tags,omitempty"`
// Concurrent limits the number of jobs globally that can run concurrently
// Option to limit the number of jobs globally that can run concurrently.
// The operator sets this to 10, if not specified
// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Concurrent",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
Concurrent *int32 `json:"concurrent,omitempty"`
// CheckInterval defines the number of seconds between checks for new jobs
// Option to define the number of seconds between checks for new jobs.
// This is set to a default of 30s by operator if not set
// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Check Interval",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
CheckInterval *int32 `json:"interval,omitempty"`
......@@ -52,7 +55,8 @@ type GitlabInstanceSpec struct {
// Name of GitLab instance created by the operator
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Instance Name",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
Name string `json:"name,omitempty"`
// URL of GitLab instance
// The fully qualified domain name of the address used to access the GitLab instance.
// For example, gitlab.example.com
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Instance URL",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
URL string `json:"url,omitempty"`
}
......@@ -67,6 +71,7 @@ type RunnerCacheSpec struct {
Region string `json:"region,omitempty"`
// Credentials is the name of the secret containing the
// 'accesskey' and 'secretkey' used to access the object storage
Credentials string `json:"credentials,omitempty"`
// Insecure enables use of HTTP protocol
......@@ -95,12 +100,15 @@ type RunnerStatus struct {
// +operator-sdk:csv:customresourcedefinitions:displayName="GitLab Runner"
// +operator-sdk:csv:customresourcedefinitions:resources={{ConfigMap,v1,""},{Secret,v1,""},{Service,v1,""},{Replicasets,v1,""},{Pod,v1,""},{Deployment,v1,""},{PersistentVolumeClaim,v1,""}}
// Runner is the Schema for the runners API
// Runner is the open source project used to run your jobs and send the results back to GitLab
type Runner struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RunnerSpec `json:"spec,omitempty"`
// Specification of the desired behavior of a GitLab Runner instance
Spec RunnerSpec `json:"spec,omitempty"`
// Most recently observed status of the GitLab Runner.
// It is read-only to the user
Status RunnerStatus `json:"status,omitempty"`
}
......
......@@ -18,7 +18,7 @@ spec:
status: {}
validation:
openAPIV3Schema:
description: Runner is the Schema for the runners API
description: Runner is the open source project used to run your jobs and send the results back to GitLab
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
......@@ -29,7 +29,7 @@ spec:
metadata:
type: object
spec:
description: RunnerSpec defines the desired state of Runner
description: Specification of the desired behavior of a GitLab Runner instance
properties:
cache:
description: Cache defines an S3 compatible object store
......@@ -38,7 +38,7 @@ spec:
description: Bucket defines the s3 bucket name
type: string
credentials:
description: Credentials is the name of the secret containing the
description: Credentials is the name of the secret containing the 'accesskey' and 'secretkey' used to access the object storage
type: string
insecure:
description: Insecure enables use of HTTP protocol
......@@ -54,32 +54,34 @@ spec:
type: string
type: object
concurrent:
description: Concurrent limits the number of jobs globally that can run concurrently
description: Option to limit the number of jobs globally that can run concurrently. The operator sets this to 10, if not specified
format: int32
type: integer
gitlab:
description: GitlabResource represents a Gitlab custom resource. Should only be used to reference Gitlab instance created by the operator
description: gitlab specifies the GitLab instance the GitLab Runner will register against
properties:
name:
description: Name of GitLab instance created by the operator
type: string
url:
description: URL of GitLab instance
description: The fully qualified domain name of the address used to access the GitLab instance. For example, gitlab.example.com
type: string
type: object
interval:
description: CheckInterval defines the number of seconds between checks for new jobs
description: Option to define the number of seconds between checks for new jobs. This is set to a default of 30s by operator if not set
format: int32
type: integer
tags:
description: List of comma separated tags to be applied to the runner
description: 'List of comma separated tags to be applied to the runner More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner'
type: string
token:
description: Name of secret containing the runner-registration-token key used to register the runner
description: Name of secret containing the 'runner-registration-token' key used to register the runner
type: string
required:
- gitlab
type: object
status:
description: RunnerStatus defines the observed state of Runner
description: Most recently observed status of the GitLab Runner. It is read-only to the user
properties:
phase:
description: Reports status of the GitLab Runner instance
......
......@@ -234,7 +234,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
version: v1beta1
- description: Runner is the Schema for the runners API
- description: Runner is the open source project used to run your jobs and send the results back to GitLab
displayName: GitLab Runner
kind: Runner
name: runners.apps.gitlab.com
......@@ -266,17 +266,17 @@ spec:
path: gitlab.name
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: URL of GitLab instance
- description: The fully qualified domain name of the address used to access the GitLab instance. For example, gitlab.example.com
displayName: Instance URL
path: gitlab.url
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: List of comma separated tags to be applied to the runner
- description: 'List of comma separated tags to be applied to the runner More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner'
displayName: Tags
path: tags
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of secret containing the runner-registration-token key used to register the runner
- description: Name of secret containing the 'runner-registration-token' key used to register the runner
displayName: Registration Token
path: token
x-descriptors:
......
......@@ -19,7 +19,8 @@ spec:
status: {}
validation:
openAPIV3Schema:
description: Runner is the Schema for the runners API
description: Runner is the open source project used to run your jobs and send
the results back to GitLab
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
......@@ -34,7 +35,7 @@ spec:
metadata:
type: object
spec:
description: RunnerSpec defines the desired state of Runner
description: Specification of the desired behavior of a GitLab Runner instance
properties:
cache:
description: Cache defines an S3 compatible object store
......@@ -44,6 +45,7 @@ spec:
type: string
credentials:
description: Credentials is the name of the secret containing the
'accesskey' and 'secretkey' used to access the object storage
type: string
insecure:
description: Insecure enables use of HTTP protocol
......@@ -59,36 +61,41 @@ spec:
type: string
type: object
concurrent:
description: Concurrent limits the number of jobs globally that can
run concurrently
description: Option to limit the number of jobs globally that can run
concurrently. The operator sets this to 10, if not specified
format: int32
type: integer
gitlab:
description: GitlabResource represents a Gitlab custom resource. Should
only be used to reference Gitlab instance created by the operator
description: gitlab specifies the GitLab instance the GitLab Runner
will register against
properties:
name:
description: Name of GitLab instance created by the operator
type: string
url:
description: URL of GitLab instance
description: The fully qualified domain name of the address used
to access the GitLab instance. For example, gitlab.example.com
type: string
type: object
interval:
description: CheckInterval defines the number of seconds between checks
for new jobs
description: Option to define the number of seconds between checks for
new jobs. This is set to a default of 30s by operator if not set
format: int32
type: integer
tags:
description: List of comma separated tags to be applied to the runner
description: 'List of comma separated tags to be applied to the runner
More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner'
type: string
token:
description: Name of secret containing the runner-registration-token
description: Name of secret containing the 'runner-registration-token'
key used to register the runner
type: string
required:
- gitlab
type: object
status:
description: RunnerStatus defines the observed state of Runner
description: Most recently observed status of the GitLab Runner. It is read-only
to the user
properties:
phase:
description: Reports status of the GitLab Runner instance
......
......@@ -230,7 +230,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
version: v1beta1
- description: Runner is the Schema for the runners API
- description: Runner is the open source project used to run your jobs and send the results back to GitLab
displayName: GitLab Runner
kind: Runner
name: runners.apps.gitlab.com
......@@ -262,17 +262,17 @@ spec:
path: gitlab.name
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: URL of GitLab instance
- description: The fully qualified domain name of the address used to access the GitLab instance. For example, gitlab.example.com
displayName: Instance URL
path: gitlab.url
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: List of comma separated tags to be applied to the runner
- description: 'List of comma separated tags to be applied to the runner More info: https://docs.gitlab.com/ee/ci/runners/#use-tags-to-limit-the-number-of-jobs-using-the-runner'
displayName: Tags
path: tags
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of secret containing the runner-registration-token key used to register the runner
- description: Name of secret containing the 'runner-registration-token' key used to register the runner
displayName: Registration Token
path: token
x-descriptors:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment