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
replicas	integer	Replicas Format: int32 Default: 1	true
version	string	Version Default: v3.5.7	true
backup	object	BackupSpec defines the configuration to backup cluster to	false
defrag	object	DefragSpec defines the configuration for automated cluster defrag	false
pause	boolean		false
podTemplate	object		false
resources	map[string]int or string	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

EtcdCluster.spec.backup

^{↩ Parent}

BackupSpec defines the configuration to backup cluster to

Name	Type	Description	Required
schedule	string		false
suspend	boolean		false

EtcdCluster.spec.defrag

^{↩ Parent}

DefragSpec defines the configuration for automated cluster defrag

Name	Type	Description	Required
ratio	string		false
schedule	string		false
size	int or string		false
suspend	boolean		false

EtcdCluster.spec.podTemplate

^{↩ Parent}

Name	Type	Description	Required
annotations	map[string]string	Annotations	false
labels	map[string]string	Labels	false

EtcdCluster.spec.restore

^{↩ Parent}

RestoreSpec defines the configuration to restore cluster from

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

EtcdCluster.status.backup

^{↩ Parent}

Backup

Name	Type	Description	Required
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