Skip to content

Commit e1ae613

Browse files
committed
OSDOCS-5402: Updated IBM CLoud to IBM Cloud Bare Metal (Classic)
1 parent 6a66196 commit e1ae613

9 files changed

+39
-42
lines changed

_attributes/common-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@ endif::[]
146146
:SMProductVersion1x: 1.1.18.2
147147
//Windows containers
148148
:productwinc: Red Hat OpenShift support for Windows Containers
149+
// IBM Cloud
150+
:ibmcloudBMProductName: IBM Cloud Bare Metal (Classic)
151+
:ibmcloudBMRegProductName: IBM Cloud® Bare Metal (Classic)
149152
// IBM Power
150153
:ibmpowerProductName: IBM Power
151154
// IBM zSystems

_distro_map.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,6 @@ openshift-rosa-portal:
195195
enterprise-4.13:
196196
name: ''
197197
dir: rosa-portal/
198-
partner-roks:
199-
name: Red Hat OpenShift on IBM Cloud
200-
author: OpenShift Documentation Project <[email protected]>
201-
site: commercial
202-
site_name: Documentation
203-
site_url: https://docs.openshift.com/
204-
branches:
205-
enterprise-4.3:
206-
name: '4'
207-
dir: roks/4
208198
openshift-webscale:
209199
name: OpenShift Container Platform
210200
author: OpenShift Documentation Project <[email protected]>

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ Topics:
358358
File: ipi-install-expanding-the-cluster
359359
- Name: Troubleshooting
360360
File: ipi-install-troubleshooting
361-
- Name: Installing bare metal clusters on IBM Cloud
361+
- Name: Installing IBM Cloud Bare Metal (Classic)
362362
Dir: installing_ibm_cloud
363363
Distros: openshift-origin,openshift-enterprise
364364
Topics:

installing/installing_ibm_cloud/install-ibm-cloud-prerequisites.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can use installer-provisioned installation to install {product-title} on IBM Cloud&#174; nodes. This document describes the prerequisites and procedures when installing {product-title} on IBM Cloud nodes.
9+
You can use installer-provisioned installation to install {product-title} on {ibmcloudBMRegProductName} nodes. This document describes the prerequisites and procedures when installing {product-title} on IBM Cloud nodes.
1010

1111
[IMPORTANT]
1212
====
@@ -20,6 +20,6 @@ Installer-provisioned installation of {product-title} requires:
2020
* One routable network
2121
* One provisioning network
2222
23-
Before starting an installer-provisioned installation of {product-title} on IBM Cloud, address the following prerequisites and requirements.
23+
Before starting an installer-provisioned installation of {product-title} on {ibmcloudBMProductName}, address the following prerequisites and requirements.
2424

2525
include::modules/install-ibm-cloud-setting-up-ibm-cloud-infrastructure.adoc[leveloffset=+1]

modules/install-ibm-cloud-configuring-the-install-config-file.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="configuring-the-install-config-file_{context}"]
77
= Configuring the install-config.yaml file
88

9-
The `install-config.yaml` file requires some additional details. Most of the information is teaching the installer and the resulting cluster enough about the available IBM Cloud&#174; hardware so that it is able to fully manage it. The material difference between installing on bare metal and installing on IBM Cloud is that you must explicitly set the privilege level for IPMI in the BMC section of the `install-config.yaml` file.
9+
The `install-config.yaml` file requires some additional details. Most of the information is teaching the installer and the resulting cluster enough about the available {ibmcloudBMRegProductName} hardware so that it is able to fully manage it. The material difference between installing on bare metal and installing on {ibmcloudBMProductName} is that you must explicitly set the privilege level for IPMI in the BMC section of the `install-config.yaml` file.
1010

1111
.Procedure
1212

@@ -59,7 +59,7 @@ pullSecret: '<pull_secret>'
5959
sshKey: '<ssh_pub_key>'
6060
----
6161
+
62-
<1> The `bmc.address` provides a `privilegelevel` configuration setting with the value set to `OPERATOR`. This is required for IBM Cloud.
62+
<1> The `bmc.address` provides a `privilegelevel` configuration setting with the value set to `OPERATOR`. This is required for {ibmcloudBMProductName} infrastructure.
6363
<2> Add the MAC address of the private `provisioning` network NIC for the corresponding node.
6464
+
6565
[NOTE]

modules/install-ibm-cloud-configuring-the-public-subnet.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="configuring-the-public-subnet_{context}"]
77
= Configuring the public subnet
88

9-
All of the {product-title} cluster nodes must be on the public subnet. IBM Cloud&#174; does not provide a DHCP server on the subnet. Set it up separately on the provisioner node.
9+
All of the {product-title} cluster nodes must be on the public subnet. {ibmcloudBMRegProductName} does not provide a DHCP server on the subnet. Set it up separately on the provisioner node.
1010

1111
You must reset the BASH variables defined when preparing the provisioner node. Rebooting the provisioner node after preparing it will delete the BASH variables previously set.
1212

modules/install-ibm-cloud-preparing-the-provisioner-node.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_content-type: PROCEDURE
66
[id="preparing-the-provisioner-node-for-openshift-install-on-ibm-cloud_{context}"]
7-
= Preparing the provisioner node for {product-title} installation on IBM Cloud
7+
= Preparing the provisioner node on {ibmcloudBMProductName} infrastructure
88

99
Perform the following steps to prepare the provisioner node.
1010

modules/install-ibm-cloud-setting-up-ibm-cloud-infrastructure.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// installing_ibm_cloud/install-ibm-cloud-installing-on-ibm-cloud.adoc
44

55
[id="setting-up-ibm-cloud-infrastructure_{context}"]
6-
= Setting up IBM Cloud infrastructure
6+
= Setting up IBM Cloud Bare Metal (Classic) infrastructure
77

8-
To deploy an {product-title} cluster on IBM Cloud&#174;, you must first provision the IBM Cloud nodes.
8+
To deploy an {product-title} cluster on {ibmcloudBMRegProductName} infrastructure, you must first provision the IBM Cloud nodes.
99

1010
[IMPORTANT]
1111
====
@@ -29,7 +29,7 @@ Create all nodes with a single public VLAN and a single private VLAN.
2929

3030
IBM Cloud public VLAN subnets use a `/28` prefix by default, which provides 16 IP addresses. That is sufficient for a cluster consisting of three control plane nodes, four worker nodes, and two IP addresses for the API VIP and Ingress VIP on the `baremetal` network. For larger clusters, you might need a smaller prefix.
3131

32-
IBM Cloud private VLAN subnets use a `/26` prefix by default, which provides 64 IP addresses. IBM Cloud will use private network IP addresses to access the Baseboard Management Controller (BMC) of each node. {product-title} creates an additional subnet for the `provisioning` network. Network traffic for the `provisioning` network subnet routes through the private VLAN. For larger clusters, you might need a smaller prefix.
32+
IBM Cloud private VLAN subnets use a `/26` prefix by default, which provides 64 IP addresses. {ibmcloudBMProductName} uses private network IP addresses to access the Baseboard Management Controller (BMC) of each node. {product-title} creates an additional subnet for the `provisioning` network. Network traffic for the `provisioning` network subnet routes through the private VLAN. For larger clusters, you might need a smaller prefix.
3333

3434
.IP addresses per prefix
3535
[options="header"]
@@ -138,11 +138,11 @@ Define a consistent clock date and time format in each cluster node's BIOS setti
138138
[discrete]
139139
== Configure a DHCP server
140140

141-
IBM Cloud does not run DHCP on the public or private VLANs. After provisioning IBM Cloud nodes, you must set up a DHCP server for the public VLAN, which corresponds to {product-title}'s `baremetal` network.
141+
{ibmcloudBMProductName} does not run DHCP on the public or private VLANs. After provisioning IBM Cloud nodes, you must set up a DHCP server for the public VLAN, which corresponds to {product-title}'s `baremetal` network.
142142

143143
[NOTE]
144144
====
145-
The IP addresses allocated to each node do not need to match the IP addresses allocated by the IBM Cloud provisioning system.
145+
The IP addresses allocated to each node do not need to match the IP addresses allocated by the {ibmcloudBMProductName} provisioning system.
146146
====
147147

148148
See the "Configuring the public subnet" section for details.
@@ -164,7 +164,7 @@ Alternatively, contact IBM Cloud support and request that they increase the IPMI
164164
[discrete]
165165
== Create bare metal servers
166166

167-
Create bare metal servers in the link:https://cloud.ibm.com[IBM Cloud dashboard] by navigating to *Create resource* -> *Bare Metal Server*.
167+
Create bare metal servers in the link:https://cloud.ibm.com[IBM Cloud dashboard] by navigating to *Create resource* -> *Bare Metal Servers for Classic*.
168168

169169
Alternatively, you can create bare metal servers with the `ibmcloud` CLI utility. For example:
170170

modules/nw-dns-forward.adoc

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ A DNS forwarding configuration for the default domain can have both the default
3434
$ oc edit dns.operator/default
3535
----
3636
+
37-
This allows the Operator to create and update the config map named `dns-default` with additional server configuration blocks based on `Server`. If none of the servers have a zone that matches the query, then name resolution falls back to the upstream DNS servers.
37+
After you issue the previous command, the Operator creates and updates the config map named `dns-default` with additional server configuration blocks based on `Server`.
38+
ifdef::openshift-rosa,openshift-dedicated[]
39+
+
40+
[IMPORTANT]
41+
====
42+
When specifying values for the `zones` parameter, ensure that you only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
43+
====
44+
+
45+
endif::[]
46+
If none of the servers have a zone that matches the query, then name resolution falls back to the upstream DNS servers.
3847
+
3948
.Configuring DNS forwarding
4049
[source,yaml]
@@ -63,14 +72,6 @@ spec:
6372
----
6473
<1> Must comply with the `rfc6335` service name syntax.
6574
<2> Must conform to the definition of a subdomain in the `rfc1123` service name syntax. The cluster domain, `cluster.local`, is an invalid subdomain for the `zones` field.
66-
ifdef::openshift-rosa,openshift-dedicated[]
67-
+
68-
[IMPORTANT]
69-
====
70-
Only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
71-
====
72-
+
73-
endif::[]
7475
<3> Defines the policy to select upstream resolvers. Default value is `Random`. You can also use the values `RoundRobin`, and `Sequential`.
7576
<4> A maximum of 15 `upstreams` is allowed per `forwardPlugin`.
7677
<5> Optional. You can use it to override the default policy and forward DNS resolution to the specified DNS resolvers (upstream resolvers) for the default domain. If you do not provide any upstream resolvers, the DNS name queries go to the servers in `/etc/resolv.conf`.
@@ -79,8 +80,17 @@ endif::[]
7980
<8> You can specify two types of `upstreams` - `SystemResolvConf` and `Network`. `SystemResolvConf` configures the upstream to use `/etc/resolv.conf` and `Network` defines a `Networkresolver`. You can specify one or both.
8081
<9> If the specified type is `Network`, you must provide an IP address. The `address` field must be a valid IPv4 or IPv6 address.
8182
<10> If the specified type is `Network`, you can optionally provide a port. The `port` field must have a value between `1` and `65535`. If you do not specify a port for the upstream, by default port 853 is tried.
83+
84+
. Optional: When working in a highly regulated environment, you might need the ability to secure DNS traffic when forwarding requests to upstream resolvers so that you can ensure additional DNS traffic and data privacy.
85+
ifdef::openshift-rosa,openshift-dedicated[]
8286
+
83-
When working in a highly regulated environment, you might need the ability to secure DNS traffic when forwarding requests to upstream resolvers so that you can ensure additional DNS traffic and data privacy. Cluster administrators can configure transport layer security (TLS) for forwarded DNS queries.
87+
[IMPORTANT]
88+
====
89+
When specifying values for the `zones` parameter, ensure that you only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
90+
====
91+
+
92+
endif::[]
93+
Cluster administrators can configure transport layer security (TLS) for forwarded DNS queries.
8494
+
8595
.Configuring DNS forwarding with TLS
8696
[source,yaml]
@@ -119,14 +129,6 @@ spec:
119129
----
120130
<1> Must comply with the `rfc6335` service name syntax.
121131
<2> Must conform to the definition of a subdomain in the `rfc1123` service name syntax. The cluster domain, `cluster.local`, is an invalid subdomain for the `zones` field. The cluster domain, `cluster.local`, is an invalid `subdomain` for `zones`.
122-
ifdef::openshift-rosa,openshift-dedicated[]
123-
+
124-
[IMPORTANT]
125-
====
126-
Only forward to specific zones, such as your intranet. You must specify at least one zone. Otherwise, your cluster can lose functionality.
127-
====
128-
+
129-
endif::[]
130132
<3> When configuring TLS for forwarded DNS queries, set the `transport` field to have the value `TLS`.
131133
By default, CoreDNS caches forwarded connections for 10 seconds. CoreDNS will hold a TCP connection open for those 10 seconds if no request is issued. With large clusters, ensure that your DNS server is aware that it might get many new connections to hold open because you can initiate a connection per node. Set up your DNS hierarchy accordingly to avoid performance issues.
132134
<4> When configuring TLS for forwarded DNS queries, this is a mandatory server name used as part of the server name indication (SNI) to validate the upstream TLS server certificate.
@@ -141,7 +143,9 @@ By default, CoreDNS caches forwarded connections for 10 seconds. CoreDNS will ho
141143
====
142144
If `servers` is undefined or invalid, the config map only contains the default server.
143145
====
144-
+
146+
147+
.Verification
148+
145149
. View the config map:
146150
+
147151
[source,terminal]

0 commit comments

Comments
 (0)