Skip to content

TELCODOCS-1509: Adding content for improved SR-IOV Network Operator node draining#74464

Merged
jab-rh merged 1 commit intoopenshift:mainfrom
rohennes:TELCODOCS-1509
May 14, 2024
Merged

TELCODOCS-1509: Adding content for improved SR-IOV Network Operator node draining#74464
jab-rh merged 1 commit intoopenshift:mainfrom
rohennes:TELCODOCS-1509

Conversation

@rohennes
Copy link
Contributor

@rohennes rohennes commented Apr 10, 2024

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

Link to docs preview:
https://74464--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/hardware_networks/configuring-sriov-device.html#configure-sr-iov-operator-parallel-nodes_configuring-sriov-device

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 10, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 10, 2024

@rohennes: This pull request references TELCODOCS-1509 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.16.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

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.

1 similar comment
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 10, 2024

@rohennes: This pull request references TELCODOCS-1509 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.16.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

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.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 10, 2024
@rohennes rohennes changed the title TELCODOCS-1509: Adding content for improved SR-IOV Network Operator node draining [WIP] TELCODOCS-1509: Adding content for improved SR-IOV Network Operator node draining Apr 10, 2024
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 10, 2024
@rohennes rohennes closed this Apr 11, 2024
@rohennes rohennes reopened this Apr 11, 2024
@openshift-bot
Copy link

openshift-bot commented Apr 11, 2024

@rohennes: This pull request references TELCODOCS-1509 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.16.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

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
Copy link

ocpdocs-previewbot commented Apr 11, 2024

@rohennes rohennes force-pushed the TELCODOCS-1509 branch 3 times, most recently from 0a2a95b to 086b83d Compare April 11, 2024 15:56
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 11, 2024
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 12, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 12, 2024

@rohennes: This pull request references TELCODOCS-1509 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.16.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

Link to docs preview:
https://74464--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/hardware_networks/configuring-sriov-device.html#configure-sr-iov-operator-parallel-nodes_configuring-sriov-device

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.

@rohennes rohennes force-pushed the TELCODOCS-1509 branch 5 times, most recently from dd59688 to e250318 Compare April 15, 2024 11:20
@rohennes
Copy link
Contributor Author

/test validate-asciidoc

@rohennes rohennes force-pushed the TELCODOCS-1509 branch 2 times, most recently from 1779d1a to 5635435 Compare April 16, 2024 08:45

The following YAML is an example of a `SriovNetworkNodeState` object created by the SR-IOV Network Operator:

// Any updates required for this section?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need it here

@evgenLevin
Copy link

/lgtm

@openshift-ci
Copy link

openshift-ci bot commented May 3, 2024

@evgenLevin: changing LGTM is restricted to collaborators

Details

In response to this:

/lgtm

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.

@openshift-ci-robot
Copy link

openshift-ci-robot commented May 7, 2024

@rohennes: This pull request references TELCODOCS-1509 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.16.0" version, but no target version was set.

Details

In response to this:

TELCODOCS-1509: The SR-IOV Node Operator drains nodes to make SR-IOV node updates. These updates allow it to do this in parallel instead of in sequence for quicker rollout.

Version(s):
4.16+

Issue:
https://issues.redhat.com/browse/TELCODOCS-1509

Link to docs preview:
https://74464--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/hardware_networks/configuring-sriov-device.html#configure-sr-iov-operator-parallel-nodes_configuring-sriov-device

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.

@rohennes
Copy link
Contributor Author

rohennes commented May 7, 2024

/label peer-review-needed

@rohennes
Copy link
Contributor Author

rohennes commented May 7, 2024

/label telco

@openshift-ci openshift-ci bot added peer-review-needed Signifies that the peer review team needs to review this PR telco Label for all Telco PRs labels May 7, 2024
@xenolinux
Copy link
Contributor

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label May 8, 2024
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! I put some suggestions and comments to consider.

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

@@ -0,0 +1,154 @@
:_mod-docs-content-type: PROCEDURE
[id="configure-sr-iov-operator-parallel-nodes_{context}"]
== Configuring parallel node draining during SR-IOV network policy updates
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Configuring parallel node draining during SR-IOV network policy updates
= Configuring parallel node draining during SR-IOV network policy updates

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: If you want this section to be appeared as level 2, you can set leveloffset=+2 for this module, in your assembly file:

For example:
include::modules/nw-sriov-configuring-multiple-nodes.adoc[leveloffset=+2]

====
* A node can only belong to one SR-IOV network pool configuration. If a node is not part of a pool, it is added to a virtual, default, pool that is configured to drain one node at a time only.

* The node might reboot during the draining process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The node might reboot during the draining process.
* The node might restart during the draining process.

https://www.ibm.com/docs/en/ibm-style?topic=word-usage#r

Use with caution reboot noun
Reboot is widely recognized among technical users, but where usage permits, use restart.

Comment on lines 14 to 16
* A node can only belong to one SR-IOV network pool configuration. If a node is not part of a pool, it is added to a virtual, default, pool that is configured to drain one node at a time only.

* The node might reboot during the draining process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* A node can only belong to one SR-IOV network pool configuration. If a node is not part of a pool, it is added to a virtual, default, pool that is configured to drain one node at a time only.
* The node might reboot during the draining process.
A node can only belong to one SR-IOV network pool configuration. If a node is not part of a pool, it is added to a virtual, default, pool that is configured to drain one node at a time only.
The node might reboot during the draining process.

IMO. bullets are not required in the note here

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 8, 2024
Copy link
Contributor

@SchSeba SchSeba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rohennes
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label May 14, 2024
@openshift-ci
Copy link

openshift-ci bot commented May 14, 2024

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

@evgenLevin
Copy link

LGTM

@jab-rh jab-rh merged commit c457395 into openshift:main May 14, 2024
@jab-rh
Copy link
Contributor

jab-rh commented May 14, 2024

/cherry-pick enterprise-4.16

@openshift-cherrypick-robot

@jab-rh: new pull request created: #75939

Details

In response to this:

/cherry-pick enterprise-4.16

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files. telco Label for all Telco PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants