vclusterconfig

type Deletion struct {
	// Prevent prevents the vCluster from being deleted
	// +optional
	Prevent bool `json:"prevent,omitempty" yaml:"prevent,omitempty"`

	// Auto holds automatic deletion configuration
	// +optional
	Auto *DeletionAuto `json:"auto,omitempty" yaml:"auto,omitempty"`
}

type DeletionAuto struct {
	// AfterInactivity specifies after how long of inactivity the virtual cluster will be deleted.
	// Uses Go duration format (e.g., "720h" for 30 days).
	// +optional
	AfterInactivity Duration `json:"afterInactivity,omitempty" yaml:"afterInactivity,omitempty"`
}

type Duration string

type Image struct {
	// Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally
	// overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.
	Registry string `json:"registry,omitempty"`

	// Repository is the repository of the container image, e.g. my-repo/my-image
	Repository string `json:"repository,omitempty"`

	// Tag is the tag of the container image, and is the default version.
	Tag string `json:"tag,omitempty"`
}

type LabelSelector struct {
	// Labels defines what labels should be looked for
	Labels map[string]string `json:"labels,omitempty"`
}

type LegacyPlatformMutator func(*LegacyPlatformConfig)

type NetrisIntegration struct {
	// Enabled defines if netris integration is enabled
	// +optional
	Enabled bool `json:"enabled,omitempty"`

	// Connector specifies the netris connector name
	// +optional
	Connector string `json:"connector,omitempty"`

	// KubeVip holds kube-vip configuration for netris
	// +optional
	KubeVip NetrisKubeVipConfig `json:"kubeVip,omitempty"`
}

type NetrisKubeVipConfig struct {
	// ServerCluster specifies the server cluster name
	// +optional
	ServerCluster string `json:"serverCluster,omitempty"`

	// Bridge specifies the bridge interface name
	// +optional
	Bridge string `json:"bridge,omitempty"`

	// IPRange specifies the IP range for kube-vip
	// +optional
	IPRange string `json:"ipRange,omitempty"`
}

type Platform struct {
	// APIKey defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:
	// * environment variable called LICENSE
	// * secret specified under platform.apiKey.secretName
	// * secret called "vcluster-platform-api-key" in the vCluster namespace
	APIKey PlatformAPIKey `json:"apiKey,omitempty"`

	// Project specifies which platform project the vcluster should be imported to
	// +optional
	Project string `json:"project,omitempty"`
}

type PlatformAPIKey struct {
	// SecretName is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace
	// where the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// CreateRBAC will automatically create the necessary RBAC roles and role bindings to allow vCluster to read the secret specified
	// in the above namespace, if specified.
	// This defaults to true.
	// +optional
	CreateRBAC *bool `json:"createRBAC,omitempty"`
}

type PlatformConfig struct {
	Sleep             *Sleep             `json:"sleep,omitempty"     yaml:"sleep,omitempty"`
	Snapshots         *Snapshots         `json:"snapshots,omitempty" yaml:"snapshots,omitempty"`
	Deletion          *Deletion          `json:"deletion,omitempty"  yaml:"deletion,omitempty"`
	Platform          *Platform          `json:"platform,omitempty"  yaml:"platform,omitempty"`
	NetrisIntegration *NetrisIntegration `json:"netris,omitempty"    yaml:"netris,omitempty"`
}

type Sleep struct {
	// Auto holds automatic sleep configuration
	Auto *SleepAuto `json:"auto,omitempty" yaml:"auto,omitempty"`
}

type SleepAuto struct {
	// AfterInactivity represents how long a vCluster can be idle before workloads are automatically put to sleep
	AfterInactivity Duration `json:"afterInactivity,omitempty" yaml:"afterInactivity,omitempty"`

	// Schedule represents a cron schedule for when to sleep workloads
	Schedule string `json:"schedule,omitempty" yaml:"schedule,omitempty"`

	// Exclude holds configuration for labels that, if present, will prevent a workload from going to sleep
	Exclude SleepAutoExclusion `json:"exclude,omitempty"`

	// Wakeup holds configuration for waking the vCluster on a schedule
	Wakeup *SleepAutoWakeup `json:"wakeup,omitempty" yaml:"wakeup,omitempty"`

	// Timezone specifies time zone used for scheduled sleep operations. Defaults to UTC.
	// Accepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation).
	// The value should be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".
	// +optional
	Timezone string `json:"timezone,omitempty" yaml:"timezone,omitempty"`
}

type SleepAutoExclusion struct {
	Selector LabelSelector `json:"selector,omitempty"`
}

type SleepAutoWakeup struct {
	Schedule string `json:"schedule,omitempty" yaml:"schedule,omitempty"`
}

type SnapshotRetention struct {
	// Period defines the number of days a snapshot will be kept
	// +optional
	Period int `json:"period,omitempty"`

	// MaxSnapshots defines the number of snapshots that can be taken
	// +optional
	MaxSnapshots int `json:"maxSnapshots,omitempty"`
}

type SnapshotSecretCredential struct {
	// SecretName is the secret name with credential
	// +optional
	SecretName string `json:"secretName,omitempty"`

	// SecretNamespace is the secret namespace with credential
	// +optional
	SecretNamespace string `json:"secretNamespace,omitempty"`
}

type SnapshotStorage struct {
	// Type specifies supported type of storage services for a snapshot S3/OCI/Container, see https://www.vcluster.com/docs/vcluster/manage/backup-restore#store-snapshots-in-s3-buckets
	// +optional
	Type string `json:"type,omitempty"`

	// S3 holds configuration for storing snapshots in S3-compatible bucket
	// +optional
	S3 SnapshotStorageS3 `json:"s3,omitempty"`

	// OCI holds configuration for storing snapshots in OCI image registries
	// +optional
	OCI SnapshotStorageOCI `json:"oci,omitempty"`

	// Container holds configuration for storing snapshots as local files inside a vCluster container
	// +optional
	Container SnapshotStorageContainer `json:"container,omitempty"`
}

type SnapshotStorageContainer struct {
	// Path specifies directory to store the snapshot
	// +optional
	Path string `json:"path,omitempty"`

	// Volume specifies which volume needs to be mounted into the container to store the snapshot
	// +optional
	Volume SnapshotStorageContainerVolume `json:"volume,omitempty"`
}

type SnapshotStorageContainerVolume struct {
	// Name to be used to mount the volume
	// +optional
	Name string `json:"name,omitempty"`

	// Path to the volume mount
	// +optional
	Path string `json:"path,omitempty"`
}

type SnapshotStorageOCI struct {
	// Repository OCI repository to store the snapshot
	// +optional
	Repository string `json:"repository,omitempty"`

	// Credential secret with the OCI Credentials
	// +optional
	Credential *SnapshotSecretCredential `json:"credential,omitempty"`

	// Username to authenticate with the OCI registry
	// +optional
	Username string `json:"username,omitempty"`

	// Password to authenticate with the OCI registry
	// +optional
	Password string `json:"password,omitempty"`
}

type SnapshotStorageS3 struct {
	// Url specifies url to the storage service
	// +optional
	Url string `json:"url,omitempty"`

	// Credential secret with the S3 Credentials, it should contain AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN
	// +optional
	Credential *SnapshotSecretCredential `json:"credential,omitempty"`
}

type SnapshotVolumes struct {
	// Enabled specifies whether a snapshot should also include volumes in the snapshot
	// +optional
	Enabled bool `json:"enabled,omitempty" yaml:"enabled,omitempty"`
}

type Snapshots struct {
	// Auto holds automatic snapshot configuration
	// +optional
	Auto *SnapshotsAuto `json:"auto,omitempty" yaml:"auto,omitempty"`
}

type SnapshotsAuto struct {
	// Schedule specifies a scheduled time in Cron format, see https://en.wikipedia.org/wiki/Cron for a virtual cluster snapshot to be taken
	// +optional
	Schedule string `json:"schedule,omitempty" yaml:"schedule,omitempty"`

	// Timezone specifies time zone used for scheduled snapshot operations. Defaults to UTC.
	// Accepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation).
	// The value should be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".
	// +optional
	Timezone string `json:"timezone,omitempty" yaml:"timezone,omitempty"`

	// Retention specifies how long snapshots will be kept
	// +optional
	Retention *SnapshotRetention `json:"retention,omitempty" yaml:"retention,omitempty"`

	// Storage specifies where the snapshot will be stored
	// +optional
	Storage *SnapshotStorage `json:"storage,omitempty" yaml:"storage,omitempty"`

	// Volumes specifies configuration for volume snapshots
	// +optional
	Volumes *SnapshotVolumes `json:"volumes,omitempty" yaml:"volumes,omitempty"`
}