OpenStack -> RHOSP in ShiftStack IPI docs

maxwelldb · maxwelldb · commit 546a0123b2e9 · 2019-10-15T12:05:43.000-04:00
diff --git a/installing/installing_openstack/installing-openstack-installer-custom.adoc b/installing/installing_openstack/installing-openstack-installer-custom.adoc
@@ -6,15 +6,15 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 In {product-title} version {product-version}, you can install a customized cluster on
-OpenStack. To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster.
+Red Hat OpenStack Platform (RHOSP). To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster.
 
 .Prerequisites
 
 * Review details about the
 xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
 processes.
 
-* Have access to an OpenStack administrator's account
+* Have access to a RHOSP administrator's account
 
 include::modules/installation-osp-default-deployment.adoc[leveloffset=+1]
 include::modules/cluster-entitlements.adoc[leveloffset=+1]
diff --git a/installing/installing_openstack/installing-openstack-installer-kuryr.adoc b/installing/installing_openstack/installing-openstack-installer-kuryr.adoc
@@ -6,15 +6,15 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 In {product-title} version {product-version}, you can install a customized cluster on
-OpenStack that uses Kuryr SDN. To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster.
+Red Hat OpenStack Platform (RHOSP) that uses Kuryr SDN. To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster.
 
 .Prerequisites
 
 * Review details about the
 xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
 processes.
 
-* Have access to an OpenStack administrator's account
+* Have access to a RHOSP administrator's account
 
 include::modules/installation-osp-default-deployment.adoc[leveloffset=+1]
 include::modules/cluster-entitlements.adoc[leveloffset=+1]
diff --git a/installing/installing_openstack/installing-openstack-installer.adoc b/installing/installing_openstack/installing-openstack-installer.adoc
@@ -6,17 +6,17 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 In {product-title} version {product-version}, you can install a cluster on
-OpenStack.
+Red Hat OpenStack Platform (RHOSP).
 
 .Prerequisites
 
 * Review details about the
 xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
 processes.
 
-* Have access to an OpenStack administrator's account
+* Have access to a RHOSP administrator's account
 
-* On OpenStack, have access to an external network that does not overlap these CIDR ranges:
+* On RHOSP, have access to an external network that does not overlap these CIDR ranges:
 ** `10.0.0.0/16`
 ** `172.30.0.0/16`
 ** `10.128.0.0/14`
diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc
@@ -80,7 +80,7 @@ endif::osp[]
 |`platform.<platform>.region`
 |The region to deploy your cluster in.
 |A valid region for your cloud, such as `us-east-1` for AWS, `centralus`
-for Azure, or `region1` for OpenStack.
+for Azure, or `region1` for Red Hat OpenStack Platform (RHOSP).
 
 |`pullSecret`
 |The pull secret that you obtained from the
@@ -214,7 +214,7 @@ in the AWS documentation.
 endif::aws[]
 
 ifdef::osp[]
-.Additional OpenStack parameters
+.Additional Red Hat OpenStack Platform (RHOSP) parameters
 [cols=".^2m,.^3a,^3a,options="header"]
 |====
 |Parameter|Description|Values
@@ -236,32 +236,32 @@ ifdef::osp[]
 |String, for example `performance`.
 
 |`machines.platform.openstack.region`
-|The region where the OpenStack cluster is created.
+|The region where the RHOSP cluster is created.
 |String, for example `region1`.
 
 |`machines.platform.openstack.cloud`
-|The name of the OpenStack cloud to use from the list of clouds in the
+|The name of the RHOSP cloud to use from the list of clouds in the
 `clouds.yaml` file.
 |String, for example `MyCloud`.
 
 |`machines.platform.openstack.externalNetwork`
-|The OpenStack external network name to be used for installation.
+|The RHOSP external network name to be used for installation.
 |String, for example `external`.
 
 |`machines.platform.openstack.computeFlavor`
-|The OpenStack flavor to use for control plane and compute machines.
+|The RHOSP flavor to use for control plane and compute machines.
 |String, for example `m1.xlarge`.
 
 |`machines.platform.openstack.lbFloatingIP`
 |An existing floating IP address to associate with the load balancer API.
 |An IP address, for example `128.0.0.1`.
 
 |`machines.platform.openstack.trunkSupport`
-|Whether OpenStack ports can be trunked.
+|Whether RHOSP ports can be trunked.
 |`true` or `false`
 
 |`machines.platform.openstack.octaviaSupport`
-|Whether OpenStack supports Octavia.
+|Whether RHOSP supports Octavia.
 |`true` or `false`
 
 |`machines.platform.openstack.defaultMachinePlatform`
diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc
@@ -103,9 +103,9 @@ to the public DNS zone that you created for your cluster.
 endif::gcp[]
 ifdef::osp[]
 .. Select *openstack* as the platform to target.
-.. Specify the OpenStack external network name to use for installing the cluster.
+.. Specify the Red Hat OpenStack Platform (RHOSP) external network name to use for installing the cluster.
 .. Specify the Floating IP address to use for external access to the OpenShift API.
-.. Specify the OpenStack flavor with at least 16 GB RAM to use for control plane
+.. Specify a RHOSP flavor with at least 16 GB RAM to use for control plane
 and compute nodes.
 .. Select the base domain to deploy the cluster to. All DNS records will be
 sub-domains of this base and will also include the cluster name.
diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc
@@ -157,9 +157,9 @@ to the public DNS zone that you created for your cluster.
 endif::gcp[]
 ifdef::osp[]
 .. Select *openstack* as the platform to target.
-.. Specify the OpenStack external network name to use for installing the cluster.
+.. Specify the Red Hat OpenStack Platform (RHOSP) external network name to use for installing the cluster.
 .. Specify the Floating IP address to use for external access to the OpenShift API.
-.. Specify the OpenStack flavor with at least 16 GB RAM to use for control plane
+.. Specify the RHOSP flavor with at least 16 GB RAM to use for control plane
 and compute nodes.
 .. Select the base domain to deploy the cluster to. All DNS records will be
 sub-domains of this base and will also include the cluster name.
diff --git a/modules/installation-osp-about-kuryr.adoc b/modules/installation-osp-about-kuryr.adoc
@@ -5,18 +5,18 @@
 [id="installation-osp-about-kuryr_{context}"]
 = About Kuryr
 
-Kuryr is a container network interface (CNI) plug-in that uses Neutron and Octavia to provide networking to Pods and Services. It is primarily designed for {product-title} clusters that run on OpenStack instances.
+Kuryr is a container network interface (CNI) plug-in that uses Neutron and Octavia to provide networking to Pods and Services. It is primarily designed for {product-title} clusters that run on Red Hat OpenStack Platform (RHOSP) instances.
 
-Kuryr improves network performance by connecting Pods to the OpenStack SDN. It also provides connections between Pods and OpenStack instances.
+Kuryr improves network performance by connecting Pods to the OpenStack SDN. It also provides connections between Pods and RHOSP instances.
 
 [IMPORTANT]
 ====
-Kuryr is recommended for deployments on encapsulated OpenStack tenant networks to avoid double encapsulation. For example, on a deployment of an encapsulated OpenShift SDN over an OpenStack network.
+Kuryr is recommended for deployments on encapsulated RHOSP-tenant networks to avoid double encapsulation. For example, on a deployment of an encapsulated OpenShift SDN over a RHOSP network.
 
 The default OpenShift SDN is recommended if:
 
 * You use provider networks or tenant VLANs.
-* The deployment will use many Services on a few hypervisors. Each Service creates an Octavia Amphora virtual machine in OpenStack that hosts a required load balancer.
+* The deployment will use many Services on a few hypervisors. Each Service creates an Octavia Amphora virtual machine in RHOSP that hosts a required load balancer.
 * You need UDP Services.
 ====
 
diff --git a/modules/installation-osp-accessing-api-floating.adoc b/modules/installation-osp-accessing-api-floating.adoc
@@ -14,7 +14,7 @@ The load balancer FIP is also used in the `install-config.yaml` file.
 
 .Procedure
 
-. Using the OpenStack CLI, create a new external network:
+. Using the Red Hat OpenStack Platform (RHOSP) CLI, create a new external network:
 +
 ----
 $ openstack floating ip create <external network>
diff --git a/modules/installation-osp-accessing-api.adoc b/modules/installation-osp-accessing-api.adoc
@@ -7,6 +7,6 @@
 [id="installation-osp-accessing-api_{context}"]
 = Enabling access to the environment
 
-At deployment, all {product-title} machines are created in an OpenStack tenant network. Therefore, they are not accessible directly in most OpenStack deployments.
+At deployment, all {product-title} machines are created in a Red Hat OpenStack Platform (RHOSP)-tenant network. Therefore, they are not accessible directly in most RHOSP deployments.
 
 You can configure the {product-title} API to be accessible either with or without floating IP addresses.
diff --git a/modules/installation-osp-balancing-external-loads.adoc b/modules/installation-osp-balancing-external-loads.adoc
@@ -5,18 +5,18 @@
 [id="installation-osp-balancing-external-loads_{context}"]
 = Configuring an external load balancer
 
-Configure an external load balancer in OpenStack to use your own load balancer, resolve external networking needs, or scale beyond what the default {product-title} load balancer can provide.
+Configure an external load balancer in Red Hat OpenStack Platform (RHOSP) to use your own load balancer, resolve external networking needs, or scale beyond what the default {product-title} load balancer can provide.
 
 The load balancer serves ports 6443, 443, and 80 to any users of the system. Port 22623 serves Ignition start-up configurations to the {product-title} machines and must not be reachable from outside the cluster.
 
 .Prerequisites
 
-* Access to an OpenStack administrator's account
-* The https://docs.openstack.org/python-openstackclient/latest/[OpenStack client] installed on the target environment
+* Access to a RHOSP administrator's account
+* The https://docs.openstack.org/python-openstackclient/latest/[RHOSP client] installed on the target environment
 
 .Procedure
 
-. Using the OpenStack CLI, add floating IP addresses to all of the control plane machines:
+. Using the RHOSP CLI, add floating IP addresses to all of the control plane machines:
 +
 ----
 $ openstack floating ip create --port master-port-0 <public network>
diff --git a/modules/installation-osp-config-yaml.adoc b/modules/installation-osp-config-yaml.adoc
@@ -6,7 +6,7 @@
 [id="installation-osp-config-yaml_{context}"]
 = Sample customized `install-config.yaml` file for OpenStack
 
-This sample `install-config.yaml` demonstrates all of the possible OpenStack
+This sample `install-config.yaml` demonstrates all of the possible Red Hat OpenStack Platform (RHOSP)
 customization options.
 
 [IMPORTANT]
diff --git a/modules/installation-osp-configuring-floating-ip.adoc b/modules/installation-osp-configuring-floating-ip.adoc
@@ -7,7 +7,7 @@
 [id="installation-osp-configuring-api-floating-ip_{context}"]
 = Configuring application access with floating IP addresses
 
-After you install {product-title}, configure OpenStack to allow application network traffic.
+After you install {product-title}, configure Red Hat OpenStack Platform (RHOSP) to allow application network traffic.
 
 .Prerequisites
 
diff --git a/modules/installation-osp-creating-image.adoc b/modules/installation-osp-creating-image.adoc
@@ -7,29 +7,29 @@
 [id="installation-osp-creating-image_{context}"]
 = Creating the {op-system-first} image
 
-The {product-title} installation program requires that a {op-system-first} image be present in the OpenStack cluster. Retrieve the latest {op-system} image, then upload it using the OpenStack CLI.
+The {product-title} installation program requires that a {op-system-first} image be present in the Red Hat OpenStack Platform (RHOSP) cluster. Retrieve the latest {op-system} image, then upload it using the RHOSP CLI.
 
 .Prerequisites
 
-* The OpenStack CLI is installed.
+* The RHOSP CLI is installed.
 
 .Procedure
 
 . Download the latest {op-system} image from the Red Hat customer portal's https://access.redhat.com/downloads/content/290[Product Downloads page].
 +
 [NOTE]
-The OpenStack QCOW2 images are delivered in compressed format, so you must specify additional options to download them.  With `curl`, specify `curl --compressed -J -L -O <image_url>`.  With `wget`, specify `wget --compression=auto <image_url>`.
+The RHOSP QCOW2 images are delivered in compressed format, so you must specify additional options to download them.  With `curl`, specify `curl --compressed -J -L -O <image_url>`.  With `wget`, specify `wget --compression=auto <image_url>`.
 
-. From the image that you downloaded, create an image that is named `rhcos` to your cluster by using the OpenStack CLI:
+. From the image that you downloaded, create an image that is named `rhcos` to your cluster by using the RHOSP CLI:
 +
 ----
 $ openstack image create --container-format=bare --disk-format=qcow2 --file rhcos-${RHCOSVERSION}-openstack.qcow2 rhcos
 ----
 +
 [CAUTION]
-If the installation program finds multiple images with the same name, it chooses one of them at random. To avoid this behavior, create unique names for resources in OpenStack.
+If the installation program finds multiple images with the same name, it chooses one of them at random. To avoid this behavior, create unique names for resources in RHOSP.
 +
 [NOTE]
-Depending on your OpenStack environment, the image can be in either `qcow2` or `raw` formats. If your environment requires the `raw` format, substitute `raw` for `qcow2` in the preceding example. For more information about image formats, see https://docs.openstack.org/image-guide/image-formats.html[Disk and container formats for images].
+Depending on your RHOSP environment, the image can be in either `qcow2` or `raw` formats. If your environment requires the `raw` format, substitute `raw` for `qcow2` in the preceding example. For more information about image formats, see https://docs.openstack.org/image-guide/image-formats.html[Disk and container formats for images].
 
-After you upload the image to OpenStack, it is available to the installation program.
+After you upload the image to RHOSP, it is available to the installation program.
diff --git a/modules/installation-osp-default-deployment.adoc b/modules/installation-osp-default-deployment.adoc
@@ -11,9 +11,9 @@ endif::[]
 [id="installation-osp-default-deployment_{context}"]
 = Resource guidelines for installing {product-title} on OpenStack
 
-Your quota must meet the following requirements to run the {product-title} installation program in OpenStack:
+Your quota must meet the following requirements to run the {product-title} installation program in RHOSP:
 
-.Recommended resources for a default {product-title} cluster on OpenStack
+.Recommended resources for a default {product-title} cluster on RHOSP
 [options="header"]
 |================================
 |Resource              | Value
@@ -49,8 +49,8 @@ By default, the {product-title} installation program stands up three control pla
 
 Each machine requires:
 
-* An instance from the OpenStack quota
-* A port from the OpenStack quota
+* An instance from the RHOSP quota
+* A port from the RHOSP quota
 * A flavor with at least 16 GB memory, 4 vCPUs, and 25 GB storage space
 
 [TIP]
@@ -63,8 +63,8 @@ Compute machines host the applications that you run on {product-title}; aim to r
 // What about instances and ports?
 // Each worker node requires:
 
-// * An instance from the OpenStack quota
-// * A port from the OpenStack quota
+// * An instance from the RHOSP quota
+// * A port from the RHOSP quota
 // * A flavor with at least 16 GB memory, 4 vCPUs, and 25 GB storage space
 
 // Each compute machine requires a flavor with at least 8 GB memory, 2 vCPUs, and 25 GB storage space.
@@ -76,8 +76,8 @@ At installation, a bootstrap machine is temporarily provisioned to stand up the
 
 The bootstrap machine requires:
 
-* An instance from the OpenStack quota
-* A port from the OpenStack quota
+* An instance from the RHOSP quota
+* A port from the RHOSP quota
 * A flavor with at least 16 GB memory, 4 vCPUs, and 25 GB storage space
 
 [NOTE]
diff --git a/modules/installation-osp-describing-cloud-parameters.adoc b/modules/installation-osp-describing-cloud-parameters.adoc
@@ -5,17 +5,17 @@
 // * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
 
 [id="installation-osp-describing-cloud-parameters_{context}"]
-= Defining OpenStack parameters for the installation program
+= Defining parameters for the installation program
 
-The {product-title} installation program relies on a file called `clouds.yaml`. The file describes OpenStack configuration parameters, including the project name, log in information, and authorization service URLs.
+The {product-title} installation program relies on a file called `clouds.yaml`. The file describes RHOSP configuration parameters, including the project name, log in information, and authorization service URLs.
 
 .Procedure
 
 . Create the `clouds.yaml` file:
 
 ** If your OpenStack distribution includes the Horizon web UI, generate a `clouds.yaml` file in it.
 
-** If your OpenStack distribution does not include the Horizon web UI, or you do not want to use Horizon, create the file yourself. For detailed information about `clouds.yaml`, see https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html#config-files[Config files] in the OpenStack documentation.
+** If your OpenStack distribution does not include the Horizon web UI, or you do not want to use Horizon, create the file yourself. For detailed information about `clouds.yaml`, see https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html#config-files[Config files] in the RHOSP documentation.
 +
 ----
 clouds:
diff --git a/modules/installation-osp-enabling-kuryr.adoc b/modules/installation-osp-enabling-kuryr.adoc
@@ -9,16 +9,16 @@ You can enable Kuryr in your project by editing a parameter in the `install-conf
 
 .Prerequisites
 
-* Kuryr requires greater than the minimum recommended resources. As an administrator, increase OpenStack's resource quotas:
+* Kuryr requires greater than the minimum recommended resources. As an administrator, increase Red Hat OpenStack Platform's (RHOSP) resource quotas:
 +
 ----
 $ openstack quota set --secgroups 100 --secgroup-rules 500 --ports 500 --subnets 100 --networks 100 <project>
 ----
 
-* Enable the `trunks` extension on your OpenStack project
+* Enable the `trunks` extension on your RHOSP project
 
-* Install and configure Octavia components in the OpenStack environment
-** Depending on your OpenStack environment, Octavia might not support UDP listeners. If it does not, your cluster cannot support UDP Services.
+* Install and configure Octavia components in the RHOSP environment
+** Depending on your RHOSP environment, Octavia might not support UDP listeners. If it does not, your cluster cannot support UDP Services.
 
 * If the default ML2/OVS Neutron driver is used, set the firewall to `openvswitch` intead of `ovs_hybrid`
 
diff --git a/modules/installation-osp-enabling-swift.adoc b/modules/installation-osp-enabling-swift.adoc
@@ -7,20 +7,20 @@
 [id="installation-osp-enabling-swift_{context}"]
 = Enabling Swift on OpenStack
 
-{product-title} on OpenStack uses https://docs.openstack.org/security-guide/object-storage.html[OpenStack Object Storage (Swift)] to store and serve user configuration files.
+{product-title} on RHOSP uses https://docs.openstack.org/security-guide/object-storage.html[OpenStack Object Storage (Swift)] to store and serve user configuration files.
 
 Swift is operated by a user account with the `swiftoperator` role and `temp-url` support.
 
 .Prerequisites
 
-* An OpenStack administrator account on the target environment
+* A RHOSP administrator account on the target environment
 * On Ceph RGW, https://docs.ceph.com/docs/master/radosgw/config-ref/#swift-settings[the `account in url` option must be enabled]
 
 .Procedure
 
-To enable Swift on OpenStack:
+To enable Swift on RHOSP:
 
-. As an administrator in the OpenStack CLI, add the `swiftoperator` role to the account that will access Swift:
+. As an administrator in the RHOSP CLI, add the `swiftoperator` role to the account that will access Swift:
 +
 ----
 $ openstack role add --user <user> --project <project> swiftoperator
@@ -31,4 +31,4 @@ $ openstack role add --user <user> --project <project> swiftoperator
 $ openstack object store account set --property Temp-URL-Key=superkey
 ----
 
-Your OpenStack deployment can now use Swift to store and serve files.
+Your RHOSP deployment can now use Swift to store and serve files.
diff --git a/modules/installation-osp-troubleshooting.adoc b/modules/installation-osp-troubleshooting.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * TBD
+// * n/a
 
 [id="installation-osp-customizing_{context}"]
 
@@ -11,12 +11,12 @@
 
 Unfortunately, there will always be some cases where {product-title} fails to install properly. In these events, it is helpful to understand the likely failure modes as well as how to troubleshoot the failure.
 
-This document discusses some troubleshooting options for OpenStack based
+This document discusses some troubleshooting options for RHOSP-based
 deployments. For general tips on troubleshooting the installation program, see the [Installer Troubleshooting](../troubleshooting.md) guide.
 
 == View instance logs
 
-OpenStack CLI tools must be installed, then:
+RHOSP CLI tools must be installed, then:
 
 ----
 $ openstack console log show <instance>
diff --git a/modules/installation-osp-verifying-external-network.adoc b/modules/installation-osp-verifying-external-network.adoc

Original file line number	Diff line number	Diff line change
@@ -14,7 +14,7 @@ The load balancer FIP is also used in the `install-config.yaml` file.
`14`	`14`
`15`	`15`	`.Procedure`
`16`	`16`
`17`		`-. Using the OpenStack CLI, create a new external network:`
	`17`	`+. Using the Red Hat OpenStack Platform (RHOSP) CLI, create a new external network:`
`18`	`18`	`+`
`19`	`19`	`----`
`20`	`20`	`$ openstack floating ip create <external network>`