API Reference - Starter Kit

Packages

Package v1 contains API Schema definitions for the eso v1 API group

AutoUpdateConfig defines the configuration for ESO image auto-updates. Appears in:

Field	Description	Default	Validation
`strategy` AutoUpdateStrategy	Strategy defines the auto-update strategy. - Auto: Automatically update to the latest version. - MajorAuto: Automatically update to the latest version in the specified major version. - Fixed: Stick to a specific version and don’t update automatically.		Enum: [Auto MajorAuto MinorAuto Fixed]
`version` string	Version specifies the version to lock to, used only if Strategy is “Fixed” or “MajorAuto”. If “MajorAuto” is chosen, only the major version will be honored.		Optional: {}

Underlying type: string AutoUpdateStrategy defines the possible strategies for auto-updates. Appears in:

EsoDeployment is the Schema for the esodeployments API

Field	Description	Default	Validation
`apiVersion` string	`eso.externalsecrets.com/v1`
`kind` string	`EsoDeployment`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` EsoDeploymentSpec

EsoDeploymentSpec defines the desired state of EsoDeployment Appears in:

Field	Description	Validation
`registryURL` string	RegistryURL specifies the URL of the ESO registry
`taglistURL` string	Tried constructing this dynamically but it seems we can’t expect the registry to have a consistent structure
`imgName` string
`autoUpdateConfig` AutoUpdateConfig	AutoUpdateConfig defines the strategy for automatically updating ESO.
`matchLabel` object (keys:string, values:string)	MatchLabel specifies the label selector for namespaces where EsoDeployment instances should be deployed
`controllerClass` string	ControllerClass specifies the controller class to use for the ESO instance	Optional: {}
`scope` string	Scope defines whether the operator should be cluster-scoped or namespace-scoped	Enum: [Namespaced Cluster]
`haEnabled` boolean	HAEnabled indicates whether high availability is enabled for the ESO deployment
`affinity` Affinity	Affinity defines the pod affinity rules
`tolerations` Toleration array	Tolerations define the pod tolerations
`nodeSelector` object (keys:string, values:string)	NodeSelector defines the node selector for the deployment
`resources` ResourceRequirements	Resources define the resource limits and requests for the ESO deployment