v1alpha1

package
v1.122.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the gkebackup v1alpha1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/gkebackup +k8s:defaulter-gen=TypeMeta +groupName=gkebackup.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "gkebackup.cnrm.cloud.google.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme

	GKEBackupBackupPlanGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(GKEBackupBackupPlan{}).Name(),
	}
)

Functions

This section is empty.

Types

type BackupplanBackupConfig 

type BackupplanBackupConfig struct {
	/* If True, include all namespaced resources. */
	// +optional
	AllNamespaces *bool `json:"allNamespaces,omitempty"`

	/* This defines a customer managed encryption key that will be used to encrypt the "config"
	portion (the Kubernetes resources) of Backups created via this plan. */
	// +optional
	EncryptionKey *BackupplanEncryptionKey `json:"encryptionKey,omitempty"`

	/* This flag specifies whether Kubernetes Secret resources should be included
	when they fall into the scope of Backups. */
	// +optional
	IncludeSecrets *bool `json:"includeSecrets,omitempty"`

	/* This flag specifies whether volume data should be backed up when PVCs are
	included in the scope of a Backup. */
	// +optional
	IncludeVolumeData *bool `json:"includeVolumeData,omitempty"`

	/* A list of namespaced Kubernetes Resources. */
	// +optional
	SelectedApplications *BackupplanSelectedApplications `json:"selectedApplications,omitempty"`

	/* If set, include just the resources in the listed namespaces. */
	// +optional
	SelectedNamespaces *BackupplanSelectedNamespaces `json:"selectedNamespaces,omitempty"`
}

func (*BackupplanBackupConfig) DeepCopy 

func (in *BackupplanBackupConfig) DeepCopy() *BackupplanBackupConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanBackupConfig.

func (*BackupplanBackupConfig) DeepCopyInto 

func (in *BackupplanBackupConfig) DeepCopyInto(out *BackupplanBackupConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanBackupSchedule 

type BackupplanBackupSchedule struct {
	/* A standard cron string that defines a repeating schedule for
	creating Backups via this BackupPlan.
	If this is defined, then backupRetainDays must also be defined. */
	// +optional
	CronSchedule *string `json:"cronSchedule,omitempty"`

	/* This flag denotes whether automatic Backup creation is paused for this BackupPlan. */
	// +optional
	Paused *bool `json:"paused,omitempty"`
}

func (*BackupplanBackupSchedule) DeepCopy 

func (in *BackupplanBackupSchedule) DeepCopy() *BackupplanBackupSchedule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanBackupSchedule.

func (*BackupplanBackupSchedule) DeepCopyInto 

func (in *BackupplanBackupSchedule) DeepCopyInto(out *BackupplanBackupSchedule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanEncryptionKey 

type BackupplanEncryptionKey struct {
	/* Google Cloud KMS encryption key. Format: projects/* /locations/* /keyRings/* /cryptoKeys/*. */
	GcpKmsEncryptionKey string `json:"gcpKmsEncryptionKey"`
}

func (*BackupplanEncryptionKey) DeepCopy 

func (in *BackupplanEncryptionKey) DeepCopy() *BackupplanEncryptionKey

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanEncryptionKey.

func (*BackupplanEncryptionKey) DeepCopyInto 

func (in *BackupplanEncryptionKey) DeepCopyInto(out *BackupplanEncryptionKey)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanNamespacedNames 

type BackupplanNamespacedNames struct {
	/* The name of a Kubernetes Resource. */
	Name string `json:"name"`

	/* The namespace of a Kubernetes Resource. */
	Namespace string `json:"namespace"`
}

func (*BackupplanNamespacedNames) DeepCopy 

func (in *BackupplanNamespacedNames) DeepCopy() *BackupplanNamespacedNames

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanNamespacedNames.

func (*BackupplanNamespacedNames) DeepCopyInto 

func (in *BackupplanNamespacedNames) DeepCopyInto(out *BackupplanNamespacedNames)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanRetentionPolicy 

type BackupplanRetentionPolicy struct {
	/* Minimum age for a Backup created via this BackupPlan (in days).
	Must be an integer value between 0-90 (inclusive).
	A Backup created under this BackupPlan will not be deletable
	until it reaches Backup's (create time + backup_delete_lock_days).
	Updating this field of a BackupPlan does not affect existing Backups.
	Backups created after a successful update will inherit this new value. */
	// +optional
	BackupDeleteLockDays *int64 `json:"backupDeleteLockDays,omitempty"`

	/* The default maximum age of a Backup created via this BackupPlan.
	This field MUST be an integer value >= 0 and <= 365. If specified,
	a Backup created under this BackupPlan will be automatically deleted
	after its age reaches (createTime + backupRetainDays).
	If not specified, Backups created under this BackupPlan will NOT be
	subject to automatic deletion. Updating this field does NOT affect
	existing Backups under it. Backups created AFTER a successful update
	will automatically pick up the new value.
	NOTE: backupRetainDays must be >= backupDeleteLockDays.
	If cronSchedule is defined, then this must be <= 360 * the creation interval.]. */
	// +optional
	BackupRetainDays *int64 `json:"backupRetainDays,omitempty"`

	/* This flag denotes whether the retention policy of this BackupPlan is locked.
	If set to True, no further update is allowed on this policy, including
	the locked field itself. */
	// +optional
	Locked *bool `json:"locked,omitempty"`
}

func (*BackupplanRetentionPolicy) DeepCopy 

func (in *BackupplanRetentionPolicy) DeepCopy() *BackupplanRetentionPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanRetentionPolicy.

func (*BackupplanRetentionPolicy) DeepCopyInto 

func (in *BackupplanRetentionPolicy) DeepCopyInto(out *BackupplanRetentionPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanSelectedApplications 

type BackupplanSelectedApplications struct {
	/* A list of namespaced Kubernetes resources. */
	NamespacedNames []BackupplanNamespacedNames `json:"namespacedNames"`
}

func (*BackupplanSelectedApplications) DeepCopy 

func (in *BackupplanSelectedApplications) DeepCopy() *BackupplanSelectedApplications

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanSelectedApplications.

func (*BackupplanSelectedApplications) DeepCopyInto 

func (in *BackupplanSelectedApplications) DeepCopyInto(out *BackupplanSelectedApplications)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupplanSelectedNamespaces 

type BackupplanSelectedNamespaces struct {
	/* A list of Kubernetes Namespaces. */
	Namespaces []string `json:"namespaces"`
}

func (*BackupplanSelectedNamespaces) DeepCopy 

func (in *BackupplanSelectedNamespaces) DeepCopy() *BackupplanSelectedNamespaces

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupplanSelectedNamespaces.

func (*BackupplanSelectedNamespaces) DeepCopyInto 

func (in *BackupplanSelectedNamespaces) DeepCopyInto(out *BackupplanSelectedNamespaces)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GKEBackupBackupPlan 

type GKEBackupBackupPlan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   GKEBackupBackupPlanSpec   `json:"spec,omitempty"`
	Status GKEBackupBackupPlanStatus `json:"status,omitempty"`
}

GKEBackupBackupPlan is the Schema for the gkebackup API +k8s:openapi-gen=true

func (*GKEBackupBackupPlan) DeepCopy 

func (in *GKEBackupBackupPlan) DeepCopy() *GKEBackupBackupPlan

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GKEBackupBackupPlan.

func (*GKEBackupBackupPlan) DeepCopyInto 

func (in *GKEBackupBackupPlan) DeepCopyInto(out *GKEBackupBackupPlan)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GKEBackupBackupPlan) DeepCopyObject 

func (in *GKEBackupBackupPlan) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GKEBackupBackupPlanList 

type GKEBackupBackupPlanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []GKEBackupBackupPlan `json:"items"`
}

GKEBackupBackupPlanList contains a list of GKEBackupBackupPlan

func (*GKEBackupBackupPlanList) DeepCopy 

func (in *GKEBackupBackupPlanList) DeepCopy() *GKEBackupBackupPlanList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GKEBackupBackupPlanList.

func (*GKEBackupBackupPlanList) DeepCopyInto 

func (in *GKEBackupBackupPlanList) DeepCopyInto(out *GKEBackupBackupPlanList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GKEBackupBackupPlanList) DeepCopyObject 

func (in *GKEBackupBackupPlanList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GKEBackupBackupPlanSpec 

type GKEBackupBackupPlanSpec struct {
	/* Defines the configuration of Backups created via this BackupPlan. */
	// +optional
	BackupConfig *BackupplanBackupConfig `json:"backupConfig,omitempty"`

	/* Defines a schedule for automatic Backup creation via this BackupPlan. */
	// +optional
	BackupSchedule *BackupplanBackupSchedule `json:"backupSchedule,omitempty"`

	/* Immutable. The source cluster from which Backups will be created via this BackupPlan. */
	Cluster string `json:"cluster"`

	/* This flag indicates whether this BackupPlan has been deactivated.
	Setting this field to True locks the BackupPlan such that no further updates will be allowed
	(except deletes), including the deactivated field itself. It also prevents any new Backups
	from being created via this BackupPlan (including scheduled Backups). */
	// +optional
	Deactivated *bool `json:"deactivated,omitempty"`

	/* User specified descriptive string for this BackupPlan. */
	// +optional
	Description *string `json:"description,omitempty"`

	/* Immutable. The region of the Backup Plan. */
	Location string `json:"location"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* RetentionPolicy governs lifecycle of Backups created under this plan. */
	// +optional
	RetentionPolicy *BackupplanRetentionPolicy `json:"retentionPolicy,omitempty"`
}

func (*GKEBackupBackupPlanSpec) DeepCopy 

func (in *GKEBackupBackupPlanSpec) DeepCopy() *GKEBackupBackupPlanSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GKEBackupBackupPlanSpec.

func (*GKEBackupBackupPlanSpec) DeepCopyInto 

func (in *GKEBackupBackupPlanSpec) DeepCopyInto(out *GKEBackupBackupPlanSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GKEBackupBackupPlanStatus 

type GKEBackupBackupPlanStatus struct {
	/* Conditions represent the latest available observations of the
	   GKEBackupBackupPlan's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* etag is used for optimistic concurrency control as a way to help prevent simultaneous
	updates of a backup plan from overwriting each other. It is strongly suggested that
	systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates
	in order to avoid race conditions: An etag is returned in the response to backupPlans.get,
	and systems are expected to put that etag in the request to backupPlans.patch or
	backupPlans.delete to ensure that their change will be applied to the same version of the resource. */
	// +optional
	Etag *string `json:"etag,omitempty"`

	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	/* The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. */
	// +optional
	ProtectedPodCount *int64 `json:"protectedPodCount,omitempty"`

	/* The State of the BackupPlan. */
	// +optional
	State *string `json:"state,omitempty"`

	/* Detailed description of why BackupPlan is in its current state. */
	// +optional
	StateReason *string `json:"stateReason,omitempty"`

	/* Server generated, unique identifier of UUID format. */
	// +optional
	Uid *string `json:"uid,omitempty"`
}

func (*GKEBackupBackupPlanStatus) DeepCopy 

func (in *GKEBackupBackupPlanStatus) DeepCopy() *GKEBackupBackupPlanStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GKEBackupBackupPlanStatus.

func (*GKEBackupBackupPlanStatus) DeepCopyInto 

func (in *GKEBackupBackupPlanStatus) DeepCopyInto(out *GKEBackupBackupPlanStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.