CommonConfig [operator.alauda.io/v1alpha1]

Description: CommonConfig is the Schema for the commonconfigs API
Type: object

Specification

Property	Type	Description
`apiVersion`	`string`	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
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	CommonConfigSpec defines the desired state of CommonConfig
`status`	`object`	CommonConfigStatus defines the observed state of CommonConfig

.spec

Description: CommonConfigSpec defines the desired state of CommonConfig
Type: object
Required: etcdglobaloidcreleaserepositories

Property	Type	Description
`elasticsearch`	`object`	Elasticsearch Config
`etcd`	`object`	Etcd Config
`ext`	`object`	Ext Config
`global`	`object`	Global configuration
`kafka`	`object`	Kafka Config
`oidc`	`object`	OIDC Config
`release`	`string`	Release verison
`repositories`	`array`	Repositories Config

.spec.elasticsearch

Description: Elasticsearch Config
Type: object

Property	Type	Description
`host`	`string`	Server address
`nodes`	`array`	Log nodes
`password`	`string`	Password
`username`	`string`	Uername

.spec.elasticsearch.nodes

Description: Log nodes
Type: array

.spec.elasticsearch.nodes[]

Type: string

.spec.etcd

Description: Etcd Config
Type: object
Required: ectdCaSecretectdPeerSecretservers

Property	Type	Description
`ectdCaSecret`	`object`	Etcd Ca Secret
`ectdPeerSecret`	`object`	Etcd Peer secret
`servers`	`array`	Etcd servers

.spec.etcd.ectdCaSecret

Description: Etcd Ca Secret
Type: object
Required: secretSource

Property	Type	Description
`secretSource`	`object`

.spec.etcd.ectdCaSecret.secretSource

Type: object
Required: tls.crttls.key

Property	Type	Description
`tls.crt`	`string`
`tls.key`	`string`

.spec.etcd.ectdPeerSecret

Description: Etcd Peer secret
Type: object
Required: secretSource

Property	Type	Description
`secretSource`	`object`

.spec.etcd.ectdPeerSecret.secretSource

Type: object
Required: tls.crttls.key

Property	Type	Description
`tls.crt`	`string`
`tls.key`	`string`

.spec.etcd.servers

Description: Etcd servers
Type: array

.spec.etcd.servers[]

Type: string

.spec.ext

Description: Ext Config
Type: object

.spec.global

Description: Global configuration
Type: object
Required: apiAddressdefaultAdminerebusApiAddresshostlabelBaseDomainreplicastlsSecret

Property	Type	Description
`apiAddress`	`string`	Platform api address
`defaultAdmin`	`string`	The platform deploys a management account by default, and the default email admin@cpaas.io
`erebusApiAddress`	`string`	Platform api gateway address
`host`	`string`	Platform access host address, support domain name or IP
`isOCP`	`boolean`	Whether to deploy on openshift cluster
`labelBaseDomain`	`string`	Platform resource instance label field, the default is cpaas.io
`namespace`	`string`	The namespace deployed by the platform, default cpaas-system
`replicas`	`integer`	The number of instances of platform common deployment components, the default is 2
`scheme`	`string`	Platform access protocol, support http or https
`tlsSecret`	`object`	Tls Secret

.spec.global.tlsSecret

Description: Tls Secret
Type: object
Required: secretSource

Property	Type	Description
`secretSource`	`object`

.spec.global.tlsSecret.secretSource

Type: object
Required: tls.crttls.key

Property	Type	Description
`tls.crt`	`string`
`tls.key`	`string`

.spec.kafka

Description: Kafka Config
Type: object
Required: authhostkafka_passwordkafka_userzk_acl_passwordzk_passwordzk_user

Property	Type	Description
`auth`	`boolean`	Whether to enable authentication
`host`	`string`	Server address
`kafka_password`	`string`
`kafka_user`	`string`
`zk_acl_password`	`string`
`zk_password`	`string`
`zk_user`	`string`

.spec.oidc

Description: OIDC Config
Type: object
Required: clientIDclientSecretissuerresponseTypescopes

Property	Type	Description
`clientID`	`string`	OIDC Client ID
`clientSecret`	`string`	OIDC Client Secret
`issuer`	`string`	OIDC server address
`responseType`	`string`	OIDC Response Type
`scopes`	`string`	OIDC Scopes

.spec.repositories

Description: Repositories Config
Type: array

.spec.repositories[]

Description: Repository Config
Type: object
Required: typeurl

Property	Type	Description
`type`	`string`	Repository type
`url`	`string`	Repository url

.status

Description: CommonConfigStatus defines the observed state of CommonConfig
Type: object

API Endpoints

The following API endpoints are available:

/apis/operator.alauda.io/v1alpha1/commonconfigs
- DELETE: delete collection of CommonConfig
- GET: list objects of kind CommonConfig
- POST: create a new CommonConfig
/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}
- DELETE: delete the specified CommonConfig
- GET: read the specified CommonConfig
- PATCH: partially update the specified CommonConfig
- PUT: replace the specified CommonConfig
/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}/status
- GET: read status of the specified CommonConfig
- PATCH: partially update status of the specified CommonConfig
- PUT: replace status of the specified CommonConfig

/apis/operator.alauda.io/v1alpha1/commonconfigs

HTTP method: DELETE
Description: delete collection of CommonConfig
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind CommonConfig
HTTP responses

HTTP code	Response body
200 - OK	`CommonConfigList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`CommonConfig` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
201 - Created	`CommonConfig` schema
202 - Accepted	`CommonConfig` schema
401 - Unauthorized	Empty

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}

HTTP method: DELETE
Description: delete the specified CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified CommonConfig
HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`CommonConfig` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
201 - Created	`CommonConfig` schema
401 - Unauthorized	Empty

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}/status

HTTP method: GET
Description: read status of the specified CommonConfig
HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified CommonConfig

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`CommonConfig` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`CommonConfig` schema
201 - Created	`CommonConfig` schema
401 - Unauthorized	Empty

#CommonConfig [operator.alauda.io/v1alpha1]

Specification#

.spec#

.spec.elasticsearch#

.spec.elasticsearch.nodes#

.spec.elasticsearch.nodes[]#

.spec.etcd#

.spec.etcd.ectdCaSecret#

.spec.etcd.ectdCaSecret.secretSource#

.spec.etcd.ectdPeerSecret#

.spec.etcd.ectdPeerSecret.secretSource#

.spec.etcd.servers#

.spec.etcd.servers[]#

.spec.ext#

.spec.global#

.spec.global.tlsSecret#

.spec.global.tlsSecret.secretSource#

.spec.kafka#

.spec.oidc#

.spec.repositories#

.spec.repositories[]#

.status#

API Endpoints#

/apis/operator.alauda.io/v1alpha1/commonconfigs#

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}#

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}/status#

CommonConfig [operator.alauda.io/v1alpha1]

Specification

.spec

.spec.elasticsearch

.spec.elasticsearch.nodes

.spec.elasticsearch.nodes[]

.spec.etcd

.spec.etcd.ectdCaSecret

.spec.etcd.ectdCaSecret.secretSource

.spec.etcd.ectdPeerSecret

.spec.etcd.ectdPeerSecret.secretSource

.spec.etcd.servers

.spec.etcd.servers[]

.spec.ext

.spec.global

.spec.global.tlsSecret

.spec.global.tlsSecret.secretSource

.spec.kafka

.spec.oidc

.spec.repositories

.spec.repositories[]

.status

API Endpoints

/apis/operator.alauda.io/v1alpha1/commonconfigs

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}

/apis/operator.alauda.io/v1alpha1/commonconfigs/{name}/status