FWaaS docs lack required packages

Bug #2009832 reported by eblock@nde.ag
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Lajos Katona

Bug Description

Like the other installation docs the fwaas doc should contain the required packages as well. For example, in this thread [1] we figured out which packages are required. Although for an experienced user it can be obvious what is missing it would be helpful if the basics are mentioned there. These two packages are required for fwnaas on Ubuntu:

- python3-neutron-fwaas
- neutron-fwaas-common

[1] https://stackoverflow.com/questions/75572612/adding-vpnaas-to-an-openstack-zed-setup/75653229?noredirect=1#comment133519986_75653229

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: ______
- [X] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - The mailing list: https://lists.openstack.org
 - IRC: 'openstack' channel on OFTC

-----------------------------------
Release: 21.0.1.dev107 on 2022-05-16 08:52:41
SHA: ee28d85db943ebc6c525fad97b225236df054016
Source: https://opendev.org/openstack/neutron/src/doc/source/admin/fwaas-v2-scenario.rst
URL: https://docs.openstack.org/neutron/zed/admin/fwaas-v2-scenario.html

tags: added: fwaas low-hanging-fruit
Changed in neutron:
importance: Undecided → Low
Revision history for this message
Lajos Katona (lajos-katona) wrote :

Thanks for reporting it, Could you please perhaps propose a fix, an example could be networking-sfc:
https://opendev.org/openstack/networking-sfc/src/branch/master/doc/source/install/install.rst

Revision history for this message
eblock@nde.ag (eblock) wrote :

I would love to, but I don't have an account for opendev.org (not the biggest issue) and I'm not really familiar with the structure or how to propose fixes. But I believe there's actually not much to add, comparing with a different service it would probably suffice to add a new section:

Install and configure components

 1. Install the packages:

    # apt install neutron-fwaas-common python3-neutron-fwaas

One other thing I noticed was that there is this page [1] which contains some pip commands, but I don't really understand how it is referred to or how it applies to the general fwaas installation guide.

[1] https://docs.openstack.org/neutron-fwaas/zed/install/index.html

Changed in neutron:
assignee: nobody → Lajos Katona (lajos-katona)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/neutron/+/881239

Changed in neutron:
status: New → In Progress
Revision history for this message
Lajos Katona (lajos-katona) wrote :

Please check if the proposal is good for your idea. as I see the doc in Neutron-fwaas project points to the one in Neutron (https://docs.openstack.org/neutron-fwaas/latest/install/index.html)

Revision history for this message
eblock@nde.ag (eblock) wrote :

It looks good to me.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.opendev.org/c/openstack/neutron/+/881239
Committed: https://opendev.org/openstack/neutron/commit/9f22dc1d3af15ef8a85d608e2d8ffb6d29140fca
Submitter: "Zuul (22348)"
Branch: master

commit 9f22dc1d3af15ef8a85d608e2d8ffb6d29140fca
Author: elajkat <email address hidden>
Date: Fri Apr 21 17:34:53 2023 +0200

    Doc: Add FWaaS v2 install details

    Change-Id: I8813efac46ff3d2a93933c3025bf5490d21cd622
    Closes-bug: #2009832

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron 23.0.0.0b2

This issue was fixed in the openstack/neutron 23.0.0.0b2 development milestone.

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.