Skip to content

Commit

Permalink
Merge pull request #42293 from mjpytlak/ibm-cloud
Browse files Browse the repository at this point in the history
OSDOCS-2855 Installing on IBM Cloud IPI
  • Loading branch information
sagidlow authored Feb 28, 2022
2 parents 6c6ae33 + 435ba26 commit 719acbd
Show file tree
Hide file tree
Showing 37 changed files with 1,121 additions and 20 deletions.
16 changes: 16 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,22 @@ Topics:
File: installing-restricted-networks-gcp
- Name: Uninstalling a cluster on GCP
File: uninstalling-cluster-gcp
- Name: Installing on IBM Cloud
Dir: installing_ibm_cloud_public
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Preparing to install on IBM Cloud
File: preparing-to-install-on-ibm-cloud
- Name: Configuring an IBM Cloud account
File: installing-ibm-cloud-account
- Name: Configuring IAM for IBM Cloud
File: configuring-iam-ibm-cloud
- Name: Installing a cluster on IBM Cloud with customizations
File: installing-ibm-cloud-customizations
- Name: Installing a cluster on IBM Cloud with network customizations
File: installing-ibm-cloud-network-customizations
- Name: Uninstalling a cluster on IBM Cloud
File: uninstalling-cluster-ibm-cloud
- Name: Installing on bare metal
Dir: installing_bare_metal
Distros: openshift-origin,openshift-enterprise
Expand Down
21 changes: 17 additions & 4 deletions installing/installing-preparing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ If you want to install and manage {product-title} yourself, you can install it o
* Google Cloud Platform (GCP)
* {rh-openstack-first}
* {rh-virtualization-first}
* IBM Cloud
* IBM Z and LinuxONE
* IBM Z and LinuxONE for {op-system-base-full} KVM
* IBM Power
Expand Down Expand Up @@ -120,10 +121,10 @@ Not all installation options are supported for all platforms, as shown in the fo
.Installer-provisioned infrastructure options
|===
ifndef::openshift-origin[]
||AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Z |IBM Power
||AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
endif::openshift-origin[]
ifdef::openshift-origin[]
||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Z |IBM Power
||AWS |Azure |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Power
endif::openshift-origin[]

|Default
Expand All @@ -138,6 +139,7 @@ endif::openshift-origin[]
|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[X]
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[X]
|xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[X]
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[X]
|
|

Expand All @@ -153,6 +155,7 @@ endif::openshift-origin[]
|
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[X]
|xref:../installing/installing_vmc/installing-vmc-customizations.adoc#installing-vmc-customizations[X]
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[X]
|
|

Expand All @@ -168,6 +171,7 @@ endif::openshift-origin[]
|
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[X]
|xref:../installing/installing_vmc/installing-vmc-network-customizations.adoc#installing-vmc-network-customizations[X]
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[X]
|
|

Expand All @@ -185,6 +189,7 @@ endif::openshift-origin[]
|xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[X]
|
|
|

|Private clusters
|xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X]
Expand All @@ -200,6 +205,7 @@ endif::openshift-origin[]
|
|
|
|

|Existing virtual private networks
|xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X]
Expand All @@ -215,6 +221,7 @@ endif::openshift-origin[]
|
|
|
|

|Government regions
|xref:../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[X]
Expand All @@ -230,6 +237,7 @@ endif::openshift-origin[]
|
|
|
|

|China regions
|xref:../installing/installing_aws/installing-aws-china.adoc#installing-aws-china-region[X]
Expand All @@ -245,15 +253,16 @@ endif::openshift-origin[]
|
|
|
|
|===

.User-provisioned infrastructure options
|===
ifndef::openshift-origin[]
||AWS |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal (x86_64) |Bare metal (arm64) |vSphere |VMC |IBM Z |IBM Z with {op-system-base} KVM |IBM Power |Platform agnostic
||AWS |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal (x86_64) |Bare metal (arm64) |vSphere |VMC |IBM Cloud |IBM Z |IBM Z with {op-system-base} KVM |IBM Power |Platform agnostic
endif::openshift-origin[]
ifdef::openshift-origin[]
||AWS |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Z |IBM Z with {op-system-base} KVM |IBM Power |Platform agnostic
||AWS |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |oVirt |Bare metal |vSphere |VMC |IBM Cloud |IBM Z |IBM Z with {op-system-base} KVM |IBM Power |Platform agnostic
endif::openshift-origin[]


Expand All @@ -269,6 +278,7 @@ endif::openshift-origin[]
|xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[X]
|xref:../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[X]
|xref:../installing/installing_vmc/installing-vmc-user-infra.adoc#installing-vmc-user-infra[X]
|
|xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[X]
|xref:../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[X]
|xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[X]
Expand All @@ -292,6 +302,7 @@ endif::openshift-origin[]
|
|
|
|

|Restricted network
|xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[X]
Expand All @@ -305,6 +316,7 @@ endif::openshift-origin[]
|
|xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[X]
|xref:../installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc#installing-restricted-networks-vmc-user-infra[X]
|
|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[X]
|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[X]
|xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[X]
Expand All @@ -326,6 +338,7 @@ endif::openshift-origin[]
|
|
|
|
|===

////
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:_content-type: ASSEMBLY
[id="configuring-iam-ibm-cloud"]
= Configuring IAM for IBM Cloud
include::modules/common-attributes.adoc[]
:context: configuring-iam-ibm-cloud

toc::[]

In environments where the cloud identity and access management (IAM) APIs are not reachable, you must put the Cloud Credential Operator (CCO) into manual mode before you install the cluster.

include::modules/alternatives-to-storing-admin-secrets-in-kube-system.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_configuring-iam-ibm-cloud"]
.Additional resources
* xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc[About the Cloud Credential Operator]
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1]
include::modules/refreshing-service-ids-ibm-cloud.adoc[leveloffset=+1]
//include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
// Will need to revisit upgrade scenario for IBM Cloud; not needed until OCP 4.11. Tentative instructions have been added for reference later.

[id="next-steps_configuring-iam-ibm-cloud"]
== Next steps
* xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a cluster on IBM Cloud with customizations]
1 change: 1 addition & 0 deletions installing/installing_ibm_cloud_public/images
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
:_content-type: ASSEMBLY
[id="installing-ibm-cloud-account"]
= Configuring an IBM Cloud account
include::modules/common-attributes.adoc[]
:context: installing-ibm-cloud-account

toc::[]

Before you can install {product-title}, you must configure an IBM Cloud account.

[id="prerequisites_installing-ibm-cloud-account"]
== Prerequisites

* You have an IBM Cloud account with a subscription. You cannot install {product-title} on a free or trial IBM Cloud account.

include::modules/quotas-and-limits-ibm-cloud.adoc[leveloffset=+1]

include::modules/installation-cis-ibm-cloud.adoc[leveloffset=+1]

include::modules/installation-ibm-cloud-iam-policies-api-key.adoc[leveloffset=+1]
include::modules/installation-ibm-cloud-creating-api-key.adoc[leveloffset=+2]

include::modules/installation-ibm-cloud-regions.adoc[leveloffset=+1]

[id="next-steps_installing-ibm-cloud-account"]
== Next steps
* xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for IBM Cloud]
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
:_content-type: ASSEMBLY
[id="installing-ibm-cloud-customizations"]
= Installing a cluster on IBM Cloud with customizations
include::modules/common-attributes.adoc[]
:context: installing-ibm-cloud-customizations

toc::[]

In {product-title} version {product-version}, you can install a customized cluster on infrastructure that the installation program provisions on IBM Cloud. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster.

[id="prerequisites_installing-ibm-cloud-customizations"]
== 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/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an IBM Cloud account] to host the cluster.
* 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.
* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for IBM Cloud].

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

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

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

include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]

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

include::modules/installation-configuration-parameters.adoc[leveloffset=+2]

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

//.Additional resources

//* ../../machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-ibm-cloud[Enabling customer-managed encryption keys for a machine set]

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

include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1]

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

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

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

[role="_additional-resources"]
[id="additional-resources_installing-ibm-cloud-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-cloud-customizations-telemetry"]
.Additional resources
* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]

[id="next-steps_installing-ibm-cloud-customizations"]
== Next steps
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
* 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].
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
:_content-type: ASSEMBLY
[id="installing-ibm-cloud-network-customizations"]
= Installing a cluster on IBM Cloud with network customizations
include::modules/common-attributes.adoc[]
:context: installing-ibm-cloud-network-customizations

toc::[]

In {product-title} version {product-version}, you can install a cluster with a
customized network configuration on infrastructure that the installation program provisions on IBM Cloud. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster.

You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.

[id="prerequisites_installing-ibm-cloud-network-customizations"]
== 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/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an IBM Cloud account] to host the cluster.
* 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.
* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for IBM Cloud].

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

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

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

include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1]

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

include::modules/installation-configuration-parameters.adoc[leveloffset=+2]

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

//.Additional resources

//* ../../machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-ibm-cloud[Enabling customer-managed encryption keys for a machine set]

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

include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1]

// Network Operator specific configuration
include::modules/nw-network-config.adoc[leveloffset=+1]
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
include::modules/nw-operator-cr.adoc[leveloffset=+1]

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

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

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

[role="_additional-resources"]
[id="additional-resources_installing-ibm-cloud-network-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-cloud-network-customizations-telemetry"]
.Additional resources
* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]

[id="next-steps_installing-ibm-cloud-network-customizations"]
== Next steps

* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
* 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].
1 change: 1 addition & 0 deletions installing/installing_ibm_cloud_public/modules
Loading

0 comments on commit 719acbd

Please sign in to comment.