OSDOCS#11851: migrating disconnected update content by skopacz1 · Pull Request #81395 · openshift/openshift-docs

skopacz1 · 2024-09-05T20:13:35Z

Version(s): 4.17+

This PR migrates the content for updating a disconnected cluster to a new section of the docs where disconnected content is to be consolidated

Links to doc previews:

QE review:

QE has approved this change.

openshift-ci-robot · 2024-09-05T20:13:38Z

@skopacz1: This pull request references OSDOCS-11851 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set.

Details

In response to this:

OSDOCS-11851

Version(s): 4.17+

This PR migrates the content for updating a disconnected cluster to a new section of the docs where disconnected content is to be consolidated

Link to docs preview:

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-09-05T20:47:02Z

🤖 Thu Sep 12 14:28:25 - Prow CI generated the docs preview:
https://81395--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

openshift-ci-robot · 2024-09-05T20:53:31Z

@skopacz1: This pull request references OSDOCS-11851 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set.

Details

In response to this:

OSDOCS-11851

Version(s): 4.17+

This PR migrates the content for updating a disconnected cluster to a new section of the docs where disconnected content is to be consolidated

Links to doc previews:

About cluster updates in a disconnected environment

Mirroring OpenShift Container Platform images

Updating a cluster in a disconnected environment using OSUS

Updating a cluster in a disconnected environment without OSUS

Uninstalling OSUS from a cluster

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.

openshift-ci-robot · 2024-09-05T20:53:51Z

@skopacz1: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

Details

In response to this:

OSDOCS-11851

Version(s): 4.17+

This PR migrates the content for updating a disconnected cluster to a new section of the docs where disconnected content is to be consolidated

Links to doc previews:

About cluster updates in a disconnected environment

Mirroring OpenShift Container Platform images

Updating a cluster in a disconnected environment using OSUS

Updating a cluster in a disconnected environment without OSUS

Uninstalling OSUS from a cluster

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.

wking · 2024-09-09T23:34:33Z

disconnected/updating/index.adoc

 A disconnected environment is one in which your cluster nodes cannot access the internet.
 For this reason, you must populate a registry with the installation images.
 If your registry host cannot access both the internet and the cluster, you can mirror the images to a file system that is disconnected from that environment and then bring that host or removable media across that gap.
 If the local container registry and the cluster are connected to the mirror registry's host, you can directly push the release images to the local registry.


This text maybe came in via ccdbf03 , so orthogonal to this pull if you want to punt. But I was giving it a closer look as the lead-off for the new sub-section, and it seems like we could simplify. "registry host" seems to be talking about a local host that can run oc mirroring commands? Maybe something like:

A disconnected environment is one in which your cluster nodes cannot access the internet, or where you want to manage update recommendations and release images locally for policy or performance purposes. This section covers mirroring OpenShift Container Platform images, managing an OpenShift Update Service, and performing cluster updates in a disconnected environment.

or some such, that leaves details about mirroring to the subsection that covers mirroring?

I think that sort of rewording is a good idea, especially since, once the installation section's mirroring content is migrated to this section, I'd like to either delete the OTA mirroring page or leave it as a stub that points to the main mirroring content.

wking · 2024-09-09T23:39:12Z

disconnected/updating/index.adoc


-[id="about-disconnected-updates-uninstalling-osus"]
+[id="about-disconnected-updates-uninstalling-osus_{context}"]
 == Uninstalling the OpenShift Update Service from a cluster


Pre-existing nit: it seems unbalanced to talk about OSUS uninstall here as a top-level section, while OSUS install is tucked down under Performing a cluster update in a disconnected environment. You can punt as orthogonal to your change, but maybe this restructure gives us a chance to rebrand the current Updating a cluster in a disconnected environment using the OpenShift Update Service section as a Managing an OpenShift Update Service section or something? Because it's really aimed at the OSUS admins, with a small bit of once-per-cluster configuration, and then a Next steps section that basically says "now you can do all the usual connected update stuff" for the for-each-cluster-update part.

This sounds like an interesting idea and one that I'd personally be willing to implement. I agree that calling the OSUS page "managing OSUS" would make more sense given that the procedures there have nothing to do with actually performing the updates themselves.

For now, I think I'll focus on migrating the content over, and later I'll circle back to do the reframing

wking · 2024-09-09T23:41:52Z

disconnected/updating/index.adoc

+* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-OSUS[Updating a cluster in a disconnected environment using the OpenShift Update Service]

-* xref:../../../updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update.adoc#updating-restricted-network-cluster[Updating a cluster in a disconnected environment without the OpenShift Update Service]
+* xref:../../disconnected/updating/disconnected-update.adoc#updating-disconnected-cluster[Updating a cluster in a disconnected environment without the OpenShift Update Service]


OTA-821 is coming up on two years old with my pitch for why OSUS-assisted updates are worth the setup cost. Worth including any of those points as we reshuffle? Or continue to punt on that, and leave the trade-offs as something customers have to work out on their own?

So one of the things we hope to achieve with this overall reorg is, when we create the index page for this entire "disconnected environments" section, we want to include a subsection on that page that provides a sort of recommended/ideal path for the "typical user's" disconnected experience.

Basically it'll be a section where we recommend users use oc-mirror, the Agent-based Installer, and update using a local OSUS, and to not deviate unless some user need makes it necessary (for example choosing a different installation method due to some constraint).

I think it would be good to wait until that happens to see if that looks like enough "user steering", and if not then I'd be open to elaborating the OSUS vs no-OSUS advantages further somewhere in this OTA section

skopacz1 · 2024-09-10T18:01:46Z

@shellyyang1989 could you PTAL when you have a chance? Thank you!

JianLi-RH · 2024-09-11T06:52:32Z

disconnected/updating/index.adoc

+A disconnected environment is one in which your cluster nodes cannot access the internet, or where you want to manage update recommendations and release images locally for policy or performance purposes.
+This section covers mirroring {product-title} images, managing an OpenShift Update Service, and performing cluster updates in a disconnected environment.
+
+A single container image registry is sufficient to host mirrored images for several clusters in the disconnected network.


@skopacz1 @wking Since we removed the description of registry from this section, I think we'd better also remove this line and put it in next section Mirroring OpenShift Container Platform images.

JianLi-RH · 2024-09-11T08:36:58Z

Some document variables are not translated on preview page, for example Platform Branch in Installing the OpenShift CLI section on https://81395--ocpdocs-pr.netlify.app/openshift-enterprise/latest/disconnected/updating/mirroring-image-repository
Hope it is expected and will work normal on release page.

skopacz1 · 2024-09-11T13:52:02Z

@JianLi-RH yes the "Branch Build" that you see in the preview is the {product-version} attribute being resolved to a generic value for the preview. In the actual docs, that will resolve to whichever version of the docs you're looking at, such as 4.17

jneczypor · 2024-09-11T16:07:33Z

/label peer-review-in-progress

jneczypor

Just a few tiny things. It looks great to me!
LGTM
/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

jneczypor · 2024-09-11T22:00:32Z

_topic_maps/_topic_map.yml

+      File: index
+    - Name: Mirroring OpenShift Container Platform images
+      File: mirroring-image-repository
+    - Name: Updating a cluster in a disconnected environment using OSUS


Suggested change

- Name: Updating a cluster in a disconnected environment using OSUS

- Name: Updating a cluster in a disconnected environment by using OSUS

I would be okay with this but the actual title of the procedure is "Updating a cluster in a disconnected environment using the OpenShift Update Service", so the current naming more closely resembles the title of the page.

Also I guess technically the procedure is more like Updating a cluster in a disconnected environment while using OSUS, so maybe I can consider renaming the title in a later PR

jneczypor · 2024-09-11T22:01:00Z

_topic_maps/_topic_map.yml

+    - Name: Updating a cluster in a disconnected environment using OSUS
+      File: disconnected-update-osus
+      Distros: openshift-enterprise
+    - Name: Updating a cluster in a disconnected environment without OSUS


Suggested change

- Name: Updating a cluster in a disconnected environment without OSUS

- Name: Updating a cluster in a disconnected environment without using OSUS

Similar to the other comment, the name of the actual procedure is "Updating a cluster in a disconnected environment without the OpenShift Update Service".

Although I will keep these topic map titles as-is, this is definitely making me reconsider the name of these assemblies, so thanks!

jneczypor · 2024-09-11T22:10:34Z

disconnected/updating/index.adoc

+
+toc::[]
+
+A disconnected environment is one in which your cluster nodes cannot access the internet, or where you want to manage update recommendations and release images locally for policy or performance purposes.


Suggested change

A disconnected environment is one in which your cluster nodes cannot access the internet, or where you want to manage update recommendations and release images locally for policy or performance purposes.

A disconnected environment is one in which your cluster nodes cannot access the internet or where you want to manage update recommendations and release images locally for policy or performance purposes.

jneczypor · 2024-09-11T22:12:34Z

disconnected/updating/index.adoc

+
+You can use one of the following procedures to update a disconnected {product-title} cluster:
+
+* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-OSUS[Updating a cluster in a disconnected environment using the OpenShift Update Service]


Suggested change

* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-OSUS[Updating a cluster in a disconnected environment using the OpenShift Update Service]

* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-OSUS[Updating a cluster in a disconnected environment by using the OpenShift Update Service]

Although I agree that maybe there's a preposition missing in this title, the actual title doesn't have "by" in it. Thanks for catching this anyways

JianLi-RH · 2024-09-12T02:08:05Z

/lgtm

openshift-ci · 2024-09-12T14:19:36Z

New changes are detected. LGTM label has been removed.

openshift-ci · 2024-09-12T14:32:53Z

@skopacz1: 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.

skopacz1 · 2024-09-12T16:41:19Z

/cherrypick enterprise-4.17

openshift-cherrypick-robot · 2024-09-12T16:42:08Z

@skopacz1: new pull request created: #81725

Details

In response to this:

/cherrypick enterprise-4.17

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 Sep 5, 2024

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

skopacz1 added the branch/enterprise-4.17 label Sep 5, 2024

skopacz1 added this to the Planned for 4.17 GA milestone Sep 5, 2024

skopacz1 force-pushed the OSDOCS-11851 branch from a0aa0d1 to b054a99 Compare September 5, 2024 20:35

openshift deleted a comment from openshift-ci bot Sep 5, 2024

skopacz1 changed the title ~~OSDOCS-11851: migrating disconnected update content~~ OSDOCS#11851: migrating disconnected update content Sep 5, 2024

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

skopacz1 force-pushed the OSDOCS-11851 branch from b054a99 to 9d8f8c1 Compare September 6, 2024 18:01

wking reviewed Sep 9, 2024

View reviewed changes

JianLi-RH reviewed Sep 11, 2024

View reviewed changes

skopacz1 force-pushed the OSDOCS-11851 branch from 82945a6 to 29c1737 Compare September 11, 2024 13:53

skopacz1 added the peer-review-needed Signifies that the peer review team needs to review this PR label Sep 11, 2024

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

jneczypor reviewed Sep 11, 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 Sep 11, 2024

openshift-ci bot assigned JianLi-RH Sep 12, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 12, 2024

OSDOCS-11851: migrating disconnected update content

08793aa

skopacz1 force-pushed the OSDOCS-11851 branch from 29c1737 to 08793aa Compare September 12, 2024 14:19

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 12, 2024

skopacz1 merged commit daedd13 into openshift:main Sep 12, 2024

openshift-cherrypick-robot mentioned this pull request Sep 12, 2024

[enterprise-4.17] OSDOCS#11851: migrating disconnected update content #81725

Merged

skopacz1 deleted the OSDOCS-11851 branch March 11, 2025 17:16

	- Name: Updating a cluster in a disconnected environment using OSUS
	- Name: Updating a cluster in a disconnected environment by using OSUS


		toc::[]

		A disconnected environment is one in which your cluster nodes cannot access the internet, or where you want to manage update recommendations and release images locally for policy or performance purposes.


		You can use one of the following procedures to update a disconnected {product-title} cluster:

		* xref:../../disconnected/updating/disconnected-update-osus.adoc#updating-disconnected-cluster-OSUS[Updating a cluster in a disconnected environment using the OpenShift Update Service]

Conversation

skopacz1 commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Sep 5, 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 Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

openshift-ci-robot commented Sep 5, 2024

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!

skopacz1 Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skopacz1 Sep 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skopacz1 commented Sep 10, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JianLi-RH commented Sep 11, 2024

Uh oh!

skopacz1 commented Sep 11, 2024

Uh oh!

jneczypor commented Sep 11, 2024

Uh oh!

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

JianLi-RH commented Sep 12, 2024

Uh oh!

openshift-ci bot commented Sep 12, 2024

Uh oh!

openshift-ci bot commented Sep 12, 2024

Uh oh!

skopacz1 commented Sep 12, 2024

Uh oh!

openshift-cherrypick-robot commented Sep 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

skopacz1 commented Sep 5, 2024 •

edited

Loading

openshift-ci-robot commented Sep 5, 2024 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Sep 5, 2024 •

edited

Loading

openshift-ci-robot commented Sep 5, 2024 •

edited by openshift-ci bot

Loading

skopacz1 Sep 10, 2024 •

edited

Loading

skopacz1 Sep 10, 2024 •

edited

Loading