fix docs for VM live migration network by johnsimcall · Pull Request #72586 · openshift/openshift-docs

johnsimcall · 2024-03-05T04:55:28Z

Avoid using the number-2 callout/identifier multiple times. Instruct users to create the net-attach-def in a particular namespace. Avoid using NAD abbreviation when the short form of NetworkAttachmentDefinition is net-attach-def

Version(s):
Applies to all versions of OpenShift documentation

Issue:
No issue exists. Do I need to create a Jira / Bugzilla for a minor change like this?

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Avoid using the openshift#2 callout/identifier multiple times. Instruct users to create the net-attach-def in a particular namespace. Avoid using NAD abbreviation when the short form of NetworkAttachmentDefinition is net-attach-def

openshift-ci · 2024-03-05T04:56:45Z

Hi @johnsimcall. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

johnsimcall · 2024-03-05T04:56:46Z

@openshift/team-documentation - would you please review this minor change that improves the documentation for creating a dedicated live migration network for KubeVirt / OpenShift Virtualization?

kalexand-rh · 2024-03-08T18:59:07Z

/ok-to-test

ocpdocs-previewbot · 2024-03-08T19:05:31Z

🤖 Fri Mar 08 19:05:31 - Prow CI generated the docs preview:
https://72586--ocpdocs-pr.netlify.app

ousleyp · 2024-03-11T18:40:48Z

@sjhala-ccs, can you please review this networking-related change? Thanks. :)

sjhala-ccs

@johnsimcall Thank you for catching this doc issue. The call out numbering and description seems fine for 4.13 and earlier versions. The changes were likely introduced during the network docs reorganization applied to 4.14+.

sjhala-ccs · 2024-03-11T20:13:39Z

-<4> Specify an IP address range for the secondary network. This range must not overlap the IP addresses of the main network.
+<2> The `NetworkAttachmentDefinition` object must be created in the {CNVNamespace} namespace.
+<3> Specify the name of the NIC to be used for live migrations.
+<4> Specify the name of the CNI plugin that provides the network for the `NetworkAttachmentDefinition`.


Suggested change

<4> Specify the name of the CNI plugin that provides the network for the `NetworkAttachmentDefinition`.

<4> Specify the name of the CNI plugin that provides the network for the network attachment definition.

sjhala-ccs · 2024-03-11T20:17:42Z

-<2> Specify the name of the NIC to be used for live migration.
-<3> Specify the name of the CNI plugin that provides the network for the NAD.
-<4> Specify an IP address range for the secondary network. This range must not overlap the IP addresses of the main network.
+<2> The `NetworkAttachmentDefinition` object must be created in the {CNVNamespace} namespace.


Suggested change

<2> The `NetworkAttachmentDefinition` object must be created in the {CNVNamespace} namespace.

<2> Specify the namespace where the `NetworkAttachmentDefinition` object resides. This must be `{CNVNamespace}`.

openshift-ci · 2024-04-12T13:44:39Z

@johnsimcall: 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/test-infra repository. I understand the commands that are listed here.

openshift-bot · 2024-09-25T01:00:24Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

bergerhoffer · 2024-10-14T15:04:09Z

The branch/enterprise-4.18 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.17. And any PR going into main must also target the latest version branch (enterprise-4.18).

If the update in your PR does NOT apply to version 4.18 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

openshift-bot · 2024-11-14T08:30:40Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2024-12-15T00:00:44Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2024-12-15T00:01:24Z

@openshift-bot: Closed this PR.

Details

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

fix docs for VM live migration network

731be76

Avoid using the openshift#2 callout/identifier multiple times. Instruct users to create the net-attach-def in a particular namespace. Avoid using NAD abbreviation when the short form of NetworkAttachmentDefinition is net-attach-def

openshift-ci Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 5, 2024

kalexand-rh requested a review from ousleyp March 8, 2024 18:59

openshift-ci Bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 8, 2024

sjhala-ccs added CNV Label for all CNV PRs branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 labels Mar 11, 2024

sjhala-ccs added this to the Continuous Release milestone Mar 11, 2024

sjhala-ccs reviewed Mar 11, 2024

View reviewed changes

sjhala-ccs added the peer-review-done Signifies that the peer review team has reviewed this PR label Mar 11, 2024

ousleyp removed their request for review April 1, 2024 21:37

kalexand-rh added the branch/enterprise-4.17 label Jun 26, 2024

openshift-ci Bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 25, 2024

bergerhoffer added the branch/enterprise-4.18 label Oct 14, 2024

openshift-ci Bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 14, 2024

openshift-ci Bot closed this Dec 15, 2024

	<4> Specify the name of the CNI plugin that provides the network for the `NetworkAttachmentDefinition`.
	<4> Specify the name of the CNI plugin that provides the network for the network attachment definition.

	<2> The `NetworkAttachmentDefinition` object must be created in the {CNVNamespace} namespace.
	<2> Specify the namespace where the `NetworkAttachmentDefinition` object resides. This must be `{CNVNamespace}`.

Conversation

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

Uh oh!

Uh oh!

openshift-ci Bot commented Mar 5, 2024

Uh oh!

johnsimcall commented Mar 5, 2024

Uh oh!

kalexand-rh commented Mar 8, 2024

Uh oh!

ocpdocs-previewbot commented Mar 8, 2024

Uh oh!

ousleyp commented Mar 11, 2024

Uh oh!

sjhala-ccs left a comment

Choose a reason for hiding this comment

Uh oh!

sjhala-ccs Mar 11, 2024

Choose a reason for hiding this comment

Uh oh!

sjhala-ccs Mar 11, 2024

Choose a reason for hiding this comment

Uh oh!

openshift-ci Bot commented Apr 12, 2024

Uh oh!

openshift-bot commented Sep 25, 2024

Uh oh!

bergerhoffer commented Oct 14, 2024

Uh oh!

openshift-bot commented Nov 14, 2024

Uh oh!

openshift-bot commented Dec 15, 2024

Uh oh!

openshift-ci Bot commented Dec 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

johnsimcall commented Mar 5, 2024 •

edited

Loading