enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80585
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||
| :_mod-docs-content-type: ASSEMBLY | ||||||
| [id="oadp-1-4-release-notes"] | ||||||
| = OADP 1.4 release notes | ||||||
| include::_attributes/common-attributes.adoc[] | ||||||
| include::_attributes/attributes-openshift-dedicated.adoc[] | ||||||
| :context: oadp-1-4-release-notes | ||||||
|
|
||||||
| toc::[] | ||||||
|
|
||||||
| The release notes for {oadp-first} describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues. | ||||||
|
|
||||||
| include::modules/oadp-1-4-0-release-notes.adoc[leveloffset=+1] | ||||||
| include::modules/oadp-backing-up-dpa-configuration-1-4-0.adoc[leveloffset=+3] | ||||||
| include::modules/oadp-upgrading-oadp-operator-1-4-0.adoc[leveloffset=+3] | ||||||
| [role="_additional-resources"] | ||||||
| .Additional resources | ||||||
| * xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators] | ||||||
|
|
||||||
| [id="oadp-converting-dpa-to-new-version-1-4-0_{context}"] | ||||||
| === Converting DPA to the new version | ||||||
|
|
||||||
|
|
||||||
| To upgrade from OADP 1.3 to 1.4, no Data Protection Application (DPA) changes are required. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. To keep the customer action center here, adding the suggested verbiage is needed: https://redhat-documentation.github.io/supplementary-style-guide/#_principle_1_customer_focus_and_action_orientation |
||||||
|
|
||||||
| [id="verifying-upgrade-1-4-0_{context}"] | ||||||
| === Verifying the upgrade | ||||||
|
|
||||||
| Verify the installation by following steps from the xref:../../../backup_and_restore/application_backup_and_restore/release-notes/oadp-release-notes-1-2.adoc#verifying-upgrade-1-2-0_oadp-release-notes[Verifying the upgrade] section. | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,66 @@ | ||||||||||||||||||||
| :_newdoc-version: 2.18.3 | ||||||||||||||||||||
| :_template-generated: 2024-06-28 | ||||||||||||||||||||
| // Module included in the following assemblies: | ||||||||||||||||||||
| // | ||||||||||||||||||||
| // * backup_and_restore/oadp-1-4-release-notes.adoc | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Update the correct relative path. Applicable to all modules.
Contributor
There was a problem hiding this comment. This seems like a required change to me |
||||||||||||||||||||
|
|
||||||||||||||||||||
| :_mod-docs-content-type: REFERENCE | ||||||||||||||||||||
|
|
||||||||||||||||||||
| [id="oadp-1-4-0-release-notes_{context}"] | ||||||||||||||||||||
| = OADP 1.4.0 release notes | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The {oadp-first} 1.4.0 release notes lists resolved issues and known issues. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. Subject/ Verb agreement required change. See https://www.ibm.com/docs/en/ibm-style?topic=grammar-verbs#general-guidelines |
||||||||||||||||||||
|
|
||||||||||||||||||||
| [id="resolved-issues-1-4-0_{context}"] | ||||||||||||||||||||
| == Resolved issues | ||||||||||||||||||||
|
|
||||||||||||||||||||
| .Restore works correctly in {product-title} 4.16 | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Previously, while restoring the deleted application namespace, the restore operation partially failed with the `resource name may not be empty` error in {product-title} 4.16. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. This seems like more of a suggestion. I think the way Andy has the error message inline is OK too. I can't find guidance explicitly saying not to do it like this. |
||||||||||||||||||||
| With this update, restore works as expected in {product-title} 4.16. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. Adding an article: https://www.ibm.com/docs/en/ibm-style?topic=grammar-articles |
||||||||||||||||||||
| link:https://issues.redhat.com/browse/OADP-4075[OADP-4075] | ||||||||||||||||||||
|
|
||||||||||||||||||||
| .Data Mover backups work properly in the {product-title} 4.16 cluster | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Previously, Velero was using the earlier version of SDK where the `Spec.SourceVolumeMode` field did not exist. As a consequence, Data Mover backups failed in the {product-title} 4.16 cluster on the external snapshotter with version 4.2. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment.
|
||||||||||||||||||||
| With this update, external snapshotter is upgraded to version 7.0 and later. As a result, backups do not fail in the {product-title} 4.16 cluster. | ||||||||||||||||||||
| link:https://issues.redhat.com/browse/OADP-3922[OADP-3922] | ||||||||||||||||||||
|
|
||||||||||||||||||||
| For a complete list of all issues resolved in this release, see the list of link:https://issues.redhat.com/issues/?filter=12438505[OADP 1.4.0 resolved issues] in Jira. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| [id="known-issues-1-4-0_{context}"] | ||||||||||||||||||||
| == Known issues | ||||||||||||||||||||
|
|
||||||||||||||||||||
| .Backup fails when checksumAlgorithm is not set for MCG | ||||||||||||||||||||
|
|
||||||||||||||||||||
| While performing a backup of any application with Noobaa as the backup location, if the `checksumAlgorithm` configuration parameter is not set, backup fails. To fix this problem, if you do not provide a value for `checksumAlgorithm` in the Backup Storage Location (BSL) configuration, an empty value is added. | ||||||||||||||||||||
| The empty value is only added for BSLs that are created using Data Protection Application (DPA) custom resource (CR), and this value is not added if BSLs are created using any other method. | ||||||||||||||||||||
| link:https://issues.redhat.com/browse/OADP-4274[OADP-4274] | ||||||||||||||||||||
|
Comment on lines
+37
to
+39
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| For a complete list of all known issues in this release, see the list of link:https://issues.redhat.com/issues/?filter=12438506[OADP 1.4.0 known issues] in Jira. | ||||||||||||||||||||
|
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| [id="upgrade-notes-1-4-0_{context}"] | ||||||||||||||||||||
| == Upgrade notes | ||||||||||||||||||||
|
|
||||||||||||||||||||
| [NOTE] | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. Since this seems like a required step, changing from a NOTE to IMPORTANT seems appropriate here: https://redhat-documentation.github.io/supplementary-style-guide/#admonitions |
||||||||||||||||||||
| ==== | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
| ==== | ||||||||||||||||||||
|
|
||||||||||||||||||||
| [id="changes-oadp-1-3-to-1-4_{context}"] | ||||||||||||||||||||
| === Changes from OADP 1.3 to 1.4 | ||||||||||||||||||||
|
Comment on lines
+52
to
+53
Contributor
There was a problem hiding this comment. Can we make this a concept module? |
||||||||||||||||||||
|
|
||||||||||||||||||||
| The Velero server has been updated from version 1.12 to 1.14. Note that there are no changes in the Data Protection Application (DPA). | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment.
IBMSG: To upgrade is to replace software with a new release or fix level of the same program or to replace hardware with a newer model or more powerful technology. An upgrade involves little work on the user’s part. |
||||||||||||||||||||
|
|
||||||||||||||||||||
| This changes the following: | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. I agree, being more specific that the update changes the following items is clearer. |
||||||||||||||||||||
|
|
||||||||||||||||||||
| * The `velero-plugin-for-csi` code is now available in the Velero code, which means an `init` container is no longer required for the plugin. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| * Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| * The `velero-plugin-for-aws` plugin updated default value of the `spec.config.checksumAlgorithm` field in `BackupStorageLocation` objects (BSLs) from `""` (no checksum calculation) to the `CRC32` algorithm. For more information, see link:https://github.com/vmware-tanzu/velero-plugin-for-aws/blob/release-1.10/backupstoragelocation.md[Velero plugins for AWS Backup Storage Location]. The checksum algorithm types are known to work only with AWS. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Contributor
There was a problem hiding this comment. It looks like this is the first mention of AWS on the page, just by a cursory glance. If that's the case then IBMSG recommends spelling out first mention: https://www.ibm.com/docs/en/ibm-style?topic=references-product-service-names#service-names
Contributor
There was a problem hiding this comment. We cannot link to GitHub, per https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-to-external-websites. |
||||||||||||||||||||
| Several S3 providers require the `md5sum` to be disabled by setting the checksum algorithm to `""`. Confirm `md5sum` algorithm support and configuration with your storage provider. | ||||||||||||||||||||
| + | ||||||||||||||||||||
| In OADP 1.4, the default value for BSLs created within DPA for this configuration is `""`. This default value means that the `md5sum` is not checked, which is consistent with OADP 1.3. For BSLs created within DPA, update it by using the `spec.backupLocations[].velero.config.checksumAlgorithm` field in the DPA. If your BSLs are created outside DPA, you can update this configuration by using `spec.config.checksumAlgorithm` in the BSLs. | ||||||||||||||||||||
|
Comment on lines
+64
to
+66
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * backup_and_restore/oadp-1-4-release-notes.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="oadp-backing-up-dpa-configuration-1-4-0_{context}"] | ||
| = Backing up the DPA configuration | ||
|
|
||
| You must back up your current `DataProtectionApplication` (DPA) configuration. | ||
|
Contributor
There was a problem hiding this comment. Would be nice if we can highlight why we are doing this?
Contributor
There was a problem hiding this comment. Data Protection Application (DPA) ??
Contributor
There was a problem hiding this comment. Is the imperative here maybe something like, "Before upgrading, you must back up your current |
||
|
|
||
| .Procedure | ||
|
|
||
| * Save your current DPA configuration by running the following command: | ||
| + | ||
| .Example command | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get dpa -n openshift-adp -o yaml > dpa.orig.backup | ||
|
Contributor
There was a problem hiding this comment. Add callout to explain the command? |
||
| ---- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * backup_and_restore/oadp-1-4-release-notes.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="oadp-upgrading-dpa-operator-1-4-0_{context}"] | ||
| = Upgrading the OADP Operator | ||
|
|
||
| Use the following procedure when upgrading the {oadp-first} Operator. | ||
|
Contributor
There was a problem hiding this comment. Avoid self-referential intro. Write something that highlights the purpose of the module.
Contributor
There was a problem hiding this comment. |
||
|
|
||
| .Procedure | ||
|
|
||
| . Change your subscription channel for the OADP Operator from `stable-1.3` to `stable-1.4`. | ||
| . Wait for the Operator and containers to update and restart. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.