API Reference

Packages

registry-operator.dev/v1alpha1

registry-operator.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the registry v1alpha1 API group

Resource Types

Registry

Registry

Registry is the Schema for the registries API.

Field	Description	Default	Validation
`apiVersion` string	`registry-operator.dev/v1alpha1`
`kind` string	`Registry`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` RegistrySpec
`status` RegistryStatus

RegistrySpec

RegistrySpec defines the desired state of Registry.

Appears in: - Registry

Field	Description	Default	Validation
`image` string	Image indicates the container image to use for the Registry.
`replicas` integer	Replicas indicates the number of the pod replicas that will be created.
`resources` ResourceRequirements	Resources describe the compute resource requirements.
`affinity` Affinity	Affinity specifies the scheduling constraints for Pods.
`storage` Storage	Storage defines the available storage options for a registry. It allows specifying different storage sources to manage storage lifecycle and persistence.

RegistryStatus

RegistryStatus defines the observed state of Registry.

Appears in: - Registry

Field	Description	Default	Validation
`ready` boolean	Ready is a boolean field that is true when the Registry is ready to be used.
`version` string	Version of the managed Registry.
`image` string	Image indicates the container image to use for the Registry.

S3StorageSource

S3StorageSource defines the configuration for connecting to an S3-compatible storage backend. It holds the necessary secret references to access an S3-compatible storage service.

Appears in: - Storage

Field	Description	Default	Validation
`bucketName` SecretKeySelector	BucketName is an optional reference to the secret key containing the default bucket name to be used.
`region` SecretKeySelector	Region is an optional reference to the secret key containing the S3 region name.
`accessKey` SecretKeySelector	AccessKey is a reference to the secret key containing the S3 access key.
`secretKey` SecretKeySelector	SecretKey is a reference to the secret key containing the S3 secret key.
`endpointURL` SecretKeySelector	EndpointURL is an optional reference to the secret key containing an override for the S3 endpoint URL.

SecretKeySelector

SecretKeySelector selects a key of a Secret.

Appears in: - S3StorageSource

Field	Description	Default	Validation
`key` string	The key of the secret to select from. Must be a valid secret key.

Storage

Storage specifies various types of storage sources that a registry can use for persistence.

Appears in: - RegistrySpec

Field	Description	Default	Validation
`emptyDir` EmptyDirVolumeSource	EmptyDir represents a temporary directory that shares a pod's lifetime.
`ephemeral` EphemeralVolumeSource	Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
`hostPath` HostPathVolumeSource	HostPath represents a directory on the host.
`persistentVolumeClaim` PersistentVolumeClaimVolumeSource	PersistentVolumeClaim represents a reference to a PersistentVolumeClaim in the same namespace.
`persistentVolumeClaimTemplate` PersistentVolumeClaimSpec	PersistentVolumeClaimTemplate allows creating PVCs dynamically. This defines a PVC template that will be instantiated for the pod.
`s3` S3StorageSource	S3 defines an S3-compatible storage source for persisting registry data. It provides a way to use object storage systems such as Amazon S3 or S3-compatible services for data persistence. This field is optional and can be configured with an endpoint and appropriate credentials.