blob: 9229b47988cb0ee569e65dc3b2771f8341a8f652 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Mark McClainb05c8762013-07-06 23:29:39 -04003# lib/neutron
Joe Gordon23946052014-01-15 21:42:32 +00004# functions - functions specific to neutron
Mark McClainb05c8762013-07-06 23:29:39 -04005
6# Dependencies:
7# ``functions`` file
8# ``DEST`` must be defined
Stephan Renatuse578eff2013-11-19 13:31:04 +01009# ``STACK_USER`` must be defined
Mark McClainb05c8762013-07-06 23:29:39 -040010
11# ``stack.sh`` calls the entry points in this order:
12#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010013# - install_neutron_agent_packages
YAMAMOTO Takashi1a669dc2015-02-05 11:54:12 +090014# - install_neutronclient
15# - install_neutron
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010016# - install_neutron_third_party
17# - configure_neutron
18# - init_neutron
19# - configure_neutron_third_party
20# - init_neutron_third_party
21# - start_neutron_third_party
22# - create_nova_conf_neutron
YAMAMOTO Takashia1875b12017-02-23 05:44:22 +090023# - configure_neutron_after_post_config
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010024# - start_neutron_service_and_check
YAMAMOTO Takashi1a669dc2015-02-05 11:54:12 +090025# - check_neutron_third_party_integration
yunhong jiang0d6e9922014-10-10 06:12:47 -070026# - start_neutron_agents
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010027# - create_neutron_initial_network
Mark McClainb05c8762013-07-06 23:29:39 -040028#
29# ``unstack.sh`` calls the entry points in this order:
30#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010031# - stop_neutron
yunhong jiang0d6e9922014-10-10 06:12:47 -070032# - stop_neutron_third_party
33# - cleanup_neutron
Mark McClainb05c8762013-07-06 23:29:39 -040034
35# Functions in lib/neutron are classified into the following categories:
36#
37# - entry points (called from stack.sh or unstack.sh)
38# - internal functions
39# - neutron exercises
40# - 3rd party programs
41
42
43# Neutron Networking
44# ------------------
45
46# Make sure that neutron is enabled in ``ENABLED_SERVICES``. If you want
47# to run Neutron on this host, make sure that q-svc is also in
48# ``ENABLED_SERVICES``.
49#
Mark McClainb05c8762013-07-06 23:29:39 -040050# See "Neutron Network Configuration" below for additional variables
51# that must be set in localrc for connectivity across hosts with
52# Neutron.
Mark McClainb05c8762013-07-06 23:29:39 -040053
John Davidge21529a52014-06-30 09:55:11 -040054# Settings
55# --------
56
Mark McClainb05c8762013-07-06 23:29:39 -040057
58# Neutron Network Configuration
59# -----------------------------
60
Sean Daguef3b2f4c2017-04-13 10:11:48 -040061if is_service_enabled tls-proxy; then
Rob Crittenden18d47782014-03-19 17:47:42 -040062 Q_PROTOCOL="https"
63fi
64
65
Mark McClainb05c8762013-07-06 23:29:39 -040066# Set up default directories
Sean Daguee08ab102014-11-13 17:09:28 -050067GITDIR["python-neutronclient"]=$DEST/python-neutronclient
Sean Dague5cb19062014-11-01 01:37:45 +010068
Doug Wiegley93e682c2015-03-03 10:31:30 -070069
Mark McClainb05c8762013-07-06 23:29:39 -040070NEUTRON_DIR=$DEST/neutron
Kyle Mestery20b839f2014-12-08 06:17:27 +000071NEUTRON_FWAAS_DIR=$DEST/neutron-fwaas
Mark McClainb05c8762013-07-06 23:29:39 -040072
73# Support entry points installation of console scripts
74if [[ -d $NEUTRON_DIR/bin/neutron-server ]]; then
75 NEUTRON_BIN_DIR=$NEUTRON_DIR/bin
Sean Dague3bdb9222013-10-22 08:36:16 -040076else
77 NEUTRON_BIN_DIR=$(get_python_exec_prefix)
Mark McClainb05c8762013-07-06 23:29:39 -040078fi
79
80NEUTRON_CONF_DIR=/etc/neutron
81NEUTRON_CONF=$NEUTRON_CONF_DIR/neutron.conf
82export NEUTRON_TEST_CONFIG_FILE=${NEUTRON_TEST_CONFIG_FILE:-"$NEUTRON_CONF_DIR/debug.ini"}
83
Kevin Benton66b361b2017-06-13 00:31:01 -070084# NEUTRON_DEPLOY_MOD_WSGI defines how neutron is deployed, allowed values:
85# - False (default) : Run neutron under Eventlet
86# - True : Run neutron under uwsgi
87# TODO(annp): Switching to uwsgi in next cycle if things turn out to be stable
88# enough
Jens Harbott3492fee2018-11-30 13:57:17 +000089NEUTRON_DEPLOY_MOD_WSGI=$(trueorfalse False NEUTRON_DEPLOY_MOD_WSGI)
Kevin Benton66b361b2017-06-13 00:31:01 -070090
91NEUTRON_UWSGI_CONF=$NEUTRON_CONF_DIR/neutron-api-uwsgi.ini
92
Slawek Kaplonski24b65ad2021-06-22 15:31:46 +020093# If NEUTRON_ENFORCE_SCOPE == True, it will set "enforce_scope"
94# and "enforce_new_defaults" to True in the Neutron's config to enforce usage
95# of the new RBAC policies and scopes.
96NEUTRON_ENFORCE_SCOPE=$(trueorfalse False NEUTRON_ENFORCE_SCOPE)
97
Adam Gandelman7614d212014-08-11 14:27:50 -070098# Agent binaries. Note, binary paths for other agents are set in per-service
99# scripts in lib/neutron_plugins/services/
100AGENT_DHCP_BINARY="$NEUTRON_BIN_DIR/neutron-dhcp-agent"
101AGENT_L3_BINARY=${AGENT_L3_BINARY:-"$NEUTRON_BIN_DIR/neutron-l3-agent"}
102AGENT_META_BINARY="$NEUTRON_BIN_DIR/neutron-metadata-agent"
103
104# Agent config files. Note, plugin-specific Q_PLUGIN_CONF_FILE is set and
105# loaded from per-plugin scripts in lib/neutron_plugins/
106Q_DHCP_CONF_FILE=$NEUTRON_CONF_DIR/dhcp_agent.ini
107Q_L3_CONF_FILE=$NEUTRON_CONF_DIR/l3_agent.ini
Adam Gandelman7614d212014-08-11 14:27:50 -0700108Q_META_CONF_FILE=$NEUTRON_CONF_DIR/metadata_agent.ini
109
Henry Gessau0fc1cc22014-07-06 22:54:34 -0400110# Default name for Neutron database
111Q_DB_NAME=${Q_DB_NAME:-neutron}
Mark McClainb05c8762013-07-06 23:29:39 -0400112# Default Neutron Plugin
Kyle Mestery6d235002013-09-18 20:27:08 +0000113Q_PLUGIN=${Q_PLUGIN:-ml2}
Mark McClainb05c8762013-07-06 23:29:39 -0400114# Default Neutron Port
115Q_PORT=${Q_PORT:-9696}
Rob Crittenden18d47782014-03-19 17:47:42 -0400116# Default Neutron Internal Port when using TLS proxy
117Q_PORT_INT=${Q_PORT_INT:-19696}
Mark McClainb05c8762013-07-06 23:29:39 -0400118# Default Neutron Host
119Q_HOST=${Q_HOST:-$SERVICE_HOST}
Rob Crittenden18d47782014-03-19 17:47:42 -0400120# Default protocol
121Q_PROTOCOL=${Q_PROTOCOL:-$SERVICE_PROTOCOL}
Brian Haley180f5eb2015-06-16 13:14:31 -0400122# Default listen address
Jens Harbottdc7b4292017-09-19 10:52:32 +0000123Q_LISTEN_ADDRESS=${Q_LISTEN_ADDRESS:-$(ipv6_unquote $SERVICE_LISTEN_ADDRESS)}
Mark McClainb05c8762013-07-06 23:29:39 -0400124# Default admin username
125Q_ADMIN_USERNAME=${Q_ADMIN_USERNAME:-neutron}
126# Default auth strategy
127Q_AUTH_STRATEGY=${Q_AUTH_STRATEGY:-keystone}
Mark McClainb05c8762013-07-06 23:29:39 -0400128# RHEL's support for namespaces requires using veths with ovs
129Q_OVS_USE_VETH=${Q_OVS_USE_VETH:-False}
130Q_USE_ROOTWRAP=${Q_USE_ROOTWRAP:-True}
Yuriy Taraday26623952014-07-16 17:41:53 +0400131Q_USE_ROOTWRAP_DAEMON=$(trueorfalse True Q_USE_ROOTWRAP_DAEMON)
Mark McClainb05c8762013-07-06 23:29:39 -0400132# Meta data IP
Jens Harbottdc7b4292017-09-19 10:52:32 +0000133Q_META_DATA_IP=${Q_META_DATA_IP:-$(ipv6_unquote $SERVICE_HOST)}
Mark McClainb05c8762013-07-06 23:29:39 -0400134# Allow Overlapping IP among subnets
135Q_ALLOW_OVERLAPPING_IP=${Q_ALLOW_OVERLAPPING_IP:-True}
Terry Wilsonf06c4432014-05-20 10:54:51 -0500136Q_NOTIFY_NOVA_PORT_STATUS_CHANGES=${Q_NOTIFY_NOVA_PORT_STATUS_CHANGES:-True}
137Q_NOTIFY_NOVA_PORT_DATA_CHANGES=${Q_NOTIFY_NOVA_PORT_DATA_CHANGES:-True}
Aaron Rosencea32b12014-03-04 16:20:14 -0800138VIF_PLUGGING_IS_FATAL=${VIF_PLUGGING_IS_FATAL:-True}
139VIF_PLUGGING_TIMEOUT=${VIF_PLUGGING_TIMEOUT:-300}
Aaron Rosen4540d002013-10-24 13:59:33 -0700140
yatinkarel6dd896f2022-04-26 16:37:07 +0530141# Allow to skip stopping of OVN services
142SKIP_STOP_OVN=${SKIP_STOP_OVN:-False}
143
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900144# The directory which contains files for Q_PLUGIN_EXTRA_CONF_FILES.
145# /etc/neutron is assumed by many of devstack plugins. Do not change.
146_Q_PLUGIN_EXTRA_CONF_PATH=/etc/neutron
147
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200148# The name of the service in the endpoint URL
149NEUTRON_ENDPOINT_SERVICE_NAME=${NEUTRON_ENDPOINT_SERVICE_NAME-"networking"}
150if [[ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" && -z "$NEUTRON_ENDPOINT_SERVICE_NAME" ]]; then
151 NEUTRON_ENDPOINT_SERVICE_NAME="networking"
152fi
153
Mark McClainb05c8762013-07-06 23:29:39 -0400154# List of config file names in addition to the main plugin config file
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900155# To add additional plugin config files, use ``neutron_server_config_add``
156# utility function. For example:
157#
158# ``neutron_server_config_add file1``
159#
160# These config files are relative to ``/etc/neutron``. The above
161# example would specify ``--config-file /etc/neutron/file1`` for
162# neutron server.
Sean Dagueafef8bf2017-03-06 14:07:23 -0500163declare -a -g Q_PLUGIN_EXTRA_CONF_FILES
Mark McClainb05c8762013-07-06 23:29:39 -0400164
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900165# same as Q_PLUGIN_EXTRA_CONF_FILES, but with absolute path.
Sean Dagueafef8bf2017-03-06 14:07:23 -0500166declare -a -g _Q_PLUGIN_EXTRA_CONF_FILES_ABS
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900167
Mark McClainb05c8762013-07-06 23:29:39 -0400168
Dean Troyere2907b42014-02-26 17:35:37 -0600169Q_RR_CONF_FILE=$NEUTRON_CONF_DIR/rootwrap.conf
170if [[ "$Q_USE_ROOTWRAP" == "False" ]]; then
171 Q_RR_COMMAND="sudo"
172else
173 NEUTRON_ROOTWRAP=$(get_rootwrap_location neutron)
174 Q_RR_COMMAND="sudo $NEUTRON_ROOTWRAP $Q_RR_CONF_FILE"
Yuriy Taraday26623952014-07-16 17:41:53 +0400175 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
176 Q_RR_DAEMON_COMMAND="sudo $NEUTRON_ROOTWRAP-daemon $Q_RR_CONF_FILE"
177 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400178fi
179
Brian Haleyeea76212014-06-27 11:45:50 -0400180
181# Distributed Virtual Router (DVR) configuration
182# Can be:
Dean Troyer3324f192014-09-18 09:26:39 -0500183# - ``legacy`` - No DVR functionality
184# - ``dvr_snat`` - Controller or single node DVR
185# - ``dvr`` - Compute node in multi-node DVR
186#
Brian Haleyeea76212014-06-27 11:45:50 -0400187Q_DVR_MODE=${Q_DVR_MODE:-legacy}
188if [[ "$Q_DVR_MODE" != "legacy" ]]; then
Brian Haleye43dfdd2017-09-12 16:13:26 -0600189 Q_ML2_PLUGIN_MECHANISM_DRIVERS=openvswitch,l2population
Brian Haleyeea76212014-06-27 11:45:50 -0400190fi
191
Dean Troyere2907b42014-02-26 17:35:37 -0600192# Provider Network Configurations
193# --------------------------------
194
YAMAMOTO Takashi15130cd2014-10-28 11:49:58 +0900195# The following variables control the Neutron ML2 plugins' allocation
196# of tenant networks and availability of provider networks. If these
197# are not configured in ``localrc``, tenant networks will be local to
198# the host (with no remote connectivity), and no physical resources
199# will be available for the allocation of provider networks.
Dean Troyere2907b42014-02-26 17:35:37 -0600200
Attila Fazekas8feaf6c2014-07-27 20:47:04 +0200201# To disable tunnels (GRE or VXLAN) for tenant networks,
202# set to False in ``local.conf``.
203# GRE tunnels are only supported by the openvswitch.
204ENABLE_TENANT_TUNNELS=${ENABLE_TENANT_TUNNELS:-True}
Dean Troyere2907b42014-02-26 17:35:37 -0600205
Richard Theis8906b482016-06-08 10:28:37 -0500206# If using GRE, VXLAN or GENEVE tunnels for tenant networks,
207# specify the range of IDs from which tenant networks are
208# allocated. Can be overridden in ``localrc`` if necessary.
Anant Patil3827dc02014-07-03 21:38:16 +0530209TENANT_TUNNEL_RANGES=${TENANT_TUNNEL_RANGES:-1:1000}
Dean Troyere2907b42014-02-26 17:35:37 -0600210
211# To use VLANs for tenant networks, set to True in localrc. VLANs
YAMAMOTO Takashi15130cd2014-10-28 11:49:58 +0900212# are supported by the ML2 plugins, requiring additional configuration
213# described below.
Dean Troyere2907b42014-02-26 17:35:37 -0600214ENABLE_TENANT_VLANS=${ENABLE_TENANT_VLANS:-False}
215
216# If using VLANs for tenant networks, set in ``localrc`` to specify
217# the range of VLAN VIDs from which tenant networks are
218# allocated. An external network switch must be configured to
219# trunk these VLANs between hosts for multi-host connectivity.
220#
221# Example: ``TENANT_VLAN_RANGE=1000:1999``
222TENANT_VLAN_RANGE=${TENANT_VLAN_RANGE:-}
223
224# If using VLANs for tenant networks, or if using flat or VLAN
225# provider networks, set in ``localrc`` to the name of the physical
226# network, and also configure ``OVS_PHYSICAL_BRIDGE`` for the
227# openvswitch agent or ``LB_PHYSICAL_INTERFACE`` for the linuxbridge
228# agent, as described below.
229#
230# Example: ``PHYSICAL_NETWORK=default``
Kevin Benton1554ade2016-07-22 09:40:19 -0700231PHYSICAL_NETWORK=${PHYSICAL_NETWORK:-public}
Dean Troyere2907b42014-02-26 17:35:37 -0600232
YAMAMOTO Takashi15130cd2014-10-28 11:49:58 +0900233# With the openvswitch agent, if using VLANs for tenant networks,
Dean Troyere2907b42014-02-26 17:35:37 -0600234# or if using flat or VLAN provider networks, set in ``localrc`` to
235# the name of the OVS bridge to use for the physical network. The
236# bridge will be created if it does not already exist, but a
237# physical interface must be manually added to the bridge as a
238# port for external connectivity.
239#
240# Example: ``OVS_PHYSICAL_BRIDGE=br-eth1``
Kevin Benton1554ade2016-07-22 09:40:19 -0700241OVS_PHYSICAL_BRIDGE=${OVS_PHYSICAL_BRIDGE:-br-ex}
Dean Troyere2907b42014-02-26 17:35:37 -0600242
YAMAMOTO Takashi15130cd2014-10-28 11:49:58 +0900243# With the linuxbridge agent, if using VLANs for tenant networks,
Dean Troyere2907b42014-02-26 17:35:37 -0600244# or if using flat or VLAN provider networks, set in ``localrc`` to
245# the name of the network interface to use for the physical
246# network.
247#
248# Example: ``LB_PHYSICAL_INTERFACE=eth1``
Jens Harbott47f76ac2020-10-29 10:42:38 +0000249if [[ $Q_AGENT == "linuxbridge" && -z ${LB_PHYSICAL_INTERFACE} ]]; then
Nate Johnstonefc04ee2020-11-03 10:04:26 -0500250 default_route_dev=$( (ip route; ip -6 route) | grep ^default | head -n 1 | awk '{print $5}')
Jens Harbott47f76ac2020-10-29 10:42:38 +0000251 die_if_not_set $LINENO default_route_dev "Failure retrieving default route device"
252 LB_PHYSICAL_INTERFACE=$default_route_dev
253fi
Dean Troyere2907b42014-02-26 17:35:37 -0600254
255# With the openvswitch plugin, set to True in ``localrc`` to enable
256# provider GRE tunnels when ``ENABLE_TENANT_TUNNELS`` is False.
257#
258# Example: ``OVS_ENABLE_TUNNELING=True``
259OVS_ENABLE_TUNNELING=${OVS_ENABLE_TUNNELING:-$ENABLE_TENANT_TUNNELS}
260
Tan Lin27a196e2014-10-31 15:44:34 +0800261# Use DHCP agent for providing metadata service in the case of
262# without L3 agent (No Route Agent), set to True in localrc.
263ENABLE_ISOLATED_METADATA=${ENABLE_ISOLATED_METADATA:-False}
264
265# Add a static route as dhcp option, so the request to 169.254.169.254
266# will be able to reach through a route(DHCP agent)
267# This option require ENABLE_ISOLATED_METADATA = True
268ENABLE_METADATA_NETWORK=${ENABLE_METADATA_NETWORK:-False}
Mark McClainb05c8762013-07-06 23:29:39 -0400269# Neutron plugin specific functions
270# ---------------------------------
271
272# Please refer to ``lib/neutron_plugins/README.md`` for details.
Hirofumi Ichihara36daecd2015-07-23 17:50:40 +0900273if [ -f $TOP_DIR/lib/neutron_plugins/$Q_PLUGIN ]; then
274 source $TOP_DIR/lib/neutron_plugins/$Q_PLUGIN
275fi
Mark McClainb05c8762013-07-06 23:29:39 -0400276
Emilien Macchi40546f72013-09-24 15:10:25 +0200277# Agent metering service plugin functions
278# -------------------------------------------
279
280# Hardcoding for 1 service plugin for now
281source $TOP_DIR/lib/neutron_plugins/services/metering
282
Sean M. Collins2a242512016-05-03 09:03:09 -0400283# L3 Service functions
284source $TOP_DIR/lib/neutron_plugins/services/l3
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200285
286# Additional Neutron service plugins
Slawek Kaplonski7f6d9282021-10-27 16:40:30 +0200287source $TOP_DIR/lib/neutron_plugins/services/placement
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200288source $TOP_DIR/lib/neutron_plugins/services/trunk
Slawek Kaplonskif9a896c2021-10-27 16:50:11 +0200289source $TOP_DIR/lib/neutron_plugins/services/qos
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200290
Mark McClainb05c8762013-07-06 23:29:39 -0400291# Use security group or not
292if has_neutron_plugin_security_group; then
293 Q_USE_SECGROUP=${Q_USE_SECGROUP:-True}
294else
295 Q_USE_SECGROUP=False
296fi
297
Dean Troyere2907b42014-02-26 17:35:37 -0600298# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +1100299_XTRACE_NEUTRON=$(set +o | grep xtrace)
Dean Troyere2907b42014-02-26 17:35:37 -0600300set +o xtrace
301
302
Mark McClainb05c8762013-07-06 23:29:39 -0400303# Functions
304# ---------
305
Adam Gandelman7614d212014-08-11 14:27:50 -0700306function _determine_config_server {
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900307 if [[ "$Q_PLUGIN_EXTRA_CONF_PATH" != '' ]]; then
308 if [[ "$Q_PLUGIN_EXTRA_CONF_PATH" = "$_Q_PLUGIN_EXTRA_CONF_PATH" ]]; then
309 deprecated "Q_PLUGIN_EXTRA_CONF_PATH is deprecated"
310 else
311 die $LINENO "Q_PLUGIN_EXTRA_CONF_PATH is deprecated"
312 fi
313 fi
314 if [[ ${#Q_PLUGIN_EXTRA_CONF_FILES[@]} > 0 ]]; then
315 deprecated "Q_PLUGIN_EXTRA_CONF_FILES is deprecated. Use neutron_server_config_add instead."
316 fi
317 for cfg_file in ${Q_PLUGIN_EXTRA_CONF_FILES[@]}; do
318 _Q_PLUGIN_EXTRA_CONF_FILES_ABS+=($_Q_PLUGIN_EXTRA_CONF_PATH/$cfg_file)
319 done
320
Adam Gandelman7614d212014-08-11 14:27:50 -0700321 local cfg_file
322 local opts="--config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE"
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900323 for cfg_file in ${_Q_PLUGIN_EXTRA_CONF_FILES_ABS[@]}; do
Tom Patzig73467042016-04-19 17:02:34 +0200324 opts+=" --config-file $cfg_file"
Adam Gandelman7614d212014-08-11 14:27:50 -0700325 done
326 echo "$opts"
327}
328
Adam Gandelman7614d212014-08-11 14:27:50 -0700329function _determine_config_l3 {
Angus Leesa1c70f22016-05-31 14:43:14 +1000330 local opts="--config-file $NEUTRON_CONF --config-file $Q_L3_CONF_FILE"
Adam Gandelman7614d212014-08-11 14:27:50 -0700331 echo "$opts"
332}
333
334# For services and agents that require it, dynamically construct a list of
335# --config-file arguments that are passed to the binary.
336function determine_config_files {
337 local opts=""
338 case "$1" in
339 "neutron-server") opts="$(_determine_config_server)" ;;
Adam Gandelman7614d212014-08-11 14:27:50 -0700340 "neutron-l3-agent") opts="$(_determine_config_l3)" ;;
341 esac
342 if [ -z "$opts" ] ; then
343 die $LINENO "Could not determine config files for $1."
344 fi
345 echo "$opts"
346}
347
Sean M. Collins2a242512016-05-03 09:03:09 -0400348# configure_mutnauq()
Mark McClainb05c8762013-07-06 23:29:39 -0400349# Set common config for all neutron server and agents.
Sean M. Collins2a242512016-05-03 09:03:09 -0400350function configure_mutnauq {
Mark McClainb05c8762013-07-06 23:29:39 -0400351 _configure_neutron_common
Brant Knudson2dd110c2015-03-14 12:39:14 -0500352 iniset_rpc_backend neutron $NEUTRON_CONF
Mark McClainb05c8762013-07-06 23:29:39 -0400353
Emilien Macchi40546f72013-09-24 15:10:25 +0200354 if is_service_enabled q-metering; then
355 _configure_neutron_metering
356 fi
Stephen Ma9b38eb22014-04-02 02:13:09 +0000357 if is_service_enabled q-agt q-svc; then
Mark McClainb05c8762013-07-06 23:29:39 -0400358 _configure_neutron_service
359 fi
360 if is_service_enabled q-agt; then
361 _configure_neutron_plugin_agent
362 fi
363 if is_service_enabled q-dhcp; then
364 _configure_neutron_dhcp_agent
365 fi
366 if is_service_enabled q-l3; then
367 _configure_neutron_l3_agent
368 fi
369 if is_service_enabled q-meta; then
370 _configure_neutron_metadata_agent
371 fi
372
Brian Haleyeea76212014-06-27 11:45:50 -0400373 if [[ "$Q_DVR_MODE" != "legacy" ]]; then
374 _configure_dvr
375 fi
Dina Belova58adaa62014-07-11 18:18:12 +0400376 if is_service_enabled ceilometer; then
377 _configure_neutron_ceilometer_notifications
378 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400379
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100380 if [[ $Q_AGENT == "ovn" ]]; then
381 configure_ovn
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100382 configure_ovn_plugin
383 fi
384
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200385 # Configure Neutron's advanced services
Slawek Kaplonski7f6d9282021-10-27 16:40:30 +0200386 if is_service_enabled q-placement neutron-placement; then
387 configure_placement_extension
388 fi
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200389 if is_service_enabled q-trunk neutron-trunk; then
390 configure_trunk_extension
391 fi
Slawek Kaplonskif9a896c2021-10-27 16:50:11 +0200392 if is_service_enabled q-qos neutron-qos; then
393 configure_qos
394 if is_service_enabled q-l3 neutron-l3; then
395 configure_l3_agent_extension_fip_qos
396 configure_l3_agent_extension_gateway_ip_qos
397 fi
398 fi
Slawek Kaplonskif758b602021-10-06 12:02:22 +0200399
armando-migliaccioe155b892015-06-12 08:55:02 -0700400 iniset $NEUTRON_CONF DEFAULT api_workers "$API_WORKERS"
Armando Migliaccio06f2ea22017-02-02 16:47:00 -0800401 # devstack is not a tool for running uber scale OpenStack
402 # clouds, therefore running without a dedicated RPC worker
403 # for state reports is more than adequate.
404 iniset $NEUTRON_CONF DEFAULT rpc_state_report_workers 0
Mark McClainb05c8762013-07-06 23:29:39 -0400405}
406
Ian Wienandaee18c72014-02-21 15:35:08 +1100407function create_nova_conf_neutron {
Lucas Alvares Gomese6385932018-06-28 11:00:28 +0100408 local conf=${1:-$NOVA_CONF}
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400409 iniset $conf neutron auth_type "password"
Jens Harbott32c00892019-04-10 10:33:39 +0000410 iniset $conf neutron auth_url "$KEYSTONE_SERVICE_URI"
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400411 iniset $conf neutron username "$Q_ADMIN_USERNAME"
412 iniset $conf neutron password "$SERVICE_PASSWORD"
413 iniset $conf neutron user_domain_name "$SERVICE_DOMAIN_NAME"
414 iniset $conf neutron project_name "$SERVICE_PROJECT_NAME"
415 iniset $conf neutron project_domain_name "$SERVICE_DOMAIN_NAME"
416 iniset $conf neutron auth_strategy "$Q_AUTH_STRATEGY"
417 iniset $conf neutron region_name "$REGION_NAME"
Mark McClainb05c8762013-07-06 23:29:39 -0400418
Matt Riedemann925c2562015-08-25 13:40:25 -0700419 # optionally set options in nova_conf
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400420 neutron_plugin_create_nova_conf $conf
Mark McClainb05c8762013-07-06 23:29:39 -0400421
Mark McClainb05c8762013-07-06 23:29:39 -0400422 if is_service_enabled q-meta; then
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400423 iniset $conf neutron service_metadata_proxy "True"
Mark McClainb05c8762013-07-06 23:29:39 -0400424 fi
Aaron Rosencea32b12014-03-04 16:20:14 -0800425
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400426 iniset $conf DEFAULT vif_plugging_is_fatal "$VIF_PLUGGING_IS_FATAL"
427 iniset $conf DEFAULT vif_plugging_timeout "$VIF_PLUGGING_TIMEOUT"
Mark McClainb05c8762013-07-06 23:29:39 -0400428}
429
Sean M. Collins2a242512016-05-03 09:03:09 -0400430# create_mutnauq_accounts() - Set up common required neutron accounts
Mark McClainb05c8762013-07-06 23:29:39 -0400431
432# Tenant User Roles
433# ------------------------------------------------------------------
434# service neutron admin # if enabled
435
436# Migrated from keystone_data.sh
Sean M. Collins2a242512016-05-03 09:03:09 -0400437function create_mutnauq_accounts {
Kevin Benton66b361b2017-06-13 00:31:01 -0700438 local neutron_url
439 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200440 neutron_url=$Q_PROTOCOL://$SERVICE_HOST/
Kevin Benton66b361b2017-06-13 00:31:01 -0700441 else
442 neutron_url=$Q_PROTOCOL://$SERVICE_HOST:$Q_PORT/
443 fi
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200444 if [ ! -z "$NEUTRON_ENDPOINT_SERVICE_NAME" ]; then
445 neutron_url=$neutron_url$NEUTRON_ENDPOINT_SERVICE_NAME
446 fi
Kevin Benton66b361b2017-06-13 00:31:01 -0700447
Mark McClainb05c8762013-07-06 23:29:39 -0400448 if [[ "$ENABLED_SERVICES" =~ "q-svc" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100449
Jamie Lennox85ff5322015-01-28 14:28:01 +1000450 create_service_user "neutron"
Bartosz Górski0abde392014-02-28 14:15:19 +0100451
Sean Dague985e9582016-02-10 07:25:24 -0500452 get_or_create_service "neutron" "network" "Neutron Service"
Matt Riedemannae4578b2016-04-23 01:45:40 +0000453 get_or_create_endpoint \
Sean Dague985e9582016-02-10 07:25:24 -0500454 "network" \
Kevin Benton66b361b2017-06-13 00:31:01 -0700455 "$REGION_NAME" "$neutron_url"
Mark McClainb05c8762013-07-06 23:29:39 -0400456 fi
457}
458
Sean M. Collins2a242512016-05-03 09:03:09 -0400459# init_mutnauq() - Initialize databases, etc.
460function init_mutnauq {
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +0200461 recreate_database $Q_DB_NAME
Clark Boylan633dbc32017-06-14 12:09:21 -0700462 time_start "dbsync"
Salvatore Orlandodd649882013-08-05 08:56:17 -0700463 # Run Neutron db migrations
464 $NEUTRON_BIN_DIR/neutron-db-manage --config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE upgrade head
Clark Boylan633dbc32017-06-14 12:09:21 -0700465 time_stop "dbsync"
Mark McClainb05c8762013-07-06 23:29:39 -0400466}
467
Sean M. Collins2a242512016-05-03 09:03:09 -0400468# install_mutnauq() - Collect source and prepare
469function install_mutnauq {
Doug Wiegley86561c32016-02-10 18:37:21 -0700470 # Install neutron-lib from git so we make sure we're testing
471 # the latest code.
472 if use_library_from_git "neutron-lib"; then
473 git_clone_by_name "neutron-lib"
474 setup_dev_lib "neutron-lib"
475 fi
476
Mark McClainb05c8762013-07-06 23:29:39 -0400477 git_clone $NEUTRON_REPO $NEUTRON_DIR $NEUTRON_BRANCH
478 setup_develop $NEUTRON_DIR
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100479
480 if [[ $Q_AGENT == "ovn" ]]; then
481 install_ovn
482 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400483}
484
Mark McClainb05c8762013-07-06 23:29:39 -0400485# install_neutron_agent_packages() - Collect source and prepare
YAMAMOTO Takashic74315e2016-07-21 17:49:43 +0900486function install_neutron_agent_packages_mutnauq {
Robert Li72b3e442014-07-17 15:04:52 -0400487 # radvd doesn't come with the OS. Install it if the l3 service is enabled.
488 if is_service_enabled q-l3; then
489 install_package radvd
490 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400491 # install packages that are specific to plugin agent(s)
492 if is_service_enabled q-agt q-dhcp q-l3; then
493 neutron_plugin_install_agent_packages
494 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400495}
496
YAMAMOTO Takashia1875b12017-02-23 05:44:22 +0900497# Finish neutron configuration
498function configure_neutron_after_post_config {
499 if [[ $Q_SERVICE_PLUGIN_CLASSES != '' ]]; then
500 iniset $NEUTRON_CONF DEFAULT service_plugins $Q_SERVICE_PLUGIN_CLASSES
501 fi
Slawek Kaplonski24b65ad2021-06-22 15:31:46 +0200502 configure_rbac_policies
503}
504
505# configure_rbac_policies() - Configure Neutron to enforce new RBAC
506# policies and scopes if NEUTRON_ENFORCE_SCOPE == True
507function configure_rbac_policies {
Grzegorz Grasza86155632021-10-18 16:52:06 +0200508 if [[ "$NEUTRON_ENFORCE_SCOPE" == "True" || "$ENFORCE_SCOPE" == True ]]; then
Slawek Kaplonski24b65ad2021-06-22 15:31:46 +0200509 iniset $NEUTRON_CONF oslo_policy enforce_new_defaults True
510 iniset $NEUTRON_CONF oslo_policy enforce_scope True
511 else
512 iniset $NEUTRON_CONF oslo_policy enforce_new_defaults False
513 iniset $NEUTRON_CONF oslo_policy enforce_scope False
514 fi
YAMAMOTO Takashia1875b12017-02-23 05:44:22 +0900515}
516
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100517# Start running OVN processes
518function start_ovn_services {
519 if [[ $Q_AGENT == "ovn" ]]; then
520 init_ovn
521 start_ovn
522 if [[ "$OVN_L3_CREATE_PUBLIC_NETWORK" == "True" ]]; then
523 if [[ "$NEUTRON_CREATE_INITIAL_NETWORKS" != "True" ]]; then
524 echo "OVN_L3_CREATE_PUBLIC_NETWORK=True is being ignored "
525 echo "because NEUTRON_CREATE_INITIAL_NETWORKS is set to False"
526 else
527 create_public_bridge
528 fi
529 fi
530 fi
531}
532
Sean Dague0eebeb42017-08-30 14:16:58 -0400533# Start running processes
Ian Wienandaee18c72014-02-21 15:35:08 +1100534function start_neutron_service_and_check {
Rob Crittenden18d47782014-03-19 17:47:42 -0400535 local service_port=$Q_PORT
536 local service_protocol=$Q_PROTOCOL
Ian Wienand7ae97292016-02-16 14:50:53 +1100537 local cfg_file_options
Kevin Benton66b361b2017-06-13 00:31:01 -0700538 local neutron_url
Ian Wienand7ae97292016-02-16 14:50:53 +1100539
540 cfg_file_options="$(determine_config_files neutron-server)"
541
Rob Crittenden18d47782014-03-19 17:47:42 -0400542 if is_service_enabled tls-proxy; then
543 service_port=$Q_PORT_INT
544 service_protocol="http"
545 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400546 # Start the Neutron service
Kevin Benton66b361b2017-06-13 00:31:01 -0700547 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
548 enable_service neutron-api
Ian Wienand312517d2018-06-22 22:23:29 +1000549 run_process neutron-api "$(which uwsgi) --procname-prefix neutron-api --ini $NEUTRON_UWSGI_CONF"
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200550 neutron_url=$Q_PROTOCOL://$Q_HOST/
Kevin Benton66b361b2017-06-13 00:31:01 -0700551 enable_service neutron-rpc-server
552 run_process neutron-rpc-server "$NEUTRON_BIN_DIR/neutron-rpc-server $cfg_file_options"
553 else
554 run_process q-svc "$NEUTRON_BIN_DIR/neutron-server $cfg_file_options"
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200555 neutron_url=$service_protocol://$Q_HOST:$service_port/
Kevin Benton66b361b2017-06-13 00:31:01 -0700556 # Start proxy if enabled
557 if is_service_enabled tls-proxy; then
558 start_tls_proxy neutron '*' $Q_PORT $Q_HOST $Q_PORT_INT
559 fi
560 fi
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200561 if [ ! -z "$NEUTRON_ENDPOINT_SERVICE_NAME" ]; then
562 neutron_url=$neutron_url$NEUTRON_ENDPOINT_SERVICE_NAME
563 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400564 echo "Waiting for Neutron to start..."
Sean Dague442e4e92015-06-24 13:24:02 -0400565
Kevin Benton66b361b2017-06-13 00:31:01 -0700566 local testcmd="wget ${ssl_ca} --no-proxy -q -O- $neutron_url"
Sean Dague442e4e92015-06-24 13:24:02 -0400567 test_with_retry "$testcmd" "Neutron did not start" $SERVICE_TIMEOUT
Mark McClainb05c8762013-07-06 23:29:39 -0400568}
569
Russell Bryant09b94602015-06-08 15:25:43 -0400570# Control of the l2 agent is separated out to make it easier to test partial
571# upgrades (everything upgraded except the L2 agent)
Sean M. Collins2a242512016-05-03 09:03:09 -0400572function start_mutnauq_l2_agent {
Davanum Srinivas59756e92015-09-23 17:42:54 -0400573 run_process q-agt "$AGENT_BINARY --config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE"
Nachi Ueno584750f2013-07-15 18:22:21 -0700574
Kahou Leid663e292015-10-24 12:18:57 -0700575 if is_provider_network && [[ $Q_AGENT == "openvswitch" ]]; then
Zhongyue Luo56b7efb2014-12-16 11:36:49 +0800576 sudo ovs-vsctl --no-wait -- --may-exist add-port $OVS_PHYSICAL_BRIDGE $PUBLIC_INTERFACE
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400577 sudo ip link set $OVS_PHYSICAL_BRIDGE up
578 sudo ip link set br-int up
579 sudo ip link set $PUBLIC_INTERFACE up
yunhong jiangae9ee6b2014-10-08 07:01:02 -0700580 if is_ironic_hardware; then
581 for IP in $(ip addr show dev $PUBLIC_INTERFACE | grep ' inet ' | awk '{print $2}'); do
582 sudo ip addr del $IP dev $PUBLIC_INTERFACE
583 sudo ip addr add $IP dev $OVS_PHYSICAL_BRIDGE
584 done
gong yong sheng348c6ac2015-06-23 14:03:47 +0800585 sudo ip route replace $FIXED_RANGE via $NETWORK_GATEWAY dev $OVS_PHYSICAL_BRIDGE
yunhong jiangae9ee6b2014-10-08 07:01:02 -0700586 fi
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400587 fi
Russell Bryant09b94602015-06-08 15:25:43 -0400588}
589
Sean M. Collins2a242512016-05-03 09:03:09 -0400590function start_mutnauq_other_agents {
Angus Leesa1c70f22016-05-31 14:43:14 +1000591 run_process q-dhcp "$AGENT_DHCP_BINARY --config-file $NEUTRON_CONF --config-file $Q_DHCP_CONF_FILE"
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400592
YAMAMOTO Takashi6839d422017-10-17 12:58:18 +0900593 run_process q-l3 "$AGENT_L3_BINARY $(determine_config_files neutron-l3-agent)"
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700594
Angus Leesa1c70f22016-05-31 14:43:14 +1000595 run_process q-meta "$AGENT_META_BINARY --config-file $NEUTRON_CONF --config-file $Q_META_CONF_FILE"
Davanum Srinivas59756e92015-09-23 17:42:54 -0400596 run_process q-metering "$AGENT_METERING_BINARY --config-file $NEUTRON_CONF --config-file $METERING_AGENT_CONF_FILENAME"
Mark McClainb05c8762013-07-06 23:29:39 -0400597}
598
Russell Bryant09b94602015-06-08 15:25:43 -0400599# Start running processes, including screen
600function start_neutron_agents {
601 # Start up the neutron agents if enabled
Sean M. Collins2a242512016-05-03 09:03:09 -0400602 start_mutnauq_l2_agent
603 start_mutnauq_other_agents
Russell Bryant09b94602015-06-08 15:25:43 -0400604}
605
Sean M. Collins2a242512016-05-03 09:03:09 -0400606function stop_mutnauq_l2_agent {
Russell Bryant09b94602015-06-08 15:25:43 -0400607 stop_process q-agt
608}
609
Sean Dague0eebeb42017-08-30 14:16:58 -0400610# stop_mutnauq_other() - Stop running processes
Sean M. Collins2a242512016-05-03 09:03:09 -0400611function stop_mutnauq_other {
Mark McClainb05c8762013-07-06 23:29:39 -0400612 if is_service_enabled q-dhcp; then
Chris Dent36891dc2015-02-03 16:22:44 +0000613 stop_process q-dhcp
Mark McClainb05c8762013-07-06 23:29:39 -0400614 pid=$(ps aux | awk '/[d]nsmasq.+interface=(tap|ns-)/ { print $2 }')
615 [ ! -z "$pid" ] && sudo kill -9 $pid
616 fi
Chris Dent36891dc2015-02-03 16:22:44 +0000617
Kevin Benton66b361b2017-06-13 00:31:01 -0700618 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
619 stop_process neutron-rpc-server
620 stop_process neutron-api
621 else
622 stop_process q-svc
623 fi
Li Maa15d9de2016-01-19 19:11:51 +0800624
625 if is_service_enabled q-l3; then
626 sudo pkill -f "radvd -C $DATA_DIR/neutron/ra"
627 stop_process q-l3
628 fi
Chris Dent36891dc2015-02-03 16:22:44 +0000629
Mark McClainb05c8762013-07-06 23:29:39 -0400630 if is_service_enabled q-meta; then
Jakub Libosvar1f763282014-01-28 23:01:38 +0100631 sudo pkill -9 -f neutron-ns-metadata-proxy || :
Chris Dent36891dc2015-02-03 16:22:44 +0000632 stop_process q-meta
Mark McClainb05c8762013-07-06 23:29:39 -0400633 fi
Akihiro Motokiedddb1f2013-12-09 20:21:06 +0900634
Akihiro Motokiedddb1f2013-12-09 20:21:06 +0900635 if is_service_enabled q-metering; then
636 neutron_metering_stop
637 fi
Li Ma50120fa2015-12-13 10:41:34 +0800638
639 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
640 sudo pkill -9 -f $NEUTRON_ROOTWRAP-daemon || :
641 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400642}
643
Russell Bryant09b94602015-06-08 15:25:43 -0400644# stop_neutron() - Stop running processes (non-screen)
Sean M. Collins2a242512016-05-03 09:03:09 -0400645function stop_mutnauq {
646 stop_mutnauq_other
647 stop_mutnauq_l2_agent
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100648
yatinkarel6dd896f2022-04-26 16:37:07 +0530649 if [[ $Q_AGENT == "ovn" && $SKIP_STOP_OVN != "True" ]]; then
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100650 stop_ovn
651 fi
Russell Bryant09b94602015-06-08 15:25:43 -0400652}
653
Sean M. Collins00e16a92015-02-20 11:45:21 -0500654# _move_neutron_addresses_route() - Move the primary IP to the OVS bridge
Adam Kacmarsky6b172c82015-08-13 15:14:05 -0600655# on startup, or back to the public interface on cleanup. If no IP is
656# configured on the interface, just add it as a port to the OVS bridge.
Sean M. Collins00e16a92015-02-20 11:45:21 -0500657function _move_neutron_addresses_route {
658 local from_intf=$1
659 local to_intf=$2
660 local add_ovs_port=$3
Brian Haleya0d1b012015-11-16 17:30:48 -0500661 local del_ovs_port=$4
662 local af=$5
Sean M. Collins00e16a92015-02-20 11:45:21 -0500663
664 if [[ -n "$from_intf" && -n "$to_intf" ]]; then
665 # Remove the primary IP address from $from_intf and add it to $to_intf,
666 # along with the default route, if it exists. Also, when called
667 # on configure we will also add $from_intf as a port on $to_intf,
668 # assuming it is an OVS bridge.
669
Matt McEuene24707b2016-07-11 08:37:59 -0500670 local IP_REPLACE=""
Adam Kacmarsky6b172c82015-08-13 15:14:05 -0600671 local IP_DEL=""
Shinobu KINJOf95315b2015-11-07 10:21:08 +0900672 local IP_UP=""
Ian Wienandada886d2015-10-07 14:06:26 +1100673 local DEFAULT_ROUTE_GW
Andreas Scheuring92e6b1a2017-04-26 13:40:42 +0200674 DEFAULT_ROUTE_GW=$(ip -f $af r | awk "/default.+$from_intf\s/ { print \$3; exit }")
Sean M. Collins00e16a92015-02-20 11:45:21 -0500675 local ADD_OVS_PORT=""
Brian Haleya0d1b012015-11-16 17:30:48 -0500676 local DEL_OVS_PORT=""
Sean M. Collins17398a32016-05-11 18:24:46 +0000677 local ARP_CMD=""
Sean M. Collins00e16a92015-02-20 11:45:21 -0500678
Brian Haleybb9caea2015-11-16 17:18:42 -0500679 IP_BRD=$(ip -f $af a s dev $from_intf scope global primary | grep inet | awk '{ print $2, $3, $4; exit }')
Adam Kacmarsky11298a02015-06-26 14:49:47 -0600680
Sean M. Collins00e16a92015-02-20 11:45:21 -0500681 if [ "$DEFAULT_ROUTE_GW" != "" ]; then
Sean M. Collins59e86a32015-11-09 11:06:39 -0500682 ADD_DEFAULT_ROUTE="sudo ip -f $af r replace default via $DEFAULT_ROUTE_GW dev $to_intf"
Sean M. Collins00e16a92015-02-20 11:45:21 -0500683 fi
684
685 if [[ "$add_ovs_port" == "True" ]]; then
Raman Budnydb02bbf2015-03-31 13:09:09 +0300686 ADD_OVS_PORT="sudo ovs-vsctl --may-exist add-port $to_intf $from_intf"
Sean M. Collins00e16a92015-02-20 11:45:21 -0500687 fi
688
Brian Haleya0d1b012015-11-16 17:30:48 -0500689 if [[ "$del_ovs_port" == "True" ]]; then
690 DEL_OVS_PORT="sudo ovs-vsctl --if-exists del-port $from_intf $to_intf"
691 fi
692
Adam Kacmarsky6b172c82015-08-13 15:14:05 -0600693 if [[ "$IP_BRD" != "" ]]; then
Brian Haley94510212015-09-02 15:40:04 -0400694 IP_DEL="sudo ip addr del $IP_BRD dev $from_intf"
Matt McEuene24707b2016-07-11 08:37:59 -0500695 IP_REPLACE="sudo ip addr replace $IP_BRD dev $to_intf"
Shinobu KINJOf95315b2015-11-07 10:21:08 +0900696 IP_UP="sudo ip link set $to_intf up"
Sean M. Collins6d4843e2016-05-12 16:14:26 -0400697 if [[ "$af" == "inet" ]]; then
698 IP=$(echo $IP_BRD | awk '{ print $1; exit }' | grep -o -E '(.*)/' | cut -d "/" -f1)
Rodolfo Alonso Hernandezca486c52020-06-25 18:22:28 +0000699 ARP_CMD="sudo arping -A -c 3 -w 5 -I $to_intf $IP "
Sean M. Collins6d4843e2016-05-12 16:14:26 -0400700 fi
Adam Kacmarsky6b172c82015-08-13 15:14:05 -0600701 fi
702
Brian Haleya0d1b012015-11-16 17:30:48 -0500703 # The add/del OVS port calls have to happen either before or
704 # after the address is moved in order to not leave it orphaned.
Matt McEuene24707b2016-07-11 08:37:59 -0500705 $DEL_OVS_PORT; $IP_DEL; $IP_REPLACE; $IP_UP; $ADD_OVS_PORT; $ADD_DEFAULT_ROUTE; $ARP_CMD
Sean M. Collins00e16a92015-02-20 11:45:21 -0500706 fi
707}
708
Slawek Kaplonskib1a89eb2021-08-26 21:42:32 +0200709# _configure_public_network_connectivity() - Configures connectivity to the
710# external network using $PUBLIC_INTERFACE or NAT on the single interface
711# machines
712function _configure_public_network_connectivity {
713 # If we've given a PUBLIC_INTERFACE to take over, then we assume
714 # that we can own the whole thing, and privot it into the OVS
715 # bridge. If we are not, we're probably on a single interface
716 # machine, and we just setup NAT so that fixed guests can get out.
717 if [[ -n "$PUBLIC_INTERFACE" ]]; then
718 _move_neutron_addresses_route "$PUBLIC_INTERFACE" "$OVS_PHYSICAL_BRIDGE" True False "inet"
719
720 if [[ $(ip -f inet6 a s dev "$PUBLIC_INTERFACE" | grep -c 'global') != 0 ]]; then
721 _move_neutron_addresses_route "$PUBLIC_INTERFACE" "$OVS_PHYSICAL_BRIDGE" False False "inet6"
722 fi
723 else
724 for d in $default_v4_route_devs; do
725 sudo iptables -t nat -A POSTROUTING -o $d -s $FLOATING_RANGE -j MASQUERADE
726 done
727 fi
728}
729
Sean M. Collins2a242512016-05-03 09:03:09 -0400730# cleanup_mutnauq() - Remove residual data files, anything left over from previous
Mark McClainb05c8762013-07-06 23:29:39 -0400731# runs that a clean run would need to clean up
Sean M. Collins2a242512016-05-03 09:03:09 -0400732function cleanup_mutnauq {
Sean M. Collins00e16a92015-02-20 11:45:21 -0500733
Yalei Wang316b3482015-07-15 21:00:31 +0800734 if [[ -n "$OVS_PHYSICAL_BRIDGE" ]]; then
Brian Haleya0d1b012015-11-16 17:30:48 -0500735 _move_neutron_addresses_route "$OVS_PHYSICAL_BRIDGE" "$PUBLIC_INTERFACE" False True "inet"
Adam Kacmarsky11298a02015-06-26 14:49:47 -0600736
Yalei Wang316b3482015-07-15 21:00:31 +0800737 if [[ $(ip -f inet6 a s dev "$OVS_PHYSICAL_BRIDGE" | grep -c 'global') != 0 ]]; then
Sean M. Collins790266f2015-11-11 13:36:35 -0500738 # ip(8) wants the prefix length when deleting
739 local v6_gateway
740 v6_gateway=$(ip -6 a s dev $OVS_PHYSICAL_BRIDGE | grep $IPV6_PUBLIC_NETWORK_GATEWAY | awk '{ print $2 }')
741 sudo ip -6 addr del $v6_gateway dev $OVS_PHYSICAL_BRIDGE
Brian Haleya0d1b012015-11-16 17:30:48 -0500742 _move_neutron_addresses_route "$OVS_PHYSICAL_BRIDGE" "$PUBLIC_INTERFACE" False False "inet6"
Yalei Wang316b3482015-07-15 21:00:31 +0800743 fi
Sean M. Collins00e16a92015-02-20 11:45:21 -0500744
Yalei Wang316b3482015-07-15 21:00:31 +0800745 if is_provider_network && is_ironic_hardware; then
746 for IP in $(ip addr show dev $OVS_PHYSICAL_BRIDGE | grep ' inet ' | awk '{print $2}'); do
747 sudo ip addr del $IP dev $OVS_PHYSICAL_BRIDGE
748 sudo ip addr add $IP dev $PUBLIC_INTERFACE
749 done
750 sudo route del -net $FIXED_RANGE gw $NETWORK_GATEWAY dev $OVS_PHYSICAL_BRIDGE
751 fi
yunhong jiangae9ee6b2014-10-08 07:01:02 -0700752 fi
753
Mark McClainb05c8762013-07-06 23:29:39 -0400754 if is_neutron_ovs_base_plugin; then
755 neutron_ovs_base_cleanup
756 fi
757
Sean M. Collins7bc2af72015-06-08 12:36:30 -0400758 if [[ $Q_AGENT == "linuxbridge" ]]; then
759 neutron_lb_cleanup
760 fi
761
Mark McClainb05c8762013-07-06 23:29:39 -0400762 # delete all namespaces created by neutron
Doug Wiegley7e40c642016-08-20 16:32:14 +0000763 for ns in $(sudo ip netns list | grep -o -E '(qdhcp|qrouter|fip|snat)-[0-9a-f-]*'); do
Mark McClainb05c8762013-07-06 23:29:39 -0400764 sudo ip netns delete ${ns}
765 done
Lucas Alvares Gomes1d468d42020-06-09 14:35:52 +0100766
767 if [[ $Q_AGENT == "ovn" ]]; then
768 cleanup_ovn
769 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400770}
771
Doug Wiegley93e682c2015-03-03 10:31:30 -0700772
Maru Newby952fd902015-01-30 22:27:12 +0000773function _create_neutron_conf_dir {
Mark McClainb05c8762013-07-06 23:29:39 -0400774 # Put config files in ``NEUTRON_CONF_DIR`` for everyone to find
Dean Troyer8421c2b2015-03-16 13:52:19 -0500775 sudo install -d -o $STACK_USER $NEUTRON_CONF_DIR
Maru Newby952fd902015-01-30 22:27:12 +0000776}
777
778# _configure_neutron_common()
779# Set common config for all neutron server and agents.
780# This MUST be called before other ``_configure_neutron_*`` functions.
781function _configure_neutron_common {
782 _create_neutron_conf_dir
Mark McClainb05c8762013-07-06 23:29:39 -0400783
Martin Hickey30d5fae2015-11-10 13:44:15 +0000784 # Uses oslo config generator to generate core sample configuration files
785 (cd $NEUTRON_DIR && exec ./tools/generate_config_file_samples.sh)
786
787 cp $NEUTRON_DIR/etc/neutron.conf.sample $NEUTRON_CONF
Mark McClainb05c8762013-07-06 23:29:39 -0400788
Jerry Zhao296c1e32015-08-07 20:43:54 -0400789 Q_POLICY_FILE=$NEUTRON_CONF_DIR/policy.json
Jerry Zhao296c1e32015-08-07 20:43:54 -0400790
791 # allow neutron user to administer neutron to match neutron account
Akihiro Motoki80769c52018-11-23 05:18:40 +0900792 # NOTE(amotoki): This is required for nova works correctly with neutron.
793 if [ -f $NEUTRON_DIR/etc/policy.json ]; then
794 cp $NEUTRON_DIR/etc/policy.json $Q_POLICY_FILE
795 sed -i 's/"context_is_admin": "role:admin"/"context_is_admin": "role:admin or user_name:neutron"/g' $Q_POLICY_FILE
796 else
797 echo '{"context_is_admin": "role:admin or user_name:neutron"}' > $Q_POLICY_FILE
798 fi
Jerry Zhao296c1e32015-08-07 20:43:54 -0400799
Mark McClainb05c8762013-07-06 23:29:39 -0400800 # Set plugin-specific variables ``Q_DB_NAME``, ``Q_PLUGIN_CLASS``.
801 # For main plugin config file, set ``Q_PLUGIN_CONF_PATH``, ``Q_PLUGIN_CONF_FILENAME``.
Mark McClainb05c8762013-07-06 23:29:39 -0400802 neutron_plugin_configure_common
803
sbauzae2c4ee22013-08-29 17:29:46 +0200804 if [[ "$Q_PLUGIN_CONF_PATH" == '' || "$Q_PLUGIN_CONF_FILENAME" == '' || "$Q_PLUGIN_CLASS" == '' ]]; then
Mark McClainb05c8762013-07-06 23:29:39 -0400805 die $LINENO "Neutron plugin not set.. exiting"
806 fi
807
808 # If needed, move config file from ``$NEUTRON_DIR/etc/neutron`` to ``NEUTRON_CONF_DIR``
809 mkdir -p /$Q_PLUGIN_CONF_PATH
810 Q_PLUGIN_CONF_FILE=$Q_PLUGIN_CONF_PATH/$Q_PLUGIN_CONF_FILENAME
Hirofumi Ichihara97cc85b2015-09-08 13:51:01 +0900811 # NOTE(hichihara): Some neutron vendor plugins were already decomposed and
812 # there is no config file in Neutron tree. They should prepare the file in each plugin.
Martin Hickey30d5fae2015-11-10 13:44:15 +0000813 if [ -f "$NEUTRON_DIR/$Q_PLUGIN_CONF_FILE.sample" ]; then
814 cp "$NEUTRON_DIR/$Q_PLUGIN_CONF_FILE.sample" /$Q_PLUGIN_CONF_FILE
815 elif [ -f $NEUTRON_DIR/$Q_PLUGIN_CONF_FILE ]; then
Hirofumi Ichihara97cc85b2015-09-08 13:51:01 +0900816 cp $NEUTRON_DIR/$Q_PLUGIN_CONF_FILE /$Q_PLUGIN_CONF_FILE
817 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400818
Ihar Hrachyshkab816e5d2014-07-21 13:53:50 +0200819 iniset $NEUTRON_CONF database connection `database_connection_url $Q_DB_NAME`
Mark McClainb05c8762013-07-06 23:29:39 -0400820 iniset $NEUTRON_CONF DEFAULT state_path $DATA_DIR/neutron
salvatoree4e535b2014-10-29 18:22:46 +0100821 iniset $NEUTRON_CONF DEFAULT use_syslog $SYSLOG
Brian Haley180f5eb2015-06-16 13:14:31 -0400822 iniset $NEUTRON_CONF DEFAULT bind_host $Q_LISTEN_ADDRESS
Martin Hickey30d5fae2015-11-10 13:44:15 +0000823 iniset $NEUTRON_CONF oslo_concurrency lock_path $DATA_DIR/neutron/lock
824
Victor Ryzhenkin878d7d82016-04-27 15:15:52 +0300825 # NOTE(freerunner): Need to adjust Region Name for nova in multiregion installation
826 iniset $NEUTRON_CONF nova region_name $REGION_NAME
827
Joe Gordonbee5c502013-08-30 13:48:08 -0400828 if [ "$VIRT_DRIVER" = 'fake' ]; then
829 # Disable arbitrary limits
830 iniset $NEUTRON_CONF quotas quota_network -1
831 iniset $NEUTRON_CONF quotas quota_subnet -1
832 iniset $NEUTRON_CONF quotas quota_port -1
833 iniset $NEUTRON_CONF quotas quota_security_group -1
834 iniset $NEUTRON_CONF quotas quota_security_group_rule -1
835 fi
836
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700837 # Format logging
Sean Dague9751be62016-04-05 12:08:57 -0400838 setup_logging $NEUTRON_CONF
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700839
Kevin Benton66b361b2017-06-13 00:31:01 -0700840 if is_service_enabled tls-proxy && [ "$NEUTRON_DEPLOY_MOD_WSGI" == "False" ]; then
Rob Crittenden18d47782014-03-19 17:47:42 -0400841 # Set the service port for a proxy to take the original
842 iniset $NEUTRON_CONF DEFAULT bind_port "$Q_PORT_INT"
Jens Harbott411c34d2017-08-29 14:40:26 +0000843 iniset $NEUTRON_CONF oslo_middleware enable_proxy_headers_parsing True
Rob Crittenden18d47782014-03-19 17:47:42 -0400844 fi
845
Mark McClainb05c8762013-07-06 23:29:39 -0400846 _neutron_setup_rootwrap
847}
848
Ian Wienandaee18c72014-02-21 15:35:08 +1100849function _configure_neutron_dhcp_agent {
Mark McClainb05c8762013-07-06 23:29:39 -0400850
Martin Hickey30d5fae2015-11-10 13:44:15 +0000851 cp $NEUTRON_DIR/etc/dhcp_agent.ini.sample $Q_DHCP_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400852
Ben Nemec03997942013-08-10 09:56:16 -0500853 iniset $Q_DHCP_CONF_FILE DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean Dague78801c12016-08-04 14:10:07 -0400854 # make it so we have working DNS from guests
855 iniset $Q_DHCP_CONF_FILE DEFAULT dnsmasq_local_resolv True
Hirofumi Ichihara2bb3a642015-08-18 12:59:08 -0700856 iniset $Q_DHCP_CONF_FILE AGENT root_helper "$Q_RR_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +0400857 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
Hirofumi Ichihara2bb3a642015-08-18 12:59:08 -0700858 iniset $Q_DHCP_CONF_FILE AGENT root_helper_daemon "$Q_RR_DAEMON_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +0400859 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400860
Tan Lin27a196e2014-10-31 15:44:34 +0800861 if ! is_service_enabled q-l3; then
862 if [[ "$ENABLE_ISOLATED_METADATA" = "True" ]]; then
863 iniset $Q_DHCP_CONF_FILE DEFAULT enable_isolated_metadata $ENABLE_ISOLATED_METADATA
864 iniset $Q_DHCP_CONF_FILE DEFAULT enable_metadata_network $ENABLE_METADATA_NETWORK
865 else
866 if [[ "$ENABLE_METADATA_NETWORK" = "True" ]]; then
867 die "$LINENO" "Enable isolated metadata is a must for metadata network"
868 fi
869 fi
870 fi
871
Mark McClainb05c8762013-07-06 23:29:39 -0400872 _neutron_setup_interface_driver $Q_DHCP_CONF_FILE
873
xurong000379977ef31d02016-07-05 11:09:40 +0800874 neutron_plugin_configure_dhcp_agent $Q_DHCP_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400875}
876
Mark McClainb05c8762013-07-06 23:29:39 -0400877
Ian Wienandaee18c72014-02-21 15:35:08 +1100878function _configure_neutron_metadata_agent {
Martin Hickey30d5fae2015-11-10 13:44:15 +0000879 cp $NEUTRON_DIR/etc/metadata_agent.ini.sample $Q_META_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400880
Ben Nemec03997942013-08-10 09:56:16 -0500881 iniset $Q_META_CONF_FILE DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Brian Haleyefc51682017-11-10 00:50:48 -0500882 iniset $Q_META_CONF_FILE DEFAULT nova_metadata_host $Q_META_DATA_IP
Armando Migliaccio06f2ea22017-02-02 16:47:00 -0800883 iniset $Q_META_CONF_FILE DEFAULT metadata_workers $API_WORKERS
Hirofumi Ichihara2bb3a642015-08-18 12:59:08 -0700884 iniset $Q_META_CONF_FILE AGENT root_helper "$Q_RR_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +0400885 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
Hirofumi Ichihara2bb3a642015-08-18 12:59:08 -0700886 iniset $Q_META_CONF_FILE AGENT root_helper_daemon "$Q_RR_DAEMON_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +0400887 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400888}
889
Dina Belova58adaa62014-07-11 18:18:12 +0400890function _configure_neutron_ceilometer_notifications {
Matt Riedemann45da7772017-03-05 13:07:39 -0500891 iniset $NEUTRON_CONF oslo_messaging_notifications driver messagingv2
Dina Belova58adaa62014-07-11 18:18:12 +0400892}
893
Ian Wienandaee18c72014-02-21 15:35:08 +1100894function _configure_neutron_metering {
Emilien Macchi40546f72013-09-24 15:10:25 +0200895 neutron_agent_metering_configure_common
896 neutron_agent_metering_configure_agent
897}
898
Brian Haleyeea76212014-06-27 11:45:50 -0400899function _configure_dvr {
900 iniset $NEUTRON_CONF DEFAULT router_distributed True
901 iniset $Q_L3_CONF_FILE DEFAULT agent_mode $Q_DVR_MODE
902}
903
904
Mark McClainb05c8762013-07-06 23:29:39 -0400905# _configure_neutron_plugin_agent() - Set config files for neutron plugin agent
906# It is called when q-agt is enabled.
Ian Wienandaee18c72014-02-21 15:35:08 +1100907function _configure_neutron_plugin_agent {
Mark McClainb05c8762013-07-06 23:29:39 -0400908 # Specify the default root helper prior to agent configuration to
909 # ensure that an agent's configuration can override the default
910 iniset /$Q_PLUGIN_CONF_FILE agent root_helper "$Q_RR_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +0400911 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
912 iniset /$Q_PLUGIN_CONF_FILE agent root_helper_daemon "$Q_RR_DAEMON_COMMAND"
913 fi
Ben Nemec03997942013-08-10 09:56:16 -0500914 iniset $NEUTRON_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400915
916 # Configure agent for plugin
917 neutron_plugin_configure_plugin_agent
918}
919
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200920function _replace_api_paste_composite {
921 local sep
922 sep=$(echo -ne "\x01")
923 # Replace it
924 $sudo sed -i -e "s/\/\: neutronversions_composite/\/"${NEUTRON_ENDPOINT_SERVICE_NAME}"\/\: neutronversions_composite/" "$Q_API_PASTE_FILE"
925 $sudo sed -i -e "s/\/healthcheck\: healthcheck/\/"${NEUTRON_ENDPOINT_SERVICE_NAME}"\/healthcheck\: healthcheck/" "$Q_API_PASTE_FILE"
926 $sudo sed -i -e "s/\/v2.0\: neutronapi_v2_0/\/"${NEUTRON_ENDPOINT_SERVICE_NAME}"\/v2.0\: neutronapi_v2_0/" "$Q_API_PASTE_FILE"
927}
928
Mark McClainb05c8762013-07-06 23:29:39 -0400929# _configure_neutron_service() - Set config files for neutron service
930# It is called when q-svc is enabled.
Ian Wienandaee18c72014-02-21 15:35:08 +1100931function _configure_neutron_service {
Mark McClainb05c8762013-07-06 23:29:39 -0400932 Q_API_PASTE_FILE=$NEUTRON_CONF_DIR/api-paste.ini
Mark McClainb05c8762013-07-06 23:29:39 -0400933 cp $NEUTRON_DIR/etc/api-paste.ini $Q_API_PASTE_FILE
Kevin Benton08a5fcc2014-07-18 16:06:12 -0700934
Slawek Kaplonski1a21ccb2022-07-08 21:57:45 +0200935 if [[ -n "$NEUTRON_ENDPOINT_SERVICE_NAME" ]]; then
936 _replace_api_paste_composite
937 fi
938
Mark McClainb05c8762013-07-06 23:29:39 -0400939 # Update either configuration file with plugin
940 iniset $NEUTRON_CONF DEFAULT core_plugin $Q_PLUGIN_CLASS
941
Ben Nemec03997942013-08-10 09:56:16 -0500942 iniset $NEUTRON_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Chris Dent74a85b02015-04-22 18:02:39 +0000943 iniset $NEUTRON_CONF oslo_policy policy_file $Q_POLICY_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400944
945 iniset $NEUTRON_CONF DEFAULT auth_strategy $Q_AUTH_STRATEGY
Dirk Mueller8ab64b32017-11-17 19:52:29 +0100946 configure_keystone_authtoken_middleware $NEUTRON_CONF $Q_ADMIN_USERNAME
Mark McClainb05c8762013-07-06 23:29:39 -0400947
Atsushi SAKAIfe7b56c2015-11-13 17:06:16 +0900948 # Configuration for neutron notifications to nova.
Terry Wilsonf06c4432014-05-20 10:54:51 -0500949 iniset $NEUTRON_CONF DEFAULT notify_nova_on_port_status_changes $Q_NOTIFY_NOVA_PORT_STATUS_CHANGES
950 iniset $NEUTRON_CONF DEFAULT notify_nova_on_port_data_changes $Q_NOTIFY_NOVA_PORT_DATA_CHANGES
Jamie Lennoxdc757dd2015-03-09 14:48:09 +1100951
Dirk Mueller8ab64b32017-11-17 19:52:29 +0100952 configure_keystone_authtoken_middleware $NEUTRON_CONF nova nova
Aaron Rosencea32b12014-03-04 16:20:14 -0800953
yatinkarel92a34db2022-05-17 20:10:48 +0530954 # Configuration for placement client
955 configure_keystone_authtoken_middleware $NEUTRON_CONF placement placement
956
Mark McClainb05c8762013-07-06 23:29:39 -0400957 # Configure plugin
958 neutron_plugin_configure_service
959}
960
961# Utility Functions
962#------------------
963
Isaku Yamahata9e136b42013-12-16 15:52:03 +0900964# _neutron_service_plugin_class_add() - add service plugin class
Ian Wienandaee18c72014-02-21 15:35:08 +1100965function _neutron_service_plugin_class_add {
Isaku Yamahata9e136b42013-12-16 15:52:03 +0900966 local service_plugin_class=$1
967 if [[ $Q_SERVICE_PLUGIN_CLASSES == '' ]]; then
968 Q_SERVICE_PLUGIN_CLASSES=$service_plugin_class
969 elif [[ ! ,${Q_SERVICE_PLUGIN_CLASSES}, =~ ,${service_plugin_class}, ]]; then
970 Q_SERVICE_PLUGIN_CLASSES="$Q_SERVICE_PLUGIN_CLASSES,$service_plugin_class"
971 fi
972}
973
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000974# _neutron_ml2_extension_driver_add_old() - add ML2 extension driver
975function _neutron_ml2_extension_driver_add_old {
976 local extension=$1
977 if [[ $Q_ML2_PLUGIN_EXT_DRIVERS == '' ]]; then
978 Q_ML2_PLUGIN_EXT_DRIVERS=$extension
979 elif [[ ! ,${Q_ML2_PLUGIN_EXT_DRIVERS}, =~ ,${extension}, ]]; then
980 Q_ML2_PLUGIN_EXT_DRIVERS="$Q_ML2_PLUGIN_EXT_DRIVERS,$extension"
981 fi
982}
983
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900984# mutnauq_server_config_add() - add server config file
985function mutnauq_server_config_add {
986 _Q_PLUGIN_EXTRA_CONF_FILES_ABS+=($1)
987}
988
Ihar Hrachyshka5893cc72014-12-22 11:49:42 +0100989# _neutron_deploy_rootwrap_filters() - deploy rootwrap filters to $Q_CONF_ROOTWRAP_D (owned by root).
990function _neutron_deploy_rootwrap_filters {
gong yong sheng3d6eaae2015-09-15 15:00:29 +0800991 if [[ "$Q_USE_ROOTWRAP" == "False" ]]; then
992 return
993 fi
Ihar Hrachyshka5893cc72014-12-22 11:49:42 +0100994 local srcdir=$1
Dean Troyer8421c2b2015-03-16 13:52:19 -0500995 sudo install -d -o root -m 755 $Q_CONF_ROOTWRAP_D
996 sudo install -o root -m 644 $srcdir/etc/neutron/rootwrap.d/* $Q_CONF_ROOTWRAP_D/
Ihar Hrachyshka5893cc72014-12-22 11:49:42 +0100997}
998
Mark McClainb05c8762013-07-06 23:29:39 -0400999# _neutron_setup_rootwrap() - configure Neutron's rootwrap
Ian Wienandaee18c72014-02-21 15:35:08 +11001000function _neutron_setup_rootwrap {
Mark McClainb05c8762013-07-06 23:29:39 -04001001 if [[ "$Q_USE_ROOTWRAP" == "False" ]]; then
1002 return
1003 fi
Mark McClainb05c8762013-07-06 23:29:39 -04001004 # Wipe any existing ``rootwrap.d`` files first
1005 Q_CONF_ROOTWRAP_D=$NEUTRON_CONF_DIR/rootwrap.d
1006 if [[ -d $Q_CONF_ROOTWRAP_D ]]; then
1007 sudo rm -rf $Q_CONF_ROOTWRAP_D
1008 fi
Ihar Hrachyshka5893cc72014-12-22 11:49:42 +01001009
1010 _neutron_deploy_rootwrap_filters $NEUTRON_DIR
1011
Mark McClainb05c8762013-07-06 23:29:39 -04001012 # Set up ``rootwrap.conf``, pointing to ``$NEUTRON_CONF_DIR/rootwrap.d``
1013 # location moved in newer versions, prefer new location
1014 if test -r $NEUTRON_DIR/etc/neutron/rootwrap.conf; then
Dean Troyer8421c2b2015-03-16 13:52:19 -05001015 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/neutron/rootwrap.conf $Q_RR_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -04001016 else
Dean Troyer8421c2b2015-03-16 13:52:19 -05001017 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/rootwrap.conf $Q_RR_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -04001018 fi
1019 sudo sed -e "s:^filters_path=.*$:filters_path=$Q_CONF_ROOTWRAP_D:" -i $Q_RR_CONF_FILE
Robert Li2c5d4622015-04-21 15:48:22 -04001020 sudo sed -e 's:^exec_dirs=\(.*\)$:exec_dirs=\1,/usr/local/bin:' -i $Q_RR_CONF_FILE
1021
Mark McClainb05c8762013-07-06 23:29:39 -04001022 # Specify ``rootwrap.conf`` as first parameter to neutron-rootwrap
1023 ROOTWRAP_SUDOER_CMD="$NEUTRON_ROOTWRAP $Q_RR_CONF_FILE *"
Yuriy Taraday26623952014-07-16 17:41:53 +04001024 ROOTWRAP_DAEMON_SUDOER_CMD="$NEUTRON_ROOTWRAP-daemon $Q_RR_CONF_FILE"
Mark McClainb05c8762013-07-06 23:29:39 -04001025
1026 # Set up the rootwrap sudoers for neutron
1027 TEMPFILE=`mktemp`
Stephan Renatuse578eff2013-11-19 13:31:04 +01001028 echo "$STACK_USER ALL=(root) NOPASSWD: $ROOTWRAP_SUDOER_CMD" >$TEMPFILE
Yuriy Taraday26623952014-07-16 17:41:53 +04001029 echo "$STACK_USER ALL=(root) NOPASSWD: $ROOTWRAP_DAEMON_SUDOER_CMD" >>$TEMPFILE
Mark McClainb05c8762013-07-06 23:29:39 -04001030 chmod 0440 $TEMPFILE
1031 sudo chown root:root $TEMPFILE
1032 sudo mv $TEMPFILE /etc/sudoers.d/neutron-rootwrap
1033
1034 # Update the root_helper
1035 iniset $NEUTRON_CONF agent root_helper "$Q_RR_COMMAND"
Yuriy Taraday26623952014-07-16 17:41:53 +04001036 if [[ "$Q_USE_ROOTWRAP_DAEMON" == "True" ]]; then
1037 iniset $NEUTRON_CONF agent root_helper_daemon "$Q_RR_DAEMON_COMMAND"
1038 fi
Mark McClainb05c8762013-07-06 23:29:39 -04001039}
1040
Ian Wienandaee18c72014-02-21 15:35:08 +11001041function _neutron_setup_interface_driver {
Mark McClainb05c8762013-07-06 23:29:39 -04001042
1043 # ovs_use_veth needs to be set before the plugin configuration
1044 # occurs to allow plugins to override the setting.
1045 iniset $1 DEFAULT ovs_use_veth $Q_OVS_USE_VETH
1046
1047 neutron_plugin_setup_interface_driver $1
1048}
Mark McClainb05c8762013-07-06 23:29:39 -04001049# Functions for Neutron Exercises
1050#--------------------------------
1051
Ian Wienandaee18c72014-02-21 15:35:08 +11001052function delete_probe {
Mark McClainb05c8762013-07-06 23:29:39 -04001053 local from_net="$1"
1054 net_id=`_get_net_id $from_net`
1055 probe_id=`neutron-debug --os-tenant-name admin --os-username admin --os-password $ADMIN_PASSWORD probe-list -c id -c network_id | grep $net_id | awk '{print $2}'`
1056 neutron-debug --os-tenant-name admin --os-username admin probe-delete $probe_id
1057}
1058
Ian Wienandaee18c72014-02-21 15:35:08 +11001059function _get_net_id {
Brian Haley4bc42c72017-11-07 15:22:00 -05001060 openstack --os-cloud devstack-admin --os-region-name="$REGION_NAME" --os-project-name admin --os-username admin --os-password $ADMIN_PASSWORD network list | grep $1 | awk '{print $2}'
Mark McClainb05c8762013-07-06 23:29:39 -04001061}
1062
Ian Wienandaee18c72014-02-21 15:35:08 +11001063function _get_probe_cmd_prefix {
Mark McClainb05c8762013-07-06 23:29:39 -04001064 local from_net="$1"
1065 net_id=`_get_net_id $from_net`
1066 probe_id=`neutron-debug --os-tenant-name admin --os-username admin --os-password $ADMIN_PASSWORD probe-list -c id -c network_id | grep $net_id | awk '{print $2}' | head -n 1`
1067 echo "$Q_RR_COMMAND ip netns exec qprobe-$probe_id"
1068}
1069
Mark McClainb05c8762013-07-06 23:29:39 -04001070# ssh check
Ian Wienandaee18c72014-02-21 15:35:08 +11001071function _ssh_check_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -04001072 local from_net=$1
1073 local key_file=$2
1074 local ip=$3
1075 local user=$4
1076 local timeout_sec=$5
1077 local probe_cmd = ""
1078 probe_cmd=`_get_probe_cmd_prefix $from_net`
Sean Dague442e4e92015-06-24 13:24:02 -04001079 local testcmd="$probe_cmd ssh -o StrictHostKeyChecking=no -i $key_file ${user}@$ip echo success"
1080 test_with_retry "$testcmd" "server $ip didn't become ssh-able" $timeout_sec
Mark McClainb05c8762013-07-06 23:29:39 -04001081}
1082
Slawek Kaplonskifaed11d2021-11-18 10:36:57 +01001083function plugin_agent_add_l2_agent_extension {
1084 local l2_agent_extension=$1
1085 if [[ -z "$L2_AGENT_EXTENSIONS" ]]; then
1086 L2_AGENT_EXTENSIONS=$l2_agent_extension
1087 elif [[ ! ,${L2_AGENT_EXTENSIONS}, =~ ,${l2_agent_extension}, ]]; then
1088 L2_AGENT_EXTENSIONS+=",$l2_agent_extension"
1089 fi
1090}
1091
Mark McClainb05c8762013-07-06 23:29:39 -04001092# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +11001093$_XTRACE_NEUTRON
Mark McClainb05c8762013-07-06 23:29:39 -04001094
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01001095# Tell emacs to use shell-script-mode
1096## Local variables:
1097## mode: shell-script
1098## End: