[WIP] HCP docs update for IBM Power #92359
Conversation
openshift-ci
bot
added
the
size/M
|
🤖 Thu Apr 24 09:23:25 - Prow CI generated the docs preview: |
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
openshift-ci
bot
added
size/L
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc
Outdated
Show resolved
Hide resolved
alishaIBM
changed the title
openshift-ci
bot
added
the
do-not-merge/work-in-progress
alishaIBM
force-pushed
the
hcp_update
branch
2 times, most recently
from
5567681 to
025093f
Compare
|
@alishaIBM: all tests passed! Full PR test history. Your PR dashboard. 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. |
There was a problem hiding this comment.
Before I can do a more detailed review, you need to make some structural changes here to comply with the OCP documentation standards. I provided a few comments to indicate what needs to be changed. Thanks! cc @xenolinux
| + | ||
| The above configuration allows you to create ISO for both x86_64 and ppc64le architectures. | ||
|
|
||
|
|
There was a problem hiding this comment.
The content in lines 68 - 100 should be in its own module.
| --release-image=quay.io/openshift-release-dev/ocp-release:${OCP_RELEASE} | ||
| ---- | ||
|
|
||
|
|
There was a problem hiding this comment.
The content from lines 103 - 147 should be in its own module.
|
|
||
| .Procedure | ||
|
|
||
| . to create heterogeneous nodepools |
There was a problem hiding this comment.
Be sure to use complete sentences and capitalize the first word in a sentence.
| . to create heterogeneous nodepools | |
| . To create heterogeneous node pools, create a YAML file that contains the following content: |
| + | ||
| This selector block is used to select the agents which are matching the given label. Which will ensure it will select only the agents from ppc64le architecture when it is scaled. | ||
|
|
||
|
|
There was a problem hiding this comment.
The content from lines 150 - 196 should be in its own module.
| ---- | ||
| + | ||
| This will create two infraenvs with x86_64 & ppc64le architectures. Before proceeding, make sure that the OS images for both architectures are added to the AgentServiceConfig. After this you can use the above infraenvs to get the minimal iso and follow the create-agent-cluster.md to add them to your cluster as agents. | ||
|
|
There was a problem hiding this comment.
The content from lines 198 - 201 should be in its own module.
| .Procedure | ||
|
|
||
| . Configure AgentServiceConfig with two heterogeneous architecture OS images: | ||
| + |
There was a problem hiding this comment.
From the OCP docs guidelines: Do not use more than one command per code block.
| $ export ISO_URL_PPC64LE="https://mirror.openshift.com/pub/openshift-v4/${ARCH_PPC64LE}/dependencies/rhcos/${OCP_MAJMIN}/${OCP_VERSION}/rhcos-${OCP_VERSION}-${ARCH_PPC64LE}-live.${ARCH_PPC64LE}.iso" | ||
| $ export ROOT_FS_URL_PPC64LE="https://mirror.openshift.com/pub/openshift-v4/${ARCH_PPC64LE}/dependencies/rhcos/${OCP_MAJMIN}/${OCP_VERSION}/rhcos-${OCP_VERSION}-${ARCH_PPC64LE}-live-rootfs.${ARCH_PPC64LE}.img" | ||
| ---- | ||
| + |
There was a problem hiding this comment.
In the following code block and others like it in this file, the code needs to be rewritten to separate out the content that the user will enter in the YAML file and the command to apply the changes. For an example, see steps 1 - 3 in Creating an InfraEnv resource for hosted control planes on IBM Z.
There was a problem hiding this comment.
To comply with the modular documentation guidelines that we follow for the OCP documentation, the various sections in this file need to be moved to their own modules. After you create those modules, in the assembly file, add the modules below your new include::modules/hcp-ibm-power-create-heterogeneous-nodepools-agent-hc.adoc[leveloffset=+1] module, and ensure that instead of using [leveloffset=+1], you use [leveloffset=+2].
Version(s): 4.18+
Issue: https://issues.redhat.com/browse/OSDOCS-14690
Link to docs preview: https://92359--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.html#hcp-ibm-power-create-heterogeneous-nodepools-agent-hc_hcp-deploy-ibm-power
QE review:
Additional information: