数据存储 [kamaji.clastix.io/v1alpha1]

描述
DataStore is the Schema for the datastores API.
类型
object

规格

属性类型描述
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

DataStoreSpec defines the desired state of DataStore.

statusobject

DataStoreStatus defines the observed state of DataStore.

.spec

描述
DataStoreSpec defines the desired state of DataStore.
类型
object
必填
driverendpoints
属性类型描述
basicAuthobject

In case of authentication enabled for the given data store, specifies the username and password pair. This value is optional.

driverstring

The driver to use to connect to the shared datastore.

endpointsarray

List of the endpoints to connect to the shared datastore. No need for protocol, just bare IP/FQDN and port.

tlsConfigobject

Defines the TLS/SSL configuration required to connect to the data store in a secure way. This value is optional.

.spec.basicAuth

描述
In case of authentication enabled for the given data store, specifies the username and password pair. This value is optional.
类型
object
必填
passwordusername
属性类型描述
passwordobject
usernameobject

.spec.basicAuth.password

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.basicAuth.password.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.spec.basicAuth.username

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.basicAuth.username.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.spec.endpoints

描述
List of the endpoints to connect to the shared datastore. No need for protocol, just bare IP/FQDN and port.
类型
array

.spec.endpoints[]

类型
string

.spec.tlsConfig

描述
Defines the TLS/SSL configuration required to connect to the data store in a secure way. This value is optional.
类型
object
必填
certificateAuthority
属性类型描述
certificateAuthorityobject

Retrieve the Certificate Authority certificate and private key, such as bare content of the file, or a SecretReference. The key reference is required since etcd authentication is based on certificates, and Kamaji is responsible in creating this.

clientCertificateobject

Specifies the SSL/TLS key and private key pair used to connect to the data store.

.spec.tlsConfig.certificateAuthority

描述
Retrieve the Certificate Authority certificate and private key, such as bare content of the file, or a SecretReference. The key reference is required since etcd authentication is based on certificates, and Kamaji is responsible in creating this.
类型
object
必填
certificate
属性类型描述
certificateobject
privateKeyobject

.spec.tlsConfig.certificateAuthority.certificate

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.tlsConfig.certificateAuthority.certificate.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.spec.tlsConfig.certificateAuthority.privateKey

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.tlsConfig.certificateAuthority.privateKey.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.spec.tlsConfig.clientCertificate

描述
Specifies the SSL/TLS key and private key pair used to connect to the data store.
类型
object
必填
certificateprivateKey
属性类型描述
certificateobject
privateKeyobject

.spec.tlsConfig.clientCertificate.certificate

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.tlsConfig.clientCertificate.certificate.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.spec.tlsConfig.clientCertificate.privateKey

类型
object
属性类型描述
contentstring

Bare content of the file, base64 encoded. It has precedence over the SecretReference value.

secretReferenceobject

.spec.tlsConfig.clientCertificate.privateKey.secretReference

类型
object
必填
keyPath
属性类型描述
keyPathstring

Name of the key for the given Secret reference where the content is stored. This value is mandatory.

namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

.status

描述
DataStoreStatus defines the observed state of DataStore.
类型
object
属性类型描述
usedByarray

List of the Tenant Control Planes, namespaced names, using this data store.

.status.usedBy

描述
List of the Tenant Control Planes, namespaced names, using this data store.
类型
array

.status.usedBy[]

类型
string

API 端点

可用的 API 端点如下:

  • /apis/kamaji.clastix.io/v1alpha1/datastores
    • DELETE: delete collection of DataStore
    • GET: list objects of kind DataStore
    • POST: create a new DataStore
  • /apis/kamaji.clastix.io/v1alpha1/datastores/{name}
    • DELETE: delete the specified DataStore
    • GET: read the specified DataStore
    • PATCH: partially update the specified DataStore
    • PUT: replace the specified DataStore
  • /apis/kamaji.clastix.io/v1alpha1/datastores/{name}/status
    • GET: read status of the specified DataStore
    • PATCH: partially update status of the specified DataStore
    • PUT: replace status of the specified DataStore

/apis/kamaji.clastix.io/v1alpha1/datastores

HTTP 方法
DELETE
描述
delete collection of DataStore
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind DataStore
HTTP 响应
HTTP 状态码响应体
200 - OKDataStoreList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new DataStore
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyDataStore schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKDataStore schema
201 - CreatedDataStore schema
202 - AcceptedDataStore schema
401 - UnauthorizedEmpty

/apis/kamaji.clastix.io/v1alpha1/datastores/{name}

HTTP 方法
DELETE
描述
delete the specified DataStore
查询参数
参数类型描述
dryRunstringWhen 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 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified DataStore
HTTP 响应
HTTP 状态码响应体
200 - OKDataStore schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified DataStore
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 - OKDataStore schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified DataStore
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyDataStore schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKDataStore schema
201 - CreatedDataStore schema
401 - UnauthorizedEmpty

/apis/kamaji.clastix.io/v1alpha1/datastores/{name}/status

HTTP 方法
GET
描述
read status of the specified DataStore
HTTP 响应
HTTP 状态码响应体
200 - OKDataStore schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified DataStore
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 - OKDataStore schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified DataStore
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyDataStore schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKDataStore schema
201 - CreatedDataStore schema
401 - UnauthorizedEmpty