Backup API reference

ClusterName is the Name of the cluster where the backup is being performed.

ClusterKind is the kind of ClusterName recorded in Kurator.

BackupNameInCluster is the name of the backup being performed within this cluster. This BackupNameInCluster is unique in Storage.

BackupStatusInCluster is the current status of the backup performed within this cluster.

ResourceFilter specifies which resources should be included in the backup. It acts as a selective criterion to determine which resources are relevant for backup. If not set, the backup process will consider all resources. This filter helps in optimizing the backup process by excluding unnecessary data.

TTL is a time.Duration-parseable string describing how long the Backup should be retained for.

OrderedResources specifies the backup order of resources of specific Kind. The map key is the resource name and value is a list of object names separated by commas. Each resource name has format “namespace/objectname”. For cluster resources, simply use “objectname”. For example, if you have a specific order for pods, such as “pod1, pod2, pod3” with all belonging to the “ns1” namespace, and a specific order for persistentvolumes, such as “pv4, pv8”, you can use the orderedResources field in YAML format as shown below:

orderedResources:
pods: "ns1/pod1, ns1/pod2, ns1/pod3"
persistentvolumes: "pv4, pv8"

Schedule defines when to run the Backup using a Cron expression. A cron expression is a format used to specify the execution time of recurring tasks, consisting of multiple fields representing different time units. ┌───────────── minute (0 - 59) │ ┌───────────── hour (0 - 23) │ │ ┌───────────── day of the month (1 - 31) │ │ │ ┌───────────── month (1 - 12) │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday; │ │ │ │ │ 7 is also Sunday on some systems) │ │ │ │ │ │ │ │ │ │

For example, “30 * * * *” represents execution at the 30th minute of every hour, and “10 10,14 * * *” represents execution at 10:10 AM and 2:10 PM every day. If not set, the backup will be executed only once.

Destination indicates the clusters where backups should be performed.

Policy are the rules defining how backups should be performed.

Conditions represent the current state of the backup operation.

Phase represents the current phase of the backup operation.

Details provides a detailed status for each backup in each cluster.

MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Fleet represents the name of a fleet which determines a set of target clusters within the namespace. This field is required to identify the context for cluster selection.

Clusters allows users to specify a subset of clusters within the selected fleet for targeted operations. If not set, it implies that the operation is targeted at all clusters within the specified fleet.

ResourceFilter specifies the resources to be included in the migration. If not set, all resources in source cluster will be migrated.

OrderedResources specifies the backup order of resources of specific Kind. The map key is the resource name and value is a list of object names separated by commas. Each resource name has format “namespace/objectname”. For cluster resources, simply use “objectname”. For example, if you have a specific order for pods, such as “pod1, pod2, pod3” with all belonging to the “ns1” namespace, and a specific order for persistentvolumes, such as “pv4, pv8”, you can use the orderedResources field in YAML format as shown below:

orderedResources:
pods: "ns1/pod1, ns1/pod2, ns1/pod3"
persistentvolumes: "pv4, pv8"

NamespaceMapping is a map of source namespace names to target namespace names to migrate into. Any source namespaces not included in the map will be migrated into namespaces of the same name.

MigrateStatus specifies which resources we should migrate the status field. If nil, no objects are included. Optional.

PreserveNodePorts specifies whether to migrate old nodePorts from source cluster to target cluster.

SourceCluster represents the source cluster for migration. The user needs to ensure that SourceCluster points to only ONE cluster. Because the current migration only supports migrating from one SourceCluster to one or more TargetCluster.

TargetClusters represents the target clusters for migration.

Policy defines the rules for the migration.

Conditions represent the current state of the migration operation.

Phase represents the current phase of the migration operation.

SourceClusterStatus provides a detailed status for backup in SourceCluster.

TargetClusterStatus provides a detailed status for each restore in each TargetCluster.

IncludedResources determines which resources will have their status restored. By default, if this list is empty, it means the status for ALL resources will be restored. For example: - If you want to restore the status only for deployments and services, set: includedResources: [“deployments”, “services”] - If you leave it empty, the status for all resources will be restored. Note: If a resource is listed in both IncludedResources and ExcludedResources, the exclusion takes precedence.

ExcludedResources lists out the resources that will NOT have their status restored. By default, if this list is empty, it means the status for NO resources will be excluded from restoration. For instance: - If you want to prevent restoring the status for pods and configmaps, set: excludedResources: [“pods”, “configmaps”] - If you leave it empty, no resources are excluded, and all will have their status restored (unless specified otherwise in IncludedResources). Note: Exclusions listed here take precedence over inclusions. So, if a resource is listed in both, its status will NOT be restored.

IncludedNamespaces is a list of namespace names to include objects from. If empty, all namespaces are included.

ExcludedNamespaces contains a list of namespaces that are not included in the backup.

IncludedResources is a slice of API resource names to include in the backup. For example, we can populate this string array with [“deployments”, “configmaps”,“clusterroles”,“storageclasses”], then we will select all resources of type deployments and configmaps. If empty, all API resources are included. Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.

ExcludedResources is a slice of resource names that are not included in the backup. Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.

IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the backup. Cannot work with IncludedClusterScopedResources, ExcludedClusterScopedResources, IncludedNamespaceScopedResources and ExcludedNamespaceScopedResources.

IncludedClusterScopedResources is a slice of cluster-scoped resource type names to include in the backup. For example, we can populate this string array with [“storageclasses”, “clusterroles”], then we will select all resources of type storageclasses and clusterroles, If set to “*”, all cluster-scoped resource types are included. The default value is empty, which means only related cluster-scoped resources are included. Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.

ExcludedClusterScopedResources is a slice of cluster-scoped resource type names to exclude from the backup. If set to “*”, all cluster-scoped resource types are excluded. The default value is empty. Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.

IncludedNamespaceScopedResources is a slice of namespace-scoped resource type names to include in the backup. For example, we can populate this string array with [“deployments”, “configmaps”], then we will select all resources of type deployments and configmaps, The default value is “*”. Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.

ExcludedNamespaceScopedResources is a slice of namespace-scoped resource type names to exclude from the backup. If set to “*”, all namespace-scoped resource types are excluded. The default value is empty. Cannot work with IncludedResources, ExcludedResources and IncludeClusterResources.

LabelSelector is a metav1.LabelSelector to filter with when adding individual objects to the backup. If empty or nil, all objects are included. Optional.

OrLabelSelectors is list of metav1.LabelSelector to filter with when adding individual objects to the backup. If multiple provided they will be joined by the OR operator. LabelSelector as well as OrLabelSelectors cannot co-exist in backup request, only one of them can be used.

ClusterName is the Name of the cluster where the restore is being performed.

ClusterKind is the kind of ClusterName recorded in Kurator.

RestoreNameInCluster is the name of the restore being performed within this cluster. This RestoreNameInCluster is unique in Storage.

RestoreStatusInCluster is the current status of the restore performed within this cluster.

ResourceFilter is the filter for the resources to be restored. If not set, all resources from the backup will be restored.

NamespaceMapping is a map of source namespace names to target namespace names to restore into. Any source namespaces not included in the map will be restored into namespaces of the same name.

PreserveStatus specifies which resources we should restore the status field. If unset, no status will be restored.

PreserveNodePorts specifies whether to restore old nodePorts from backup. If not specified, default to false.

BackupName specifies the backup on which this restore operation is based.

Destination indicates the clusters where restore should be performed. if not set, all the clusters from Backup.spec.destination will perform restore.

Policy defines the customization rules for the restore. If null, the backup will be fully restored using default settings.

Conditions represent the current state of the restore operation.

Phase represents the current phase of the restore operation.

Details provides a detailed status for each restore in each cluster.