Skip to content

Commit e960c7b

Browse files
CarmiWisemonanarnold97
CarmiWisemon
authored and
anarnold97
committed
OADP 2419 Release Notes for OADP 1.3.0 & Upgrade notes for 1.2.0
1 parent d67a0fa commit e960c7b

12 files changed

+579
-1
lines changed

‎backup_and_restore/application_backup_and_restore/oadp-release-notes.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,32 @@ toc::[]
99

1010
The release notes for OpenShift API for Data Protection (OADP) describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues.
1111

12+
include::modules/oadp-release-notes-1-3-0.adoc[leveloffset=+1]
13+
include::modules/oadp-upgrade-from-oadp-data-mover-1-2-0.adoc[leveloffset=+3]
14+
include::modules/oadp-backing-up-dpa-configuration-1-3-0.adoc[leveloffset=+3]
15+
include::modules/oadp-upgrading-oadp-operator-1-3-0.adoc[leveloffset=+3]
16+
[role="_additional-resources"]
17+
.Additional resources
18+
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators]
19+
20+
include::modules/oadp-converting-dpa-to-new-version-1-3-0.adoc[leveloffset=+3]
21+
include::modules/oadp-verifying-upgrade-1-3-0.adoc[leveloffset=+3]
22+
1223
include::modules/oadp-release-notes-1-2-3.adoc[leveloffset=+1]
1324
1425
include::modules/oadp-release-notes-1-2-2.adoc[leveloffset=+1]
1526
1627
include::modules/oadp-release-notes-1-2-1.adoc[leveloffset=+1]
1728
1829
include::modules/oadp-release-notes-1-2-0.adoc[leveloffset=+1]
30+
include::modules/oadp-backing-up-dpa-configuration-1-2-0.adoc[leveloffset=+3]
31+
include::modules/oadp-upgrading-oadp-operator-1-2-0.adoc[leveloffset=+3]
32+
[role="_additional-resources"]
33+
.Additional resources
34+
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators]
35+
36+
include::modules/oadp-converting-to-new-dpa-1-2-0.adoc[leveloffset=+3]
37+
include::modules/oadp-verifying-upgrade-1-2-0.adoc[leveloffset=+3]
1938
2039
include::modules/oadp-release-notes-1-1-7.adoc[leveloffset=+1]
2140

‎modules/oadp-backing-up-dpa-configuration-1-2-0.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/oadp-release-notes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
7+
[id="oadp-backing-up-dpa-configuration-1-2-0_{context}"]
8+
= Backing up the DPA configuration
9+
10+
You must back up your current `DataProtectionApplication` (DPA) configuration.
11+
12+
.Procedure
13+
* Save your current DPA configuration by running the following command:
14+
+
15+
.Example
16+
[source,terminal]
17+
----
18+
$ oc get dpa -n openshift-adp -o yaml > dpa.orig.backup
19+
----
20+

‎modules/oadp-backing-up-dpa-configuration-1-3-0.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/oadp-release-notes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
7+
[id="oadp-backing-up-dpa-configuration-1-3-0_{context}"]
8+
= Backing up the DPA configuration
9+
10+
You must back up your current `DataProtectionApplication` (DPA) configuration.
11+
12+
.Procedure
13+
* Save your current DPA configuration by running the following command:
14+
+
15+
.Example
16+
[source,terminal]
17+
----
18+
$ oc get dpa -n openshift-adp -o yaml > dpa.orig.backup
19+
----

‎modules/oadp-converting-dpa-to-new-version-1-3-0.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/oadp-release-notes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
7+
[id="oadp-converting-dpa-to-new-version-1-3-0_{context}"]
8+
= Converting DPA to the new version
9+
10+
If you need to move backups off cluster with the Data Mover, reconfigure the `DataProtectionApplication` (DPA) manifest as follows.
11+
12+
.Procedure
13+
. Click *Operators* → *Installed Operators* and select the OADP Operator.
14+
. In the *Provided APIs* section, click *View more*.
15+
. Click *Create instance* in the *DataProtectionApplication* box.
16+
. Click *YAML View* to display the current DPA parameters.
17+
+
18+
.Example current DPA
19+
[source,yaml]
20+
----
21+
spec:
22+
configuration:
23+
features:
24+
dataMover:
25+
enable: true
26+
credentialName: dm-credentials
27+
velero:
28+
defaultPlugins:
29+
- vsm
30+
- csi
31+
- openshift
32+
# ...
33+
----
34+
35+
. Update the DPA parameters:
36+
* Remove the `features.dataMover` key and values from the DPA.
37+
* Remove the VolumeSnapshotMover (VSM) plugin.
38+
* Add the `nodeAgent` key and values.
39+
+
40+
.Example updated DPA
41+
[source,yaml]
42+
----
43+
spec:
44+
configuration:
45+
nodeAgent:
46+
enable: true
47+
uploaderType: kopia
48+
velero:
49+
defaultPlugins:
50+
- csi
51+
- openshift
52+
# ...
53+
----
54+
55+
. Wait for the DPA to reconcile successfully.

‎modules/oadp-converting-to-new-dpa-1-2-0.adoc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/oadp-release-notes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
7+
[id="oadp-converting-to-new-dpa-1-2-0_{context}"]
8+
= Converting DPA to the new version
9+
10+
If you use the fields that were updated in the `spec.configuration.velero.args` stanza, you must configure your `DataProtectionApplication` (DPA) manifest to use the new parameter names.
11+
12+
.Procedure
13+
14+
. Click *Operators* → *Installed Operators* and select the OADP Operator.
15+
. Select *Provided APIs*, click *Create instance* in the *DataProtectionApplication* box.
16+
. Click *YAML View* to display the current DPA parameters.
17+
+
18+
.Example current DPA
19+
[source,yaml]
20+
----
21+
spec:
22+
configuration:
23+
velero:
24+
args:
25+
default-volumes-to-restic: true
26+
default-restic-prune-frequency: 6000
27+
restic-timeout: 600
28+
# ...
29+
----
30+
31+
. Update the DPA parameters:
32+
. Update the DPA parameter names without changing their values:
33+
.. Change the `default-volumes-to-restic` key to `default-volumes-to-fs-backup`.
34+
.. Change the `default-restic-prune-frequency` key to `default-repo-maintain-frequency`.
35+
.. Change the `restic-timeout` key to `fs-backup-timeout`.
36+
37+
+
38+
.Example updated DPA
39+
[source,yaml]
40+
----
41+
spec:
42+
configuration:
43+
velero:
44+
args:
45+
default-volumes-to-fs-backup: true
46+
default-repo-maintain-frequency: 6000
47+
fs-backup-timeout: 600
48+
# ...
49+
----
50+
51+
. Wait for the DPA to reconcile successfully.

‎modules/oadp-release-notes-1-2-0.adoc

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * backup_and_restore/oadp-release-notes.adoc
44

55
:_mod-docs-content-type: REFERENCE
6-
[id="migration-oadp-release-notes-1-2-0_{context}"]
6+
[id="oadp-release-notes-1-2-0_{context}"]
77
= OADP 1.2.0 release notes
88

99
The OADP 1.2.0 release notes include information about new features, bug fixes, and known issues.
@@ -43,3 +43,33 @@ The HTTP/2 protocol is susceptible to a denial of service attack because request
4343
It is advised to upgrade to OADP 1.2.3, which resolves this issue.
4444

4545
For more information, see link:https://access.redhat.com/security/cve/cve-2023-39325[CVE-2023-39325 (Rapid Reset Attack)].
46+
47+
[id="Upgrade-notes-1-2-0_{context}"]
48+
== Upgrade notes
49+
50+
[NOTE]
51+
====
52+
Always upgrade to the next minor version. *Do not* skip versions. To update to a later version, upgrade only one channel at a time. For example, to upgrade from {oadp-first} 1.1 to 1.3, upgrade first to 1.2, then to 1.3.
53+
====
54+
55+
[id="changes-oadp-1-1-to-1-2_{context}"]
56+
=== Changes from OADP 1.1 to 1.2
57+
58+
The Velero server was updated from version 1.9 to 1.11.
59+
60+
In OADP 1.2, the `DataProtectionApplication` (DPA) configuration `spec.configuration.velero.args` has the following changes:
61+
62+
* The `default-volumes-to-restic` field was renamed to `default-volumes-to-fs-backup`. If you use `spec.velero`, you must add it again with the new name to your DPA after upgrading OADP.
63+
64+
* The `default-volumes-to-restic` field was renamed to `default-volumes-to-fs-backup`. If you use `spec.velero`, you must add it again with the new name to your DPA after upgrading OADP.
65+
66+
* The `restic-timeout` field was renamed to `fs-backup-timeout`. If you use `spec.velero`, you must add it again with the new name to your DPA after upgrading OADP.
67+
68+
* The `restic` daemon set was renamed to `node-agent`. OADP automatically updates the name of the daemon set.
69+
70+
* The custom resource definition `resticrepositories.velero.io` was renamed to `backuprepositories.velero.io`.
71+
72+
* The custom resource definition `resticrepositories.velero.io` can be removed from the cluster.
73+
74+
[id="upgrade-steps-1-2-0_{context}"]
75+
=== Upgrading steps

‎modules/oadp-release-notes-1-3-0.adoc

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/oadp-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="oadp-release-notes-1-3-0_{context}"]
7+
= OADP 1.3.0 release notes
8+
9+
The {oadp-first} 1.3.0 release notes lists new features, resolved issues and bugs, and known issues.
10+
11+
[id="new-features-1-3-0_{context}"]
12+
== New features
13+
14+
.Velero built-in DataMover
15+
16+
OADP 1.3 includes a built-in Data Mover that you can use to move Container Storage Interface (CSI) volume snapshots to a remote object store. The built-in Data Mover allows you to restore stateful applications from the remote object store if a failure, accidental deletion, or corruption of the cluster occurs. It uses Kopia as the uploader mechanism to read the snapshot data and to write to the Unified Repository.
17+
18+
19+
:FeatureName: Velero built-in DataMover
20+
include::snippets/technology-preview.adoc[]
21+
22+
.Backing up applications with File System Backup: Kopia or Restic
23+
24+
Velero’s File System Backup (FSB) supports two backup libraries: the Restic path and the Kopia path.
25+
26+
Velero allows users to select between the two paths.
27+
28+
For backup, specify the path during the installation through the `uploader-type` flag. The valid value is either `restic` or `kopia`. This field defaults to `kopia` if the value is not specified. The selection cannot be changed after the installation.
29+
30+
.GCP Cloud authentication
31+
32+
Google Cloud Platform (GCP) authentication enables you to use short-lived Google credentials.
33+
34+
GCP with Workload Identity Federation enables you to use Identity and Access Management (IAM) to grant external identities IAM roles, including the ability to impersonate service accounts. This eliminates the maintenance and security risks associated with service account keys.
35+
36+
.AWS ROSA STS authentication
37+
38+
You can use {oadp-first} with {product-rosa} (ROSA) clusters to backup and restore application data.
39+
40+
ROSA provides seamless integration with a wide range of AWS compute, database, analytics, machine learning, networking, mobile, and other services to speed up the building and delivering of differentiating experiences to your customers.
41+
42+
You can subscribe to the service directly from your AWS account.
43+
44+
After the clusters are created, you can operate your clusters by using the OpenShift web console. The ROSA service also uses OpenShift APIs and command-line interface (CLI) tools.
45+
46+
[id="resolved-issues-1-3-0_{context}"]
47+
== Resolved issues
48+
49+
.ACM applications were removed and re-created on managed clusters after restore
50+
Applications on managed clusters were deleted and re-created upon restore activation. {oadp-full} (OADP 1.2) backup and restore process is faster than the older versions. The OADP performance change caused this behavior when restoring ACM resources. Therefore, some resources were restored before other resources, which caused the removal of the applications from managed clusters.
51+
link:https://issues.redhat.com/browse/OADP-2686[OADP-2686]
52+
53+
54+
.Restic restore was partially failing due to Pod Security standard
55+
56+
During interoperability testing, {product-title} 4.14 had the pod Security mode set to `enforce`, which caused the pod to be denied. This was caused due to the restore order. The pod was getting created before the security context constraints (SCC) resource, since the pod violated the `podSecurity` standard, it denied the pod. When setting the restore priority field on the Velero server, restore is successful. link:https://issues.redhat.com/browse/OADP-2688[OADP-2688]
57+
58+
.Possible pod volume backup failure if Velero is installed in several namespaces
59+
60+
There was a regresssion in Pod Volume Backup (PVB) functionality when Velero was installed in several namespaces. The PVB controller was not properly limiting itself to PVBs in its own namespace.
61+
link:https://issues.redhat.com/browse/OADP-2308[OADP-2308]
62+
63+
.OADP Velero plugins returning "received EOF, stopping recv loop" message
64+
65+
In OADP, Velero plugins were started as separate processes. When the Velero operation completes, either successfully or not, they exit. Therefore, if you see a `received EOF, stopping recv loop` messages in debug logs, it does not mean an error occurred, it means that a plugin operation has completed. link:https://issues.redhat.com/browse/OADP-2176[OADP-2176]
66+
67+
.CVE-2023-39325 Multiple HTTP/2 enabled web servers are vulnerable to a DDoS attack (Rapid Reset Attack)
68+
In previous releases of OADP, the HTTP/2 protocol was susceptible to a denial of service attack because request cancellation could reset multiple streams quickly. The server had to set up and tear down the streams while not hitting any server-side limit for the maximum number of active streams per connection. This resulted in a denial of service due to server resource consumption.
69+
70+
For more information, see link:https://access.redhat.com/security/cve/cve-2023-39325[CVE-2023-39325 (Rapid Reset Attack)]
71+
72+
73+
For a complete list of all issues resolved in this release, see the list of link:https://issues.redhat.com/issues/?filter=12422837[OADP 1.3.0 resolved issues] in Jira.
74+
75+
[id="known-issues-1-3-0_{context}"]
76+
== Known issues
77+
78+
.CSI plugin errors on nil pointer when csiSnapshotTimeout is set to a short duration
79+
The CSI plugin errors on nil pointer when `csiSnapshotTimeout` is set to a short duration. Sometimes it succeeds to complete the snapshot within a short duration, but often it panics with the backup `PartiallyFailed` with the following error: `plugin panicked: runtime error: invalid memory address or nil pointer dereference`.
80+
81+
.Backup is marked as PartiallyFailed when volumeSnapshotContent CR has an error
82+
If any of the `VolumeSnapshotContent` CRs have an error related to removing the `VolumeSnapshotBeingCreated` annotation, it moves the backup to the `WaitingForPluginOperationsPartiallyFailed` phase. link:https://issues.redhat.com/browse/OADP-2871[OADP-2871]
83+
84+
.Performance issues when restoring 30,000 resources for the first time
85+
When restoring 30,000 resources for the first time, without an existing-resource-policy, it takes twice as long to restore them, than it takes during the second and third try with an existing-resource-policy set to `update`. link:https://issues.redhat.com/browse/OADP-3071[OADP-3071]
86+
87+
.Post restore hooks might start running before Datadownload operation has released the related PV
88+
Due to the asynchronous nature of the Data Mover operation, a post-hook might be attempted before the related pods persistent volumes (PVs) are released by the Data Mover persistent volume claim (PVC).
89+
90+
91+
.GCP-Workload Identity Federation VSL backup PartiallyFailed
92+
VSL backup `PartiallyFailed` when GCP workload identity is configured on GCP.
93+
94+
95+
For a complete list of all known issues in this release, see the list of link:https://issues.redhat.com/issues/?filter=12422838[OADP 1.3.0 known issues] in Jira.
96+
97+
[id="upgrade-notes-1-3-0_{context}"]
98+
== Upgrade notes
99+
100+
[NOTE]
101+
====
102+
Always upgrade to the next minor version. *Do not* skip versions. To update to a later version, upgrade only one channel at a time. For example, to upgrade from {oadp-first} 1.1 to 1.3, upgrade first to 1.2, and then to 1.3.
103+
====
104+
105+
[id="changes-oadp-1-2-to-1-3_{context}"]
106+
=== Changes from OADP 1.2 to 1.3
107+
108+
The Velero server has been updated from version 1.11 to 1.12.
109+
110+
{oadp-first} 1.3 uses the Velero built-in Data Mover instead of the VolumeSnapshotMover (VSM) or the Volsync Data Mover.
111+
112+
This changes the following:
113+
114+
* The `spec.features.dataMover` field and the VSM plugin are not compatible with OADP 1.3, and you must remove the configuration from the `DataProtectionApplication` (DPA) configuration.
115+
116+
* The Volsync Operator is no longer required for Data Mover functionality, and you can remove it.
117+
118+
* The custom resource definitions `volumesnapshotbackups.datamover.oadp.openshift.io` and `volumesnapshotrestores.datamover.oadp.openshift.io` are no longer required, and you can remove them.
119+
120+
* The secrets used for the OADP-1.2 Data Mover are no longer required, and you can remove them.
121+
122+
OADP 1.3 supports Kopia, which is an alternative file system backup tool to Restic.
123+
124+
* To employ Kopia, use the new `spec.configuration.nodeAgent` field as shown in the following example:
125+
+
126+
.Example
127+
[source,yaml]
128+
----
129+
spec:
130+
configuration:
131+
nodeAgent:
132+
enable: true
133+
uploaderType: kopia
134+
# ...
135+
----
136+
137+
* The `spec.configuration.restic` field is deprecated in OADP 1.3 and will be removed in a future version of OADP. To avoid seeing deprecation warnings, remove the `restic` key and its values, and use the following new syntax:
138+
+
139+
.Example
140+
[source,yaml]
141+
----
142+
spec:
143+
configuration:
144+
nodeAgent:
145+
enable: true
146+
uploaderType: restic
147+
# ...
148+
----
149+
150+
[NOTE]
151+
====
152+
In OADP 1.4, the `kopia` will become the default `uploaderType` value.
153+
====
154+
155+
[id="upgrade-steps-1-3-0_{context}"]
156+
=== Upgrading steps

0 commit comments

Comments
 (0)