blob: 5ef9280981e32d2185e013b364eb3b7fef044a91 [file] [log] [blame]
Sean M. Collins2a242512016-05-03 09:03:09 -04001#!/bin/bash
2#
3# lib/neutron
4# Install and start **Neutron** network services
5
6# Dependencies:
7#
8# ``functions`` file
9# ``DEST`` must be defined
10
11# ``stack.sh`` calls the entry points in this order:
12#
13# - is_XXXX_enabled
14# - install_XXXX
15# - configure_XXXX
16# - init_XXXX
17# - start_XXXX
18# - stop_XXXX
19# - cleanup_XXXX
20
21# Save trace setting
22XTRACE=$(set +o | grep xtrace)
23set +o xtrace
24
25# Defaults
26# --------
27
28# Set up default directories
29GITDIR["python-neutronclient"]=$DEST/python-neutronclient
30
Kevin Benton66b361b2017-06-13 00:31:01 -070031# NEUTRON_DEPLOY_MOD_WSGI defines how neutron is deployed, allowed values:
32# - False (default) : Run neutron under Eventlet
33# - True : Run neutron under uwsgi
34# TODO(annp): Switching to uwsgi in next cycle if things turn out to be stable
35# enough
Jens Harbott3492fee2018-11-30 13:57:17 +000036NEUTRON_DEPLOY_MOD_WSGI=$(trueorfalse False NEUTRON_DEPLOY_MOD_WSGI)
Sean M. Collins2a242512016-05-03 09:03:09 -040037NEUTRON_AGENT=${NEUTRON_AGENT:-openvswitch}
38NEUTRON_DIR=$DEST/neutron
Ian Wienand1f82f432017-10-04 09:51:02 +110039NEUTRON_AUTH_CACHE_DIR=${NEUTRON_AUTH_CACHE_DIR:-/var/cache/neutron}
Sean M. Collins2a242512016-05-03 09:03:09 -040040
Brian Haley9aaa5292017-09-20 14:23:05 -040041NEUTRON_DISTRIBUTED_ROUTING=$(trueorfalse False NEUTRON_DISTRIBUTED_ROUTING)
42# Distributed Virtual Router (DVR) configuration
43# Can be:
44# - ``legacy`` - No DVR functionality
45# - ``dvr_snat`` - Controller or single node DVR
46# - ``dvr`` - Compute node in multi-node DVR
47# - ``dvr_no_external`` - Compute node in multi-node DVR, no external network
48#
49# Default is 'dvr_snat' since it can handle both DVR and legacy routers
50NEUTRON_DVR_MODE=${NEUTRON_DVR_MODE:-dvr_snat}
51
Sean M. Collins2a242512016-05-03 09:03:09 -040052NEUTRON_BIN_DIR=$(get_python_exec_prefix)
53NEUTRON_DHCP_BINARY="neutron-dhcp-agent"
54
55NEUTRON_CONF_DIR=/etc/neutron
56NEUTRON_CONF=$NEUTRON_CONF_DIR/neutron.conf
57NEUTRON_META_CONF=$NEUTRON_CONF_DIR/metadata_agent.ini
58
59NEUTRON_DHCP_CONF=$NEUTRON_CONF_DIR/dhcp_agent.ini
60NEUTRON_L3_CONF=$NEUTRON_CONF_DIR/l3_agent.ini
61NEUTRON_AGENT_CONF=$NEUTRON_CONF_DIR/
Josh8f721622018-02-01 09:45:47 +020062NEUTRON_CREATE_INITIAL_NETWORKS=${NEUTRON_CREATE_INITIAL_NETWORKS:-True}
Sean M. Collins2a242512016-05-03 09:03:09 -040063
64NEUTRON_STATE_PATH=${NEUTRON_STATE_PATH:=$DATA_DIR/neutron}
Ian Wienand1f82f432017-10-04 09:51:02 +110065NEUTRON_AUTH_CACHE_DIR=${NEUTRON_AUTH_CACHE_DIR:-/var/cache/neutron}
Sean M. Collins2a242512016-05-03 09:03:09 -040066
Kevin Benton66b361b2017-06-13 00:31:01 -070067NEUTRON_UWSGI_CONF=$NEUTRON_CONF_DIR/neutron-api-uwsgi.ini
68
Sean M. Collins2a242512016-05-03 09:03:09 -040069# By default, use the ML2 plugin
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +090070NEUTRON_CORE_PLUGIN=${NEUTRON_CORE_PLUGIN:-ml2}
71NEUTRON_CORE_PLUGIN_CONF_FILENAME=${NEUTRON_CORE_PLUGIN_CONF_FILENAME:-ml2_conf.ini}
72NEUTRON_CORE_PLUGIN_CONF_PATH=$NEUTRON_CONF_DIR/plugins/$NEUTRON_CORE_PLUGIN
73NEUTRON_CORE_PLUGIN_CONF=$NEUTRON_CORE_PLUGIN_CONF_PATH/$NEUTRON_CORE_PLUGIN_CONF_FILENAME
Sean M. Collins2a242512016-05-03 09:03:09 -040074
Ihar Hrachyshkabf697f52017-02-23 12:09:01 +000075NEUTRON_METERING_AGENT_CONF_FILENAME=${NEUTRON_METERING_AGENT_CONF_FILENAME:-metering_agent.ini}
76NEUTRON_METERING_AGENT_CONF=$NEUTRON_CONF_DIR/$NEUTRON_METERING_AGENT_CONF_FILENAME
77
Sean M. Collins2a242512016-05-03 09:03:09 -040078NEUTRON_AGENT_BINARY=${NEUTRON_AGENT_BINARY:-neutron-$NEUTRON_AGENT-agent}
79NEUTRON_L3_BINARY=${NEUTRON_L3_BINARY:-neutron-l3-agent}
80NEUTRON_META_BINARY=${NEUTRON_META_BINARY:-neutron-metadata-agent}
Ihar Hrachyshkabf697f52017-02-23 12:09:01 +000081NEUTRON_METERING_BINARY=${NEUTRON_METERING_BINARY:-neutron-metering-agent}
Sean M. Collins2a242512016-05-03 09:03:09 -040082
83# Public facing bits
Sean Daguef3b2f4c2017-04-13 10:11:48 -040084if is_service_enabled tls-proxy; then
Sean M. Collins2a242512016-05-03 09:03:09 -040085 NEUTRON_SERVICE_PROTOCOL="https"
86fi
87NEUTRON_SERVICE_HOST=${NEUTRON_SERVICE_HOST:-$SERVICE_HOST}
88NEUTRON_SERVICE_PORT=${NEUTRON_SERVICE_PORT:-9696}
89NEUTRON_SERVICE_PORT_INT=${NEUTRON_SERVICE_PORT_INT:-19696}
90NEUTRON_SERVICE_PROTOCOL=${NEUTRON_SERVICE_PROTOCOL:-$SERVICE_PROTOCOL}
91
92NEUTRON_AUTH_STRATEGY=${NEUTRON_AUTH_STRATEGY:-keystone}
93NEUTRON_ROOTWRAP=$(get_rootwrap_location neutron)
94NEUTRON_ROOTWRAP_CONF_FILE=$NEUTRON_CONF_DIR/rootwrap.conf
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +000095NEUTRON_ROOTWRAP_CMD="$NEUTRON_ROOTWRAP $NEUTRON_ROOTWRAP_CONF_FILE"
96NEUTRON_ROOTWRAP_DAEMON_CMD="$NEUTRON_ROOTWRAP-daemon $NEUTRON_ROOTWRAP_CONF_FILE"
Sean M. Collins2a242512016-05-03 09:03:09 -040097
Derek Higginse3e9ea22018-11-09 15:43:13 +000098# This is needed because _neutron_ovs_base_configure_l3_agent will set
99# external_network_bridge
100Q_USE_PROVIDERNET_FOR_PUBLIC=${Q_USE_PROVIDERNET_FOR_PUBLIC:-True}
Ihar Hrachyshka615e1152017-02-23 10:41:51 +0000101# This is needed because _neutron_ovs_base_configure_l3_agent uses it to create
102# an external network bridge
103PUBLIC_BRIDGE=${PUBLIC_BRIDGE:-br-ex}
104PUBLIC_BRIDGE_MTU=${PUBLIC_BRIDGE_MTU:-1500}
105
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900106# Additional neutron api config files
Sean Dagueafef8bf2017-03-06 14:07:23 -0500107declare -a -g _NEUTRON_SERVER_EXTRA_CONF_FILES_ABS
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900108
Sean M. Collins2a242512016-05-03 09:03:09 -0400109# Functions
110# ---------
111
112# Test if any Neutron services are enabled
113# is_neutron_enabled
114function is_neutron_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700115 [[ ,${DISABLED_SERVICES} =~ ,"neutron" ]] && return 1
Sean M. Collins2a242512016-05-03 09:03:09 -0400116 [[ ,${ENABLED_SERVICES} =~ ,"neutron-" || ,${ENABLED_SERVICES} =~ ,"q-" ]] && return 0
117 return 1
118}
119
120# Test if any Neutron services are enabled
121# is_neutron_enabled
122function is_neutron_legacy_enabled {
Clark Boylan902158b2017-05-30 14:11:09 -0700123 [[ ,${DISABLED_SERVICES} =~ ,"neutron" ]] && return 1
Sean M. Collins2a242512016-05-03 09:03:09 -0400124 [[ ,${ENABLED_SERVICES} =~ ,"q-" ]] && return 0
125 return 1
126}
127
YAMAMOTO Takashic74315e2016-07-21 17:49:43 +0900128if is_neutron_legacy_enabled; then
129 source $TOP_DIR/lib/neutron-legacy
130fi
131
Sean M. Collins2a242512016-05-03 09:03:09 -0400132# cleanup_neutron() - Remove residual data files, anything left over from previous
133# runs that a clean run would need to clean up
134function cleanup_neutron_new {
135 source $TOP_DIR/lib/neutron_plugins/${NEUTRON_AGENT}_agent
136 if is_neutron_ovs_base_plugin; then
137 neutron_ovs_base_cleanup
138 fi
139
140 if [[ $NEUTRON_AGENT == "linuxbridge" ]]; then
141 neutron_lb_cleanup
142 fi
143 # delete all namespaces created by neutron
144 for ns in $(sudo ip netns list | grep -o -E '(qdhcp|qrouter|qlbaas|fip|snat)-[0-9a-f-]*'); do
145 sudo ip netns delete ${ns}
146 done
147}
148
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000149# configure_root_helper_options() - Configure agent rootwrap helper options
150function configure_root_helper_options {
151 local conffile=$1
152 iniset $conffile agent root_helper "sudo $NEUTRON_ROOTWRAP_CMD"
153 iniset $conffile agent root_helper_daemon "sudo $NEUTRON_ROOTWRAP_DAEMON_CMD"
154}
155
Sean M. Collins2a242512016-05-03 09:03:09 -0400156# configure_neutron() - Set config files, create data dirs, etc
157function configure_neutron_new {
158 sudo install -d -o $STACK_USER $NEUTRON_CONF_DIR
159
160 (cd $NEUTRON_DIR && exec ./tools/generate_config_file_samples.sh)
161
162 cp $NEUTRON_DIR/etc/neutron.conf.sample $NEUTRON_CONF
163
164 configure_neutron_rootwrap
165
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900166 mkdir -p $NEUTRON_CORE_PLUGIN_CONF_PATH
Sean M. Collins2a242512016-05-03 09:03:09 -0400167
YAMAMOTO Takashi1df17c92017-05-01 17:00:42 +0900168 # NOTE(yamamoto): A decomposed plugin should prepare the config file in
169 # its devstack plugin.
170 if [ -f $NEUTRON_DIR/etc/neutron/plugins/$NEUTRON_CORE_PLUGIN/$NEUTRON_CORE_PLUGIN_CONF_FILENAME.sample ]; then
171 cp $NEUTRON_DIR/etc/neutron/plugins/$NEUTRON_CORE_PLUGIN/$NEUTRON_CORE_PLUGIN_CONF_FILENAME.sample $NEUTRON_CORE_PLUGIN_CONF
172 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400173
174 iniset $NEUTRON_CONF database connection `database_connection_url neutron`
175 iniset $NEUTRON_CONF DEFAULT state_path $NEUTRON_STATE_PATH
176 iniset $NEUTRON_CONF oslo_concurrency lock_path $NEUTRON_STATE_PATH/lock
177 iniset $NEUTRON_CONF DEFAULT use_syslog $SYSLOG
178
Gary Kottond2ef6152016-09-20 04:12:11 -0700179 iniset $NEUTRON_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean M. Collinsfbba3b92016-05-12 11:17:53 -0400180
Sean M. Collins5394cc12016-05-11 15:03:38 -0400181 iniset_rpc_backend neutron $NEUTRON_CONF
182
Sean M. Collins2a242512016-05-03 09:03:09 -0400183 # Neutron API server & Neutron plugin
184 if is_service_enabled neutron-api; then
185 local policy_file=$NEUTRON_CONF_DIR/policy.json
186 cp $NEUTRON_DIR/etc/policy.json $policy_file
187 # Allow neutron user to administer neutron to match neutron account
188 sed -i 's/"context_is_admin": "role:admin"/"context_is_admin": "role:admin or user_name:neutron"/g' $policy_file
189
190 cp $NEUTRON_DIR/etc/api-paste.ini $NEUTRON_CONF_DIR/api-paste.ini
191
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900192 iniset $NEUTRON_CONF DEFAULT core_plugin $NEUTRON_CORE_PLUGIN
Sean M. Collins2a242512016-05-03 09:03:09 -0400193
Sean M. Collins2a242512016-05-03 09:03:09 -0400194 iniset $NEUTRON_CONF DEFAULT policy_file $policy_file
195 iniset $NEUTRON_CONF DEFAULT allow_overlapping_ips True
Brian Haley9aaa5292017-09-20 14:23:05 -0400196 iniset $NEUTRON_CONF DEFAULT router_distributed $NEUTRON_DISTRIBUTED_ROUTING
Sean M. Collins2a242512016-05-03 09:03:09 -0400197
198 iniset $NEUTRON_CONF DEFAULT auth_strategy $NEUTRON_AUTH_STRATEGY
Ian Wienand1f82f432017-10-04 09:51:02 +1100199 configure_auth_token_middleware $NEUTRON_CONF neutron $NEUTRON_AUTH_CACHE_DIR keystone_authtoken
200 configure_auth_token_middleware $NEUTRON_CONF nova $NEUTRON_AUTH_CACHE_DIR nova
Sean M. Collins2a242512016-05-03 09:03:09 -0400201
202 # Configure VXLAN
203 # TODO(sc68cal) not hardcode?
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900204 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 tenant_network_types vxlan
Brian Haley9aaa5292017-09-20 14:23:05 -0400205
206 local mech_drivers="openvswitch"
207 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
208 mech_drivers+=",l2population"
209 else
210 mech_drivers+=",linuxbridge"
211 fi
212 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 mechanism_drivers $mech_drivers
213
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900214 iniset $NEUTRON_CORE_PLUGIN_CONF ml2_type_vxlan vni_ranges 1001:2000
Sean M. Collinsedcb7e52016-12-15 11:29:28 -0500215 iniset $NEUTRON_CORE_PLUGIN_CONF ml2_type_flat flat_networks public
Matt Riedemannc9c9d312016-09-15 20:33:22 -0400216 if [[ "$NEUTRON_PORT_SECURITY" = "True" ]]; then
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000217 neutron_ml2_extension_driver_add port_security
Matt Riedemannc9c9d312016-09-15 20:33:22 -0400218 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400219 fi
220
221 # Neutron OVS or LB agent
222 if is_service_enabled neutron-agent; then
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900223 iniset $NEUTRON_CORE_PLUGIN_CONF agent tunnel_types vxlan
224 iniset $NEUTRON_CORE_PLUGIN_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000225 configure_root_helper_options $NEUTRON_CORE_PLUGIN_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400226
227 # Configure the neutron agent
228 if [[ $NEUTRON_AGENT == "linuxbridge" ]]; then
Sean M. Collinsedcb7e52016-12-15 11:29:28 -0500229 iniset $NEUTRON_CORE_PLUGIN_CONF securitygroup firewall_driver iptables
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900230 iniset $NEUTRON_CORE_PLUGIN_CONF vxlan local_ip $HOST_IP
Jakub Libosvara99ab702018-05-14 16:12:52 +0200231 elif [[ $NEUTRON_AGENT == "openvswitch" ]]; then
232 iniset $NEUTRON_CORE_PLUGIN_CONF securitygroup firewall_driver openvswitch
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900233 iniset $NEUTRON_CORE_PLUGIN_CONF ovs local_ip $HOST_IP
Brian Haley9aaa5292017-09-20 14:23:05 -0400234
235 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
236 iniset $NEUTRON_CORE_PLUGIN_CONF agent l2_population True
237 iniset $NEUTRON_CORE_PLUGIN_CONF agent enable_distributed_routing True
238 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400239 fi
Ihar Hrachyshkab3a210f2016-09-29 13:26:30 +0000240
Denis Buliga0bf75a42017-02-06 16:56:46 +0200241 if ! running_in_container; then
242 enable_kernel_bridge_firewall
243 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400244 fi
245
246 # DHCP Agent
247 if is_service_enabled neutron-dhcp; then
248 cp $NEUTRON_DIR/etc/dhcp_agent.ini.sample $NEUTRON_DHCP_CONF
249
Gary Kottond2ef6152016-09-20 04:12:11 -0700250 iniset $NEUTRON_DHCP_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean Dague78801c12016-08-04 14:10:07 -0400251 # make it so we have working DNS from guests
252 iniset $NEUTRON_DHCP_CONF DEFAULT dnsmasq_local_resolv True
253
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000254 configure_root_helper_options $NEUTRON_DHCP_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400255 iniset $NEUTRON_DHCP_CONF DEFAULT interface_driver $NEUTRON_AGENT
256 neutron_plugin_configure_dhcp_agent $NEUTRON_DHCP_CONF
257 fi
258
259 if is_service_enabled neutron-l3; then
260 cp $NEUTRON_DIR/etc/l3_agent.ini.sample $NEUTRON_L3_CONF
261 iniset $NEUTRON_L3_CONF DEFAULT interface_driver $NEUTRON_AGENT
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900262 neutron_service_plugin_class_add router
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000263 configure_root_helper_options $NEUTRON_L3_CONF
Gary Kottond2ef6152016-09-20 04:12:11 -0700264 iniset $NEUTRON_L3_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean M. Collins2a242512016-05-03 09:03:09 -0400265 neutron_plugin_configure_l3_agent $NEUTRON_L3_CONF
Ihar Hrachyshkae3915932017-02-24 06:24:47 +0000266
267 # Configure the neutron agent to serve external network ports
268 if [[ $NEUTRON_AGENT == "linuxbridge" ]]; then
269 iniset $NEUTRON_CORE_PLUGIN_CONF linux_bridge bridge_mappings "$PUBLIC_NETWORK_NAME:$PUBLIC_BRIDGE"
270 else
271 iniset $NEUTRON_CORE_PLUGIN_CONF ovs bridge_mappings "$PUBLIC_NETWORK_NAME:$PUBLIC_BRIDGE"
272 fi
Brian Haley9aaa5292017-09-20 14:23:05 -0400273
274 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
275 iniset $NEUTRON_L3_CONF DEFAULT agent_mode $NEUTRON_DVR_MODE
276 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400277 fi
278
279 # Metadata
Sean M. Collins1cd28282016-05-11 15:07:19 -0400280 if is_service_enabled neutron-metadata-agent; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400281 cp $NEUTRON_DIR/etc/metadata_agent.ini.sample $NEUTRON_META_CONF
282
Gary Kottond2ef6152016-09-20 04:12:11 -0700283 iniset $NEUTRON_META_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Ken'ichi Ohmichi2da019f2017-10-11 09:57:25 -0700284 iniset $NEUTRON_META_CONF DEFAULT nova_metadata_host $SERVICE_HOST
Armando Migliaccio06f2ea22017-02-02 16:47:00 -0800285 iniset $NEUTRON_META_CONF DEFAULT metadata_workers $API_WORKERS
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000286 # TODO(ihrachys) do we really need to set rootwrap for metadata agent?
287 configure_root_helper_options $NEUTRON_META_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400288
289 # TODO(dtroyer): remove the v2.0 hard code below
Sean Daguec13b8a12017-04-20 06:54:51 -0400290 iniset $NEUTRON_META_CONF DEFAULT auth_url $KEYSTONE_SERVICE_URI
Ian Wienand1f82f432017-10-04 09:51:02 +1100291 configure_auth_token_middleware $NEUTRON_META_CONF neutron $NEUTRON_AUTH_CACHE_DIR DEFAULT
Sean M. Collins2a242512016-05-03 09:03:09 -0400292 fi
293
294 # Format logging
Sean Dague27f66e92017-05-02 09:08:17 -0400295 setup_logging $NEUTRON_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400296
Kevin Benton66b361b2017-06-13 00:31:01 -0700297 if is_service_enabled tls-proxy && [ "$NEUTRON_DEPLOY_MOD_WSGI" == "False" ]; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400298 # Set the service port for a proxy to take the original
299 iniset $NEUTRON_CONF DEFAULT bind_port "$NEUTRON_SERVICE_PORT_INT"
Jens Harbott411c34d2017-08-29 14:40:26 +0000300 iniset $NEUTRON_CONF oslo_middleware enable_proxy_headers_parsing True
Sean M. Collins2a242512016-05-03 09:03:09 -0400301 fi
302
Sean M. Collins8063fee2016-05-24 11:27:36 -0700303 # Metering
304 if is_service_enabled neutron-metering; then
Ihar Hrachyshkabf697f52017-02-23 12:09:01 +0000305 cp $NEUTRON_DIR/etc/metering_agent.ini.sample $NEUTRON_METERING_AGENT_CONF
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900306 neutron_service_plugin_class_add metering
Sean M. Collins8063fee2016-05-24 11:27:36 -0700307 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400308}
309
310# configure_neutron_rootwrap() - configure Neutron's rootwrap
311function configure_neutron_rootwrap {
Sean M. Collins2a242512016-05-03 09:03:09 -0400312 # Deploy new rootwrap filters files (owned by root).
313 # Wipe any existing rootwrap.d files first
314 if [[ -d $NEUTRON_CONF_DIR/rootwrap.d ]]; then
315 sudo rm -rf $NEUTRON_CONF_DIR/rootwrap.d
316 fi
317
318 # Deploy filters to /etc/neutron/rootwrap.d
319 sudo install -d -o root -g root -m 755 $NEUTRON_CONF_DIR/rootwrap.d
320 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/neutron/rootwrap.d/*.filters $NEUTRON_CONF_DIR/rootwrap.d
321
322 # Set up ``rootwrap.conf``, pointing to ``$NEUTRON_CONF_DIR/rootwrap.d``
323 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/rootwrap.conf $NEUTRON_CONF_DIR
324 sudo sed -e "s:^filters_path=.*$:filters_path=$NEUTRON_CONF_DIR/rootwrap.d:" -i $NEUTRON_CONF_DIR/rootwrap.conf
325
326 # Set up the rootwrap sudoers for Neutron
327 tempfile=`mktemp`
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000328 echo "$STACK_USER ALL=(root) NOPASSWD: $NEUTRON_ROOTWRAP_CMD *" >$tempfile
329 echo "$STACK_USER ALL=(root) NOPASSWD: $NEUTRON_ROOTWRAP_DAEMON_CMD" >>$tempfile
Sean M. Collins2a242512016-05-03 09:03:09 -0400330 chmod 0440 $tempfile
331 sudo chown root:root $tempfile
332 sudo mv $tempfile /etc/sudoers.d/neutron-rootwrap
333}
334
335# Make Neutron-required changes to nova.conf
Lucas Alvares Gomese6385932018-06-28 11:00:28 +0100336# Takes a single optional argument which is the config file to update,
337# if not passed $NOVA_CONF is used.
Sean M. Collins2a242512016-05-03 09:03:09 -0400338function configure_neutron_nova_new {
Lucas Alvares Gomese6385932018-06-28 11:00:28 +0100339 local conf=${1:-$NOVA_CONF}
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400340 iniset $conf DEFAULT use_neutron True
341 iniset $conf neutron auth_type "password"
342 iniset $conf neutron auth_url "$KEYSTONE_SERVICE_URI"
343 iniset $conf neutron username neutron
344 iniset $conf neutron password "$SERVICE_PASSWORD"
345 iniset $conf neutron user_domain_name "Default"
346 iniset $conf neutron project_name "$SERVICE_TENANT_NAME"
347 iniset $conf neutron project_domain_name "Default"
348 iniset $conf neutron auth_strategy $NEUTRON_AUTH_STRATEGY
349 iniset $conf neutron region_name "$REGION_NAME"
Sean M. Collins2a242512016-05-03 09:03:09 -0400350
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400351 iniset $conf DEFAULT firewall_driver nova.virt.firewall.NoopFirewallDriver
Sean M. Collins2a242512016-05-03 09:03:09 -0400352
Gary Kotton88f85582016-08-14 06:55:42 -0700353 # optionally set options in nova_conf
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400354 neutron_plugin_create_nova_conf $conf
Gary Kotton88f85582016-08-14 06:55:42 -0700355
Sean M. Collins1cd28282016-05-11 15:07:19 -0400356 if is_service_enabled neutron-metadata-agent; then
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400357 iniset $conf neutron service_metadata_proxy "True"
Sean M. Collins2a242512016-05-03 09:03:09 -0400358 fi
359
360}
361
362# Tenant User Roles
363# ------------------------------------------------------------------
364# service neutron admin # if enabled
365
366# create_neutron_accounts() - Create required service accounts
367function create_neutron_accounts_new {
Kevin Benton66b361b2017-06-13 00:31:01 -0700368 local neutron_url
369
370 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
371 neutron_url=$NEUTRON_SERVICE_PROTOCOL://$NEUTRON_SERVICE_HOST/networking/
372 else
373 neutron_url=$NEUTRON_SERVICE_PROTOCOL://$NEUTRON_SERVICE_HOST:$NEUTRON_SERVICE_PORT/
374 fi
375
376
Sean M. Collins2a242512016-05-03 09:03:09 -0400377 if [[ "$ENABLED_SERVICES" =~ "neutron-api" ]]; then
378
379 create_service_user "neutron"
380
381 neutron_service=$(get_or_create_service "neutron" \
382 "network" "Neutron Service")
383 get_or_create_endpoint $neutron_service \
Kevin Benton66b361b2017-06-13 00:31:01 -0700384 "$REGION_NAME" "$neutron_url"
Sean M. Collins2a242512016-05-03 09:03:09 -0400385 fi
386}
387
Ian Wienand1f82f432017-10-04 09:51:02 +1100388# create_neutron_cache_dir() - Part of the init_neutron() process
389function create_neutron_cache_dir {
390 # Create cache dir
391 sudo install -d -o $STACK_USER $NEUTRON_AUTH_CACHE_DIR
392 rm -f $NEUTRON_AUTH_CACHE_DIR/*
393}
394
Sean M. Collins2a242512016-05-03 09:03:09 -0400395# init_neutron() - Initialize databases, etc.
396function init_neutron_new {
397
398 recreate_database neutron
399
Clark Boylan633dbc32017-06-14 12:09:21 -0700400 time_start "dbsync"
Sean M. Collins2a242512016-05-03 09:03:09 -0400401 # Run Neutron db migrations
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000402 $NEUTRON_BIN_DIR/neutron-db-manage upgrade heads
Clark Boylan633dbc32017-06-14 12:09:21 -0700403 time_stop "dbsync"
Ian Wienand1f82f432017-10-04 09:51:02 +1100404
405 create_neutron_cache_dir
Sean M. Collins2a242512016-05-03 09:03:09 -0400406}
407
408# install_neutron() - Collect source and prepare
409function install_neutron_new {
410 git_clone $NEUTRON_REPO $NEUTRON_DIR $NEUTRON_BRANCH
411 setup_develop $NEUTRON_DIR
412
413 # Install neutron-lib from git so we make sure we're testing
414 # the latest code.
415 if use_library_from_git "neutron-lib"; then
416 git_clone_by_name "neutron-lib"
417 setup_dev_lib "neutron-lib"
418 fi
419
420 # L3 service requires radvd
421 if is_service_enabled neutron-l3; then
422 install_package radvd
423 fi
424
425 if is_service_enabled neutron-agent neutron-dhcp neutron-l3; then
426 #TODO(sc68cal) - kind of ugly
427 source $TOP_DIR/lib/neutron_plugins/${NEUTRON_AGENT}_agent
428 neutron_plugin_install_agent_packages
429 fi
430
431}
432
433# install_neutronclient() - Collect source and prepare
434function install_neutronclient {
435 if use_library_from_git "python-neutronclient"; then
436 git_clone_by_name "python-neutronclient"
437 setup_dev_lib "python-neutronclient"
438 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-neutronclient"]}/tools/,/etc/bash_completion.d/}neutron.bash_completion
439 fi
440}
441
442# start_neutron_api() - Start the API process ahead of other things
443function start_neutron_api {
444 local service_port=$NEUTRON_SERVICE_PORT
445 local service_protocol=$NEUTRON_SERVICE_PROTOCOL
Kevin Benton66b361b2017-06-13 00:31:01 -0700446 local neutron_url
Sean M. Collins2a242512016-05-03 09:03:09 -0400447 if is_service_enabled tls-proxy; then
448 service_port=$NEUTRON_SERVICE_PORT_INT
449 service_protocol="http"
450 fi
451
YAMAMOTO Takashied887d82017-02-22 14:21:33 -0500452 local opts=""
453 opts+=" --config-file $NEUTRON_CONF"
454 opts+=" --config-file $NEUTRON_CORE_PLUGIN_CONF"
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900455 local cfg_file
456 for cfg_file in ${_NEUTRON_SERVER_EXTRA_CONF_FILES_ABS[@]}; do
457 opts+=" --config-file $cfg_file"
458 done
459
Kevin Benton66b361b2017-06-13 00:31:01 -0700460 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
461 run_process neutron-api "$NEUTRON_BIN_DIR/uwsgi --procname-prefix neutron-api --ini $NEUTRON_UWSGI_CONF"
462 neutron_url=$service_protocol://$NEUTRON_SERVICE_HOST/networking/
463 enable_service neutron-rpc-server
464 run_process neutron-rpc-server "$NEUTRON_BIN_DIR/neutron-rpc-server $opts"
465 else
466 # Start the Neutron service
467 # TODO(sc68cal) Stop hard coding this
468 run_process neutron-api "$NEUTRON_BIN_DIR/neutron-server $opts"
469 neutron_url=$service_protocol://$NEUTRON_SERVICE_HOST:$service_port
470 # Start proxy if enabled
471 if is_service_enabled tls-proxy; then
472 start_tls_proxy neutron '*' $NEUTRON_SERVICE_PORT $NEUTRON_SERVICE_HOST $NEUTRON_SERVICE_PORT_INT
473 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400474 fi
475
Kevin Benton66b361b2017-06-13 00:31:01 -0700476 if ! wait_for_service $SERVICE_TIMEOUT $neutron_url; then
477 die $LINENO "neutron-api did not start"
Sean M. Collins2a242512016-05-03 09:03:09 -0400478 fi
479}
480
Sean Dague0eebeb42017-08-30 14:16:58 -0400481# start_neutron() - Start running processes
Sean M. Collins2a242512016-05-03 09:03:09 -0400482function start_neutron_new {
Sean M. Collins2a242512016-05-03 09:03:09 -0400483 # Start up the neutron agents if enabled
484 # TODO(sc68cal) Make this pluggable so different DevStack plugins for different Neutron plugins
485 # can resolve the $NEUTRON_AGENT_BINARY
486 if is_service_enabled neutron-agent; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000487 # TODO(ihrachys) stop loading ml2_conf.ini into agents, instead load agent specific files
488 run_process neutron-agent "$NEUTRON_BIN_DIR/$NEUTRON_AGENT_BINARY --config-file $NEUTRON_CONF --config-file $NEUTRON_CORE_PLUGIN_CONF"
Sean M. Collins2a242512016-05-03 09:03:09 -0400489 fi
490 if is_service_enabled neutron-dhcp; then
491 neutron_plugin_configure_dhcp_agent $NEUTRON_DHCP_CONF
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000492 run_process neutron-dhcp "$NEUTRON_BIN_DIR/$NEUTRON_DHCP_BINARY --config-file $NEUTRON_CONF --config-file $NEUTRON_DHCP_CONF"
Sean M. Collins2a242512016-05-03 09:03:09 -0400493 fi
494 if is_service_enabled neutron-l3; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000495 run_process neutron-l3 "$NEUTRON_BIN_DIR/$NEUTRON_L3_BINARY --config-file $NEUTRON_CONF --config-file $NEUTRON_L3_CONF"
YAMAMOTO Takashic07170a2016-07-20 19:44:05 +0900496 fi
Josh8f721622018-02-01 09:45:47 +0200497 if is_service_enabled neutron-api && [[ "$NEUTRON_CREATE_INITIAL_NETWORKS" == "True" ]]; then
YAMAMOTO Takashi07edde12016-10-19 19:21:00 +0000498 # XXX(sc68cal) - Here's where plugins can wire up their own networks instead
499 # of the code in lib/neutron_plugins/services/l3
500 if type -p neutron_plugin_create_initial_networks > /dev/null; then
501 neutron_plugin_create_initial_networks
502 else
503 # XXX(sc68cal) Load up the built in Neutron networking code and build a topology
504 source $TOP_DIR/lib/neutron_plugins/services/l3
505 # Create the networks using servic
506 create_neutron_initial_network
507 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400508 fi
Sean M. Collins1cd28282016-05-11 15:07:19 -0400509 if is_service_enabled neutron-metadata-agent; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000510 run_process neutron-metadata-agent "$NEUTRON_BIN_DIR/$NEUTRON_META_BINARY --config-file $NEUTRON_CONF --config-file $NEUTRON_META_CONF"
Sean M. Collins2a242512016-05-03 09:03:09 -0400511 fi
Sean M. Collins8063fee2016-05-24 11:27:36 -0700512
513 if is_service_enabled neutron-metering; then
Ihar Hrachyshka868746b2017-09-13 15:44:18 -0600514 run_process neutron-metering "$NEUTRON_BIN_DIR/$NEUTRON_METERING_BINARY --config-file $NEUTRON_CONF --config-file $NEUTRON_METERING_AGENT_CONF"
Sean M. Collins8063fee2016-05-24 11:27:36 -0700515 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400516}
517
Sean Dague0eebeb42017-08-30 14:16:58 -0400518# stop_neutron() - Stop running processes
Sean M. Collins2a242512016-05-03 09:03:09 -0400519function stop_neutron_new {
520 for serv in neutron-api neutron-agent neutron-l3; do
521 stop_process $serv
522 done
523
Kevin Benton66b361b2017-06-13 00:31:01 -0700524 if is_service_enabled neutron-rpc-server; then
525 stop_process neutron-rpc-server
526 fi
527
Sean M. Collins2a242512016-05-03 09:03:09 -0400528 if is_service_enabled neutron-dhcp; then
529 stop_process neutron-dhcp
530 pid=$(ps aux | awk '/[d]nsmasq.+interface=(tap|ns-)/ { print $2 }')
531 [ ! -z "$pid" ] && sudo kill -9 $pid
532 fi
533
Sean M. Collins1cd28282016-05-11 15:07:19 -0400534 if is_service_enabled neutron-metadata-agent; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400535 sudo pkill -9 -f neutron-ns-metadata-proxy || :
Sean M. Collins1cd28282016-05-11 15:07:19 -0400536 stop_process neutron-metadata-agent
Sean M. Collins2a242512016-05-03 09:03:09 -0400537 fi
538}
539
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900540# neutron_service_plugin_class_add() - add service plugin class
541function neutron_service_plugin_class_add_new {
542 local service_plugin_class=$1
543 local plugins=""
544
545 plugins=$(iniget $NEUTRON_CONF DEFAULT service_plugins)
YAMAMOTO Takashi84e45c92017-02-22 14:25:14 -0500546 if [ $plugins ]; then
547 plugins+=","
548 fi
549 plugins+="${service_plugin_class}"
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900550 iniset $NEUTRON_CONF DEFAULT service_plugins $plugins
551}
552
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000553function _neutron_ml2_extension_driver_add {
554 local driver=$1
555 local drivers=""
556
557 drivers=$(iniget $NEUTRON_CORE_PLUGIN_CONF ml2 extension_drivers)
558 if [ $drivers ]; then
559 drivers+=","
560 fi
561 drivers+="${driver}"
562 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 extension_drivers $drivers
563}
564
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900565function neutron_server_config_add_new {
566 _NEUTRON_SERVER_EXTRA_CONF_FILES_ABS+=($1)
567}
568
YAMAMOTO Takashic043b6f2017-02-23 22:30:08 -0500569# neutron_deploy_rootwrap_filters() - deploy rootwrap filters
570function neutron_deploy_rootwrap_filters_new {
571 local srcdir=$1
572 sudo install -d -o root -g root -m 755 $NEUTRON_CONF_DIR/rootwrap.d
573 sudo install -o root -g root -m 644 $srcdir/etc/neutron/rootwrap.d/*.filters $NEUTRON_CONF_DIR/rootwrap.d
574}
575
Sean M. Collins2a242512016-05-03 09:03:09 -0400576# Dispatch functions
577# These are needed for compatibility between the old and new implementations
578# where there are function name overlaps. These will be removed when
579# neutron-legacy is removed.
580# TODO(sc68cal) Remove when neutron-legacy is no more.
581function cleanup_neutron {
Kevin Benton66b361b2017-06-13 00:31:01 -0700582 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
583 stop_process neutron-api
584 stop_process neutron-rpc-server
585 remove_uwsgi_config "$NEUTRON_UWSGI_CONF" "$NEUTRON_BIN_DIR/neutron-api"
586 sudo rm -f $(apache_site_config_for neutron-api)
587 fi
588
Sean M. Collins2a242512016-05-03 09:03:09 -0400589 if is_neutron_legacy_enabled; then
590 # Call back to old function
591 cleanup_mutnauq "$@"
592 else
593 cleanup_neutron_new "$@"
594 fi
595}
596
597function configure_neutron {
598 if is_neutron_legacy_enabled; then
599 # Call back to old function
600 configure_mutnauq "$@"
601 else
602 configure_neutron_new "$@"
603 fi
Kevin Benton66b361b2017-06-13 00:31:01 -0700604
605 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
606 write_uwsgi_config "$NEUTRON_UWSGI_CONF" "$NEUTRON_BIN_DIR/neutron-api" "/networking"
607 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400608}
609
610function configure_neutron_nova {
611 if is_neutron_legacy_enabled; then
612 # Call back to old function
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400613 create_nova_conf_neutron $NOVA_CONF
614 if [[ "${CELLSV2_SETUP}" == "superconductor" ]]; then
615 for i in $(seq 1 $NOVA_NUM_CELLS); do
616 local conf
617 conf=$(conductor_conf $i)
618 create_nova_conf_neutron $conf
619 done
620 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400621 else
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400622 configure_neutron_nova_new $NOVA_CONF
623 if [[ "${CELLSV2_SETUP}" == "superconductor" ]]; then
624 for i in $(seq 1 $NOVA_NUM_CELLS); do
625 local conf
626 conf=$(conductor_conf $i)
627 configure_neutron_nova_new $conf
628 done
629 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400630 fi
631}
632
633function create_neutron_accounts {
634 if is_neutron_legacy_enabled; then
635 # Call back to old function
636 create_mutnauq_accounts "$@"
637 else
638 create_neutron_accounts_new "$@"
639 fi
640}
641
642function init_neutron {
643 if is_neutron_legacy_enabled; then
644 # Call back to old function
645 init_mutnauq "$@"
646 else
647 init_neutron_new "$@"
648 fi
649}
650
651function install_neutron {
652 if is_neutron_legacy_enabled; then
653 # Call back to old function
654 install_mutnauq "$@"
655 else
656 install_neutron_new "$@"
657 fi
658}
659
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900660function neutron_service_plugin_class_add {
661 if is_neutron_legacy_enabled; then
662 # Call back to old function
663 _neutron_service_plugin_class_add "$@"
664 else
665 neutron_service_plugin_class_add_new "$@"
666 fi
667}
668
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000669function neutron_ml2_extension_driver_add {
670 if is_neutron_legacy_enabled; then
671 # Call back to old function
672 _neutron_ml2_extension_driver_add_old "$@"
673 else
674 _neutron_ml2_extension_driver_add "$@"
675 fi
676}
677
YAMAMOTO Takashic74315e2016-07-21 17:49:43 +0900678function install_neutron_agent_packages {
679 if is_neutron_legacy_enabled; then
680 # Call back to old function
681 install_neutron_agent_packages_mutnauq "$@"
682 else
683 :
684 fi
685}
686
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900687function neutron_server_config_add {
688 if is_neutron_legacy_enabled; then
689 # Call back to old function
690 mutnauq_server_config_add "$@"
691 else
692 neutron_server_config_add_new "$@"
693 fi
694}
695
Sean M. Collins2a242512016-05-03 09:03:09 -0400696function start_neutron {
697 if is_neutron_legacy_enabled; then
698 # Call back to old function
699 start_mutnauq_l2_agent "$@"
700 start_mutnauq_other_agents "$@"
701 else
702 start_neutron_new "$@"
703 fi
704}
705
706function stop_neutron {
707 if is_neutron_legacy_enabled; then
708 # Call back to old function
709 stop_mutnauq "$@"
710 else
711 stop_neutron_new "$@"
712 fi
713}
714
YAMAMOTO Takashic043b6f2017-02-23 22:30:08 -0500715function neutron_deploy_rootwrap_filters {
716 if is_neutron_legacy_enabled; then
717 # Call back to old function
718 _neutron_deploy_rootwrap_filters "$@"
719 else
720 neutron_deploy_rootwrap_filters_new "$@"
721 fi
722}
723
Sean M. Collins2a242512016-05-03 09:03:09 -0400724# Restore xtrace
725$XTRACE