Skip to content

Commit 213b827

Browse files
authored
Merge pull request #109069 from lahinson/osdocs-16094-hcp-hc-shared-namespace
[OSDOCS-16095]: Adding note about shared namespaces to HCP on Virt DR docs
2 parents 5d2511a + 262f943 commit 213b827

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

modules/backup-hosted-cluster-virt.adoc

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[id="backup-hosted-cluster-virt_{context}"]
77
= Backing up a hosted cluster on {VirtProductName}
88

9+
[role="_abstract"]
910
When you back up a hosted cluster on {VirtProductName}, the hosted cluster can remain running. The backup contains the hosted control plane components and the etcd for the hosted cluster.
1011

1112
When the hosted cluster is not running compute nodes on external infrastructure, hosted cluster workload data that is stored in persistent volume claims (PVCs) that are provisioned by KubeVirt CSI are also backed up. The backup does not contain any KubeVirt virtual machines (VMs) that are used as compute nodes. Those VMs are automatically re-created after the restore process is completed.
@@ -24,7 +25,7 @@ metadata:
2425
labels:
2526
velero.io/storage-location: default
2627
spec:
27-
includedNamespaces: <1>
28+
includedNamespaces:
2829
- clusters
2930
- clusters-hosted
3031
includedResources:
@@ -49,23 +50,31 @@ spec:
4950
- service
5051
- route
5152
excludedResources: [ ]
52-
labelSelector: <2>
53+
labelSelector:
5354
matchExpressions:
5455
- key: 'hypershift.openshift.io/is-kubevirt-rhcos'
5556
operator: 'DoesNotExist'
5657
storageLocation: default
5758
preserveNodePorts: true
5859
ttl: 4h0m0s
59-
snapshotMoveData: true <3>
60-
datamover: "velero" <4>
61-
defaultVolumesToFsBackup: false <5>
60+
snapshotMoveData: true
61+
datamover: "velero"
62+
defaultVolumesToFsBackup: false
6263
----
6364
+
64-
<1> This field selects the namespaces from the objects to back up. Include namespaces from both the hosted cluster and the hosted control plane. In this example, `clusters` is a namespace from the hosted cluster and `clusters-hosted` is a namespace from the hosted control plane. By default, the `HostedControlPlane` namespace is `clusters-<hosted_cluster_name>`.
65-
<2> The boot image of the VMs that are used as the hosted cluster nodes are stored in large PVCs. To reduce backup time and storage size, you can filter those PVCs out of the backup by adding this label selector.
66-
<3> This field and the `datamover` field enable automatically uploading the CSI `VolumeSnapshots` to remote cloud storage.
67-
<4> This field and the `snapshotMoveData` field enable automatically uploading the CSI `VolumeSnapshots` to remote cloud storage.
68-
<5> This field indicates whether pod volume file system backup is used for all volumes by default. Set this value to `false` to back up the PVCs that you want.
65+
where:
66+
+
67+
`includedNamespaces`:: Specifies the namespaces from the objects to back up. Include namespaces from both the hosted cluster and the hosted control plane. In this example, `clusters` is a namespace from the hosted cluster and `clusters-hosted` is a namespace from the hosted control plane.
68+
+
69+
[IMPORTANT]
70+
====
71+
If you store all hosted cluster information in a shared namespace and then back up and restore a hosted cluster, you might unintentionally change other hosted clusters. To avoid this issue, do not store all hosted cluster information in a shared namespace. Alternatively, you can back up and restore resources based on labels.
72+
====
73+
+
74+
`labelSelector`:: Specifies the boot image of the VMs that are used as the hosted cluster nodes are stored in large PVCs. To reduce backup time and storage size, you can filter those PVCs out of the backup by adding this label selector.
75+
`snapshotMoveData`:: Along with the `datamover` field, specifies that the CSI `VolumeSnapshots` are automatically uploaded to remote cloud storage.
76+
`datamover`:: Along with the `snapshotMoveData` field, specifies that the CSI `VolumeSnapshots` are automatically uploaded to remote cloud storage.
77+
`defaultVolumesToFsBackup`:: Specifies whether pod volume file system backup is used for all volumes by default. Set this value to `false` to back up the PVCs that you want.
6978

7079
. Apply the changes to the YAML file by entering the following command:
7180
+

0 commit comments

Comments
 (0)