Adoption of octavia service #728

weinimo · 2024-11-13T11:10:14Z

Octavia adoption documentation

JIRAs: OSPRH-10750 OSPNET-1078

softwarefactory-project-zuul · 2024-11-27T17:09:47Z

Build failed (check pipeline). Post recheck (without leading slash)
to rerun all jobs. Make sure the failure cause has been resolved before
you rerun jobs.

https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/41a8e533fe264f5cb491dd92e4ae6a1d

✔️ noop SUCCESS in 0s
✔️ adoption-standalone-to-crc-ceph SUCCESS in 3h 16m 51s
❌ adoption-standalone-to-crc-no-ceph FAILURE in 53m 58s
✔️ adoption-docs-preview SUCCESS in 1m 18s

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

beagles

Looks pretty good. Just a couple of questions. Also, should we include flipping the o-hm0 network configuration scripts on the controller to be ONBOOT=no?

softwarefactory-project-zuul · 2024-12-04T13:46:27Z

Build failed (check pipeline). Post recheck (without leading slash)
to rerun all jobs. Make sure the failure cause has been resolved before
you rerun jobs.

https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/e9669c0258bc48a19f6171e47963b346

✔️ noop SUCCESS in 0s
❌ adoption-standalone-to-crc-ceph RETRY_LIMIT in 48m 57s
❌ adoption-standalone-to-crc-no-ceph RETRY_LIMIT in 51m 02s
✔️ adoption-docs-preview SUCCESS in 1m 13s

weinimo · 2025-01-21T16:37:58Z

@weinimo Let me know when you're done with incorporating the doc changes, and then I'll ask another writer on my team to peer review the user doc files. Thanks!

@klgill It is ready now for peer review. Thanks.

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

rheslop · 2025-01-21T17:54:32Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

 ----

-Make sure to replace `<path to the ssh key>` with the correct path to the ssh
-key for connecting to the controller.
+. Run the following set of commands to regenerate the keys and certificates and install the data in {rhocp_long}. These commands convert the existing single certificate authority (CA) configuration into a


Suggested change

. Run the following set of commands to regenerate the keys and certificates and install the data in {rhocp_long}. These commands convert the existing single certificate authority (CA) configuration into a

. Run the following set of commands to convert the existing single certificate authority (CA) configuration into a dual CA configuration. These commands regenerate the keys and certificates and insert them into {rhocp_long}.

Recommend switching the statements because "Run the following set of commands to..." assumes the user goal, which looks like the second statement. Then the first seems to be saying what the commands are actually doing. Reworded install the data to "insert them into" for clarity, but I'm not sure if this is a technically correct interpretation of what you're saying

Could drop "set of" or maybe even drop "Run the following set of commands to" for fluff. Could change "These commands regenerate the keys and certificates and insert them into {rhocp_long}. " to "You can use these commands to regenerate the keys and certificates and insert them into {rhocp_long}." to make it more user-focused.

I will update this in a separate commit. Your suggestion does not update line 27 so I would need to make a manual update anyway. Thanks for the suggestions!

rheslop · 2025-01-21T17:56:32Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc


+. (Optional) Public SSH key of Amphorae
+
+These commands will copy the existing public SSH key that can be used for connecting to the amphorae and installs it in Openshift.


Suggest rewording here. "installs it into OpenShift" has an ambiguous pronoun "it" which can refer to either the SSH key or amphorae. Do we need the "which can be used for connecting..." part?

I'd also drop "will". I think we don't really use future tense in our docs. "can be used" is passive, could change to "that you can use". Are "these commands" the previous commands or the next commands? Maybe something like:
"Copy the existing public SSH key that you can use for connecting to the amphorae and install it in Openshift:"

Thanks. I don't have a strong opinion about the "which can be used for connecting" part. I think it helps the user understand what it is used for. I will leave it in for now.

rheslop · 2025-01-21T18:01:07Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

 ----

-These commands convert the existing single CA configuration into a dual CA configuration.
+. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command adds the network interface to use as the VLAN base interface for the management network for network isolation on the {OpenShiftShort} nodes:


Suggested change

. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command adds the network interface to use as the VLAN base interface for the management network for network isolation on the {OpenShiftShort} nodes:

. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command configures the VLAN base interface for the management network on the {OpenShiftShort} nodes. This is necessary for network isolation.

I might drop "the following command" to make it more instructional.
Maybe:
"Add the network interface for the VLAN base interface of the management network for network isolation on the {OpenShiftShort} nodes:"

Is the "management network for network isolation" a thing or is "network isolation" like a goal of these steps? If it's the latter, could say: "To isolate the management network, add the network interface for the VLAN base interface:"

I'm not sure of the wording at the moment but the idea here is that there is a host interface added to the octavia network attachment's bridge. This is there because a bridge style network attachment is needed to be usable with the OVN/OVS (macvlan doesn't work in this case) but bridge NAD's do not provide connectivity between hosts. If that host interface is a VLAN interface, then there is some isolation between the octavia load balancer management network traffic and other networks.

How about we just say "Add the {loadbalancer_service} interfaces to each NodeNetworkConfigurationPolicy custom resource (CR)." and leave away the rest that is not really relevant to the user?

rheslop · 2025-01-21T18:04:41Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+<1> Replace `<enp6s0>` with the name of the network interface in your {OpenShiftShort} setup.
+<2> Replace `<mtu>` with the `mtu` value in your environment.
+
+. Configure the {loadbalancer_service} network attachment definition to connect pods that manage load balancer virtual machines (amphorae) and the OpenvSwitch pods that are managed by the OVN operator:


Here I'm unsure if this means that you're providing network connectivity to both the pods that manage load balancer virtual machines and the OpenvSwitch pods that are managed by the OVN operator, or if you are more specifically connecting them to each other. So the following suggestion might not be correct.

Suggested change

. Configure the {loadbalancer_service} network attachment definition to connect pods that manage load balancer virtual machines (amphorae) and the OpenvSwitch pods that are managed by the OVN operator:

. Configure the {loadbalancer_service} network attachment definition to connect pods that manage load balancer virtual machines (amphorae) to the OpenvSwitch pods that are managed by the OVN operator:

could put the goal or outcome first:
"To connect pods that manage load balancer virtual machines (amphorae) and the OpenvSwitch pods that are managed by the OVN operator, configure the {loadbalancer_service} network attachment definition:"

I'm not sure if we have style guidelines on this

rheslop · 2025-01-21T18:08:04Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+. Delete the old management network ports:
+
+The first command stores the network ID of the old management network in the
+variable `WALLABY_LB_MGMT_NET_ID` for later use. Then, all ports that are used in the network get deleted.


This looks like it should be two steps

klgill · 2025-01-21T18:23:05Z

@weinimo Let me know when you're done with incorporating the doc changes, and then I'll ask another writer on my team to peer review the user doc files. Thanks!

@klgill It is ready now for peer review. Thanks.

@weinimo There will be two people peer reviewing the docs files in this PR. I gave them both until Monday to complete the review.

mickogeary · 2025-01-21T19:00:34Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc


-== Enabling the {loadbalancer_service} in OpenShift
-Run the following command in order to enable the {loadbalancer_service} CR.


Could just say:
"Enable the {loadbalancer_service} CR:"

mickogeary · 2025-01-21T19:04:15Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+
+.. Connect to each of the Controller nodes on the old control plane, for example, `overcloud-controller-0`.
+
+.. Open the configuration script for the management interface. For example:


"Open the configuration script for the management interface, for example:"

What is the example here? Will customer have a different configuration script? I guess that's what ifcfg-o-hm0 is?

Oh I see that is mentioned in next line. Could maybe say:
"Open the management interface configuration script in a text editor such as vi:"

Thanks. I just noticed it is not actually a script but only a configuration file, so I replaced "script" with "file".

mickogeary · 2025-01-21T19:06:29Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+$ sudo vi /etc/sysconfig/network-scripts/ifcfg-o-hm0
+----
+
+The exact name of the script depends on the previous `OctaviaMgmtPortDevName` setting.


Maybe:
"The script name is based on the OctaviaMgmtPortDevName setting and might differ in your environment. "

Thanks, I will add "previous" to your suggestion, because this is a setting made in the 17.1 deployment.

mickogeary · 2025-01-21T19:11:14Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+
+The exact name of the script depends on the previous `OctaviaMgmtPortDevName` setting.
+
+.. Change `ONBOOT=yes` to `ONBOOT=no` so that the interface does not get enabled automatically on reboot:


"Change ONBOOT=yes to ONBOOT=no to ensure that the interface is disabled on reboot:"

Co-authored-by: Roger Heslop <heslop@outlook.com>

weinimo

@rheslop @mickogeary Thanks for your reviews. I think I have incorporated all of your suggestions. Please double-check.

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

weinimo · 2025-01-22T11:10:03Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

 ----

-Make sure to replace `<path to the ssh key>` with the correct path to the ssh
-key for connecting to the controller.
+. Run the following set of commands to regenerate the keys and certificates and install the data in {rhocp_long}. These commands convert the existing single certificate authority (CA) configuration into a


I will update this in a separate commit. Your suggestion does not update line 27 so I would need to make a manual update anyway. Thanks for the suggestions!

weinimo · 2025-01-22T11:17:56Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc


+. (Optional) Public SSH key of Amphorae
+
+These commands will copy the existing public SSH key that can be used for connecting to the amphorae and installs it in Openshift.


Thanks. I don't have a strong opinion about the "which can be used for connecting" part. I think it helps the user understand what it is used for. I will leave it in for now.

weinimo · 2025-01-22T12:01:47Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+
+.. Connect to each of the Controller nodes on the old control plane, for example, `overcloud-controller-0`.
+
+.. Open the configuration script for the management interface. For example:


Thanks. I just noticed it is not actually a script but only a configuration file, so I replaced "script" with "file".

weinimo · 2025-01-22T12:04:05Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

+$ sudo vi /etc/sysconfig/network-scripts/ifcfg-o-hm0
+----
+
+The exact name of the script depends on the previous `OctaviaMgmtPortDevName` setting.


Thanks, I will add "previous" to your suggestion, because this is a setting made in the 17.1 deployment.

weinimo · 2025-01-22T13:39:44Z

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

 ----

-These commands convert the existing single CA configuration into a dual CA configuration.
+. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command adds the network interface to use as the VLAN base interface for the management network for network isolation on the {OpenShiftShort} nodes:


How about we just say "Add the {loadbalancer_service} interfaces to each NodeNetworkConfigurationPolicy custom resource (CR)." and leave away the rest that is not really relevant to the user?

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

klgill · 2025-01-22T14:16:53Z

@rheslop @mickogeary Thanks for your reviews. I think I have incorporated all of your suggestions. Please double-check.

Thanks, @weinimo. I'll check the updated docs today.

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

klgill · 2025-01-22T15:56:59Z

@weinimo I made a couple of additional minor edits. Otherwise, LGTM.

Co-authored-by: Katie Gilligan <kgilliga@redhat.com>

jistr · 2025-01-28T10:53:08Z

/lgtm

openshift-ci · 2025-01-28T13:59:56Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

weinimo force-pushed the octavia-stop branch 2 times, most recently from 16136da to d7bf201 Compare November 13, 2024 11:36

weinimo changed the title ~~Stop octavia services in stop_openstack_services role~~ Stop/start octavia services Nov 13, 2024

weinimo requested review from jistr and yadneshk November 18, 2024 15:59

weinimo force-pushed the octavia-stop branch 2 times, most recently from d61eb34 to a3291c7 Compare November 26, 2024 14:33

weinimo changed the title ~~Stop/start octavia services~~ Adoption of octavia service Nov 26, 2024

weinimo force-pushed the octavia-stop branch 9 times, most recently from ebe6304 to 7053d99 Compare November 27, 2024 13:45

weinimo force-pushed the octavia-stop branch 2 times, most recently from 505c13f to aaa16da Compare December 3, 2024 12:31

weinimo mentioned this pull request Dec 3, 2024

Octavia data plane adoption #703

Closed

beagles reviewed Dec 3, 2024

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Show resolved Hide resolved

beagles reviewed Dec 3, 2024

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Outdated Show resolved Hide resolved

beagles reviewed Dec 3, 2024

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Show resolved Hide resolved

beagles reviewed Dec 3, 2024

View reviewed changes

weinimo force-pushed the octavia-stop branch 4 times, most recently from d9fbac4 to 001e057 Compare December 4, 2024 12:54

Update docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

6bc92cb

weinimo force-pushed the octavia-stop branch from 675f41b to 6bc92cb Compare January 20, 2025 17:44

Update NNCP config OSPRH-13457

bb3147d

weinimo force-pushed the octavia-stop branch from 7c5fed2 to bb3147d Compare January 21, 2025 12:27

rheslop reviewed Jan 21, 2025

View reviewed changes

mickogeary reviewed Jan 21, 2025

View reviewed changes

weinimo and others added 2 commits January 22, 2025 14:54

Update docs_user/modules/proc_adopting-the-loadbalancer-service.adoc

66abc30

Co-authored-by: Roger Heslop <heslop@outlook.com>

Updates after peer review

4222524

weinimo commented Jan 22, 2025

View reviewed changes

klgill reviewed Jan 22, 2025

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Outdated Show resolved Hide resolved

klgill reviewed Jan 22, 2025

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Outdated Show resolved Hide resolved

klgill reviewed Jan 22, 2025

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Outdated Show resolved Hide resolved

klgill reviewed Jan 22, 2025

View reviewed changes

docs_user/modules/proc_adopting-the-loadbalancer-service.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

7597605

Co-authored-by: Katie Gilligan <kgilliga@redhat.com>

weinimo requested a review from jistr January 27, 2025 15:18

openshift-ci bot assigned jistr Jan 28, 2025

openshift-ci bot added the lgtm label Jan 28, 2025

klgill approved these changes Jan 28, 2025

View reviewed changes

klgill added the approved label Jan 28, 2025

openshift-merge-bot bot merged commit 0d137d0 into openstack-k8s-operators:main Jan 28, 2025
6 checks passed

weinimo deleted the octavia-stop branch January 28, 2025 14:58

	. Run the following set of commands to regenerate the keys and certificates and install the data in {rhocp_long}. These commands convert the existing single certificate authority (CA) configuration into a
	. Run the following set of commands to convert the existing single certificate authority (CA) configuration into a dual CA configuration. These commands regenerate the keys and certificates and insert them into {rhocp_long}.

	. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command adds the network interface to use as the VLAN base interface for the management network for network isolation on the {OpenShiftShort} nodes:
	. Add the {loadbalancer_service} interfaces to each `NodeNetworkConfigurationPolicy` custom resource (CR). The following command configures the VLAN base interface for the management network on the {OpenShiftShort} nodes. This is necessary for network isolation.

	. Configure the {loadbalancer_service} network attachment definition to connect pods that manage load balancer virtual machines (amphorae) and the OpenvSwitch pods that are managed by the OVN operator:
	. Configure the {loadbalancer_service} network attachment definition to connect pods that manage load balancer virtual machines (amphorae) to the OpenvSwitch pods that are managed by the OVN operator:


		== Enabling the {loadbalancer_service} in OpenShift
		Run the following command in order to enable the {loadbalancer_service} CR.


		.. Connect to each of the Controller nodes on the old control plane, for example, `overcloud-controller-0`.

		.. Open the configuration script for the management interface. For example:

Adoption of octavia service #728

Adoption of octavia service #728

Conversation

weinimo commented Nov 13, 2024 • edited Loading

softwarefactory-project-zuul bot commented Nov 27, 2024

beagles left a comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Dec 4, 2024

weinimo commented Jan 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

klgill commented Jan 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weinimo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

klgill commented Jan 22, 2025

klgill commented Jan 22, 2025

jistr commented Jan 28, 2025

openshift-ci bot commented Jan 28, 2025

weinimo commented Nov 13, 2024 •

edited

Loading