diff --git a/installing/installing_openstack/installing-openstack-installer-custom.adoc b/installing/installing_openstack/installing-openstack-installer-custom.adoc index 4a92824986bf..805c1cf67d93 100644 --- a/installing/installing_openstack/installing-openstack-installer-custom.adoc +++ b/installing/installing_openstack/installing-openstack-installer-custom.adoc @@ -7,18 +7,34 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -In {product-title} version {product-version}, you can install a customized cluster on -{rh-openstack-first}. To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster. +In {product-title} version {product-version}, you can install a customized cluster on {rh-openstack-first}. To customize the installation, modify parameters in the `install-config.yaml` before you install the cluster. -== Prerequisites +Ensure that you meet the following 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 verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. -* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]. -* You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#recommended-host-practices[Recommended practices for scaling the cluster]. +* You reviewed details about the {product-title} installation and update processes. +* You read the documentation on selecting a cluster installation method and preparing it for users. +* You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the supported platforms for {product-title} clusters section. You can also compare platform support across different versions by viewing the {product-title} on {rh-openstack} support matrix. +* You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see "Optimizing storage". +* You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see "Recommended practices for scaling the cluster". * You have the metadata service enabled in {rh-openstack}. +You can complete the following configurations after you install a cluster on {rh-openstack} with customizations: + +* Customize your cluster. +* Enable remote health reporting. +* Configure ingress cluster traffic by using a node port. +* If you did not configure {rh-openstack} to accept application traffic over floating IP addresses, configure {rh-openstack} access with floating IP addresses. + +[role="_additional-resources"] +.Additional resources + +* xref:../../architecture/architecture-installation.adoc#architecture-installation[Installation and update] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] +* xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for {product-title} clusters] +* link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix (Red Hat Knowledgebase)] +* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] +* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#recommended-host-practices[Recommended practices for scaling the cluster] + include::modules/installation-osp-default-deployment.adoc[leveloffset=+1] include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2] @@ -49,7 +65,8 @@ include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../installing/installing_openstack/installation-config-parameters-openstack.adoc#installation-config-parameters-openstack[Installation configuration parameters for OpenStack] + +* xref:../../installing/installing_openstack/installation-config-parameters-openstack.adoc#installation-config-parameters-openstack[Installation configuration parameters for {rh-openstack}] include::modules/installation-configure-proxy.adoc[leveloffset=+2] @@ -63,17 +80,13 @@ include::modules/installation-osp-provider-network-preparation.adoc[leveloffset= include::modules/installation-osp-deploying-provider-networks-installer.adoc[leveloffset=+3] -[TIP] -==== -You can add additional networks, including provider networks, to the `platform.openstack.additionalNetworkIDs` list. +[role="_additional-resources"] +.Additional resources -After you deploy your cluster, you can attach pods to additional networks. For more information, see xref:../../networking/multiple_networks/understanding-multiple-networks.adoc#understanding-multiple-networks[Understanding multiple networks]. -==== +* xref:../../networking/multiple_networks/understanding-multiple-networks.adoc#understanding-multiple-networks[Understanding multiple networks] include::modules/installation-osp-config-yaml.adoc[leveloffset=+2] - -//Dual-stack networking include::modules/install-osp-dualstack.adoc[leveloffset=+2] include::modules/install-osp-deploy-dualstack.adoc[leveloffset=+3] @@ -82,7 +95,8 @@ include::modules/installation-configuring-shiftstack-single-ipv6.adoc[leveloffse [role="_additional-resources"] .Additional resources -* See xref:../../disconnected/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift] + +* xref:../../disconnected/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift] include::modules/installation-osp-external-lb-config.adoc[leveloffset=+2] @@ -104,20 +118,20 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* See xref:../../web_console/web-console.adoc#web-console[Accessing the web console] for more details about accessing and understanding the {product-title} web console. +* xref:../../web_console/web-console.adoc#web-console[Accessing the web console] 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 +* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] -[id="next-steps_{context}"] -== Next steps +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can -xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. -* If you need to enable external access to node ports, xref:../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[configure ingress cluster traffic by using a node port]. -* If you did not configure {rh-openstack} to accept application traffic over floating IP addresses, xref:../../installing/installing_openstack/installing-openstack-network-config.adoc#installation-osp-configuring-api-floating-ip_installing-openstack-network-config[configure {rh-openstack} access with floating IP addresses]. +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Postinstallation cluster tasks] +* xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting] +* xref:../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[Configuring ingress cluster traffic by using a NodePort] +* xref:../../installing/installing_openstack/installing-openstack-network-config.adoc#installation-osp-configuring-api-floating-ip_installing-openstack-network-config[Configuring network settings after installing {rh-openstack}] diff --git a/modules/install-osp-deploy-dualstack.adoc b/modules/install-osp-deploy-dualstack.adoc index 18041267eede..17b2cbb914b0 100644 --- a/modules/install-osp-deploy-dualstack.adoc +++ b/modules/install-osp-deploy-dualstack.adoc @@ -152,7 +152,7 @@ platform: * `platform.openstack.controlPlanePort.fixedIPs` specifies the subnets for the control plane port. The CIDR of any subnet specified in this field must match the CIDRs listed on `networking.machineNetwork`. * `platform.openstack.controlPlanePort.fixedIPs[].subnet` specifies each subnet. You can specify a value for either `name` or `id`, or both. * `platform.openstack.controlPlanePort.network` specifies the network. Specifying the `network` under the `controlPlanePort` field is optional. - ++ [NOTE] ==== When using an installation host in an isolated dual-stack network, the IPv6 address might not be reassigned correctly upon reboot. @@ -178,7 +178,7 @@ ipv6.addr-gen-mode=0 After you create and edit the file, reboot the installation host. ==== - ++ [NOTE] ==== The `ip=dhcp,dhcp6` kernel argument, which is set on all of the nodes, results in a single Network Manager connection profile that activates on many interfaces simultaneously. diff --git a/modules/install-osp-dualstack.adoc b/modules/install-osp-dualstack.adoc index 457185e3ea81..a27a63149626 100644 --- a/modules/install-osp-dualstack.adoc +++ b/modules/install-osp-dualstack.adoc @@ -1,6 +1,7 @@ // Module included in the following assemblies: // // * installing/installing_openstack/installing-openstack-installer-custom.adoc + :_mod-docs-content-type: CONCEPT [id="install-osp-dualstack_{context}"] = Configuring a cluster with dual-stack networking @@ -20,4 +21,3 @@ For earlier versions of {rh-openstack}, you can enable the dual-stack configurat ==== {rh-openstack} does not support the conversion of an IPv4 single-stack cluster to a dual-stack cluster network. ==== - diff --git a/modules/installation-osp-bootstrap-machine.adoc b/modules/installation-osp-bootstrap-machine.adoc index 80af2ec6bfd3..d3fda607e6d0 100644 --- a/modules/installation-osp-bootstrap-machine.adoc +++ b/modules/installation-osp-bootstrap-machine.adoc @@ -7,8 +7,7 @@ = Bootstrap machine [role="_abstract"] -During installation, a bootstrap machine is temporarily provisioned to stand up the -control plane. After the production control plane is ready, the bootstrap +During installation, a bootstrap machine is temporarily provisioned to stand up the control plane. After the production control plane is ready, the bootstrap machine is deprovisioned. The bootstrap machine requires: diff --git a/modules/installation-osp-config-yaml.adoc b/modules/installation-osp-config-yaml.adoc index 5aec0921fb69..afa94d0c9078 100644 --- a/modules/installation-osp-config-yaml.adoc +++ b/modules/installation-osp-config-yaml.adoc @@ -6,7 +6,8 @@ [id="installation-osp-config-yaml_{context}"] = Sample customized install-config.yaml file for {rh-openstack} -The following example `install-config.yaml` files demonstrate all of the possible {rh-openstack-first} customization options. +[role="_abstract"] +The example `install-config.yaml` files demonstrate all of the possible {rh-openstack-first} customization options. [IMPORTANT] This sample file is provided for reference only. You must obtain your `install-config.yaml` file by using the installation program. diff --git a/modules/installation-osp-default-deployment.adoc b/modules/installation-osp-default-deployment.adoc index 7fb4ffece9e2..4b8881fc2b22 100644 --- a/modules/installation-osp-default-deployment.adoc +++ b/modules/installation-osp-default-deployment.adoc @@ -28,11 +28,11 @@ To support an {product-title} installation, your {rh-openstack-first} quota must |Server groups | 2 - plus 1 for each additional availability zone in each machine pool |====================================== -A cluster might function with fewer than recommended resources, but its performance is not guaranteed. +A cluster might function with fewer than recommended resources, but cluster performance is not guaranteed. [IMPORTANT] ==== -If {rh-openstack} object storage (Swift) is available and operated by a user account with the `swiftoperator` role, it is used as the default backend for the {product-title} image registry. In this case, the volume storage requirement is 175 GB. Swift space requirements vary depending on the size of the image registry. +If {rh-openstack} object storage (Swift) is available and operated by a user account with the `swiftoperator` role, Swift is used as the default backend for the {product-title} image registry. In this case, the volume storage requirement is 175 GB. Swift space requirements vary depending on the size of the image registry. ==== [NOTE] diff --git a/modules/installation-osp-deploying-provider-networks-installer.adoc b/modules/installation-osp-deploying-provider-networks-installer.adoc index 34831803a989..462971f39976 100644 --- a/modules/installation-osp-deploying-provider-networks-installer.adoc +++ b/modules/installation-osp-deploying-provider-networks-installer.adoc @@ -7,8 +7,16 @@ [id="installation-osp-deploying-provider-networks-installer_{context}"] = Deploying a cluster that has a primary interface on a provider network +[role="_abstract"] You can deploy an {product-title} cluster that has its primary network interface on an {rh-openstack-first} provider network. +[TIP] +==== +You can add additional networks, including provider networks, to the `platform.openstack.additionalNetworkIDs` list. + +After you deploy your cluster, you can attach pods to additional networks. For more information, see "Understanding multiple networks". +==== + .Prerequisites * Your {rh-openstack-first} deployment is configured as described by "{rh-openstack} provider network requirements for cluster installation". @@ -16,25 +24,29 @@ You can deploy an {product-title} cluster that has its primary network interface .Procedure . In a text editor, open the `install-config.yaml` file. + . Set the value of the `platform.openstack.apiVIPs` property to the IP address for the API VIP. + . Set the value of the `platform.openstack.ingressVIPs` property to the IP address for the Ingress VIP. + . Set the value of the `platform.openstack.machinesSubnet` property to the UUID of the provider network subnet. -. Set the value of the `networking.machineNetwork.cidr` property to the CIDR block of the provider network subnet. +. Set the value of the `networking.machineNetwork.cidr` property to the CIDR block of the provider network subnet. ++ [IMPORTANT] ==== The `platform.openstack.apiVIPs` and `platform.openstack.ingressVIPs` properties must both be unassigned IP addresses from the `networking.machineNetwork.cidr` block. ==== - ++ .Section of an installation configuration file for a cluster that relies on a {rh-openstack} provider network [source,yaml] ---- ... platform: openstack: - apiVIPs: <1> + apiVIPs: - 192.0.2.13 - ingressVIPs: <1> + ingressVIPs: - 192.0.2.23 machinesSubnet: fa806b2f-ac49-4bce-b9db-124bc64209bf # ... @@ -42,12 +54,12 @@ The `platform.openstack.apiVIPs` and `platform.openstack.ingressVIPs` properties machineNetwork: - cidr: 192.0.2.0/24 ---- - -<1> In {product-title} 4.12 and later, the `apiVIP` and `ingressVIP` configuration settings are deprecated. Instead, use a list format to enter values in the `apiVIPs` and `ingressVIPs` configuration settings. - ++ +** In {product-title} 4.12 and later, the `apiVIP` and `ingressVIP` configuration settings are deprecated. Instead, use a list format to enter values in the `apiVIPs` and `ingressVIPs` configuration settings. ++ [WARNING] ==== You cannot set the `platform.openstack.externalNetwork` or `platform.openstack.externalDNS` parameters while using a provider network for the primary network interface. ==== - ++ When you deploy the cluster, the installer uses the `install-config.yaml` file to deploy the cluster on the provider network. diff --git a/modules/installation-osp-external-lb-config.adoc b/modules/installation-osp-external-lb-config.adoc index 6c55485fda5a..2635d95042e3 100644 --- a/modules/installation-osp-external-lb-config.adoc +++ b/modules/installation-osp-external-lb-config.adoc @@ -2,7 +2,8 @@ [id="install-osp-external-lb-config_{context}"] = Installation configuration for a cluster on OpenStack with a user-managed load balancer -The following example `install-config.yaml` file demonstrates how to configure a cluster that uses an external, user-managed load balancer rather than the default internal load balancer. +[role="_abstract"] +The example `install-config.yaml` file demonstrates how to configure a cluster that uses an external, user-managed load balancer rather than the default internal load balancer. [source,yaml] ---- @@ -31,14 +32,17 @@ networking: platform: openstack: cloud: mycloud - machinesSubnet: 8586bf1a-cc3c-4d40-bdf6-c243decc603a <1> + machinesSubnet: 8586bf1a-cc3c-4d40-bdf6-c243decc603a apiVIPs: - 192.168.10.5 ingressVIPs: - 192.168.10.7 loadBalancer: - type: UserManaged <2> + type: UserManaged ---- -<1> Regardless of which load balancer you use, the load balancer is deployed to this subnet. -<2> The `UserManaged` value indicates that you are using an user-managed load balancer. \ No newline at end of file + +where: + +`platform.openstack.machineSubnet`:: Regardless of which load balancer you use, the load balancer is deployed to this subnet. +`platform.openstack.loadBalancer.type`:: Specifies the `UserManaged` value, which indicates that you are using a user-managed load balancer. diff --git a/modules/installation-osp-verifying-external-network.adoc b/modules/installation-osp-verifying-external-network.adoc index 7d23524d7137..d1534e6edfb6 100644 --- a/modules/installation-osp-verifying-external-network.adoc +++ b/modules/installation-osp-verifying-external-network.adoc @@ -19,6 +19,7 @@ endif::[] [id="installation-osp-verifying-external-network_{context}"] = Verifying external network access +[role="_abstract"] The {product-title} installation process requires external network access. You must provide an external network value to it, or deployment fails. Before you begin the process, verify that a network with the external router type exists in {rh-openstack-first}. .Prerequisites @@ -42,10 +43,10 @@ $ openstack network list --long -c ID -c Name -c "Router Type" | 148a8023-62a7-4672-b018-003462f8d7dc | public_network | External | +--------------------------------------+----------------+-------------+ ---- - ++ A network with an external router type appears in the network list. If at least one does not, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/director_installation_and_usage/performing-overcloud-post-installation-tasks#creating-a-default-floating-ip-network[Creating a default floating IP network] and link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/director_installation_and_usage/performing-overcloud-post-installation-tasks#creating-a-default-provider-network[Creating a default provider network]. - ifdef::osp-custom[] ++ [IMPORTANT] ==== If the external network's CIDR range overlaps one of the default network ranges, you must change the matching network ranges in the `install-config.yaml` file before you start the installation process. @@ -66,12 +67,12 @@ The default network ranges are: |==== ==== endif::osp-custom[] - ifdef::osp-custom[] [WARNING] ++ If the installation program finds multiple networks with the same name, it sets one of them at random. To avoid this behavior, create unique names for resources in {rh-openstack}. endif::osp-custom[] - ++ [NOTE] ==== If the Neutron trunk service plugin is enabled, a trunk port is created by default. For more information, see https://wiki.openstack.org/wiki/Neutron/TrunkPort[Neutron trunk port].