enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80585

anarnold97 · 2024-08-16T12:56:57Z

Cherry pick to 4.13

Cherry Picked from enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80253 xref: 7eac7a7

Jira

OADP-4657 - [DOC] Release Notes for OADP 1.4.0 for OCP 4.13
- Release notes added to 4.13 to address the ACM issue. However, when @adellape was reviewing, there were so many corrections, rather than make them for just 4.13, I created this PR for the sake of uniformity. See this PR for further details. This created the need for the cherry pick

Version(s):

OCP 4.13 +

Link to docs preview:

OADP 1.4.0 release notes in OCP 4.13

QE review:

QE has approved this change.

openshift-ci-robot · 2024-08-16T12:57:02Z

@anarnold97: This pull request references OADP-4657 which is a valid jira issue.

In response to this:

Cherry pick to 4.13

Cherry Picked from enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80253 xref: 7eac7a7

Jira

OADP-4657 - [DOC] Release Notes for OADP 1.4.0 for OCP 4.13

Release notes added to 4.13 to address the ACM issue. However, when @adellape was reviewing, there were so many corrections, rather than make them for just 4.13, I created this PR for the sake of uniformity.

See this PR for further details.

Version(s):

OCP 4.13 +

Link to docs preview:

OADP 1.4.0 release notes in OCP 4.13

QE review:

QE has approved this change.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2024-08-16T13:03:09Z

🤖 Mon Aug 19 11:31:02 - Prow CI generated the docs preview:

https://80585--ocpdocs-pr.netlify.app/openshift-enterprise/latest/backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.html

openshift-ci-robot · 2024-08-16T13:07:03Z

@anarnold97: This pull request references OADP-4657 which is a valid jira issue.

In response to this:

Cherry pick to 4.13

Cherry Picked from enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80253 xref: 7eac7a7

Jira

OADP-4657 - [DOC] Release Notes for OADP 1.4.0 for OCP 4.13

Release notes added to 4.13 to address the ACM issue. However, when @adellape was reviewing, there were so many corrections, rather than make them for just 4.13, I created this PR for the sake of uniformity. See this PR for further details. This created the need for the cherry pick

Version(s):

OCP 4.13 +

Link to docs preview:

OADP 1.4.0 release notes in OCP 4.13

QE review:

QE has approved this change.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

anarnold97 · 2024-08-16T13:07:24Z

/label oadp

anarnold97 · 2024-08-16T13:07:43Z

/label peer-review-needed

agantony · 2024-08-19T09:16:06Z

/label peer-review-in-progress

anarnold97 · 2024-08-19T11:10:55Z

Updated to include topic map

Signed-off-by: A.Arnold <anarnold@redhat.com>

openshift-ci · 2024-08-19T11:32:30Z

@anarnold97: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

agantony

Added a few suggestions for your conisderation; overall lgtm!

agantony · 2024-08-19T13:19:40Z

backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc

+* 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


Upgrading DPA ....?

agantony · 2024-08-19T13:22:15Z

backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc

+[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.


Suggested change

To upgrade from OADP 1.3 to 1.4, no Data Protection Application (DPA) changes are required.

To upgrade from OADP 1.3 to 1.4, you do not need to make any changes to the Data Protection Application (DPA).

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

agantony · 2024-08-19T13:25:21Z

backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc

+[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.


Suggested change

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.

To verify the installation, complete the steps in 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.

agantony · 2024-08-19T13:32:10Z

modules/oadp-1-4-0-release-notes.adoc

+:_template-generated: 2024-06-28
+// Module included in the following assemblies:
+//
+// * backup_and_restore/oadp-1-4-release-notes.adoc


Update the correct relative path. Applicable to all modules.

This seems like a required change to me

agantony · 2024-08-19T13:33:33Z

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

+[id="oadp-backing-up-dpa-configuration-1-4-0_{context}"]
+= Backing up the DPA configuration
+
+You must back up your current `DataProtectionApplication` (DPA) configuration.


Would be nice if we can highlight why we are doing this?

Data Protection Application (DPA) ??

Is the imperative here maybe something like, "Before upgrading, you must back up your current DataProtectionApplication (DPA) configuration."

agantony · 2024-08-19T14:19:20Z

modules/oadp-1-4-0-release-notes.adoc

+
+* 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.
+
+* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.


Suggested change

* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.

* Velero has changed the default values for client burst and QPS from 30 and 20 to 100 and 100 respectively.

agantony · 2024-08-19T14:21:45Z

modules/oadp-1-4-0-release-notes.adoc

+
+* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.
+
+* 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.


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.

* The `velero-plugin-for-aws` plugin has updated the 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].

+

[NOTE]

====

The checksum algorithms only work with AWS.

====

Expand AWS??

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

agantony · 2024-08-19T14:22:09Z

modules/oadp-1-4-0-release-notes.adoc

+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.


Suggested change

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.

For some S3 providers, you must disable the `md5sum`. To disable the `md5sum`, you must set the checksum algorithm to `""`. Confirm the `md5sum` support and configuration of the `md5sum` algorithm 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 DPA. If your BSLs are created outside of DPA, you can upgrade this configuration by using `spec.config.checksumAlgorithm` in the BSLs.

agantony · 2024-08-19T14:23:47Z

backup_and_restore/application_backup_and_restore/release-notes/oadp-1-4-release-notes.adoc

+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]


Suggested change

* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators]

* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Changing the update channel for an Operator]

agantony · 2024-08-19T14:24:29Z

modules/oadp-1-4-0-release-notes.adoc

+[id="changes-oadp-1-3-to-1-4_{context}"]
+=== Changes from OADP 1.3 to 1.4


Can we make this a concept module?

agantony · 2024-08-19T14:41:21Z

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

anarnold97 · 2024-08-19T14:43:35Z

/label merge-review-needed

skrthomas · 2024-08-19T18:51:46Z

@anarnold97 I notice there are many of @agantony 's peer review comments that still need to be addressed. If you choose not to accept, please write a response at least so that merge reviewers will know you've seen and interpreted the feedback. Once you've made your commit with the peer-review feedback incorporated, please add the merge-review-needed label back.

skrthomas · 2024-08-19T19:40:07Z

modules/oadp-1-4-0-release-notes.adoc

+[id="changes-oadp-1-3-to-1-4_{context}"]
+=== Changes from OADP 1.3 to 1.4
+
+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).


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.

skrthomas · 2024-08-19T19:40:47Z

modules/oadp-1-4-0-release-notes.adoc

+
+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).
+
+This changes the following:


I agree, being more specific that the update changes the following items is clearer.

skrthomas · 2024-08-19T19:47:21Z

modules/oadp-1-4-0-release-notes.adoc

+
+* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.
+
+* 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.


We cannot link to GitHub, per https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-to-external-websites.

skrthomas · 2024-08-19T19:48:23Z

modules/oadp-1-4-0-release-notes.adoc

+
+* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.
+
+* 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.


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

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 16, 2024

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 16, 2024

openshift-ci bot added the OADP Label for all OADP PRs label Aug 16, 2024

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Aug 16, 2024

openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Aug 19, 2024

anarnold97 force-pushed the 4.13-OADP-1-4-release-notes-update-4.13-review branch from 7d206ed to 7fbac1e Compare August 19, 2024 11:10

enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13

682666a

Signed-off-by: A.Arnold <anarnold@redhat.com>

anarnold97 force-pushed the 4.13-OADP-1-4-release-notes-update-4.13-review branch from 6d8aa3a to 682666a Compare August 19, 2024 11:24

agantony reviewed Aug 19, 2024

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Aug 19, 2024

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Aug 19, 2024

skrthomas reviewed Aug 19, 2024

View reviewed changes

anarnold97 closed this Aug 19, 2024

	To upgrade from OADP 1.3 to 1.4, no Data Protection Application (DPA) changes are required.
	To upgrade from OADP 1.3 to 1.4, you do not need to make any changes to the Data Protection Application (DPA).

	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.
	To verify the installation, complete the steps in 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.


		* 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.

		* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.

	* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.
	* Velero has changed the default values for client burst and QPS from 30 and 20 to 100 and 100 respectively.


		* Velero changed client Burst and QPS defaults from 30 and 20 to 100 and 100, respectively.

		* 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.

	* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Updating installed Operators]
	* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-changing-update-channel_olm-upgrading-operators[Changing the update channel for an Operator]

		[id="changes-oadp-1-3-to-1-4_{context}"]
		=== Changes from OADP 1.3 to 1.4


		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).

		This changes the following:

enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80585

enterprise-4.13 OADP-4657: Release Notes for 1.4.0 for OCP 4.13 #80585

Uh oh!

Conversation

anarnold97 commented Aug 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Cherry pick to 4.13

Jira

Version(s):

Link to docs preview:

QE review:

Uh oh!

openshift-ci-robot commented Aug 16, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Cherry pick to 4.13

Jira

Version(s):

Link to docs preview:

QE review:

Uh oh!

ocpdocs-previewbot commented Aug 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Aug 16, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Cherry pick to 4.13

Jira

Version(s):

Link to docs preview:

QE review:

Uh oh!

anarnold97 commented Aug 16, 2024

Uh oh!

anarnold97 commented Aug 16, 2024

Uh oh!

agantony commented Aug 19, 2024

Uh oh!

anarnold97 commented Aug 19, 2024

Uh oh!

openshift-ci bot commented Aug 19, 2024

Uh oh!

agantony left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

agantony commented Aug 19, 2024

Uh oh!

anarnold97 commented Aug 19, 2024

Uh oh!

anarnold97 commented Aug 16, 2024 •

edited

Loading

openshift-ci-robot commented Aug 16, 2024 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Aug 16, 2024 •

edited

Loading

openshift-ci-robot commented Aug 16, 2024 •

edited by openshift-ci bot

Loading