EtcdCluster [operator.etcd.io/v1alpha1]
- Description
- EtcdCluster is the Schema for the etcdclusters API.
- Type
object
Specification
.spec
- Description
- EtcdClusterSpec defines the desired state of EtcdCluster.
- Type
object- Required
sizeversion
.spec.etcdOptions
- Description
- 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.
- Type
array
.spec.etcdOptions[]
- Type
string
.spec.podTemplate
- Description
- PodTemplate is the pod template to use for the etcd cluster.
- Type
object
.spec.storageSpec
- Description
- 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.
- Type
object- Required
volumeSizeRequest
.spec.tls
- Description
- TLS is the TLS certificate configuration to use for the etcd cluster and etcd operator.
- Type
object
.spec.tls.providerCfg
- Type
object
.spec.tls.providerCfg.autoCfg
- Type
object
.spec.tls.providerCfg.autoCfg.altNames
- Description
- 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.
- Type
object
.spec.tls.providerCfg.autoCfg.altNames.dnsNames
- Description
- DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local
- Type
array
.spec.tls.providerCfg.autoCfg.altNames.dnsNames[]
- Type
string
.spec.tls.providerCfg.autoCfg.altNames.ipAddresses
- Description
- IPs is the expected array of IP address subject alternative names.
- Type
array
.spec.tls.providerCfg.autoCfg.altNames.ipAddresses[]
- Type
string
.spec.tls.providerCfg.autoCfg.organizations
- Description
- Organization is the expected array of Organization names to be used on the Certificate.
- Type
array
.spec.tls.providerCfg.autoCfg.organizations[]
- Type
string
.spec.tls.providerCfg.certManagerCfg
- Type
object- Required
issuerKindissuerName
.spec.tls.providerCfg.certManagerCfg.altNames
- Description
- 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.
- Type
object
.spec.tls.providerCfg.certManagerCfg.altNames.dnsNames
- Description
- DNSNames is the expected array of DNS subject alternative names. if empty defaults to $(POD_NAME).$(ETCD_CLUSTER_NAME).$(POD_NAMESPACE).svc.cluster.local
- Type
array
.spec.tls.providerCfg.certManagerCfg.altNames.dnsNames[]
- Type
string
.spec.tls.providerCfg.certManagerCfg.altNames.ipAddresses
- Description
- IPs is the expected array of IP address subject alternative names.
- Type
array
.spec.tls.providerCfg.certManagerCfg.altNames.ipAddresses[]
- Type
string
.spec.tls.providerCfg.certManagerCfg.organizations
- Description
- Organization is the expected array of Organization names to be used on the Certificate.
- Type
array
.spec.tls.providerCfg.certManagerCfg.organizations[]
- Type
string
.status
- Description
- EtcdClusterStatus defines the observed state of EtcdCluster.
- Type
object
API Endpoints
The following API endpoints are available:
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclustersDELETE: delete collection of EtcdClusterGET: list objects of kind EtcdClusterPOST: create a new EtcdCluster
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}DELETE: delete the specified EtcdClusterGET: read the specified EtcdClusterPATCH: partially update the specified EtcdClusterPUT: replace the specified EtcdCluster
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}/statusGET: read status of the specified EtcdClusterPATCH: partially update status of the specified EtcdClusterPUT: replace status of the specified EtcdCluster
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters
- HTTP method
DELETE- Description
- delete collection of EtcdCluster
- HTTP responses
- HTTP method
GET- Description
- list objects of kind EtcdCluster
- HTTP responses
- HTTP method
POST- Description
- create a new EtcdCluster
- Query parameters
- Body parameters
- HTTP responses
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}
- HTTP method
DELETE- Description
- delete the specified EtcdCluster
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified EtcdCluster
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified EtcdCluster
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified EtcdCluster
- Query parameters
- Body parameters
- HTTP responses
/apis/operator.etcd.io/v1alpha1/namespaces/{namespace}/etcdclusters/{name}/status
- HTTP method
GET- Description
- read status of the specified EtcdCluster
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified EtcdCluster
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified EtcdCluster
- Query parameters
- Body parameters
- HTTP responses