api.md

API Reference

Packages:

• etcd.fleet.agoda.com/v1

etcd.fleet.agoda.com/v1

Resource Types:

• EtcdCluster

EtcdCluster

^{↩ Parent}

EtcdCluster is the Schema for the etcdclusters API

Name	Type	Description	Required
apiVersion	string	etcd.fleet.agoda.com/v1	true
kind	string	EtcdCluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EtcdClusterSpec defines the desired state of EtcdCluster	false
status	object	EtcdClusterStatus defines the observed state of EtcdCluster	false

EtcdCluster.spec

^{↩ Parent}

EtcdClusterSpec defines the desired state of EtcdCluster

Name	Type	Description	Required
version	string	Version Default: v3.5.7	true
backup	object	BackupSpec defines the configuration to backup cluster to	false
commonAnnotations	map[string]string	CommonAnnotations	false
commonLabels	map[string]string	CommonLabels	false
defrag	object	DefragSpec defines the configuration for automated cluster defrag	false
priorityClassName	string	PriorityClassName is the pod's priority	false
replicas	integer	Replicas Format: int32 Default: 1	false
resources	object	Compute Resources required by each member of cluster. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
restore	object	RestoreSpec defines the configuration to restore cluster from	false
runtimeClassName	string	RuntimeClassName is the pod's runtime class	false
storageMedium	string	StorageMedium=Memory creates emptyDir volume on tmpfs Default:	false
storageQuota	int or string	StorageQuota sets a size limit on storage Default: 4G	false

EtcdCluster.spec.backup

^{↩ Parent}

BackupSpec defines the configuration to backup cluster to

Name	Type	Description	Required
enabled	boolean		false
schedule	string		false
secretName	string		false

EtcdCluster.spec.defrag

^{↩ Parent}

DefragSpec defines the configuration for automated cluster defrag

Name	Type	Description	Required
enabled	boolean		false
schedule	string		false
threshold	object		false

EtcdCluster.spec.defrag.threshold

^{↩ Parent}

Name	Type	Description	Required
ratio	string		false
size	int or string		false

EtcdCluster.spec.resources

^{↩ Parent}

Compute Resources required by each member of cluster. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
claims	[]object	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.	false
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

EtcdCluster.spec.resources.claims[index]

^{↩ Parent}

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name	Type	Description	Required
name	string	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.	true
request	string	Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.	false

EtcdCluster.spec.restore

^{↩ Parent}

RestoreSpec defines the configuration to restore cluster from

Name	Type	Description	Required
key	string		false
prefix	string		false
secretName	string		false

EtcdCluster.status

^{↩ Parent}

EtcdClusterStatus defines the observed state of EtcdCluster

Name	Type	Description	Required
availableReplicas	integer	AvailableReplicas is the number of fully provisioned members. Format: int32	false
backup	object	Backup	false
conditions	[]object	Latest service status of cluster	false
endpoint	string	Endpoint is the etcd client endpoint	false
learnerReplicas	integer	LearnerReplicas Format: int32	false
members	[]object	Members is the status of each cluster member.	false
observedGeneration	integer	ObservedGeneration Format: int64	false
phase	string	Lifecycle phase	false
readyReplicas	integer	ReadyReplicas is the number of ready member pods. Format: int32	false
replicas	integer	Replicas is the number of non-terminated members. Format: int32	false
secretName	string	SecretName is the name of the secret containing the etcd client certificate	false
updatedReplicas	integer	UpdatedReplicas is the number of members that are synced with cluster spec Format: int32	false
version	string	Version is the observed version of etcd cluster	false

EtcdCluster.status.backup

^{↩ Parent}

Backup

Name	Type	Description	Required
enabled	boolean		true
lastScheduleTime	string	Format: date-time	false
lastSuccessfulTime	string	Format: date-time	false

EtcdCluster.status.conditions[index]

^{↩ Parent}

Name	Type	Description	Required
status	string		true
type	string		true
lastTransitionTime	string	Format: date-time	false
message	string		false
reason	string		false

EtcdCluster.status.members[index]

^{↩ Parent}

MemberStatus defines the observed state of EtcdCluster member

Name	Type	Description	Required
available	boolean		true
id	string		true
endpoint	string		false
errors	[]string		false
lastSuccessfulTime	string	Format: date-time	false
name	string		false
role	string		false
size	int or string		false
version	string		false