Add hardware_enablement category and SRO documentation #35687
Conversation
openshift-ci
bot
added
do-not-merge/work-in-progress
|
✔️ Deploy Preview for osdocs ready! 🔨 Explore the source changes: f2b8eba 🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/61438203895d87000850f129 😎 Browse the preview: https://deploy-preview-35687--osdocs.netlify.app/openshift-enterprise/latest/hardware_enablement/psap-special-resource-operator |
dagrayvid
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
dagrayvid
force-pushed
the
add-sro
branch
2 times, most recently
from
957310a to
44963d0
Compare
There was a problem hiding this comment.
How do you delete the SpecialResource? Do you delete the simple-kmod-local.yaml file? If so, maybe:
To remove the simple-kmod kernel module from the node, delete the simple-kmod-local.yaml file that contains the SpecialResource specification. The kernel module is unloaded when the driver container pod is deleted.
There was a problem hiding this comment.
I rewrote this to be more clear.
openshift-ci
bot
added
the
needs-rebase
There was a problem hiding this comment.
It is recommended that you create the Namespace as detailed in the previous section.
openshift-ci
bot
added
size/XXL
openshift-ci
bot
removed
the
needs-rebase
|
@kmccarron-rh thanks for all of the helpful feedback. I believe I implemented all the suggested changes. |
dagrayvid
force-pushed
the
add-sro
branch
4 times, most recently
from
d37bb31 to
ae685e2
Compare
|
Thanks @kmccarron-rh, I implemented those changes and fixed the xref related build errors. |
There was a problem hiding this comment.
Maybe mention something about SNO not having the image registry, and requiring enable or an external one?
There was a problem hiding this comment.
I added a pointer to the additional resources in the prerequisites modules/special-resource-operator-using.adoc to make this more clear, but didn't add a specific mention of SNO because it's not specific to SNO. It also applies to baremetal installs, etc. Let me know if you think more clarification is needed
|
Related Jira: https://issues.redhat.com/browse/OSDOCS-2396 Direct link to new Hardware enablement book: Direct Link to new Special Resource Operator section: |
maxwelldb
added
peer-review-needed
| Distros: openshift-origin,openshift-enterprise | ||
| Topics: | ||
| - Name: About hardware enablement on OpenShift | ||
| File: about-hardware-enablement |
There was a problem hiding this comment.
To verify: no need for Distros here?
|
|
||
| toc::[] | ||
|
|
||
| Many applications require specialized hardware or software which depend on kernel modules or drivers. The recommended approach to load out-of-tree kernel modules on {op-system-first} nodes is to use driver containers. To deploy out-of-tree drivers at the same time as cluster installation (day-1) the kmods-via-containers framework can be used. For loading drivers or kernel modules on an existing {product-title} cluster (day-2) {product-title} offers several tools: |
There was a problem hiding this comment.
ISG
| Many applications require specialized hardware or software which depend on kernel modules or drivers. The recommended approach to load out-of-tree kernel modules on {op-system-first} nodes is to use driver containers. To deploy out-of-tree drivers at the same time as cluster installation (day-1) the kmods-via-containers framework can be used. For loading drivers or kernel modules on an existing {product-title} cluster (day-2) {product-title} offers several tools: | |
| Many applications require specialized hardware or software that depends on kernel modules or drivers. The recommended approach to load out-of-tree kernel modules on {op-system-first} nodes is to use driver containers. To deploy out-of-tree drivers at the same time as cluster installation (day 1), use the kmods-via-containers framework. To load drivers or kernel modules on an existing {product-title} cluster (day 2), {product-title} offers several tools: |
I would think about ways to rephrase or eliminate "day 1" and "day 2." We don't use those widely in customer-facing docs.
There was a problem hiding this comment.
"The recommended approach..." is passive. Could restructure like:
"You can use driver containers to load out-of-tree kernel modules..."
(Just as an example.)
Similar idea for the sentence after it.
|
|
||
| Many applications require specialized hardware or software which depend on kernel modules or drivers. The recommended approach to load out-of-tree kernel modules on {op-system-first} nodes is to use driver containers. To deploy out-of-tree drivers at the same time as cluster installation (day-1) the kmods-via-containers framework can be used. For loading drivers or kernel modules on an existing {product-title} cluster (day-2) {product-title} offers several tools: | ||
|
|
||
| * The Driver Toolkit is a container image which is a part of every OpenShift release. It contains the kernel packages and other common dependencies needed for building a driver or kernel module. The Driver Toolkit can be used as a base image for driver container image builds on the {product-title}. |
There was a problem hiding this comment.
| * The Driver Toolkit is a container image which is a part of every OpenShift release. It contains the kernel packages and other common dependencies needed for building a driver or kernel module. The Driver Toolkit can be used as a base image for driver container image builds on the {product-title}. | |
| * The Driver Toolkit is a container image that is part of every OpenShift release. It contains the kernel packages and other common dependencies that are needed to build a driver or kernel module. The Driver Toolkit can be used as a base image for driver container image builds on the {product-title}. |
There was a problem hiding this comment.
Unsure about the capitalization of "Driver Toolkit." Is this a branding decision?
| Many applications require specialized hardware or software which depend on kernel modules or drivers. The recommended approach to load out-of-tree kernel modules on {op-system-first} nodes is to use driver containers. To deploy out-of-tree drivers at the same time as cluster installation (day-1) the kmods-via-containers framework can be used. For loading drivers or kernel modules on an existing {product-title} cluster (day-2) {product-title} offers several tools: | ||
|
|
||
| * The Driver Toolkit is a container image which is a part of every OpenShift release. It contains the kernel packages and other common dependencies needed for building a driver or kernel module. The Driver Toolkit can be used as a base image for driver container image builds on the {product-title}. | ||
| * The Special Resource Operator (SRO) orchestrates the building and management of driver containers for loading kernel modules and drivers on an existing (day 2) OpenShift or Kubernetes cluster. |
There was a problem hiding this comment.
| * The Special Resource Operator (SRO) orchestrates the building and management of driver containers for loading kernel modules and drivers on an existing (day 2) OpenShift or Kubernetes cluster. | |
| * The Special Resource Operator (SRO) orchestrates the building and management of driver containers to load kernel modules and drivers on an existing (day 2) OpenShift or Kubernetes cluster. |
|
|
||
| * Obtain the image pull secret needed to perform an installation of {product-title}, from the link:https://console.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. | ||
| * Install the OpenShift CLI (`oc`). | ||
| * You have obtained the image pull secret needed to perform an installation of {product-title}, from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site. |
There was a problem hiding this comment.
ISG recommends simple present tense as much as possible. Simple past if necessary.
Ex: "You have the image..."/"You obtained the image..."
| + | ||
| [source,terminal] | ||
| ---- | ||
| mkdir -p chart/simple-kmod-0.0.1/templates |
There was a problem hiding this comment.
| mkdir -p chart/simple-kmod-0.0.1/templates | |
| $ mkdir -p chart/simple-kmod-0.0.1/templates |
All command line sections should start with $ or #.
| ---- | ||
|
|
||
|
|
||
| . Use the following SpecialResource manifest to deploy the simple-kmod using the Helm chart that you created in the ConfigMap. The `spec.chart.repository.url` field tells SRO to look for the chart in a ConfigMap. Optionally, uncomment the #debug: true line, to have the YAML files in the chart printed in full in the operator logs and to verify that the logs are created and templated properly. Save this YAML as `simple-kmod-configmap.yaml` |
There was a problem hiding this comment.
You could use callouts to simplify this step.
| uri: "https://github.com/openshift-psap/kvc-simple-kmod.git" | ||
| ---- | ||
|
|
||
| . Create the SpecialResource with: |
There was a problem hiding this comment.
| . Create the SpecialResource with: | |
| . Create the `SpecialResource` [resource]: |
Watch for this construction elsewhere.
| $ oc create -f simple-kmod-configmap.yaml | ||
| ---- | ||
|
|
||
| . The simple-kmod resources are deployed in the namespace `simple-kmod` as specified in the object manifest. After a short time, the build pod for the simple-kmod driver container should start running. After a few minutes, the build should complete and the driver container pods should start Running. |
There was a problem hiding this comment.
What's the instruction here?
| simple_kmod 16384 0 | ||
| ---- | ||
|
|
||
| To remove the simple-kmod kernel module from the node, delete the simple-kmod SpecialResource API object with `oc delete`. The kernel module is unloaded when the driver container pod is deleted. |
There was a problem hiding this comment.
Is this a note rather than a LI?
maxwelldb
added
peer-review-done
|
#36674 -Suggested doc changes are implemented in this PR. |
|
@kmccarron-rh I am assuming this can now be closed. I will go ahead and close it, but please reach out if that is an error. |
6 participants
No description provided.