[OSDOCS#17057[: CQA 2.0 disconnected cluster - installing #116157
[OSDOCS#17057[: CQA 2.0 disconnected cluster - installing #116157rh-sgehlot wants to merge 1 commit into
Conversation
|
🤖 Wed Jul 22 16:26:38 - Prow CI generated the docs preview: https://116157--ocpdocs-pr.netlify.app/openshift-enterprise/latest/disconnected/installing.html |
|
|
||
| For more information, see: | ||
|
|
||
| * xref:../installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc#understanding-disconnected-installation-mirroring[Understanding disconnected installation mirroring] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * xref:../installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc#understanding-disconnected-installation-mirroring[Understanding disconnected installation mirroring] | ||
| * xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| For more information, see: | ||
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[Installing a cluster on {aws-short} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[Installing a cluster on {aws-short} in a restricted network] | ||
| * User-provisioned infrastructure: xref:../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Installing a cluster on {aws-short} in a restricted network with user-provisioned infrastructure] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| For more information, see: | ||
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[Installing a cluster on {azure-short} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[Installing a cluster on {azure-short} in a restricted network] | ||
|
|
||
| * User-provisioned infrastructure: xref:../installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc#installing-restricted-networks-azure-user-provisioned[Installing a cluster on {azure-short} in a restricted network with user-provisioned infrastructure] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
| = Installing a bare-metal cluster | ||
|
|
||
| [role="_abstract"] | ||
| You can install a bare-metal {product-title} cluster in a disconnected environment. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'bare metal' rather than 'bare-metal'. For more information, see RedHat.TermsErrors.
| [role="_abstract"] | ||
| You can install a bare-metal {product-title} cluster in a disconnected environment. | ||
|
|
||
| For more information, see xref:../installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| For more information, see: | ||
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[Installing a cluster on {gcp-short} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[Installing a cluster on {gcp-short} in a restricted network] | ||
| * User-provisioned infrastructure: xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[Installing a cluster on {gcp-short} in a restricted network with user-provisioned infrastructure] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
| [role="_abstract"] | ||
| You can install an {product-title} cluster on {ibm-cloud-name} in a disconnected environment. | ||
|
|
||
| For more information, see xref:../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[Installing a cluster on {ibm-cloud-title} in a restricted network]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
| [role="_abstract"] | ||
| You can install an {product-title} cluster on {ibm-power-title} in a disconnected environment. | ||
|
|
||
| For more information, see xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[Installing a cluster on {ibm-power-title} in a restricted network]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| For more information, see: | ||
|
|
||
| * xref:../installing/installing_ibm_z/upi/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[Installing a cluster with z/VM on {ibm-z-title} and {ibm-linuxone-title} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * xref:../installing/installing_ibm_z/upi/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[Installing a cluster with z/VM on {ibm-z-title} and {ibm-linuxone-title} in a restricted network] | ||
|
|
||
| * xref:../installing/installing_ibm_z/upi/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[Installing a cluster with {op-system-base} KVM on {ibm-z-title} and {ibm-linuxone-title} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * xref:../installing/installing_ibm_z/upi/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[Installing a cluster with {op-system-base} KVM on {ibm-z-title} and {ibm-linuxone-title} in a restricted network] | ||
|
|
||
| * xref:../installing/installing_ibm_z/upi/installing-restricted-networks-ibm-z-lpar.adoc#installing-restricted-networks-ibm-z-lpar[Installing a cluster in an LPAR on {ibm-z-title} and {ibm-linuxone-title} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
| [role="_abstract"] | ||
| You can install an {product-title} cluster on Nutanix in a disconnected environment. | ||
|
|
||
| For more information, see xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[Installing a cluster on Nutanix in a restricted network]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
| [role="_abstract"] | ||
| You can install an {product-title} cluster on {rh-openstack-first} in a disconnected environment. | ||
|
|
||
| For more information, see xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[Installing a cluster on OpenStack in a restricted network]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| For more information, see: | ||
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[Installing a cluster on {vmw-short} in a restricted network] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
|
|
||
| * Installer-provisioned infrastructure: xref:../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[Installing a cluster on {vmw-short} in a restricted network] | ||
|
|
||
| * User-provisioned infrastructure: xref:../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[Installing a cluster on {vmw-short} in a restricted network with user-provisioned infrastructure] |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).
ba84942 to
2064efa
Compare
a4a26d9 to
50e531a
Compare
|
@rh-sgehlot: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
skopacz1
left a comment
There was a problem hiding this comment.
Looks really good! I just left a few small comments
| //Installing a cluster with the Agent-based Installer | ||
| include::modules/installing-agent-based-installer.adoc[leveloffset=+1] |
There was a problem hiding this comment.
The modularization looks good, but the ifndef needs to be put back to make sure that this content is excluded from openshift origin/OKD:
| //Installing a cluster with the Agent-based Installer | |
| include::modules/installing-agent-based-installer.adoc[leveloffset=+1] | |
| ifndef::openshift-origin[] | |
| //Installing a cluster with the Agent-based Installer | |
| include::modules/installing-agent-based-installer.adoc[leveloffset=+1] | |
| endif::openshift-origin[] |
There was a problem hiding this comment.
I see now that you put the conditionals inside the module.
In this specific case, because everything inside the module is conditionalized anyways, what you should do instead is put the conditionals around the module include statement in the assembly, like the comment above.
Please also make the same feedback for all other modules with conditionals for the okd distro
| = Installing a cluster with the Agent-based Installer | ||
|
|
||
| [role="_abstract"] | ||
| You can install an {product-title} cluster in a disconnected environment with the Agent-based installer. |
There was a problem hiding this comment.
Nit - capital I:
| You can install an {product-title} cluster in a disconnected environment with the Agent-based installer. | |
| You can install an {product-title} cluster in a disconnected environment with the Agent-based Installer. |
| [role="_abstract"] | ||
| You can install an {product-title} cluster in a disconnected environment with the Agent-based installer. | ||
|
|
||
| For more information, see: |
There was a problem hiding this comment.
This is good, I would add "the following" to more explicitly introduce the list with a full sentence (it's a style guide rule for translation)
| For more information, see: | |
| For more information, see the following: |
Please apply this to your other modules as well
|
|
||
| * xref:../installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc#understanding-disconnected-installation-mirroring[Understanding disconnected installation mirroring] | ||
| * xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] |
There was a problem hiding this comment.
This is not your fault but since this was first written I have changed the name of this assembly and forgot to update the xref here:
| * xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] | |
| * xref:../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with customizations] |
Version(s):
4.20 +
Issue:
https://redhat.atlassian.net/browse/OSDOCS-17057
Link to docs preview:
https://116157--ocpdocs-pr.netlify.app/openshift-enterprise/latest/disconnected/installing.html
QE review:
Additional information: