Commit f38e7235 authored by Edmund Ochieng's avatar Edmund Ochieng

update kubectl explain output for GitLab resource

parent af0f639d
......@@ -27,21 +27,32 @@ type GitLabSpec struct {
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Release",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
Release string `json:"release,omitempty"`
// The URL through which to access GitLab instance
// The fully qualified domain name used to access the GitLab instance.
// For example: gitlab.example.com
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="GitLab URL",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
URL string `json:"url,omitempty"`
// Name of tls secret used to secure the GitLab instance
// Name of tls secret used to secure the GitLab instance URL
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="TLS Certificate",xDescriptors="urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret"
TLS string `json:"tls,omitempty"`
SMTP SMTPConfiguration `json:"smtp,omitempty"`
Registry RegistrySpec `json:"registry,omitempty"`
ObjectStore ObjectStoreSpec `json:"objectStore,omitempty"`
Redis *RedisSpec `json:"redis,omitempty"`
Database *DatabaseSpec `json:"postgres,omitempty"`
CertIssuer *ACMEOptions `json:"acme,omitempty"`
TLS string `json:"tls,omitempty"`
// If specified, SMTP provides the details of the email server
// used by GitLab to send outgoing email
SMTP SMTPConfiguration `json:"smtp,omitempty"`
// Options used to setup the GitLab Registry
Registry RegistrySpec `json:"registry,omitempty"`
// The parameters for the object storage used to store GitLab artifacts
ObjectStore ObjectStoreSpec `json:"objectStore,omitempty"`
// If specified, the Redis options override the default behavior of the
// Redis key-value store deployed by the operator
Redis *RedisSpec `json:"redis,omitempty"`
// If specified, overrides the default behavior of the Postgresql
// database deployed by the operator
Database *DatabaseSpec `json:"postgres,omitempty"`
// If specified, the options used by Cert-Manager to generate certificates.
// More info: https://cert-manager.io/docs/configuration/acme/
CertIssuer *ACMEOptions `json:"acme,omitempty"`
// Volume for Gitaly statefulset
Volume VolumeSpec `json:"volume,omitempty"`
Volume VolumeSpec `json:"volume,omitempty"`
// If specified, defines the parameters used when autoscaling GitLab resources
AutoScaling *AutoScalingSpec `json:"autoscaling,omitempty"`
}
......@@ -64,7 +75,7 @@ type RegistrySpec struct {
TLS string `json:"tls,omitempty"`
}
// ObjectStoreSpec defines options for Gitlab registry
// ObjectStoreSpec defines options for GitLab registry
type ObjectStoreSpec struct {
// Development will result in a minio deployment being
// created for testing /development purposes
......@@ -125,7 +136,7 @@ type AutoScalingSpec struct {
// Maximum number of replicas to scale to
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Maxiumum Replicas",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
MaxReplicas int32 `json:"maxReplicas,omitempty"`
// Percentage CPU mark at which autoscaling triggers
// Percentage CPU of the requested CPU resources at which autoscaling triggers
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="CPU Percentage Threshold",xDescriptors="urn:alm:descriptor:com.tectonic.ui:text"
TargetCPU *int32 `json:"targetCPU,omitempty"`
}
......@@ -193,12 +204,15 @@ type GitLabStatus struct {
// +operator-sdk:csv:customresourcedefinitions:displayName="GitLab"
// +operator-sdk:csv:customresourcedefinitions:resources={{ConfigMap,v1,""},{Secret,v1,""},{Service,v1,""},{Pod,v1,""},{Deployment,v1,""},{StatefulSet,v1,""},{PersistentVolumeClaim,v1,""},{Runner,v1beta1,""},{GLBackup,v1beta1,""}}
// GitLab is the Schema for the gitlabs API
// GitLab is a complete DevOps platform, delivered in a single application
type GitLab struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec GitLabSpec `json:"spec,omitempty"`
// Specification of the desired behavior of a GitLab instance
Spec GitLabSpec `json:"spec,omitempty"`
// Most recently observed status of the GitLab instance.
// It is read-only to the user
Status GitLabStatus `json:"status,omitempty"`
}
......
......@@ -33,7 +33,7 @@ spec:
status: {}
validation:
openAPIV3Schema:
description: GitLab is the Schema for the gitlabs API
description: GitLab is a complete DevOps platform, delivered in a single application
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'
......@@ -44,10 +44,10 @@ spec:
metadata:
type: object
spec:
description: GitLabSpec defines the desired state of GitLab
description: Specification of the desired behavior of a GitLab instance
properties:
acme:
description: ACMEOptions defines the values for the ACME service that will provide certificates
description: 'If specified, the options used by Cert-Manager to generate certificates. More info: https://cert-manager.io/docs/configuration/acme/'
properties:
email:
description: Email is the email for this account
......@@ -803,7 +803,7 @@ spec:
type: array
type: object
autoscaling:
description: AutoScalingSpec are the parameters to configure autoscaling
description: If specified, defines the parameters used when autoscaling GitLab resources
properties:
maxReplicas:
description: Maximum number of replicas to scale to
......@@ -814,12 +814,12 @@ spec:
format: int32
type: integer
targetCPU:
description: Percentage CPU mark at which autoscaling triggers
description: Percentage CPU of the requested CPU resources at which autoscaling triggers
format: int32
type: integer
type: object
objectStore:
description: ObjectStoreSpec defines options for Gitlab registry
description: The parameters for the object storage used to store GitLab artifacts
properties:
credentials:
description: Credentials contains the name of the secret that contains the `accesskey` and `secretkey` values required to access an existing minio instance. Should be an even number equal to or larger than four
......@@ -835,7 +835,7 @@ spec:
type: string
type: object
postgres:
description: DatabaseSpec defines database options
description: If specified, overrides the default behavior of the Postgresql database deployed by the operator
properties:
replicas:
format: int32
......@@ -852,7 +852,7 @@ spec:
type: object
type: object
redis:
description: RedisSpec defines Redis options
description: If specified, the Redis options override the default behavior of the Redis key-value store deployed by the operator
properties:
replicas:
format: int32
......@@ -869,7 +869,7 @@ spec:
type: object
type: object
registry:
description: RegistrySpec defines options for GitLab registry
description: Options used to setup the GitLab Registry
properties:
disable:
type: boolean
......@@ -882,7 +882,7 @@ spec:
description: The GitLab version to deploy
type: string
smtp:
description: 'SMTPConfiguration defines options for Gitlab registry More on configuration options available below: https://docs.gitlab.com/omnibus/settings/smtp.html'
description: If specified, SMTP provides the details of the email server used by GitLab to send outgoing email
properties:
authentication:
description: 'Authentication represents authentication mechanism Options include: login, plain, cram_md5'
......@@ -923,10 +923,10 @@ spec:
type: string
type: object
tls:
description: Name of tls secret used to secure the GitLab instance
description: Name of tls secret used to secure the GitLab instance URL
type: string
url:
description: The URL through which to access GitLab instance
description: 'The fully qualified domain name used to access the GitLab instance. For example: gitlab.example.com'
type: string
volume:
description: Volume for Gitaly statefulset
......@@ -940,7 +940,7 @@ spec:
type: object
type: object
status:
description: GitLabStatus defines the observed state of GitLab
description: Most recently observed status of the GitLab instance. It is read-only to the user
properties:
health:
description: HealthCheck represents the status of services that make up Gitlab
......
......@@ -78,7 +78,7 @@ spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- description: GitLab is the Schema for the gitlabs API
- description: GitLab is a complete DevOps platform, delivered in a single application
displayName: GitLab
kind: GitLab
name: gitlabs.apps.gitlab.com
......@@ -121,7 +121,7 @@ spec:
path: autoscaling.minReplicas
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Percentage CPU mark at which autoscaling triggers
- description: Percentage CPU of the requested CPU resources at which autoscaling triggers
displayName: CPU Percentage Threshold
path: autoscaling.targetCPU
x-descriptors:
......@@ -151,12 +151,12 @@ spec:
path: release
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of tls secret used to secure the GitLab instance
- description: Name of tls secret used to secure the GitLab instance URL
displayName: TLS Certificate
path: tls
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret
- description: The URL through which to access GitLab instance
- description: 'The fully qualified domain name used to access the GitLab instance. For example: gitlab.example.com'
displayName: GitLab URL
path: url
x-descriptors:
......
......@@ -34,7 +34,7 @@ spec:
status: {}
validation:
openAPIV3Schema:
description: GitLab is the Schema for the gitlabs API
description: GitLab is a complete DevOps platform, delivered in a single application
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
......@@ -49,11 +49,11 @@ spec:
metadata:
type: object
spec:
description: GitLabSpec defines the desired state of GitLab
description: Specification of the desired behavior of a GitLab instance
properties:
acme:
description: ACMEOptions defines the values for the ACME service that
will provide certificates
description: 'If specified, the options used by Cert-Manager to generate
certificates. More info: https://cert-manager.io/docs/configuration/acme/'
properties:
email:
description: Email is the email for this account
......@@ -1552,7 +1552,8 @@ spec:
type: array
type: object
autoscaling:
description: AutoScalingSpec are the parameters to configure autoscaling
description: If specified, defines the parameters used when autoscaling
GitLab resources
properties:
maxReplicas:
description: Maximum number of replicas to scale to
......@@ -1563,12 +1564,14 @@ spec:
format: int32
type: integer
targetCPU:
description: Percentage CPU mark at which autoscaling triggers
description: Percentage CPU of the requested CPU resources at which
autoscaling triggers
format: int32
type: integer
type: object
objectStore:
description: ObjectStoreSpec defines options for Gitlab registry
description: The parameters for the object storage used to store GitLab
artifacts
properties:
credentials:
description: Credentials contains the name of the secret that contains
......@@ -1590,7 +1593,8 @@ spec:
type: string
type: object
postgres:
description: DatabaseSpec defines database options
description: If specified, overrides the default behavior of the Postgresql
database deployed by the operator
properties:
replicas:
format: int32
......@@ -1607,7 +1611,8 @@ spec:
type: object
type: object
redis:
description: RedisSpec defines Redis options
description: If specified, the Redis options override the default behavior
of the Redis key-value store deployed by the operator
properties:
replicas:
format: int32
......@@ -1624,7 +1629,7 @@ spec:
type: object
type: object
registry:
description: RegistrySpec defines options for GitLab registry
description: Options used to setup the GitLab Registry
properties:
disable:
type: boolean
......@@ -1637,8 +1642,8 @@ spec:
description: The GitLab version to deploy
type: string
smtp:
description: 'SMTPConfiguration defines options for Gitlab registry
More on configuration options available below: https://docs.gitlab.com/omnibus/settings/smtp.html'
description: If specified, SMTP provides the details of the email server
used by GitLab to send outgoing email
properties:
authentication:
description: 'Authentication represents authentication mechanism
......@@ -1682,10 +1687,11 @@ spec:
type: string
type: object
tls:
description: Name of tls secret used to secure the GitLab instance
description: Name of tls secret used to secure the GitLab instance URL
type: string
url:
description: The URL through which to access GitLab instance
description: 'The fully qualified domain name used to access the GitLab
instance. For example: gitlab.example.com'
type: string
volume:
description: Volume for Gitaly statefulset
......@@ -1699,7 +1705,8 @@ spec:
type: object
type: object
status:
description: GitLabStatus defines the observed state of GitLab
description: Most recently observed status of the GitLab instance. It is
read-only to the user
properties:
health:
description: HealthCheck represents the status of services that make
......
......@@ -74,7 +74,7 @@ spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- description: GitLab is the Schema for the gitlabs API
- description: GitLab is a complete DevOps platform, delivered in a single application
displayName: GitLab
kind: GitLab
name: gitlabs.apps.gitlab.com
......@@ -117,7 +117,7 @@ spec:
path: autoscaling.minReplicas
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Percentage CPU mark at which autoscaling triggers
- description: Percentage CPU of the requested CPU resources at which autoscaling triggers
displayName: CPU Percentage Threshold
path: autoscaling.targetCPU
x-descriptors:
......@@ -147,12 +147,12 @@ spec:
path: release
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:text
- description: Name of tls secret used to secure the GitLab instance
- description: Name of tls secret used to secure the GitLab instance URL
displayName: TLS Certificate
path: tls
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret
- description: The URL through which to access GitLab instance
- description: 'The fully qualified domain name used to access the GitLab instance. For example: gitlab.example.com'
displayName: GitLab URL
path: url
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