Commit Graph

54 Commits

Author SHA1 Message Date
Slawek Kaplonski 842f2f8e6c [Docs] Fix info about provider bridge name in the bridge_mappings
Previously in all our install guides there were info that name of the
physical interface should be put in the bridge_mappings config option in
ths OVS agent's config. This wasn't correct as bridge_mappings expects
there bridge name instead.

Change-Id: I0698aa4621a15c1927ad2c352501cea02e6ee70c
2023-10-27 17:57:41 +02:00
Zuul 53f4fd6b9f Merge "doc: Fix wrong sections of ovs-agent config options" 2023-10-26 18:36:56 +00:00
Takashi Kajinami 34f7a5805e doc: Fix wrong sections of ovs-agent config options
The sections described in the documentation does not match the actual
section names in current neutron.

 * local_ip now belongs to the [ovs] section
 * tunnel_types now belongs to the [agent] section
 * l2_population now belongs to the [agent] section

Also the tunnel_types option is not explained in the example snippet.

Change-Id: Ic2bde217a03a884855d299f3142394a4229745bc
2023-10-26 09:00:56 +09:00
Zuul 389bc155f8 Merge "doc: Stop configuring authtoken middleware in compute" 2023-10-25 23:58:36 +00:00
Takashi Kajinami 2bcad25d34 doc: Stop configuring authtoken middleware in compute
... because the middleware is used only by neutron-server.

This also removes the metadata shared secret from compute, because
metadata-agent runs only in controller nodes according to the guide.

Change-Id: I0e5ed7453384d24581bcd8c3a85c8fc36fab910f
2023-10-25 11:26:51 +09:00
Takashi Kajinami 2a637820eb doc: Remove remaining description about allow_overlapping_ips
The option was already removed.

Change-Id: Ic1bcec77e3ef1bac5dc59d5f492348ee9ac9993e
2023-10-25 11:24:51 +09:00
Arnaud Morin 30c0e5699e Fix doc links for networking option 2
Wrong links were introduced long time ago, this is setting the good
links.

Change-Id: Ib3dbe570f3aecb9533fa4623726db5551fd87100
Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com>
2023-05-04 11:07:16 +02:00
Brian Haley 4fa85b9a99 Fix incorrect mysql examples
Command to create the neutron database was missing '>'.

Trivialfix

Closes-bug: #2000870

Change-Id: Id5555ec16bd855c0fae9b58e03038740e759bf2e
2023-01-03 11:16:34 -05:00
Rodolfo Alonso Hernandez 1a9ae924fd Add VXLAN support reference in the OVN installation guide
That includes the limitation of ML2/OVN for VXLAN networks to
a maximum of 4096 networks and the explanation.

Closes-Bug: #1998085
Change-Id: I0b0ba353c219a49acd80edecd0997d1f653b0192
2022-11-18 18:10:51 +01:00
Zuul 1e4cc72901 Merge "Doc: Capitalize keystone domain names" 2022-11-22 12:15:14 +00:00
Brian Haley a2090e4cbc Doc: Capitalize keystone domain names
There is an inconsistency for keystone domain names
in the docs, 'default' and 'Default'. Should always
use the latter, 'Default'.

Change-Id: I4487de4e121362a02f839546721f007781f84057
Closes-bug: #1996889
2022-11-17 11:42:14 -05:00
Rodolfo Alonso Hernandez c6a83988ea Replace Linux Bridge with Open vSwitch in installation docs
This patch replaces the Linux Bridge references with Open vSwitch in
the installation manuals.

Closes-Bug: #1996772
Change-Id: Ib63daad7fac52e1e10dca2e98add01d5ee7635a3
2022-11-13 19:46:56 +01:00
renliang17 562e9704f8 Update documentation link for openSUSE index.
Change-Id: Ie8dd684a7b79b0a322b1f2d17fffb4d58cfe94fc
2022-11-04 13:59:58 +08:00
Zuul aefcaf4944 Merge "Revert "doc: Remove fwaas references from docs"" 2022-05-27 11:20:30 +00:00
Lajos Katona 7c4f273ed9 Revert "doc: Remove fwaas references from docs"
This reverts commit bce27811df.

Reason for revert: neutron-fwaas has maintainers so the documentation should be available.

Due to changes since the original deletion commit the following changes
were added:
* Add note that OVN is not yet supported
* Remove note that Horizon support is not available

Change-Id: I1a739ee045b49e9b44283c28f95b1accc8a1e37f
2022-05-17 12:01:55 +02:00
Slawek Kaplonski fde91e8059 Remove "allow_overlapping_ips" config option
It was deprecated in Yoga by patch [1]. Now it's time to remove it.

[1] https://review.opendev.org/c/openstack/neutron/+/807848

Closes-Bug: #1942294
Change-Id: I95555395c8adcec70459d5f438e1080da358c4d4
2022-04-12 16:29:21 +02:00
Cheol-Min Kim 30c6092747 Fix typo in the third instruction paragraph of "Controller nodes" block
Closes-Bug: #1962324
Signed-off-by: Cheol-Min Kim <cheolminkim@vanilet.pe.kr>
Change-Id: Ia4607259c1a344876a515d8ce450655de453ad8f
2022-03-01 21:07:17 +09:00
Radosław Piliszek dc4a57d966 Make OVN driver validate Geneve max_header_size
Also updates the docs to be clearer on OVN-Geneve relation topics.

Co-Authored-By: Elvira García Ruiz <egarciar@redhat.com>
Change-Id: Ia253cc4d85261ce1535f4d27b3da91275d879903
Closes-bug: #1868137
2021-09-02 08:41:19 +00:00
tcervi cfd8232cd3 Added dnsmasq for opensuse installation
Updating documentation since opensuse needs dnsmasq to install openstack-neutron-dhcp-agent

Change-Id: I745d358cc369a605565a95f8c5260ee49d8fc190
2021-06-07 16:05:37 -03:00
Slawek Kaplonski c4fb1d1711 [Doc] Update Freenode to OFTC as our IRC server
Change-Id: I4e4d819e271495fa650a275246df8925ef84fd25
2021-05-31 21:54:08 +02:00
elajkat bce27811df doc: Remove fwaas references from docs
FWaaS was retired with [1], so it's time to remove the misleading
references from doc as well.

[1]: https://review.opendev.org/c/openstack/neutron-fwaas/+/735829

Change-Id: Ic098263b7450c09308eeff4ef6dd2f8097c0a449
2021-03-10 06:16:33 +00:00
Maciej Józefczyk db6ebd22e1 Update cirros image to cirros-0.5.1-x86_64 globally
New cirros with recent fixes for metadata service
has been released. Lets update the image version on gate.

Also stop using different images for OVN. Lets use default
settings from devstack.

First we need to merge [2].

[1] e40bcd2964
[2] https://review.opendev.org/#/c/711492/

Change-Id: Idc614f9f25188bd1a1e1d5424274acf04ba99328
2020-07-07 22:06:39 +00:00
Dmitrii Shcherbakov 397a5177bd Fix a typo in the OVN manual install guide
Using a colon is not correct in this context and results in service
startup errors like this:

AttributeError: module 'neutron.services.ovn_l3'
has no attribute 'plugin:OVNL3RouterPlugin'

It could be that this hasn't been modified after copying from setup.cfg
where a colon is used correctly.

Moreover, it would be better to use entrypoint names, so this change
changes that for the L3 service plugin as well as the core plugin.

Change-Id: Id51704a50f42b65049e535aaeb9dc6847a3737bb
2020-06-15 13:24:57 +03:00
Maciej Józefczyk 2d1cd99311 [OVN][DOC] Update path to L3RouterPlugin
The path was old pointing not existing networking-ovn path.

Fixed also first paragraph about OVS/OVN installation.

Change-Id: Iee77443c0ac8cb83d4e380c53db8405eca642b2b
Closes-Bug: #1879747
2020-05-21 12:32:24 +02:00
Slawek Kaplonski cd66232c2b Merge networking-ovn documentation into neutron
It also adds 2 sample of devstack's local.conf file
for deploying Neutron with OVN mechanism driver.

Needed to create PNG files out of the existing SVG
ones in order to pass the pdf doc build.

Co-Authored-By: Aaron Rosen <aaronorosen@gmail.com>
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Co-Authored-By: Amitabha Biswas <abiswas@us.ibm.com>
Co-Authored-By: Andreas Jaeger <aj@suse.com>
Co-Authored-By: Anh Tran <anhtt@vn.fujitsu.com>
Co-Authored-By: Assaf Muller <amuller@redhat.com>
Co-Authored-By: Babu Shanmugam <bschanmu@redhat.com>
Co-Authored-By: Brian Haley <bhaley@redhat.com>
Co-Authored-By: Chandra S Vejendla <csvejend@us.ibm.com>
Co-Authored-By: Daniel Alvarez <dalvarez@redhat.com>
Co-Authored-By: Dong Jun <dongj@dtdream.com>
Co-Authored-By: Emilien Macchi <emilien@redhat.com>
Co-Authored-By: Flavio Fernandes <flavio@flaviof.com>
Co-Authored-By: Gal Sagie <gal.sagie@huawei.com>
Co-Authored-By: Gary Kotton <gkotton@vmware.com>
Co-Authored-By: Guoshuai Li <ligs@dtdream.com>
Co-Authored-By: Han Zhou <zhouhan@gmail.com>
Co-Authored-By: Hong Hui Xiao <xiaohhui@cn.ibm.com>
Co-Authored-By: Jakub Libosvar <libosvar@redhat.com>
Co-Authored-By: Jeff Feng <jianhua@us.ibm.com>
Co-Authored-By: Jenkins <jenkins@review.openstack.org>
Co-Authored-By: Jonathan Herlin <jonte@jherlin.se>
Co-Authored-By: Kyle Mestery <mestery@mestery.com>
Co-Authored-By: Le Hou <houl7@chinaunicom.cn>
Co-Authored-By: Lucas Alvares Gomes <lucasagomes@gmail.com>
Co-Authored-By: Matthew Kassawara <mkassawara@gmail.com>
Co-Authored-By: Miguel Angel Ajo <majopela@redhat.com>
Co-Authored-By: Murali Rangachari <muralirdev@gmail.com>
Co-Authored-By: Numan Siddique <nusiddiq@redhat.com>
Co-Authored-By: Reedip <rbanerje@redhat.com>
Co-Authored-By: Richard Theis <rtheis@us.ibm.com>
Co-Authored-By: Russell Bryant <rbryant@redhat.com>
Co-Authored-By: Ryan Moats <rmoats@us.ibm.com>
Co-Authored-By: Simon Pasquier <spasquier@mirantis.com>
Co-Authored-By: Terry Wilson <twilson@redhat.com>
Co-Authored-By: Tong Li <litong01@us.ibm.com>
Co-Authored-By: Yunxiang Tao <taoyunxiang@cmss.chinamobile.com>
Co-Authored-By: Yushiro FURUKAWA <y.furukawa_2@jp.fujitsu.com>
Co-Authored-By: chen-li <shchenli@cn.ibm.com>
Co-Authored-By: gong yong sheng <gong.yongsheng@99cloud.net>
Co-Authored-By: lidong <lidongbj@inspur.com>
Co-Authored-By: lzklibj <lzklibj@cn.ibm.com>
Co-Authored-By: melissaml <ma.lei@99cloud.net>
Co-Authored-By: pengyuesheng <pengyuesheng@gohighsec.com>
Co-Authored-By: reedip <rbanerje@redhat.com>
Co-Authored-By: venkata anil <anilvenkata@redhat.com>
Co-Authored-By: xurong00037997 <xu.rong@zte.com.cn>
Co-Authored-By: zhangdebo <zhangdebo@inspur.com>
Co-Authored-By: zhangyanxian <zhang.yanxian@zte.com.cn>
Co-Authored-By: zhangyanxian <zhangyanxianmail@163.com>

Change-Id: Ia121ec5146c1d35b3282e44fd1eb98932939ea8c
Partially-Implements: blueprint neutron-ovn-merge
2020-02-13 18:54:15 +09:00
Zuul a63f344748 Merge "Remove Neutron LBaaS" 2019-09-24 03:40:39 +00:00
Michael Johnson d1d0a04c37 Remove Neutron LBaaS
Neutron-LBaaS has now been retired and there will be no Train
release[1]. This patch removes neutron-lbaas references from
neutron.

[1] https://review.opendev.org/658494

Closes-Bug: #1833125
Change-Id: I0fe3fbaf4adf7fb104632fd94cd093e701e12289
2019-09-20 07:46:06 +00:00
YAMAMOTO Takashi 1df7e4bc46 doc: Remove stale references to external_network_bridge
This is a leftover of https://review.opendev.org/#/c/395568/ .

Closes-Bug: #1844171
Change-Id: I99e45b78a5b56601f02c9e3c09b621c4d3b67de3
2019-09-17 22:19:19 +09:00
Zuul 78aae12a88 Merge "PDF documentation build" 2019-08-30 19:42:42 +00:00
Akihiro Motoki 66274cdae3 PDF documentation build
The following changes are made for PDF document.

- Sample config/policy files are skipped for PDF doc build.
  We hit several problems around verbatim of inline samples
  in neutron, nova and others, so we decided to skip them now.
  Downloadable links also should be avoided in PDF doc
  as PDF doc is expected to work alone.
- tocdepth for latex is explicitly set to 3 for better navigation
  in the generated PDF. The default was 1 and we cannot provide
  enough information in PDF TOC.
- The module index is disabled as the neutron document does not
  generate a full module index and it shows only partial entries.
  'makeindex' and 'printindex' are set to empty in latex_elements.

The existing contents (mainly the top page) are reorganized a bit
for a better TOC of the generated PDF document:

- The top page of the documentation is simplified only with toctree
  to avoid almost duplicated entries in the TOC of the PDF documentation.
  The current TOC for PDF doc seems to use section titles as the first
  level and title of linked pages as the second level. They are almost
  same and the generated TOC would be redundant.
- The link to the API reference in the top page was moved
  to a subdirectory so that PDF TOC can include it.
- 'Search' section is shown in index.rst only when the builder is 'html'
  as this section uses a form and makes sense only for HTML doc.

Story: 2006099
Task: 35127
Depends-On: https://review.opendev.org/664555
Change-Id: I6f1614a643efa7fad3c2a6ce5692d6873ca0ebd0
2019-08-26 02:50:58 +09:00
Matt Riedemann e8653f28de doc: remove deprecated [neutron]/url from compute install guide
The nova [neutron]/url config option was deprecated in Queens [1]
and is being removed in Train [2]. The neutron install guide
sections about configuring compute to work with neutron were still
using the url option so this change removes them. There are a few
things to note here:

1. The url option functionality is replaced with the endpoint_override
   option from keystoneauth1 but we don't really want users using that
   unless there is a real need. One of the main reasons for moving the
   nova configuration to use keystoneauth1 was so that the network
   service endpoint can be looked up via KSA dynamically based on the
   configurable interfaces (public, internal, private) and service types
   authority so the endpoint URL will just be pulled from the service
   catalog. That means not having to hard-code the endpoint URL in nova
   config which makes deployment and config management simpler. As such,
   the url option removed in the install guide here is not replaced with
   the endpoint_override option.

2. Following on #1, the install guide portion about the nova/neutron config
   is updated with a link back to the nova config guide for the full set
   of options in case an operator needs to tweak the config, e.g. to set
   valid_interfaces or endpoint_override because the KSA defaults don't work
   for their deployment.

3. With the old url option, if region_name was not specified, nova would
   default to 'RegionOne'. That is not the case if not using the url option
   so we leave the region_one config in the install guide example, otherwise
   region_name would default to None.

[1] I41724a612a5f3eabd504f3eaa9d2f9d141ca3f69
[2] I6c068a84c4c0bd88f088f9328d7897bfc1f843f1

Change-Id: I30445edeb8509330571db28c7d61dd63886e9e61
Closes-Bug: #1840930
2019-08-21 16:09:09 -04:00
Gabriele Cerami 2b9655a784 Install doc: append provider network creation link
Creating the provider network is a necessary step for option 1. The step
is only described in a document in the general installation guide.
This patch links this document at the end of every option1 controller
installation document

Change-Id: I33713aec50e0646a3b42b9d202ac730d3a0578a5
Close-Bug: #1824788
2019-04-27 16:32:48 +01:00
Lajos Katona 534e850392 Add lock_path in installation guide
Oslo_concurrency needs lock_path option, make it consistent in
documentation for Suse, Redhat and Ubuntu installation guides.

Change-Id: Ib675d7bf399f2aa7eba9d343fa0f06281d33089a
Related-Bug: #1796976
Closes-Bug: #1812497
2019-01-22 09:42:51 +01:00
Akihiro Motoki bc29d4843d Revert "Remove -u root as mysql is executed with root user"
This commit was approved just to keep the consistency with
other OpenStack projects, but most proposed changes related to it
have been rejected so far [1].
The main reason is because it is clearer to specify options explicitly
and we should not assume some configuration.

I totally agree these opinions and see no reason that neutron
contineus to use different command line options for mysql.
Consistency in the installation guide will bring better user experience.

[1] https://review.openstack.org/#/q/file:%255Edoc/source/install/.*+message:mysql

This reverts commit 59d178c9de.

Related-Bug: #1785025
Change-Id: I699d03de9e26d5784e6bd5e7d4fa219de6209207
2019-01-07 15:46:52 +09:00
SapanaJadhav f4d438019e neutron.conf needs lock_path set for router to operate
This change is adding required configuration in neutron.conf
to set the lock_path parameter, which was missing in
compute-install-ubuntu.rst

Change-Id: If090bdf060dfe21d11b1a5dfd010dc8167d9e45e
Closes-Bug: #1796976
2018-10-21 22:00:50 +05:30
Zuul 5226e50c68 Merge "Update the doc url about SUSE basic network configuration" 2018-08-09 11:27:23 +00:00
Lajos Katona 59d178c9de Remove -u root as mysql is executed with root user
As openstack installation guides suggest to run mysql with root shell
user, mysql will not ask for password, so in
controller-install-*.rst "-u root -p" is useless.

Change-Id: Ib209661f6dcbbdeb158bd1acf343c084f8ed8930
Closes-Bug: #1785025
2018-08-09 07:51:40 +02:00
yanpuqing 047ac941ba Update the doc url about SUSE basic network configuration
Change-Id: I84605d1218f33e05ebedb16fd907ce267dd1c42a
2018-07-25 08:37:15 +00:00
Zuul c012f2c474 Merge "Update neutron configuration documentation URL" 2018-05-29 21:53:16 +00:00
yanpuqing f723dfadee Update neutron configuration documentation URL
Current URL of network configuration guide for Red Hat Enterprise Linux
and CentOS is incorrect

Change-Id: I9098801c6e87a58ac907784c4c1f68651c5c6ae1
Closes-Bug: 1737313
2018-05-28 20:13:42 +00:00
caoyuan 68a7ef0c59 Update auth_url in install docs
Beginning with the Queens release, the keystone install guide
recommends running all interfaces on the same port. This patch
updates the install guide to reflect that change.

Change-Id: I8bf64e2c47b55512f3ce42da3849911603cbcde0
2018-05-13 00:19:27 +08:00
Stephen Finucane 626a8976e1 trivial: Fix file permissions
None of these should be executable, from what I can tell.

Side note: never backup a git repo to an NTFS drive or you lose all your
permissions and need hacks to restore them.

Change-Id: I34de5488129c575a66b38b400c31393fb511765f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2018-05-10 10:07:39 +00:00
Hidekazu Nakamura e1761d2e29 Update install doc for ubuntu
This change updates the auth_url value to match what has changed
in the keystone install guide:

https://review.openstack.org/#/c/541857/

Change-Id: I97356b31af35ef19d02b9f0c0a57cbde16752c65
2018-05-07 11:21:34 +09:00
melissaml 769d499670 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: I19a55c7e849dd47edff4d37a87a860ecc7e9ad27
2018-04-18 19:02:00 +08:00
Boden R 87a36cacc6 remove tag and tag_ext extensions
The tag and tag_ext extensions are deprecated for removal, but are not
used widely today [1]. Rather than rehoming these extensions to
neutron-lib and carrying out their deprecation life-cycle for no
apparent reason, this patch proposes we just remove them now.

While [2] initially removed these extensions, we had to revert
them with [3].

Depends-On: I295a5b84eb7fa3439561fa009b7499f94d8df4d2

[1] http://codesearch.openstack.org/?q=from%20neutron.extensions%20import%20(tag_ext%7Ctag)
[2] I0d7bcd789b468b1dd3f7ea13e6751a46203d6778
[3] If16443616eee703b66d57b6422dd451a443fbc64

Change-Id: I97095453610fff114d999a526d67e78119546ff5
2018-03-16 13:09:42 -06:00
Hongbin Lu 4904455bf2 Revert "remove tag and tag_ext extensions"
It looks this patch breaks Zun's gate. The reason might be
that Zun depends on Kuryr-libnetwork which still use the
legacy tag extension. I propose to revert this for now and
give the kuryr team some time to migrate to the new extension.

This reverts commit 38148d1752.

Change-Id: If16443616eee703b66d57b6422dd451a443fbc64
2018-02-14 06:32:30 +00:00
Boden R 38148d1752 remove tag and tag_ext extensions
The tag and tag_ext extensions are deprecated for removal, but are not
used today [1]. Rather than rehoming these extensions to neutron-lib and
carrying out their deprecation life-cycle for no apparent reason, this
patch proposes we just remove them now.

[1] http://codesearch.openstack.org/?q=from%20neutron.extensions%20import%20(tag_ext%7Ctag)

Change-Id: I0d7bcd789b468b1dd3f7ea13e6751a46203d6778
2018-02-12 09:04:15 -07:00
Guoqiang Ding b1f05504ed Update the documentation links
The documentation links which start with "admin-guide" and
"networking-guide" are outdated. Fix them to be friendly
to new contributors.

Change-Id: I656ba3b82df6acd2555735093127ca59f7042d44
2017-12-13 10:49:46 +00:00
Boden R 7a61f8636d clarify nova prereq for controller install docs
This patch adds a note to clarify the need for nova to be installed
prior to configuring the compute service for neutron.

Change-Id: If7f16c1bd01843c244b87a48a024d17e57cb775e
Closes-Bug: #1732669
2017-11-27 08:55:14 -07:00
ericxiett 47f43070e0 Fix missing content of neutron database creation.
Change-Id: I0a45b38d77c7f468472ae48541721636fb6fb05c
Partial-Bug: #1718125
2017-09-19 19:12:38 +08:00