ROX-14221: upgrade procedures for cloud #78259

kcarmichael08 · 2024-06-28T17:35:53Z

Version(s):
4.4+

Links to docs previews:

https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-operator
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-helm
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl

QE review:

QE has approved this change. (ACS has no QE, reviewed/ack'd by ACS SME)

Additional information:

Note to technical reviewers:
This material is reused from the RHACS docs where applicable. I have removed references to Central, but if there are things in these docs that do not apply to Cloud, please mark in your review. Thank you!

openshift-ci-robot · 2024-06-28T17:35:57Z

@kcarmichael08: This pull request references ROX-14221 which is a valid jira issue.

Details

In response to this:

Version(s):
4.4+

Issue

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

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-06-28T17:44:57Z

🤖 Tue Jul 16 21:48:55 - Prow CI generated the docs preview:
https://78259--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

openshift-ci-robot · 2024-06-28T18:21:02Z

@kcarmichael08: This pull request references ROX-14221 which is a valid jira issue.

Details

In response to this:

Version(s):
4.4+

Issue

Link to docs preview

QE review:

QE has approved this change.

Additional information:

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.

kcarmichael08 · 2024-07-02T17:16:42Z

/retest

openshift-ci-robot · 2024-07-02T19:44:41Z

@kcarmichael08: This pull request references ROX-14221 which is a valid jira issue.

Details

In response to this:

Version(s):
4.4+

Issue

Links to docs previews:

https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-operator
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-helm
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl

QE review:

QE has approved this change.

Additional information:

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.

kcarmichael08 · 2024-07-03T14:20:55Z

/retest

kcarmichael08 · 2024-07-03T15:17:33Z

/retest deploy-preview

openshift-ci-robot · 2024-07-03T18:33:32Z

@kcarmichael08: This pull request references ROX-14221 which is a valid jira issue.

Details

In response to this:

Version(s):
4.4+

Issue

Links to docs previews:

https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-operator
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-helm
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl

QE review:

QE has approved this change.

Additional information:

Note to technical reviewers:
This material is reused from the RHACS docs where applicable. I have removed references to Central, but if there are things in these docs that do not apply to Cloud, please mark in your review. Thank you!

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.

cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.adoc

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.adoc

openshift-ci-robot · 2024-07-15T14:58:08Z

@kcarmichael08: This pull request references ROX-14221 which is a valid jira issue.

Details

In response to this:

Version(s):
4.4+

Issue

Links to docs previews:

https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-operator
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-helm
https://78259--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl

QE review:

QE has approved this change. (ACS has no QE, reviewed/ack'd by ACS SME)

Additional information:

Note to technical reviewers:
This material is reused from the RHACS docs where applicable. I have removed references to Central, but if there are things in these docs that do not apply to Cloud, please mark in your review. Thank you!

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.

lahinson

Nice job on this large doc set! I made a few suggestions based on IBM Style and the OCP doc guidelines.

lahinson · 2024-07-16T14:57:00Z

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

+[role="_abstract"]
+You can upgrade your secured clusters in {product-title-managed-short} by using Helm charts.
+
+If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:


Suggested change

If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:

If you installed {product-title-short} secured clusters by using Helm charts, you can upgrade to the latest version of {product-title-short} by updating the Helm chart and running the `helm upgrade` command.

I removed the ordered list because in the preview, it looked like there was a procedure in the assembly, when the procedure is actually further down the page.

Removed "have" to use the simple present tense, per IBM Style.

IBM Style word usage advises against the term "perform" in technical content.

lahinson · 2024-07-16T15:01:18Z

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

+
+If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:
+
+. Update the Helm chart.


Suggested change

. Update the Helm chart.

lahinson · 2024-07-16T15:01:27Z

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

+If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:
+
+. Update the Helm chart.
+. Run the `helm upgrade` command.


Suggested change

. Run the `helm upgrade` command.

lahinson · 2024-07-16T15:08:34Z

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

+. Update the Helm chart.
+. Run the `helm upgrade` command.
+
+[role="_additional-resources"]


Suggested change

[role="_additional-resources"]

In the preview, it looks like maybe the "Updating the Helm chart repository" module is mixed up with an "Additional resources" section.

lahinson · 2024-07-16T15:08:46Z

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc

+. Run the `helm upgrade` command.
+
+[role="_additional-resources"]
+.Additional resources


Suggested change

.Additional resources

lahinson · 2024-07-16T15:41:17Z

modules/migrating-sccs-during-the-manual-upgrade.adoc

 ----
-
+endif::cloud-svc[]
 . To add the required roles and role bindings to use the {osp} SCCs for all secured clusters, perform the following steps:


Suggested change

. To add the required roles and role bindings to use the {osp} SCCs for all secured clusters, perform the following steps:

. To add the required roles and role bindings to use the {osp} SCCs for all secured clusters, complete the following steps:

lahinson · 2024-07-16T15:43:26Z

modules/operator-upgrade-change-subscription-channel.adoc

 ====
-You must change the subscription channel for all clusters where you have installed {product-title-short} Operator, including Central and all Secured clusters.
+ifndef::cloud-svc[]
+You must change the subscription channel for all clusters where you have installed the {product-title-short} Operator, including Central and all Secured clusters.


Suggested change

You must change the subscription channel for all clusters where you have installed the {product-title-short} Operator, including Central and all Secured clusters.

You must change the subscription channel for all clusters where you installed the {product-title-short} Operator, including Central and all Secured clusters.

lahinson · 2024-07-16T15:43:34Z

modules/operator-upgrade-change-subscription-channel.adoc

+You must change the subscription channel for all clusters where you have installed the {product-title-short} Operator, including Central and all Secured clusters.
+endif::[]
+ifdef::cloud-svc[]
+You must change the subscription channel for all secured clusters where you have installed the {product-title-short} Operator.


Suggested change

You must change the subscription channel for all secured clusters where you have installed the {product-title-short} Operator.

You must change the subscription channel for all secured clusters where you installed the {product-title-short} Operator.

lahinson · 2024-07-16T15:43:52Z

modules/operator-upgrade-change-subscription-channel.adoc

 .Prerequisites
+ifndef::cloud-svc[]
 * You must verify that you are using the latest {product-title-short} 3.74 Operator and there are no pending manual Operator upgrades.
 * You must verify that you have backed up your existing Central database.


Suggested change

* You must verify that you have backed up your existing Central database.

* You must verify that you backed up your Central database.

lahinson · 2024-07-16T15:44:53Z

modules/operator-upgrade-change-subscription-channel.adoc

 <1> If you use Kubernetes, enter `kubectl` instead of `oc`.

-During the update the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens once when you upgrade.
+During the update the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens after when you upgrade.


Suggested change

During the update the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens after when you upgrade.

During the update, the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens after when you upgrade.

In the second sentence, I'm not sure what you mean by "...and only happens after when you upgrade."

This is existing text, so I will ask (I don't know the answer).

kcarmichael08 · 2024-07-16T20:05:17Z

/retest

kcarmichael08 · 2024-07-16T21:12:41Z

/retest

openshift-ci · 2024-07-16T21:49:10Z

@kcarmichael08: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

kcarmichael08 · 2024-07-16T21:49:35Z

/cherrypick rhacs-docs-4.4

kcarmichael08 · 2024-07-16T21:49:44Z

/cherrypick rhacs-docs-4.5

openshift-cherrypick-robot · 2024-07-16T21:50:21Z

@kcarmichael08: #78259 failed to apply on top of branch "rhacs-docs-4.4":

Applying: upgrade procedures for cloud
.git/rebase-apply/patch:229: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	modules/change-collection-method.adoc
M	modules/install-roxctl-cli-linux.adoc
M	modules/install-roxctl-cli-macos.adoc
M	modules/prepare-operator-upgrades.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/prepare-operator-upgrades.adoc
CONFLICT (content): Merge conflict in modules/prepare-operator-upgrades.adoc
Auto-merging modules/install-roxctl-cli-macos.adoc
Auto-merging modules/install-roxctl-cli-linux.adoc
Auto-merging modules/change-collection-method.adoc
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 upgrade procedures for cloud
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick rhacs-docs-4.4

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.

openshift-cherrypick-robot · 2024-07-16T21:50:30Z

@kcarmichael08: new pull request created: #78968

Details

In response to this:

/cherrypick rhacs-docs-4.5

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.

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

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

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch 3 times, most recently from 0bc3a7b to 1e450db Compare July 2, 2024 17:07

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch 6 times, most recently from 2c271a1 to 336a2c6 Compare July 2, 2024 19:28

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch 11 times, most recently from f39aeae to e643462 Compare July 3, 2024 14:07

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch from e643462 to b9d567a Compare July 3, 2024 14:41

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch 2 times, most recently from f8aa662 to 86deb12 Compare July 3, 2024 17:18

vladbologa reviewed Jul 8, 2024

View reviewed changes

cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.adoc Outdated Show resolved Hide resolved

vladbologa reviewed Jul 8, 2024

View reviewed changes

cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc Outdated Show resolved Hide resolved

cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.adoc Outdated Show resolved Hide resolved

cloud_service/upgrading-cloud/upgrade-cloudsvc-operator.adoc Show resolved Hide resolved

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch from 86deb12 to e532cdd Compare July 15, 2024 14:45

kcarmichael08 added peer-review-needed Signifies that the peer review team needs to review this PR RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.4 Label for PRs that apply to RHACS 4.4 rhacs-docs-4.5 labels Jul 15, 2024

lahinson added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 16, 2024

lahinson reviewed Jul 16, 2024

View reviewed changes

lahinson 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 labels Jul 16, 2024

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch from e532cdd to 6e07f71 Compare July 16, 2024 18:57

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch from 6e07f71 to 04e22ea Compare July 16, 2024 21:40

upgrade procedures for cloud

8c03b55

kcarmichael08 force-pushed the ROX-14221-cloud-upgrade branch from 04e22ea to 8c03b55 Compare July 16, 2024 21:45

kcarmichael08 merged commit d6a92ee into openshift:rhacs-docs-main Jul 16, 2024

openshift-cherrypick-robot mentioned this pull request Jul 16, 2024

[rhacs-docs-4.5] ROX-14221: upgrade procedures for cloud #78968

Merged

kcarmichael08 mentioned this pull request Jul 16, 2024

[rhacs-docs-4.4] manual cherry pick of Updates for RHACS CS GA #78973

Merged

	If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:
	If you installed {product-title-short} secured clusters by using Helm charts, you can upgrade to the latest version of {product-title-short} by updating the Helm chart and running the `helm upgrade` command.


		If you have installed {product-title-short} secured clusters by using Helm charts, to upgrade to the latest version of {product-title-short} perform the following steps:

		. Update the Helm chart.

	. To add the required roles and role bindings to use the {osp} SCCs for all secured clusters, perform the following steps:
	. To add the required roles and role bindings to use the {osp} SCCs for all secured clusters, complete the following steps:

	You must change the subscription channel for all clusters where you have installed the {product-title-short} Operator, including Central and all Secured clusters.
	You must change the subscription channel for all clusters where you installed the {product-title-short} Operator, including Central and all Secured clusters.

	* You must verify that you have backed up your existing Central database.
	* You must verify that you backed up your Central database.

	During the update the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens after when you upgrade.
	During the update, the {product-title-short} Operator provisions a new deployment called `central-db` and your data begins migrating. It takes around 30 minutes and only happens after when you upgrade.

ROX-14221: upgrade procedures for cloud #78259

ROX-14221: upgrade procedures for cloud #78259

Uh oh!

Conversation

kcarmichael08 commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

kcarmichael08 commented Jul 2, 2024

Uh oh!

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

Uh oh!

Uh oh!

kcarmichael08 commented Jul 3, 2024

Uh oh!

kcarmichael08 commented Jul 3, 2024

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

lahinson 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!

kcarmichael08 commented Jul 16, 2024

Uh oh!

kcarmichael08 commented Jul 16, 2024

Uh oh!

openshift-ci bot commented Jul 16, 2024

Uh oh!

kcarmichael08 commented Jul 16, 2024

Uh oh!

kcarmichael08 commented Jul 16, 2024

Uh oh!

openshift-cherrypick-robot commented Jul 16, 2024

Uh oh!

openshift-cherrypick-robot commented Jul 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

kcarmichael08 commented Jun 28, 2024 •

edited

Loading

openshift-ci-robot commented Jun 28, 2024 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Jun 28, 2024 •

edited

Loading

openshift-ci-robot commented Jun 28, 2024 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jul 2, 2024 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jul 3, 2024 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jul 15, 2024 •

edited by openshift-ci bot

Loading