VPNaaS docs lack packages to install

Bug #2009831 reported by eblock@nde.ag
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
New
Low
Unassigned

Bug Description

Like the other installation docs the vpnaas 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 vpnaas on Ubuntu:

- python3-neutron-vpnaas
- neutron-vpnaas-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: 22.1.0.dev22 on 2018-07-19 01:56:36
SHA: 7caa0febd04c5d0a3568a471806b785560ae3f02
Source: https://opendev.org/openstack/neutron/src/doc/source/admin/vpnaas-scenario.rst
URL: https://docs.openstack.org/neutron/latest/admin/vpnaas-scenario.html

Changed in neutron:
importance: Undecided → Low
tags: added: low-hanging-fruit vpnaas
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-vpnaas-common python3-neutron-vpnaas

And then there's also this page [1] containing some sort of (brief) installation info but it's outdated, I believe because the package names are different. Also it's not really clear how it's referred to and what the correct structure would be.

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

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.