Skip to content

Commit 2bc9500

Browse files
committed
Add OSP SR-IOV installation docs
1 parent d5ffdb2 commit 2bc9500

29 files changed

+705
-28
lines changed

_topic_map.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,10 @@ Topics:
259259
File: installing-openstack-user
260260
- Name: Installing a cluster on OpenStack with Kuryr on your own infrastructure
261261
File: installing-openstack-user-kuryr
262+
- Name: Installing a cluster on OpenStack on your own SR-IOV infrastructure
263+
File: installing-openstack-user-sr-iov
264+
# - Name: Installing a cluster on OpenStack with Kuryr on your own SR-IOV infrastructure
265+
# File: installing-openstack-user-sr-iov-kuryr
262266
- Name: Installing a cluster on OpenStack in a restricted network
263267
File: installing-openstack-installer-restricted
264268
# - Name: Load balancing deployments on OpenStack

installing/installing_openstack/installing-openstack-installer-custom.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In {product-title} version {product-version}, you can install a customized clust
1313
* Review details about the
1414
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
1515
processes.
16-
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version in the _Available platforms_ 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].
16+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
1717

1818
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
1919

installing/installing_openstack/installing-openstack-installer-kuryr.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In {product-title} version {product-version}, you can install a customized clust
1313
* Review details about the
1414
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
1515
processes.
16-
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version in the _Available platforms_ 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].
16+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
1717

1818
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
1919

installing/installing_openstack/installing-openstack-installer-restricted.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ to complete all installation steps.
2121

2222
* Review details about the
2323
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update processes].
24-
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by consulting the architecture documentation's xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[list of available platforms]. 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].
24+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
2525

2626
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
2727

installing/installing_openstack/installing-openstack-user-kuryr.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Using your own infrastructure allows you to integrate your cluster with existing
1414

1515
* Review details about the
1616
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
17-
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version in the _Available platforms_ 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].
17+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
1818

1919
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
2020

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
// Not supported in 4.7.
2+
3+
[id="installing-openstack-user-sr-iov-kuryr"]
4+
= Installing a cluster on OpenStack with Kuryr on your own SR-IOV infrastructure
5+
include::modules/common-attributes.adoc[]
6+
:context: installing-openstack-user-sr-iov-kuryr
7+
8+
toc::[]
9+
10+
In {product-title} {product-version}, you can install a cluster on
11+
{rh-openstack-first} that runs on user-provisioned infrastructure and uses SR-IOV networks to run compute machines.
12+
13+
Using your own infrastructure allows you to integrate your cluster with existing infrastructure and modifications. The process requires more labor on your part than installer-provisioned installations, because you must create all {rh-openstack} resources, such as Nova servers, Neutron ports, and security groups. However, Red Hat provides Ansible playbooks to help you in the deployment process.
14+
15+
== Prerequisites
16+
17+
* Review details about the
18+
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
19+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
20+
21+
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
22+
23+
* Have a {rh-openstack} account where you want to install {product-title}.
24+
25+
* On the machine where you run the installation program, have:
26+
** A single directory in which you can keep the files you create during the installation process
27+
** Python 3
28+
29+
include::modules/installation-osp-about-kuryr.adoc[leveloffset=+1]
30+
include::modules/installation-osp-default-kuryr-deployment.adoc[leveloffset=+1]
31+
include::modules/installation-osp-kuryr-increase-quota.adoc[leveloffset=+2]
32+
include::modules/installation-osp-kuryr-neutron-configuration.adoc[leveloffset=+2]
33+
include::modules/installation-osp-kuryr-octavia-configuration.adoc[leveloffset=+2]
34+
include::modules/installation-osp-kuryr-known-limitations.adoc[leveloffset=+2]
35+
include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2]
36+
include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
37+
include::modules/cluster-entitlements.adoc[leveloffset=+1]
38+
include::modules/installation-osp-downloading-modules.adoc[leveloffset=+1]
39+
include::modules/installation-osp-downloading-playbooks.adoc[leveloffset=+1]
40+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
41+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
42+
// include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
43+
include::modules/installation-osp-creating-image.adoc[leveloffset=+1]
44+
include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1]
45+
include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
46+
include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2]
47+
include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2]
48+
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
49+
include::modules/installation-initializing.adoc[leveloffset=+1]
50+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
51+
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
52+
include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
53+
include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2]
54+
include::modules/installation-osp-emptying-worker-pools.adoc[leveloffset=+2]
55+
include::modules/installation-osp-modifying-networktype.adoc[leveloffset=+2]
56+
include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]
57+
include::modules/installation-osp-converting-ignition-resources.adoc[leveloffset=+1]
58+
include::modules/installation-osp-creating-control-plane-ignition.adoc[leveloffset=+1]
59+
include::modules/installation-osp-creating-network-resources.adoc[leveloffset=+1]
60+
include::modules/installation-osp-creating-bootstrap-machine.adoc[leveloffset=+1]
61+
include::modules/installation-osp-creating-control-plane.adoc[leveloffset=+1]
62+
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
63+
include::modules/installation-osp-deleting-bootstrap-resources.adoc[leveloffset=+1]
64+
include::modules/installation-osp-configuring-sr-iov.adoc[leveloffset=+1]
65+
include::modules/installation-osp-creating-sr-iov-compute-machines.adoc[leveloffset=+1]
66+
67+
To finish configuring SR-IOV for your cluster, complete the SR-IOV-related "Next steps" that follow the installation process.
68+
69+
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
70+
include::modules/installation-osp-verifying-installation.adoc[leveloffset=+1]
71+
72+
== Next steps
73+
74+
* To complete SR-IOV configuration for your cluster:
75+
** xref:../../post_installation_configuration/network-configuration.html#networking-osp-preparing-for-sr-iov_post-install-network-configuration[Prepare the cluster for SR-IOV].
76+
** xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.html#what-huge-pages-do_huge-pages[Install the performance operator with huge pages support].
77+
** xref:../../networking/hardware_networks/installing-sriov-operator.html#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
78+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
79+
* If necessary, you can
80+
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].
81+
* If you need to enable external access to node ports, xref:../../networking/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].
82+
* If you did not configure {rh-openstack} to accept application traffic over floating IP addresses, xref:../../post_installation_configuration/network-configuration.adoc#installation-osp-configuring-api-floating-ip_post-install-network-configuration[configure {rh-openstack} access with floating IP addresses].
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
[id="installing-openstack-user-sr-iov"]
2+
= Installing a cluster on OpenStack on your own SR-IOV infrastructure
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-openstack-user-sr-iov
5+
6+
toc::[]
7+
8+
In {product-title} {product-version}, you can install a cluster on
9+
{rh-openstack-first} that runs on user-provisioned infrastructure and uses single-root input/output virtualization (SR-IOV) networks to run compute machines.
10+
11+
Using your own infrastructure allows you to integrate your cluster with existing infrastructure and modifications. The process requires more labor on your part than installer-provisioned installations, because you must create all {rh-openstack} resources, such as Nova servers, Neutron ports, and security groups. However, Red Hat provides Ansible playbooks to help you in the deployment process.
12+
13+
== Prerequisites
14+
15+
* Review details about the
16+
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
17+
** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by using the "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].
18+
19+
* Verify that your network configuration does not rely on a provider network. Provider networks are not supported.
20+
21+
* Have an {rh-openstack} account where you want to install {product-title}.
22+
23+
* On the machine where you run the installation program, have:
24+
** A single directory in which you can keep the files you create during the installation process
25+
** Python 3
26+
27+
include::modules/cluster-entitlements.adoc[leveloffset=+1]
28+
include::modules/installation-osp-default-deployment.adoc[leveloffset=+1]
29+
include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2]
30+
include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
31+
include::modules/installation-osp-downloading-modules.adoc[leveloffset=+1]
32+
include::modules/installation-osp-downloading-playbooks.adoc[leveloffset=+1]
33+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
34+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
35+
include::modules/installation-osp-creating-image.adoc[leveloffset=+1]
36+
include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1]
37+
include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
38+
include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2]
39+
include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2]
40+
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
41+
include::modules/installation-initializing.adoc[leveloffset=+1]
42+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
43+
include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
44+
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
45+
include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2]
46+
include::modules/installation-osp-emptying-worker-pools.adoc[leveloffset=+2]
47+
include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]
48+
include::modules/installation-osp-converting-ignition-resources.adoc[leveloffset=+1]
49+
include::modules/installation-osp-creating-control-plane-ignition.adoc[leveloffset=+1]
50+
include::modules/installation-osp-creating-network-resources.adoc[leveloffset=+1]
51+
Optionally, you can use the the `inventory.yaml` file that you created to customize your installation. For example, you can deploy a cluster that uses bare metal machines.
52+
53+
include::modules/installation-osp-deploying-bare-metal-machines.adoc[leveloffset=+2]
54+
include::modules/installation-osp-creating-bootstrap-machine.adoc[leveloffset=+1]
55+
include::modules/installation-osp-creating-control-plane.adoc[leveloffset=+1]
56+
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
57+
include::modules/installation-osp-deleting-bootstrap-resources.adoc[leveloffset=+1]
58+
include::modules/installation-osp-configuring-sr-iov.adoc[leveloffset=+1]
59+
include::modules/installation-osp-creating-sr-iov-compute-machines.adoc[leveloffset=+1]
60+
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
61+
include::modules/installation-osp-verifying-installation.adoc[leveloffset=+1]
62+
The cluster is operational. Before you can configure it for SR-IOV networks though, you must perform additional tasks.
63+
64+
include::modules/networking-osp-preparing-for-sr-iov.adoc[leveloffset=+1]
65+
include::modules/networking-osp-enabling-metadata.adoc[leveloffset=+2]
66+
include::modules/networking-osp-enabling-vfio-noiommu.adoc[leveloffset=+2]
67+
68+
[NOTE]
69+
====
70+
After you apply the machine config to the machine pool, you can xref:../../post_installation_configuration/machine-configuration-tasks.html#checking-mco-status_post-install-machine-configuration-tasks[watch the machine config pool status] to see when the machines are available.
71+
====
72+
73+
// TODO: If bullet one of Next steps is truly required for this flow, these topics (in full or in part) could be added here rather than linked to.
74+
// This document is quite long, however, and operator installation and configuration should arguably remain in their their own assemblies.
75+
76+
The cluster is installed and prepared for SR-IOV configuration. You must now perform the SR-IOV configuration tasks in "Next steps".
77+
78+
== Additional resources
79+
* See xref:../../scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.html#cnf-understanding-low-latency_cnf-master[Performance Addon Operator for low latency nodes] for information about configuring your deployment for real-time running and low latency.
80+
81+
== Next steps
82+
83+
* To complete SR-IOV configuration for your cluster:
84+
** xref:../../scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.html#installing-the-performance-addon-operator_cnf-master[Install the Performance Addon Operator].
85+
** xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.html#what-huge-pages-do_huge-pages[Configure the Performance Addon Operator with huge pages support].
86+
** xref:../../networking/hardware_networks/installing-sriov-operator.html#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
87+
** xref:../../networking/hardware_networks/configuring-sriov-device.html#nw-sriov-networknodepolicy-object_configuring-sriov-device[Configure your SR-IOV network device].
88+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
89+
* If necessary, you can
90+
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].
91+
* If you need to enable external access to node ports, xref:../../networking/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].
92+
* If you did not configure {rh-openstack} to accept application traffic over floating IP addresses, xref:../../post_installation_configuration/network-configuration.adoc#installation-osp-configuring-api-floating-ip_post-install-network-configuration[configure {rh-openstack} access with floating IP addresses].

0 commit comments

Comments
 (0)