PowerVC IPI: Initial documentation

_attributes/common-attributes.adoc

@@ -311,6 +311,9 @@ endif::[]
 :ibm-power-title: IBM Power
 :ibm-power-server-name: IBM Power(R) Virtual Server
 :ibm-power-server-title: IBM Power Virtual Server
+:ibm-power-vc-name: IBM PowerVC
+:ibm-power-vc-title: IBM(R) Power(R) Virtualization Center
+:ibm-power-vc: IBM PowerVC
 // IBM zSystems
 :ibm-z-name: IBM Z(R)
 :ibm-z-title: IBM Z

_topic_maps/_topic_map.yml

@@ -534,6 +534,18 @@ Topics:
     File: installing-restricted-networks-ibm-power
   - Name: Installation configuration parameters for IBM Power
     File: installation-config-parameters-ibm-power
+- Name: Installing on IBM PowerVC
+  Dir: installing_ibm_powervc
+  Distros: openshift-enterprise
+  Topics:
+  - Name: Preparing to install on IBM PowerVC
+    File: preparing-to-install-on-ibm-powervc
+  - Name: Installing a cluster on IBM PowerVC with customizations
+    File: installing-ibm-powervc-installer-custom
+  - Name: Installation configuration parameters for IBM PowerVC
+    File: installation-config-parameters-ibm-powervc
+  - Name: Uninstalling a cluster on IBM PowerVC
+    File: uninstalling-cluster-powervc
 - Name: Installing on IBM Power Virtual Server
   Dir: installing_ibm_powervs
   Distros: openshift-enterprise

installing/installing_ibm_powervc/_attributes

@@ -0,0 +1 @@
+../../_attributes/

installing/installing_ibm_powervc/images

@@ -0,0 +1 @@
+../../images/

installing/installing_ibm_powervc/installation-config-parameters-ibm-powervc.adoc

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="installation-config-parameters-ibm-powervc"]
+= Installation configuration parameters for IBM PowerVC
+include::_attributes/common-attributes.adoc[]
+:context: installation-config-parameters-ibm-powervc
+:platform: IBM PowerVC
+
+toc::[]
+
+Before you deploy an {product-title} cluster on {ibm-power-vc-title} ({ibm-power-vc}), you provide parameters to customize your cluster and the platform that hosts it. When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further.
+
+include::modules/installation-configuration-parameters.adoc[leveloffset=+1]

installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc

@@ -0,0 +1,54 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="installing-ibm-powervc-installer-custom"]
+= Installing a cluster on IBM PowerVC with customizations
+include::_attributes/common-attributes.adoc[]
+:context: installing-ibm-powervc-installer-custom
+
+toc::[]
+
+In {product-title} version {product-version}, you can install a customized cluster on
+{ibm-power-vc-name}. To customize the installation, modify parameters in the `install-config.yaml` before you install the 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/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
+* You have a load balancing service you can use with the {ibm-power-vc-name} network you intend to use.
+* You have a DHCP server backing the {ibm-power-vc-name} network you intend to use.
+
+include::modules/installation-ibm-powervc-default-deployment.adoc[leveloffset=+1]
+
+include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
+
+include::modules/installation-initializing.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../../installing/installing_ibm_powervc/installation-config-parameters-ibm-powervc.adoc#installation-config-parameters-ibm-powervc[Installation configuration parameters for IBM PowerVC]
+
+include::modules/installation-launching-installer.adoc[leveloffset=+1]
+
+// Installing the OpenShift CLI on Linux
+include::modules/cli-installing-cli-linux.adoc[leveloffset=+1]
+
+// Installing the OpenShift CLI on Windows
+include::modules/cli-installing-cli-windows.adoc[leveloffset=+1]
+
+// Installing the OpenShift CLI on macOS
+include::modules/cli-installing-cli-macos.adoc[leveloffset=+1]
+
+include::modules/installation-osp-verifying-cluster-status.adoc[leveloffset=+1]
+
+include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_installing-ibm-powervc-customizations-console"]
+.Additional resources
+* xref:../../web_console/web-console.adoc#web-console[Accessing the web console]
+
+include::modules/cluster-telemetry.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_installing-ibm-powervc-customizations-telemetry"]
+.Additional resources
+* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]

installing/installing_ibm_powervc/modules

@@ -0,0 +1 @@
+../../modules/

installing/installing_ibm_powervc/preparing-to-install-on-ibm-powervc.adoc

@@ -0,0 +1,22 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="preparing-to-install-on-powervc"]
+= Preparing to install on IBM PowerVC
+include::_attributes/common-attributes.adoc[]
+:context: preparing-to-install-on-powervc
+
+toc::[]
+
+You can install {product-title} on {ibm-power-vc-title} ({ibm-power-vc-name}) using installer-provisioned infrastructure.
+
+[id="preparing-to-install-on-powervc-prerequisites"]
+== 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/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
+
+[id="choosing-an-method-to-install-ocp-on-powervc-installer-provisioned"]
+=== Installing a cluster on installer-provisioned infrastructure
+
+You can install a cluster on {ibm-power-vc-name} infrastructure that is provisioned by the {product-title} installation program, by using one of the following methods:
+
+**xref:../../installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc#installing-ibm-powervc-installer-custom[Installing a cluster on IBM PowerVC with customizations]**: You can install a customized cluster on {ibm-power-vc-name}. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation].

installing/installing_ibm_powervc/snippets

@@ -0,0 +1 @@
+../../snippets/

installing/installing_ibm_powervc/uninstalling-cluster-powervc.adoc

@@ -0,0 +1,13 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="uninstalling-cluster-ibm-powervc"]
+= Uninstalling a cluster on IBM PowerVC
+include::_attributes/common-attributes.adoc[]
+:context: uninstalling-cluster-ibm-powervc
+//:context: uninstalling-cluster-openstack
+
+toc::[]
+
+You can remove a cluster that you deployed to {ibm-power-vc-name}.
+
+// Removing a cluster that uses installer-provisioned infrastructure
+include::modules/installation-uninstall-clouds.adoc[leveloffset=+1]

modules/cli-installing-cli-linux.adoc

@@ -37,6 +37,7 @@
 // * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
 // * installing/installing-nutanix-installer-provisioned.adoc
 // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc

modules/cli-installing-cli-macos.adoc

@@ -37,6 +37,7 @@
 // * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
 // * installing/installing-nutanix-installer-provisioned.adoc
 // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc

modules/cli-installing-cli-windows.adoc

@@ -37,6 +37,7 @@
 // * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc
 // * installing/installing-nutanix-installer-provisioned.adoc
 // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc

modules/cli-logging-in-kubeadmin.adoc

@@ -32,6 +32,7 @@
 // * installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc
 // * installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc
 // * installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc

modules/cluster-telemetry.adoc

@@ -55,6 +55,7 @@
 // * installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc
 // * installing/installing_ibm_power/installing-ibm-power.adoc
 // * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc

modules/installation-configuration-parameters.adoc

@@ -38,6 +38,9 @@ endif::[]
 ifeval::["{context}" == "installation-config-parameters-ibm-power-vs"]
 :ibm-power-vs:
 endif::[]
+ifeval::["{context}" == "installation-config-parameters-ibm-powervc"]
+:ibm-power-vc:
+endif::[]
 ifeval::["{context}" == "installation-config-parameters-nutanix"]
 :nutanix:
 endif::[]
@@ -190,6 +193,122 @@ ifdef::ibm-power-vs[]
 endif::ibm-power-vs[]
 |====
 
+ifdef::ibm-power-vc[]
+[id="installation-configuration-parameters-additional-powervc_{context}"]
+== Additional {ibm-power-vc-name} configuration parameters
+
+Additional {ibm-power-vc} configuration parameters are described in the following table:
+
+.Additional {ibm-power-vc} parameters
+[cols=".^l,.^a",options="header"]
+|====
+|Parameter|Description
+
+|platform:
+  powervc:
+    cloud:
+|The name of the {ibm-power-vc} cloud to use from the list of clouds in the `clouds.yaml` file.
+
+In the cloud configuration in the `clouds.yaml` file, if possible, use application credentials rather than a user name and password combination. Using application credentials avoids disruptions from secret propogation that follow user name and password rotation.
+
+*Value:* String, for example `MyCloud`.
+
+|====
+
+[id="installation-configuration-parameters-optional-ibm-power-vc_{context}"]
+== Optional {ibm-power-vc} configuration parameters
+
+Optional {ibm-power-vc} configuration parameters are described in the following table:
+
+.Optional {ibm-power-vc} parameters
+[%header, cols=".^l,.^a"]
+|====
+|Parameter|Description
+
+|compute:
+  platform:
+    powervc:
+      zones:
+|{ibm-power-vc} Compute availability zones to install machines on. If this parameter is not set, the installation program relies on the default settings that the {ibm-power-vc} administrator configured.
+
+*Value:* A list of strings. For example, `["zone-1", "zone-2"]`.
+
+|controlPlane:
+  platform:
+    powervc:
+      zones:
+|{ibm-power-vc} Compute availability zones to install machines on. If this parameter is not set, the installation program relies on the default settings that the {ibm-power-vc} administrator configured.
+
+*Value:* A list of strings. For example, `["zone-1", "zone-2"]`.
+
+|platform:
+  powervc:
+    clusterOSImage:
+|The name of the existing {ibm-power-vc} image.
+
+*Value:* the name of an existing {ibm-power-vc} image, for example `my-rhcos`.
+
+|platform:
+  powervc:
+    controlPlanePort:
+      fixedIPs:
+
+|Subnets for the machines to use.
+
+*Value:* A list of subnet names or UUIDs to use in cluster installation.
+
+|platform:
+  powervc:
+    controlPlanePort:
+      network:
+|A network for the machines to use.
+
+*Value:* The UUID or name of an {ibm-power-vc} network to use in cluster installation.
+
+|platform:
+  powervc:
+    defaultMachinePlatform:
+|The default machine pool platform configuration.
+
+*Value:*
+[source,json]
+----
+{
+   "type": "my-compute-template",
+}
+----
+
+|platform:
+  powervc:
+    externalDNS:
+|IP addresses for external DNS servers that cluster instances use for DNS resolution.
+
+*Value:* A list of IP addresses as strings. For example, `["8.8.8.8", "192.168.1.12"]`.
+
+|platform:
+  powervc:
+    loadbalancer:
+|Whether or not to use the default, internal load balancer. If the value is set to `UserManaged`, this default load balancer is disabled so that you can deploy a cluster that uses an external, user-managed load balancer. If the parameter is not set, or if the value is `OpenShiftManagedDefault`, the cluster uses the default load balancer.
+
+*Value:* `UserManaged` or `OpenShiftManagedDefault`.
+
+|platform:
+  powervc:
+    apiVIPs:
+|Virtual IP (VIP) addresses that you configured for control plane API access.
+
+*Value:* A list of IP addresses as strings. For example, `["10.0.0.30", "10.0.0.31"]`
+
+|platform:
+  powervc:
+    ingressVIPs:
+|Virtual IP (VIP) addresses that you configured for cluster ingress.
+
+*Value:* A list of IP addresses as strings. For example, `["10.0.0.32", "10.0.0.33"]`
+
+|====
+endif::ibm-power-vc[]
+
 [id="installation-configuration-parameters-network_{context}"]
 == Network configuration parameters
 
@@ -623,13 +742,13 @@ ifdef::ibm-z[]
 *Value:* String
 endif::ibm-z[]
 
-ifdef::ibm-power,ibm-power-vs[]
+ifdef::ibm-power,ibm-power-vc,ibm-power-vs[]
 |controlPlane:
   architecture:
 |Determines the instruction set architecture of the machines in the pool. Currently, heterogeneous clusters are not supported, so all pools must specify the same architecture. The valid value is the default: `ppc64le`.
 
 *Value:* String
-endif::ibm-power,ibm-power-vs[]
+endif::ibm-power,ibm-power-vc,ibm-power-vs[]
 
 ifdef::agent[]
 |controlPlane:
@@ -4537,6 +4656,9 @@ endif::[]
 ifeval::["{context}" == "installation-config-parameters-ibm-power-vs"]
 :!ibm-power-vs:
 endif::[]
+ifeval::["{context}" == "installation-config-parameters-ibm-powervc"]
+:!ibm-power-vc:
+endif::[]
 ifeval::["{context}" == "installation-config-parameters-nutanix"]
 :!nutanix:
 endif::[]

modules/installation-ibm-powervc-default-deployment.adoc

@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="installation-ibm-powervc-default-deployment_{context}"]
+= Resource guidelines for installing {product-title} on {ibm-power-vc-name}
+
+To support an {product-title} installation, it is recommended that your {ibm-power-vc-name} has room for the following resources available:
+
+.Recommended resources for a default {product-title} cluster on {ibm-power-vc-name}
+[options="header"]
+|======================================
+|Resource              | Value
+|Subnets               | 1
+|RAM                   | 88 GB
+|vCPUs                 | 22
+|Volume storage        | 275 GB
+|Instances             | 7
+|======================================
+
+A cluster might function with fewer than recommended resources.

modules/installation-initializing.adoc

@@ -17,6 +17,7 @@
 // * installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc
 // * installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc
 // * installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
 // * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc
@@ -93,6 +94,9 @@ endif::[]
 ifeval::["{context}" == "installing-ibm-cloud-customizations"]
 :ibm-cloud:
 endif::[]
+ifeval::["{context}" == "installing-ibm-powervc-installer-custom"]
+:ibm-power-vc-platform:
+endif::[]
 ifeval::["{context}" == "installing-ibm-power-vs-customizations"]
 :ibm-power-vs:
 endif::[]
@@ -191,6 +195,9 @@ endif::vsphere[]
 ifdef::nutanix[]
 Nutanix.
 endif::nutanix[]
+ifdef::ibm-power-vc-platform[]
+{ibm-power-vc-name}.
+endif::ibm-power-vc-platform[]
 
 .Prerequisites
 
@@ -779,6 +786,9 @@ endif::[]
 ifeval::["{context}" == "installing-ibm-cloud-customizations"]
 :!ibm-cloud:
 endif::[]
+ifeval::["{context}" == "installing-ibm-powervc-installer-custom"]
+:!ibm-power-vc-platform:
+endif::[]
 ifeval::["{context}" == "installing-ibm-power-vs-customizations"]
 :!ibm-power-vs:
 endif::[]

modules/installation-launching-installer.adoc

@@ -36,6 +36,7 @@
 // * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
 // * installing/installing-nutanix-installer-provisioned.adoc
 // * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc
 // * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
 // * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc
@@ -211,6 +212,10 @@ ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provis
 :nutanix:
 :single-step:
 endif::[]
+ifeval::["{context}" == "installing-ibm-powervc-installer-custom"]
+:custom-config:
+:single-step:
+endif::[]
 ifeval::["{context}" == "installing-ibm-power-vs-customizations"]
 :custom-config:
 :single-step:
@@ -685,6 +690,10 @@ ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provis
 :!nutanix:
 :!single-step:
 endif::[]
+ifeval::["{context}" == "installing-ibm-powervc-installer-custom"]
+:!custom-config:
+:!single-step:
+endif::[]
 ifeval::["{context}" == "installing-ibm-power-vs-customizations"]
 :!custom-config:
 :!single-step:

modules/installation-osp-verifying-cluster-status.adoc

@@ -3,6 +3,7 @@
 // * installing/installing_openstack/installing-openstack-installer.adoc
 // * installing/installing_openstack/installing-openstack-installer-custom.adoc
 // * installing/installing_openstack/installing-openstack-installer-restricted.adoc
+// * installing/installing_ibm_powervc/installing-ibm-powervc-installer-custom.adoc