Migration to OVN in charm-guide

Bug #2031099 reported by Kamal Bhaskar
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Charm Guide
Fix Released
High
Brian Haley

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [ ] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [x] I have a fix to the document that I can paste below including example: input and output.

Hello

Documentation improvement needed as shown below.

On Step 8 of the procedure doc "Migrate to OVN":

#### Currently ####

8. Deploy the Neutron OVN plugin application

juju deploy neutron-api-plugin-ovn \
   --series focal \
   --config dns-servers=="1.1.1.1 8.8.8.8"

####

#### Should be updated to ####

8. Deploy the Neutron OVN plugin application

juju deploy neutron-api-plugin-ovn \
   --series focal \
   --config dns-servers="1.1.1.1 8.8.8.8"

####

The double equals-to i.e == should actually be =.

Impact:

This double equal to made the value assigned to the config along with one equal to i.e

$ juju config neutron-api-plugin-ovn dns-servers
=1.1.1.1 8.8.8.8
$

and caused complete DHCP outage in the openstack overlay networking.

Thanks & regards

-----------------------------------
Release: 0.0.1.dev741 on 2022-08-29 12:31:49
SHA: e4f2121ca20e7aba55276190edcf5cf3d022b1dd
Source: https://opendev.org/openstack/charm-guide/src/doc/source/project/procedures/ovn-migration.rst
URL: https://docs.openstack.org/charm-guide/latest/project/procedures/ovn-migration.html

Tags: charm-guide
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to charm-guide (master)
Changed in charm-guide:
status: New → In Progress
Changed in charm-guide:
assignee: nobody → Brian Haley (brian-haley)
Changed in charm-guide:
importance: Undecided → High
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to charm-guide (master)

Reviewed: https://review.opendev.org/c/openstack/charm-guide/+/891206
Committed: https://opendev.org/openstack/charm-guide/commit/49b626837f4761fe53410a3de81c611f9db4c104
Submitter: "Zuul (22348)"
Branch: master

commit 49b626837f4761fe53410a3de81c611f9db4c104
Author: Brian Haley <email address hidden>
Date: Fri Aug 11 10:58:29 2023 -0400

    Fix typo in OVN migration guide

    The OVN migration guide accidentally had a '==' in the
    example for setting dns_servers, which resulted in an
    invalid IP such as '=10.0.0.1'. Fixing allows DHCP to
    succeed.

    Closes-bug: #2031099
    Change-Id: Ib6e2a9137e2e40edbbf02e8057f2ddc590cea11e

Changed in charm-guide:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.