-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OCPBUGS-64584 Modify DPU Operator Docs to reflect 4.20 code #101591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| // Module included in the following assemblies: | ||
kquinn1204 marked this conversation as resolved.
Show resolved
Hide resolved
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable. |
||
| // | ||
| // * networking/networking_operators/installing-dpu-operator.adoc | ||
|
|
||
| :_mod-docs-content-type: Concept | ||
| [id="overview-installing-dpu-operator_{context}"] | ||
| = Installing the DPU Operator | ||
|
|
||
| [role="_abstract"] | ||
| You can install the Data Processing Unit (DPU) Operator on both host and DPU clusters to manage device lifecycle and network attachments using the CLI or web console. | ||
|
|
||
| Cluster administrators can install the DPU Operator on the host cluster and all DPU clusters using the {product-title} CLI or the web console. The DPU Operator manages the lifecycle, DPU devices, and network attachments for all supported DPUs." | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| You need to install the DPU Operator on the host cluster and each of the DPU clusters. | ||
| ==== | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * networking/networking_operators/nw-dpu-running-workloads.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="nw-dpu-monitoring-status_{context}"] | ||
| = Monitoring the status of DPU | ||
|
|
||
| [role="_abstract"] | ||
| You can monitor the DPU infrastructure status to check the current state and health of your DPU devices across the cluster. | ||
|
|
||
| You can monitor the DPU status to see the current state of the DPU infrastructure. | ||
|
|
||
| The `oc get dpu` command shows the current state of the DPU infrastructure. Follow this procedure to monitor the status of various cards. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The OpenShift CLI (`oc`) is installed. | ||
kquinn1204 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * An account with `cluster-admin` privileges is available. | ||
| * The DPU Operator is installed. | ||
| .Procedure | ||
|
|
||
| . Run the following command to check the overall health of your nodes: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get nodes | ||
| ---- | ||
| + | ||
| The example output provides a list of all nodes in the cluster along with their status. Ensure that all nodes are in the `Ready` state before proceeding. | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| NAME STATUS ROLES AGE VERSION | ||
| ocpcluster-master-1 Ready master 10d v1.32.9 | ||
| ocpcluster-master-2 Ready master 10d v1.32.9 | ||
| ocpcluster-master-3 Ready master 10d v1.32.9 | ||
| ocpcluster-dpu-ipu-219 Ready worker 42h v1.32.9 | ||
| ocpcluster-dpu-marvell-41 Ready worker 3d23h v1.32.9 | ||
| ocpcluster-dpu-ptl-243 Ready worker 3d23h v1.32.9 | ||
| worker-host-ipu-219 Ready worker 3d19h v1.32.9 | ||
| worker-host-marvell-41 Ready worker 4d v1.32.9 | ||
| worker-host-ptl-243 Ready worker 3d23h v1.32.9 | ||
| ---- | ||
| + | ||
| This output shows three master nodes, and three worker nodes identified by the worker-host prefix, for example, `worker-host-ipu-219`. Each worker node contains a DPU identified by the ocpcluster-dpu prefix, for example, `ocpcluster-dpu-ipu-219`. | ||
|
|
||
| . Run the following command to report on the status of the DPUs: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get dpu | ||
| ---- | ||
| + | ||
| The example output provides a list of detected DPUs. | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| NAME DPU PRODUCT DPU SIDE MODE NAME STATUS | ||
| 030001163eec00ff-host Intel Netsec Accelerator false worker-host-ptl-243 True | ||
| d4-e5-c9-00-ec-3v-dpu Intel Netsec Accelerator true worker-dpu-ptl-243 True | ||
| intel-ipu-0000-06-00.0-host Intel IPU E2100 false worker-host-ipu-219 False | ||
| intel-ipu-dpu Intel IPU E2100 true worker-dpu-ipu-219 False | ||
| marvell-dpu-0000-87-00.0-host Marvell DPU false worker-host-marvell-41 True | ||
| marvell-dpu-ipu Marvell DPU true worker-dpu-marvell-41 True | ||
| ---- | ||
kquinn1204 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * `DPU PRODUCT`:Displays the vendor or type of DPU, for example, Intel or Marvell. | ||
| * `DPU SIDE`:Indicates whether the DPU is operating on the host side (`false`) or the DPU side (`true`). Each physical DPU is represented twice. | ||
| * `MODE NAME`:The name of the node where the DPU is located. This is the host worker node for `false` entries and the DPU node for `true` entries. | ||
| * `STATUS`:Indicates whether the DPU is functioning correctly (`True`) or has issues (`False`). | ||
kquinn1204 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| + | ||
| [NOTE] | ||
| ==== | ||
| Run `oc get dpu -o yaml` to get more details about the status. | ||
| ==== | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.