API Reference
Autogenerated API Reference for the CRD
5 minute read
Packages
etcd.aenix.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the etcd.aenix.io v1alpha1 API group
Resource Types
EmbeddedMetadataResource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata EmbeddedObjectMetadata | Refer to Kubernetes API documentation for fields of metadata. |
EmbeddedObjectMetadata
EmbeddedObjectMetadata contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta Only fields which are relevant to embedded resources are included.
Appears in:
- EmbeddedMetadataResource
- EmbeddedPersistentVolumeClaim
- EmbeddedPodDisruptionBudget
- EmbeddedService
- PodTemplate
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names | ||
labels object (keys:string, values:string) | Labels Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels | ||
annotations object (keys:string, values:string) | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
EmbeddedPersistentVolumeClaim
EmbeddedPersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim. It contains TypeMeta and a reduced ObjectMeta.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata EmbeddedObjectMetadata | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
EmbeddedPodDisruptionBudget
EmbeddedPodDisruptionBudget describes PDB resource for etcd cluster members
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata EmbeddedObjectMetadata | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PodDisruptionBudgetSpec | Spec defines the desired characteristics of a PDB. More info: https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#pod-disruption-budgets |
EmbeddedService
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata EmbeddedObjectMetadata | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServiceSpec | Spec defines the behavior of the service. |
EtcdCluster
EtcdCluster is the Schema for the etcdclusters API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | etcd.aenix.io/v1alpha1 | ||
kind string | EtcdCluster | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec EtcdClusterSpec |
EtcdClusterSpec
EtcdClusterSpec defines the desired state of EtcdCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
replicas integer | Replicas is the count of etcd instances in cluster. | 3 | Minimum: 0 |
options object (keys:string, values:string) | Options are the extra arguments to pass to the etcd container. | ||
podTemplate PodTemplate | PodTemplate defines the desired state of PodSpec for etcd members. If not specified, default values will be used. | ||
serviceTemplate EmbeddedService | Service defines the desired state of Service for etcd members. If not specified, default values will be used. | ||
headlessServiceTemplate EmbeddedMetadataResource | HeadlessService defines the desired state of HeadlessService for etcd members. If not specified, default values will be used. | ||
podDisruptionBudgetTemplate EmbeddedPodDisruptionBudget | PodDisruptionBudgetTemplate describes PDB resource to create for etcd cluster members. Nil to disable. | ||
storage StorageSpec | |||
security SecuritySpec | Security describes security settings of etcd (authentication, certificates, rbac) |
PodDisruptionBudgetSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
minAvailable IntOrString | MinAvailable describes minimum ready replicas. If both are empty, controller will implicitly calculate MaxUnavailable based on number of replicas Mutually exclusive with MaxUnavailable. | ||
maxUnavailable IntOrString | MinAvailable describes maximum not ready replicas. If both are empty, controller will implicitly calculate MaxUnavailable based on number of replicas Mutually exclusive with MinAvailable |
PodTemplate
PodTemplate allows overrides, such as sidecars, init containers, changes to the security context, etc to the pod template generated by the operator.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
metadata EmbeddedObjectMetadata | Refer to Kubernetes API documentation for fields of metadata. | ||
spec PodSpec | Spec follows the structure of a regular Pod spec. Overrides defined here will be strategically merged with the default pod spec, generated by the operator. |
SecuritySpec
SecuritySpec defines security settings for etcd.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
tls TLSSpec | Section for user-managed tls certificates | ||
enableAuth boolean | Section to enable etcd auth |
StorageSpec
StorageSpec defines the configured storage for a etcd members.
If neither emptyDir nor volumeClaimTemplate is specified, then by default an EmptyDir will be used.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
emptyDir EmptyDirVolumeSource | EmptyDirVolumeSource to be used by the StatefulSets. If specified, used in place of any volumeClaimTemplate. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir | ||
volumeClaimTemplate EmbeddedPersistentVolumeClaim | A PVC spec to be used by the StatefulSets. |
TLSSpec
TLSSpec defines user-managed certificates names.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
peerTrustedCASecret string | Trusted CA certificate secret to secure peer-to-peer communication between etcd nodes. It is expected to have ca.crt field in the secret. This secret must be created in the namespace with etcdCluster CR. | ||
peerSecret string | Certificate secret to secure peer-to-peer communication between etcd nodes. It is expected to have tls.crt and tls.key fields in the secret. This secret must be created in the namespace with etcdCluster CR. | ||
serverTrustedCASecret string | Trusted CA for etcd server certificates for client-server communication. Is necessary to set trust between operator and etcd. It is expected to have ca.crt field in the secret. If it is not specified, then insecure communication will be used. This secret must be created in the namespace with etcdCluster CR. | ||
serverSecret string | Server certificate secret to secure client-server communication. Is provided to the client who connects to etcd by client port (2379 by default). It is expected to have tls.crt and tls.key fields in the secret. This secret must be created in the namespace with etcdCluster CR. | ||
clientTrustedCASecret string | Trusted CA for client certificates that are provided by client to etcd. It is expected to have ca.crt field in the secret. This secret must be created in the namespace with etcdCluster CR. | ||
clientSecret string | Client certificate for etcd-operator to do maintenance. It is expected to have tls.crt and tls.key fields in the secret. This secret must be created in the namespace with etcdCluster CR. |
Feedback
Was this page helpful?