Skip to content

[MULTIARCH-3975] New IBM Z LPAR installation assembly #71071

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.

Sign up for GitHub

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 1 commit into from
Feb 12, 2024
Merged

[MULTIARCH-3975] New IBM Z LPAR installation assembly #71071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,10 @@ Topics:
File: installing-ibm-z-kvm
- Name: Restricted network IBM Z installation with RHEL KVM
File: installing-restricted-networks-ibm-z-kvm
- Name: Installing a cluster in an LPAR on IBM Z and IBM LinuxONE
File: installing-ibm-z-lpar
- Name: Restricted network IBM Z installation in an LPAR
File: installing-restricted-networks-ibm-z-lpar
- Name: Installation configuration parameters for IBM Z and IBM LinuxONE
File: installation-config-parameters-ibm-z
- Name: Installing on IBM Power
Expand Down
149 changes: 149 additions & 0 deletions installing/installing_ibm_z/installing-ibm-z-lpar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-ibm-z-lpar"]
= Installing a cluster in an LPAR on {ibm-z-title} and {ibm-linuxone-title}
include::_attributes/common-attributes.adoc[]
:context: installing-ibm-z-lpar

toc::[]

[role="_abstract"]
In {product-title} version {product-version}, you can install a cluster in a logical partition (LPAR) on {ibm-z-name} or {ibm-linuxone-name} infrastructure that you provision.

[NOTE]
====
While this document refers only to {ibm-z-name}, all information in it also applies to {ibm-linuxone-name}.
====

[IMPORTANT]
====
Additional considerations exist for non-bare metal platforms. Review the information in the
link:https://access.redhat.com/articles/4207611[guidelines for deploying {product-title} on non-tested platforms] before you install an {product-title} cluster.
====

== Prerequisites

* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
* Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process.
* You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access.
* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.

[NOTE]
====
Be sure to also review this site list if you are configuring a proxy.
====

include::modules/cluster-entitlements.adoc[leveloffset=+1]

[id="installation-requirements-user-infra-lpar_{context}"]
== Requirements for a cluster with user-provisioned infrastructure

For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.

This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.

include::modules/installation-machine-requirements.adoc[leveloffset=+2]
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]

include::modules/minimum-ibm-z-system-requirements.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* link:https://www.ibm.com/docs/en/systems-hardware/zsystems/3932-A02?topic=library-prsm-planning-guide[Processors Resource/Systems Manager Planning Guide] in {ibm-name} Documentation for PR/SM mode considerations.

* link:https://www.ibm.com/docs/en/systems-hardware/zsystems/3932-A02?topic=library-dynamic-partition-manager-dpm-guide[IBM Dynamic Partition Manager (DPM) Guide] in {ibm-name} Documentation for DPM mode considerations.

* link:https://www.vm.ibm.com/library/presentations/lparperf.pdf[Topics in LPAR performance] for LPAR weight management and entitlements.

* xref:../../scalability_and_performance/ibm-z-recommended-host-practices.adoc#ibm-z-recommended-host-practices[Recommended host practices for {ibm-z-name} & {ibm-linuxone-name} environments]

include::modules/preferred-ibm-z-system-requirements.adoc[leveloffset=+2]
include::modules/csr-management.adoc[leveloffset=+2]
include::modules/installation-network-user-infra.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]

include::modules/installation-dns-user-infra.adoc[leveloffset=+2]

include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]

include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]

include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]

include::modules/ssh-agent-using.adoc[leveloffset=+1]

include::modules/installation-obtaining-installer.adoc[leveloffset=+1]

include::modules/cli-installing-cli.adoc[leveloffset=+1]

include::modules/installation-initializing-manual.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../installing/installing_ibm_z/installation-config-parameters-ibm-z.adoc#installation-config-parameters-ibm-z[Installation configuration parameters for {ibm-z-name}]

include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]

include::modules/installation-configure-proxy.adoc[leveloffset=+2]

include::modules/installation-three-node-cluster.adoc[leveloffset=+2]

include::modules/nw-operator-cr.adoc[leveloffset=+1]

include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]

include::modules/ibmz-configure-nbde-with-static-ip.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-butane_installing-customizing[Creating machine configs with Butane]

include::modules/installation-ibm-z-user-infra-machines-iso.adoc[leveloffset=+1]

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+2]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

include::modules/installation-approve-csrs.adoc[leveloffset=+1]

include::modules/installation-operators-config.adoc[leveloffset=+1]

include::modules/installation-registry-storage-config.adoc[leveloffset=+2]

include::modules/registry-configuring-storage-baremetal.adoc[leveloffset=+3]

include::modules/installation-registry-storage-non-production.adoc[leveloffset=+3]

include::modules/installation-complete-user-infra.adoc[leveloffset=+1]

include::modules/cluster-telemetry.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* See xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service

* link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within OpenShift4 nodes without SSH].

[id="next-steps_installing-ibm-z-lpar"]
== Next steps

* xref:../../post_installation_configuration/machine-configuration-tasks.adoc#rhcos-enabling-multipath_post-install-machine-configuration-tasks[Enabling multipathing with kernel arguments on {op-system}].

* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].

* If necessary, you can
Copy link
Contributor

Choose a reason for hiding this comment

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

Please avoid text here. I know this makes it a bit awkward, but these sections really should only be links with link text.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wouldn't it be better to stay in sync with the other providers? My VSC search has 46 results in 28 files on * If necessary, you can xref

Copy link
Contributor

Choose a reason for hiding this comment

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

All I am saying is that our guidelines have us avoiding text in Additional resources. I am not sure if this is a Jupiter requirement that is now no longer relevant. Maybe take a question to the docs forum? I agree that text is required in some of the xrefs for context, but as a peer reviewer I do need to point out the guideline.

xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
154 changes: 154 additions & 0 deletions installing/installing_ibm_z/installing-restricted-networks-ibm-z-lpar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-restricted-networks-ibm-z-lpar"]
= Installing a cluster in an LPAR on {ibm-z-title} and {ibm-linuxone-title} in a restricted network
include::_attributes/common-attributes.adoc[]
:context: installing-restricted-networks-ibm-z-lpar

toc::[]

[role="_abstract"]
In {product-title} version {product-version}, you can install a cluster in a logical partition (LPAR) on {ibm-z-name} or {ibm-linuxone-name} infrastructure that you provision in a restricted network.

[NOTE]
====
While this document refers to only {ibm-z-name}, all information in it also applies to {ibm-linuxone-name}.
====

[IMPORTANT]
====
Additional considerations exist for non-bare metal platforms. Review the information in the
link:https://access.redhat.com/articles/4207611[guidelines for deploying {product-title} on non-tested platforms] before you install an {product-title} cluster.
====

== Prerequisites

* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
* You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained the `imageContentSources` data for your version of {product-title}.
* Before you begin the installation process, you must move or remove any existing installation files. This ensures that the required installation files are created and updated during the installation process.
+
[IMPORTANT]
====
Ensure that installation steps are done from a machine with access to the installation media.
====
* You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access.
* If you use a firewall and plan to use the Telemetry service, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to.
+
[NOTE]
====
Be sure to also review this site list if you are configuring a proxy.
====

include::modules/installation-about-restricted-network.adoc[leveloffset=+1]

include::modules/cluster-entitlements.adoc[leveloffset=+1]

[id="installation-requirements-user-infra_{context}"]
== Requirements for a cluster with user-provisioned infrastructure

For a cluster that contains user-provisioned infrastructure, you must deploy all
of the required machines.

This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.

include::modules/installation-machine-requirements.adoc[leveloffset=+2]
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]

include::modules/minimum-ibm-z-system-requirements.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* link:https://www.ibm.com/docs/en/systems-hardware/zsystems/3932-A02?topic=library-prsm-planning-guide[Processors Resource/Systems Manager Planning Guide] in {ibm-name} Documentation for PR/SM mode considerations.

* link:https://www.ibm.com/docs/en/systems-hardware/zsystems/3932-A02?topic=library-dynamic-partition-manager-dpm-guide[IBM Dynamic Partition Manager (DPM) Guide] in {ibm-name} Documentation for DPM mode considerations.

* link:https://www.vm.ibm.com/library/presentations/lparperf.pdf[Topics in LPAR performance] for LPAR weight management and entitlements.

* xref:../../scalability_and_performance/ibm-z-recommended-host-practices.adoc#ibm-z-recommended-host-practices[Recommended host practices for {ibm-z-name} & {ibm-linuxone-name} environments]

include::modules/preferred-ibm-z-system-requirements.adoc[leveloffset=+2]
include::modules/csr-management.adoc[leveloffset=+2]
include::modules/installation-network-user-infra.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]

include::modules/installation-dns-user-infra.adoc[leveloffset=+2]

include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]

include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]

include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]

include::modules/ssh-agent-using.adoc[leveloffset=+1]

//You extract the installation program from the mirrored content.

//You install the CLI on the mirror host.

include::modules/installation-initializing-manual.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../installing/installing_ibm_z/installation-config-parameters-ibm-z.adoc#installation-config-parameters-ibm-z[Installation configuration parameters for {ibm-z-name}]

include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]

include::modules/installation-configure-proxy.adoc[leveloffset=+2]

include::modules/installation-three-node-cluster.adoc[leveloffset=+2]

include::modules/nw-operator-cr.adoc[leveloffset=+1]

include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]

include::modules/ibmz-configure-nbde-with-static-ip.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-butane_installing-customizing[Creating machine configs with Butane]

include::modules/installation-ibm-z-user-infra-machines-iso.adoc[leveloffset=+1]

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+2]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

include::modules/installation-approve-csrs.adoc[leveloffset=+1]

include::modules/installation-operators-config.adoc[leveloffset=+1]

include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]

include::modules/installation-registry-storage-config.adoc[leveloffset=+2]

include::modules/registry-configuring-storage-baremetal.adoc[leveloffset=+3]

include::modules/installation-registry-storage-non-production.adoc[leveloffset=+3]

include::modules/installation-complete-user-infra.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within {product-title} version 4 nodes without SSH].

[id="next-steps_ibmz-lpar-restricted"]
== Next steps

* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
* If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores].
Copy link
Contributor

Choose a reason for hiding this comment

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

I do not have a suggestion on how to get around this, but adding text to these references is not supported.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same comment as before, shouldn't this rather be in sync with other providers? There's 12 results for this in next steps.

* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
* If necessary, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#insights-operator-register-disconnected-cluster_opting-out-remote-health-reporting[Registering your disconnected cluster]
Loading