EtcdCluster [operator.etcd.io/v1alpha1]

描述
EtcdCluster is the Schema for the etcdclusters 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

EtcdClusterSpec defines the desired state of EtcdCluster.

statusobject

EtcdClusterStatus defines the observed state of EtcdCluster.

.spec

描述
EtcdClusterSpec defines the desired state of EtcdCluster.
类型
object
必填
sizeversion
属性类型描述
etcdOptionsarray

etcd configuration options are passed as command line arguments to the etcd container, refer to etcd documentation for configuration options applicable for the version of etcd being used.

imageRegistrystring

ImageRegistry specifies the container registry that hosts the etcd images. If unset, it defaults to the value provided via the controller's --image-registry flag, which itself defaults to "gcr.io/etcd-development/etcd".

podTemplateobject

PodTemplate is the pod template to use for the etcd cluster.

sizeinteger

Size is the expected size of the etcd cluster.

storageSpecobject

StorageSpec is the name of the StorageSpec to use for the etcd cluster. If not provided, then each POD just uses the temporary storage inside the container.

tlsobject

TLS is the TLS certificate configuration to use for the etcd cluster and etcd operator.

versionstring

Version is the expected version of the etcd container image.

.spec.etcdOptions

描述
etcd configuration options are passed as command line arguments to the etcd container, refer to etcd documentation for configuration options applicable for the version of etcd being used.
类型
array

.spec.etcdOptions[]

类型
string

.spec.podTemplate

描述
PodTemplate is the pod template to use for the etcd cluster.
类型
object
属性类型描述
metadataObjectMeta

Metadata is the metadata to add to the pod.

.spec.storageSpec

描述
StorageSpec is the name of the StorageSpec to use for the etcd cluster. If not provided, then each POD just uses the temporary storage inside the container.
类型
object
必填
volumeSizeRequest
属性类型描述
accessModesstring
pvcNamestring
storageClassNamestring
volumeSizeLimitinteger|string
volumeSizeRequestinteger|string

.spec.tls

描述
TLS is the TLS certificate configuration to use for the etcd cluster and etcd operator.
类型
object
属性类型描述
providerstring
providerCfgobject

.spec.tls.providerCfg

类型
object
属性类型描述
autoCfgobject
certManagerCfgobject

.spec.tls.providerCfg.autoCfg

类型
object
属性类型描述
altNamesobject

AltNames contains the domain names and IP addresses that will be added to the x509 certificate SubAltNames fields. The values will be passed directly to the x509.Certificate object.

caBundleSecretstring

CABundleSecret is the expected secret name with CABundle present. It's used by each etcd POD to verify TLS communications with its peers or clients. If it isn't provided, the CA included in the secret generated by certificate provider will be used instead if present; otherwise, there is no way to verify TLS communications.

commonNamestring

CommonName is the expected common name X509 certificate subject attribute. Should have a length of 64 characters or fewer to avoid generating invalid CSRs.

organizationsarray

Organization is the expected array of Organization names to be used on the Certificate.

validityDurationstring

ValidityDuration is the expected duration until which the certificate will be valid, expects in human-readable duration: 100d12h, if empty defaults to 90d

.spec.tls.providerCfg.autoCfg.altNames

描述
AltNames contains the domain names and IP addresses that will be added to the x509 certificate SubAltNames fields. The values will be passed directly to the x509.Certificate object.
类型
object
属性类型描述
dnsNamesarray

DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local

ipAddressesarray

IPs is the expected array of IP address subject alternative names.

.spec.tls.providerCfg.autoCfg.altNames.dnsNames

描述
DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local
类型
array

.spec.tls.providerCfg.autoCfg.altNames.dnsNames[]

类型
string

.spec.tls.providerCfg.autoCfg.altNames.ipAddresses

描述
IPs is the expected array of IP address subject alternative names.
类型
array

.spec.tls.providerCfg.autoCfg.altNames.ipAddresses[]

类型
string

.spec.tls.providerCfg.autoCfg.organizations

描述
Organization is the expected array of Organization names to be used on the Certificate.
类型
array

.spec.tls.providerCfg.autoCfg.organizations[]

类型
string

.spec.tls.providerCfg.certManagerCfg

类型
object
必填
issuerKindissuerName
属性类型描述
altNamesobject

AltNames contains the domain names and IP addresses that will be added to the x509 certificate SubAltNames fields. The values will be passed directly to the x509.Certificate object.

caBundleSecretstring

CABundleSecret is the expected secret name with CABundle present. It's used by each etcd POD to verify TLS communications with its peers or clients. If it isn't provided, the CA included in the secret generated by certificate provider will be used instead if present; otherwise, there is no way to verify TLS communications.

commonNamestring

CommonName is the expected common name X509 certificate subject attribute. Should have a length of 64 characters or fewer to avoid generating invalid CSRs.

issuerKindstring

IssuerKind is the expected kind of Issuer, either "ClusterIssuer" or "Issuer"

issuerNamestring

IssuerName is the expected name of Issuer required to issue a certificate

organizationsarray

Organization is the expected array of Organization names to be used on the Certificate.

validityDurationstring

ValidityDuration is the expected duration until which the certificate will be valid, expects in human-readable duration: 100d12h, if empty defaults to 90d

.spec.tls.providerCfg.certManagerCfg.altNames

描述
AltNames contains the domain names and IP addresses that will be added to the x509 certificate SubAltNames fields. The values will be passed directly to the x509.Certificate object.
类型
object
属性类型描述
dnsNamesarray

DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local

ipAddressesarray

IPs is the expected array of IP address subject alternative names.

.spec.tls.providerCfg.certManagerCfg.altNames.dnsNames

描述
DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local
类型
array

.spec.tls.providerCfg.certManagerCfg.altNames.dnsNames[]

类型
string

.spec.tls.providerCfg.certManagerCfg.altNames.ipAddresses

描述
IPs is the expected array of IP address subject alternative names.
类型
array

.spec.tls.providerCfg.certManagerCfg.altNames.ipAddresses[]

类型
string

.spec.tls.providerCfg.certManagerCfg.organizations

描述
Organization is the expected array of Organization names to be used on the Certificate.
类型
array

.spec.tls.providerCfg.certManagerCfg.organizations[]

类型
string

.status

描述
EtcdClusterStatus defines the observed state of EtcdCluster.
类型
object

API 端点

可用的 API 端点如下:

  • /apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters
    • DELETE: delete collection of EtcdCluster
    • GET: list objects of kind EtcdCluster
    • POST: create a new EtcdCluster
  • /apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}
    • DELETE: delete the specified EtcdCluster
    • GET: read the specified EtcdCluster
    • PATCH: partially update the specified EtcdCluster
    • PUT: replace the specified EtcdCluster
  • /apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}/status
    • GET: read status of the specified EtcdCluster
    • PATCH: partially update status of the specified EtcdCluster
    • PUT: replace status of the specified EtcdCluster

/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters

HTTP 方法
DELETE
描述
delete collection of EtcdCluster
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind EtcdCluster
HTTP 响应
HTTP 状态码响应体
200 - OKEtcdClusterList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new EtcdCluster
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyEtcdCluster schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKEtcdCluster schema
201 - CreatedEtcdCluster schema
202 - AcceptedEtcdCluster schema
401 - UnauthorizedEmpty

/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}

HTTP 方法
DELETE
描述
delete the specified EtcdCluster
查询参数
参数类型描述
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 EtcdCluster
HTTP 响应
HTTP 状态码响应体
200 - OKEtcdCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified EtcdCluster
查询参数
参数类型描述
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 - OKEtcdCluster schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified EtcdCluster
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyEtcdCluster schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKEtcdCluster schema
201 - CreatedEtcdCluster schema
401 - UnauthorizedEmpty

/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}/status

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