Alauda Container Platform

简体中文

CommonConfig [operator.alauda.io/v1alpha1]

描述: CommonConfig is the Schema for the commonconfigs API
类型: object

规格

属性	类型	描述
`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

描述: CommonConfigSpec defines the desired state of CommonConfig
类型: object
必填: etcdglobaloidcreleaserepositories

属性	类型	描述
`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

描述: Elasticsearch Config
类型: object

属性	类型	描述
`host`	`string`	Server address
`nodes`	`array`	Log nodes
`password`	`string`	Password
`username`	`string`	Uername

.spec.elasticsearch.nodes

描述: Log nodes
类型: array

.spec.elasticsearch.nodes[]

类型: string

.spec.etcd

描述: Etcd Config
类型: object
必填: ectdCaSecretectdPeerSecretservers

属性	类型	描述
`ectdCaSecret`	`object`	Etcd Ca Secret
`ectdPeerSecret`	`object`	Etcd Peer secret
`servers`	`array`	Etcd servers

.spec.etcd.ectdCaSecret

描述: Etcd Ca Secret
类型: object
必填: secretSource

属性	类型	描述
`secretSource`	`object`

.spec.etcd.ectdCaSecret.secretSource

类型: object
必填: tls.crttls.key

属性	类型	描述
`tls.crt`	`string`
`tls.key`	`string`

.spec.etcd.ectdPeerSecret

描述: Etcd Peer secret
类型: object
必填: secretSource

属性	类型	描述
`secretSource`	`object`

.spec.etcd.ectdPeerSecret.secretSource

类型: object
必填: tls.crttls.key

属性	类型	描述
`tls.crt`	`string`
`tls.key`	`string`

.spec.etcd.servers

描述: Etcd servers
类型: array

.spec.etcd.servers[]

类型: string

.spec.ext

描述: Ext Config
类型: object

.spec.global

描述: Global configuration
类型: object
必填: apiAddressdefaultAdminerebusApiAddresshostlabelBaseDomainreplicastlsSecret

属性	类型	描述
`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

描述: Tls Secret
类型: object
必填: secretSource

属性	类型	描述
`secretSource`	`object`

.spec.global.tlsSecret.secretSource

类型: object
必填: tls.crttls.key

属性	类型	描述
`tls.crt`	`string`
`tls.key`	`string`

.spec.kafka

描述: Kafka Config
类型: object
必填: authhostkafka_passwordkafka_userzk_acl_passwordzk_passwordzk_user

属性	类型	描述
`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

描述: OIDC Config
类型: object
必填: clientIDclientSecretissuerresponseTypescopes

属性	类型	描述
`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

描述: Repositories Config
类型: array

.spec.repositories[]

描述: Repository Config
类型: object
必填: typeurl

属性	类型	描述
`type`	`string`	Repository type
`url`	`string`	Repository url

.status

描述: CommonConfigStatus defines the observed state of CommonConfig
类型: object

API 端点

可用的 API 端点如下：

/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

HTTP 方法: DELETE
描述: delete collection of CommonConfig
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind CommonConfig
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CommonConfigList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new CommonConfig

查询参数

参数	类型	描述
`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`	`CommonConfig` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CommonConfig` schema
201 - Created	`CommonConfig` schema
202 - Accepted	`CommonConfig` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified CommonConfig

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified CommonConfig
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified CommonConfig

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`CommonConfig` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified CommonConfig

查询参数

参数	类型	描述
`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`	`CommonConfig` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CommonConfig` schema
201 - Created	`CommonConfig` schema
401 - Unauthorized	Empty