Skip to content

Commit 561c1a3

Browse files
authored
Merge pull request #36088 from maxwelldb/shiftstack-octavia-support-osdocs2604
[OSDOCS-2604] Document ShiftStack cloud provider option configuration
2 parents 79d12e7 + 6b96115 commit 561c1a3

File tree

4 files changed

+68
-0
lines changed

4 files changed

+68
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
2323
include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
2424
include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1]
2525
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
26+
include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1]
2627
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
2728
include::modules/installation-initializing.adoc[leveloffset=+1]
2829
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
3030
include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
3131
include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1]
3232
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
33+
include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1]
3334
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
3435
include::modules/installation-initializing.adoc[leveloffset=+1]
3536
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
2828
include::modules/cluster-entitlements.adoc[leveloffset=+1]
2929
include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
3030
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
31+
include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1]
3132
include::modules/installation-creating-image-restricted.adoc[leveloffset=+1]
3233
include::modules/installation-initializing.adoc[leveloffset=+1]
3334
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
//Module included in the following assemblies:
2+
//
3+
// * installing/installing_openstack/installing-openstack-installer.adoc
4+
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
5+
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
6+
// * installing/installing_openstack/installing-openstack-installer-user.adoc
7+
8+
[id="installation-osp-setting-cloud-provider-options_{context}"]
9+
= Setting cloud provider options
10+
11+
Optionally, you can edit the cloud provider configuration for your cluster. The cloud provider configuration controls how {product-title} interacts with {rh-openstack-first}.
12+
13+
For a complete list of cloud provider configuration parameters, see link:https://v1-18.docs.kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#cloud-conf[the `cloud.conf` specification].
14+
15+
.Procedure
16+
17+
. If you have not already generated manifest files for your cluster, generate them by running the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ openshift-install --dir <destination_directory> create manifests
22+
----
23+
24+
. In a text editor, open the cloud-provider configuration manifest file. For example:
25+
+
26+
[source,terminal]
27+
----
28+
$ vi openshift/manifests/cloud-provider-config.yaml
29+
----
30+
31+
. Modify the options based on link:https://v1-18.docs.kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#cloud-conf[the `cloud.conf` specification].
32+
+
33+
Configuring Octavia for load balancing is a common case. For example:
34+
+
35+
[source,yaml]
36+
----
37+
#...
38+
[LoadBalancer]
39+
use-octavia=true <1>
40+
lb-provider = "amphora" <2>
41+
floating-network-id="d3deb660-4190-40a3-91f1-37326fe6ec4a"<3>
42+
#...
43+
----
44+
<1> This property enables Octavia integration.
45+
<2> This property sets the Octavia provider that your load balancer uses. It accepts `"ovn"` or `"amphora"` as values. If you choose to use OVN, you must also set `lb-method` to `SOURCE_IP_PORT`.
46+
<3> This property is required if you want to use multiple external networks with your cluster. The cloud provider creates floating IP addresses on the network that is specified here.
47+
+
48+
[IMPORTANT]
49+
====
50+
Prior to saving your changes, verify that the file is structured correctly. Clusters might fail if properties are not placed in the appropriate section.
51+
====
52+
53+
. Save the changes to the file and proceed with installation.
54+
+
55+
[TIP]
56+
====
57+
You can update your cloud provider configuration after you run the installer. On a command line, run:
58+
59+
[source,terminal]
60+
----
61+
$ oc edit configmap -n openshift-config cloud-provider-config
62+
----
63+
64+
After you save your changes, your cluster will take some time to reconfigure itself. The process is complete if none of your nodes have a `SchedulingDisabled` status.
65+
====

0 commit comments

Comments
 (0)