blob: 62f7366e7e697c789803557c02dc4aff421d689f [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
36NEUTRON_DEPLOY_MOD_WSGI=${NEUTRON_DEPLOY_MOD_WSGI:-False}
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
Sean M. Collins2a242512016-05-03 09:03:09 -0400186 # Allow neutron user to administer neutron to match neutron account
Akihiro Motoki80769c52018-11-23 05:18:40 +0900187 # NOTE(amotoki): This is required for nova works correctly with neutron.
188 if [ -f $NEUTRON_DIR/etc/policy.json ]; then
189 cp $NEUTRON_DIR/etc/policy.json $policy_file
190 sed -i 's/"context_is_admin": "role:admin"/"context_is_admin": "role:admin or user_name:neutron"/g' $policy_file
191 else
192 echo '{"context_is_admin": "role:admin or user_name:neutron"}' > $policy_file
193 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400194
195 cp $NEUTRON_DIR/etc/api-paste.ini $NEUTRON_CONF_DIR/api-paste.ini
196
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900197 iniset $NEUTRON_CONF DEFAULT core_plugin $NEUTRON_CORE_PLUGIN
Sean M. Collins2a242512016-05-03 09:03:09 -0400198
Sean M. Collins2a242512016-05-03 09:03:09 -0400199 iniset $NEUTRON_CONF DEFAULT policy_file $policy_file
200 iniset $NEUTRON_CONF DEFAULT allow_overlapping_ips True
Brian Haley9aaa5292017-09-20 14:23:05 -0400201 iniset $NEUTRON_CONF DEFAULT router_distributed $NEUTRON_DISTRIBUTED_ROUTING
Sean M. Collins2a242512016-05-03 09:03:09 -0400202
203 iniset $NEUTRON_CONF DEFAULT auth_strategy $NEUTRON_AUTH_STRATEGY
Ian Wienand1f82f432017-10-04 09:51:02 +1100204 configure_auth_token_middleware $NEUTRON_CONF neutron $NEUTRON_AUTH_CACHE_DIR keystone_authtoken
205 configure_auth_token_middleware $NEUTRON_CONF nova $NEUTRON_AUTH_CACHE_DIR nova
Sean M. Collins2a242512016-05-03 09:03:09 -0400206
207 # Configure VXLAN
208 # TODO(sc68cal) not hardcode?
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900209 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 tenant_network_types vxlan
Brian Haley9aaa5292017-09-20 14:23:05 -0400210
211 local mech_drivers="openvswitch"
212 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
213 mech_drivers+=",l2population"
214 else
215 mech_drivers+=",linuxbridge"
216 fi
217 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 mechanism_drivers $mech_drivers
218
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900219 iniset $NEUTRON_CORE_PLUGIN_CONF ml2_type_vxlan vni_ranges 1001:2000
Sean M. Collinsedcb7e52016-12-15 11:29:28 -0500220 iniset $NEUTRON_CORE_PLUGIN_CONF ml2_type_flat flat_networks public
Matt Riedemannc9c9d312016-09-15 20:33:22 -0400221 if [[ "$NEUTRON_PORT_SECURITY" = "True" ]]; then
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000222 neutron_ml2_extension_driver_add port_security
Matt Riedemannc9c9d312016-09-15 20:33:22 -0400223 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400224 fi
225
226 # Neutron OVS or LB agent
227 if is_service_enabled neutron-agent; then
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900228 iniset $NEUTRON_CORE_PLUGIN_CONF agent tunnel_types vxlan
229 iniset $NEUTRON_CORE_PLUGIN_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000230 configure_root_helper_options $NEUTRON_CORE_PLUGIN_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400231
232 # Configure the neutron agent
233 if [[ $NEUTRON_AGENT == "linuxbridge" ]]; then
Sean M. Collinsedcb7e52016-12-15 11:29:28 -0500234 iniset $NEUTRON_CORE_PLUGIN_CONF securitygroup firewall_driver iptables
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900235 iniset $NEUTRON_CORE_PLUGIN_CONF vxlan local_ip $HOST_IP
Jakub Libosvara99ab702018-05-14 16:12:52 +0200236 elif [[ $NEUTRON_AGENT == "openvswitch" ]]; then
237 iniset $NEUTRON_CORE_PLUGIN_CONF securitygroup firewall_driver openvswitch
YAMAMOTO Takashi4a55d2a2016-08-24 15:30:09 +0900238 iniset $NEUTRON_CORE_PLUGIN_CONF ovs local_ip $HOST_IP
Brian Haley9aaa5292017-09-20 14:23:05 -0400239
240 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
241 iniset $NEUTRON_CORE_PLUGIN_CONF agent l2_population True
242 iniset $NEUTRON_CORE_PLUGIN_CONF agent enable_distributed_routing True
243 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400244 fi
Ihar Hrachyshkab3a210f2016-09-29 13:26:30 +0000245
Denis Buliga0bf75a42017-02-06 16:56:46 +0200246 if ! running_in_container; then
247 enable_kernel_bridge_firewall
248 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400249 fi
250
251 # DHCP Agent
252 if is_service_enabled neutron-dhcp; then
253 cp $NEUTRON_DIR/etc/dhcp_agent.ini.sample $NEUTRON_DHCP_CONF
254
Gary Kottond2ef6152016-09-20 04:12:11 -0700255 iniset $NEUTRON_DHCP_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean Dague78801c12016-08-04 14:10:07 -0400256 # make it so we have working DNS from guests
257 iniset $NEUTRON_DHCP_CONF DEFAULT dnsmasq_local_resolv True
258
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000259 configure_root_helper_options $NEUTRON_DHCP_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400260 iniset $NEUTRON_DHCP_CONF DEFAULT interface_driver $NEUTRON_AGENT
261 neutron_plugin_configure_dhcp_agent $NEUTRON_DHCP_CONF
262 fi
263
264 if is_service_enabled neutron-l3; then
265 cp $NEUTRON_DIR/etc/l3_agent.ini.sample $NEUTRON_L3_CONF
266 iniset $NEUTRON_L3_CONF DEFAULT interface_driver $NEUTRON_AGENT
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900267 neutron_service_plugin_class_add router
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000268 configure_root_helper_options $NEUTRON_L3_CONF
Gary Kottond2ef6152016-09-20 04:12:11 -0700269 iniset $NEUTRON_L3_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Sean M. Collins2a242512016-05-03 09:03:09 -0400270 neutron_plugin_configure_l3_agent $NEUTRON_L3_CONF
Ihar Hrachyshkae3915932017-02-24 06:24:47 +0000271
272 # Configure the neutron agent to serve external network ports
273 if [[ $NEUTRON_AGENT == "linuxbridge" ]]; then
274 iniset $NEUTRON_CORE_PLUGIN_CONF linux_bridge bridge_mappings "$PUBLIC_NETWORK_NAME:$PUBLIC_BRIDGE"
275 else
276 iniset $NEUTRON_CORE_PLUGIN_CONF ovs bridge_mappings "$PUBLIC_NETWORK_NAME:$PUBLIC_BRIDGE"
277 fi
Brian Haley9aaa5292017-09-20 14:23:05 -0400278
279 if [[ "$NEUTRON_DISTRIBUTED_ROUTING" = "True" ]]; then
280 iniset $NEUTRON_L3_CONF DEFAULT agent_mode $NEUTRON_DVR_MODE
281 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400282 fi
283
284 # Metadata
Sean M. Collins1cd28282016-05-11 15:07:19 -0400285 if is_service_enabled neutron-metadata-agent; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400286 cp $NEUTRON_DIR/etc/metadata_agent.ini.sample $NEUTRON_META_CONF
287
Gary Kottond2ef6152016-09-20 04:12:11 -0700288 iniset $NEUTRON_META_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Ken'ichi Ohmichi2da019f2017-10-11 09:57:25 -0700289 iniset $NEUTRON_META_CONF DEFAULT nova_metadata_host $SERVICE_HOST
Armando Migliaccio06f2ea22017-02-02 16:47:00 -0800290 iniset $NEUTRON_META_CONF DEFAULT metadata_workers $API_WORKERS
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000291 # TODO(ihrachys) do we really need to set rootwrap for metadata agent?
292 configure_root_helper_options $NEUTRON_META_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400293
294 # TODO(dtroyer): remove the v2.0 hard code below
Sean Daguec13b8a12017-04-20 06:54:51 -0400295 iniset $NEUTRON_META_CONF DEFAULT auth_url $KEYSTONE_SERVICE_URI
Ian Wienand1f82f432017-10-04 09:51:02 +1100296 configure_auth_token_middleware $NEUTRON_META_CONF neutron $NEUTRON_AUTH_CACHE_DIR DEFAULT
Sean M. Collins2a242512016-05-03 09:03:09 -0400297 fi
298
299 # Format logging
Sean Dague27f66e92017-05-02 09:08:17 -0400300 setup_logging $NEUTRON_CONF
Sean M. Collins2a242512016-05-03 09:03:09 -0400301
Kevin Benton66b361b2017-06-13 00:31:01 -0700302 if is_service_enabled tls-proxy && [ "$NEUTRON_DEPLOY_MOD_WSGI" == "False" ]; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400303 # Set the service port for a proxy to take the original
304 iniset $NEUTRON_CONF DEFAULT bind_port "$NEUTRON_SERVICE_PORT_INT"
Jens Harbott411c34d2017-08-29 14:40:26 +0000305 iniset $NEUTRON_CONF oslo_middleware enable_proxy_headers_parsing True
Sean M. Collins2a242512016-05-03 09:03:09 -0400306 fi
307
Sean M. Collins8063fee2016-05-24 11:27:36 -0700308 # Metering
309 if is_service_enabled neutron-metering; then
Ihar Hrachyshkabf697f52017-02-23 12:09:01 +0000310 cp $NEUTRON_DIR/etc/metering_agent.ini.sample $NEUTRON_METERING_AGENT_CONF
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900311 neutron_service_plugin_class_add metering
Sean M. Collins8063fee2016-05-24 11:27:36 -0700312 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400313}
314
315# configure_neutron_rootwrap() - configure Neutron's rootwrap
316function configure_neutron_rootwrap {
Sean M. Collins2a242512016-05-03 09:03:09 -0400317 # Deploy new rootwrap filters files (owned by root).
318 # Wipe any existing rootwrap.d files first
319 if [[ -d $NEUTRON_CONF_DIR/rootwrap.d ]]; then
320 sudo rm -rf $NEUTRON_CONF_DIR/rootwrap.d
321 fi
322
323 # Deploy filters to /etc/neutron/rootwrap.d
324 sudo install -d -o root -g root -m 755 $NEUTRON_CONF_DIR/rootwrap.d
325 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/neutron/rootwrap.d/*.filters $NEUTRON_CONF_DIR/rootwrap.d
326
327 # Set up ``rootwrap.conf``, pointing to ``$NEUTRON_CONF_DIR/rootwrap.d``
328 sudo install -o root -g root -m 644 $NEUTRON_DIR/etc/rootwrap.conf $NEUTRON_CONF_DIR
329 sudo sed -e "s:^filters_path=.*$:filters_path=$NEUTRON_CONF_DIR/rootwrap.d:" -i $NEUTRON_CONF_DIR/rootwrap.conf
330
331 # Set up the rootwrap sudoers for Neutron
332 tempfile=`mktemp`
Ihar Hrachyshkae65ab4a2017-02-24 17:47:55 +0000333 echo "$STACK_USER ALL=(root) NOPASSWD: $NEUTRON_ROOTWRAP_CMD *" >$tempfile
334 echo "$STACK_USER ALL=(root) NOPASSWD: $NEUTRON_ROOTWRAP_DAEMON_CMD" >>$tempfile
Sean M. Collins2a242512016-05-03 09:03:09 -0400335 chmod 0440 $tempfile
336 sudo chown root:root $tempfile
337 sudo mv $tempfile /etc/sudoers.d/neutron-rootwrap
338}
339
340# Make Neutron-required changes to nova.conf
Lucas Alvares Gomese6385932018-06-28 11:00:28 +0100341# Takes a single optional argument which is the config file to update,
342# if not passed $NOVA_CONF is used.
Sean M. Collins2a242512016-05-03 09:03:09 -0400343function configure_neutron_nova_new {
Lucas Alvares Gomese6385932018-06-28 11:00:28 +0100344 local conf=${1:-$NOVA_CONF}
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400345 iniset $conf DEFAULT use_neutron True
346 iniset $conf neutron auth_type "password"
347 iniset $conf neutron auth_url "$KEYSTONE_SERVICE_URI"
348 iniset $conf neutron username neutron
349 iniset $conf neutron password "$SERVICE_PASSWORD"
350 iniset $conf neutron user_domain_name "Default"
351 iniset $conf neutron project_name "$SERVICE_TENANT_NAME"
352 iniset $conf neutron project_domain_name "Default"
353 iniset $conf neutron auth_strategy $NEUTRON_AUTH_STRATEGY
354 iniset $conf neutron region_name "$REGION_NAME"
Sean M. Collins2a242512016-05-03 09:03:09 -0400355
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400356 iniset $conf DEFAULT firewall_driver nova.virt.firewall.NoopFirewallDriver
Sean M. Collins2a242512016-05-03 09:03:09 -0400357
Gary Kotton88f85582016-08-14 06:55:42 -0700358 # optionally set options in nova_conf
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400359 neutron_plugin_create_nova_conf $conf
Gary Kotton88f85582016-08-14 06:55:42 -0700360
Sean M. Collins1cd28282016-05-11 15:07:19 -0400361 if is_service_enabled neutron-metadata-agent; then
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400362 iniset $conf neutron service_metadata_proxy "True"
Sean M. Collins2a242512016-05-03 09:03:09 -0400363 fi
364
365}
366
367# Tenant User Roles
368# ------------------------------------------------------------------
369# service neutron admin # if enabled
370
371# create_neutron_accounts() - Create required service accounts
372function create_neutron_accounts_new {
Kevin Benton66b361b2017-06-13 00:31:01 -0700373 local neutron_url
374
375 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
376 neutron_url=$NEUTRON_SERVICE_PROTOCOL://$NEUTRON_SERVICE_HOST/networking/
377 else
378 neutron_url=$NEUTRON_SERVICE_PROTOCOL://$NEUTRON_SERVICE_HOST:$NEUTRON_SERVICE_PORT/
379 fi
380
381
Sean M. Collins2a242512016-05-03 09:03:09 -0400382 if [[ "$ENABLED_SERVICES" =~ "neutron-api" ]]; then
383
384 create_service_user "neutron"
385
386 neutron_service=$(get_or_create_service "neutron" \
387 "network" "Neutron Service")
388 get_or_create_endpoint $neutron_service \
Kevin Benton66b361b2017-06-13 00:31:01 -0700389 "$REGION_NAME" "$neutron_url"
Sean M. Collins2a242512016-05-03 09:03:09 -0400390 fi
391}
392
Ian Wienand1f82f432017-10-04 09:51:02 +1100393# create_neutron_cache_dir() - Part of the init_neutron() process
394function create_neutron_cache_dir {
395 # Create cache dir
396 sudo install -d -o $STACK_USER $NEUTRON_AUTH_CACHE_DIR
397 rm -f $NEUTRON_AUTH_CACHE_DIR/*
398}
399
Sean M. Collins2a242512016-05-03 09:03:09 -0400400# init_neutron() - Initialize databases, etc.
401function init_neutron_new {
402
403 recreate_database neutron
404
Clark Boylan633dbc32017-06-14 12:09:21 -0700405 time_start "dbsync"
Sean M. Collins2a242512016-05-03 09:03:09 -0400406 # Run Neutron db migrations
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000407 $NEUTRON_BIN_DIR/neutron-db-manage upgrade heads
Clark Boylan633dbc32017-06-14 12:09:21 -0700408 time_stop "dbsync"
Ian Wienand1f82f432017-10-04 09:51:02 +1100409
410 create_neutron_cache_dir
Sean M. Collins2a242512016-05-03 09:03:09 -0400411}
412
413# install_neutron() - Collect source and prepare
414function install_neutron_new {
415 git_clone $NEUTRON_REPO $NEUTRON_DIR $NEUTRON_BRANCH
416 setup_develop $NEUTRON_DIR
417
418 # Install neutron-lib from git so we make sure we're testing
419 # the latest code.
420 if use_library_from_git "neutron-lib"; then
421 git_clone_by_name "neutron-lib"
422 setup_dev_lib "neutron-lib"
423 fi
424
425 # L3 service requires radvd
426 if is_service_enabled neutron-l3; then
427 install_package radvd
428 fi
429
430 if is_service_enabled neutron-agent neutron-dhcp neutron-l3; then
431 #TODO(sc68cal) - kind of ugly
432 source $TOP_DIR/lib/neutron_plugins/${NEUTRON_AGENT}_agent
433 neutron_plugin_install_agent_packages
434 fi
435
436}
437
438# install_neutronclient() - Collect source and prepare
439function install_neutronclient {
440 if use_library_from_git "python-neutronclient"; then
441 git_clone_by_name "python-neutronclient"
442 setup_dev_lib "python-neutronclient"
443 sudo install -D -m 0644 -o $STACK_USER {${GITDIR["python-neutronclient"]}/tools/,/etc/bash_completion.d/}neutron.bash_completion
444 fi
445}
446
447# start_neutron_api() - Start the API process ahead of other things
448function start_neutron_api {
449 local service_port=$NEUTRON_SERVICE_PORT
450 local service_protocol=$NEUTRON_SERVICE_PROTOCOL
Kevin Benton66b361b2017-06-13 00:31:01 -0700451 local neutron_url
Sean M. Collins2a242512016-05-03 09:03:09 -0400452 if is_service_enabled tls-proxy; then
453 service_port=$NEUTRON_SERVICE_PORT_INT
454 service_protocol="http"
455 fi
456
YAMAMOTO Takashied887d82017-02-22 14:21:33 -0500457 local opts=""
458 opts+=" --config-file $NEUTRON_CONF"
459 opts+=" --config-file $NEUTRON_CORE_PLUGIN_CONF"
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900460 local cfg_file
461 for cfg_file in ${_NEUTRON_SERVER_EXTRA_CONF_FILES_ABS[@]}; do
462 opts+=" --config-file $cfg_file"
463 done
464
Kevin Benton66b361b2017-06-13 00:31:01 -0700465 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
466 run_process neutron-api "$NEUTRON_BIN_DIR/uwsgi --procname-prefix neutron-api --ini $NEUTRON_UWSGI_CONF"
467 neutron_url=$service_protocol://$NEUTRON_SERVICE_HOST/networking/
468 enable_service neutron-rpc-server
469 run_process neutron-rpc-server "$NEUTRON_BIN_DIR/neutron-rpc-server $opts"
470 else
471 # Start the Neutron service
472 # TODO(sc68cal) Stop hard coding this
473 run_process neutron-api "$NEUTRON_BIN_DIR/neutron-server $opts"
474 neutron_url=$service_protocol://$NEUTRON_SERVICE_HOST:$service_port
475 # Start proxy if enabled
476 if is_service_enabled tls-proxy; then
477 start_tls_proxy neutron '*' $NEUTRON_SERVICE_PORT $NEUTRON_SERVICE_HOST $NEUTRON_SERVICE_PORT_INT
478 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400479 fi
480
Kevin Benton66b361b2017-06-13 00:31:01 -0700481 if ! wait_for_service $SERVICE_TIMEOUT $neutron_url; then
482 die $LINENO "neutron-api did not start"
Sean M. Collins2a242512016-05-03 09:03:09 -0400483 fi
484}
485
Sean Dague0eebeb42017-08-30 14:16:58 -0400486# start_neutron() - Start running processes
Sean M. Collins2a242512016-05-03 09:03:09 -0400487function start_neutron_new {
Sean M. Collins2a242512016-05-03 09:03:09 -0400488 # Start up the neutron agents if enabled
489 # TODO(sc68cal) Make this pluggable so different DevStack plugins for different Neutron plugins
490 # can resolve the $NEUTRON_AGENT_BINARY
491 if is_service_enabled neutron-agent; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000492 # TODO(ihrachys) stop loading ml2_conf.ini into agents, instead load agent specific files
493 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 -0400494 fi
495 if is_service_enabled neutron-dhcp; then
496 neutron_plugin_configure_dhcp_agent $NEUTRON_DHCP_CONF
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000497 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 -0400498 fi
499 if is_service_enabled neutron-l3; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000500 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 +0900501 fi
Josh8f721622018-02-01 09:45:47 +0200502 if is_service_enabled neutron-api && [[ "$NEUTRON_CREATE_INITIAL_NETWORKS" == "True" ]]; then
YAMAMOTO Takashi07edde12016-10-19 19:21:00 +0000503 # XXX(sc68cal) - Here's where plugins can wire up their own networks instead
504 # of the code in lib/neutron_plugins/services/l3
505 if type -p neutron_plugin_create_initial_networks > /dev/null; then
506 neutron_plugin_create_initial_networks
507 else
508 # XXX(sc68cal) Load up the built in Neutron networking code and build a topology
509 source $TOP_DIR/lib/neutron_plugins/services/l3
510 # Create the networks using servic
511 create_neutron_initial_network
512 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400513 fi
Sean M. Collins1cd28282016-05-11 15:07:19 -0400514 if is_service_enabled neutron-metadata-agent; then
Ihar Hrachyshka19f4b3f2017-02-23 20:44:18 +0000515 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 -0400516 fi
Sean M. Collins8063fee2016-05-24 11:27:36 -0700517
518 if is_service_enabled neutron-metering; then
Ihar Hrachyshka868746b2017-09-13 15:44:18 -0600519 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 -0700520 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400521}
522
Sean Dague0eebeb42017-08-30 14:16:58 -0400523# stop_neutron() - Stop running processes
Sean M. Collins2a242512016-05-03 09:03:09 -0400524function stop_neutron_new {
525 for serv in neutron-api neutron-agent neutron-l3; do
526 stop_process $serv
527 done
528
Kevin Benton66b361b2017-06-13 00:31:01 -0700529 if is_service_enabled neutron-rpc-server; then
530 stop_process neutron-rpc-server
531 fi
532
Sean M. Collins2a242512016-05-03 09:03:09 -0400533 if is_service_enabled neutron-dhcp; then
534 stop_process neutron-dhcp
535 pid=$(ps aux | awk '/[d]nsmasq.+interface=(tap|ns-)/ { print $2 }')
536 [ ! -z "$pid" ] && sudo kill -9 $pid
537 fi
538
Sean M. Collins1cd28282016-05-11 15:07:19 -0400539 if is_service_enabled neutron-metadata-agent; then
Sean M. Collins2a242512016-05-03 09:03:09 -0400540 sudo pkill -9 -f neutron-ns-metadata-proxy || :
Sean M. Collins1cd28282016-05-11 15:07:19 -0400541 stop_process neutron-metadata-agent
Sean M. Collins2a242512016-05-03 09:03:09 -0400542 fi
543}
544
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900545# neutron_service_plugin_class_add() - add service plugin class
546function neutron_service_plugin_class_add_new {
547 local service_plugin_class=$1
548 local plugins=""
549
550 plugins=$(iniget $NEUTRON_CONF DEFAULT service_plugins)
YAMAMOTO Takashi84e45c92017-02-22 14:25:14 -0500551 if [ $plugins ]; then
552 plugins+=","
553 fi
554 plugins+="${service_plugin_class}"
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900555 iniset $NEUTRON_CONF DEFAULT service_plugins $plugins
556}
557
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000558function _neutron_ml2_extension_driver_add {
559 local driver=$1
560 local drivers=""
561
562 drivers=$(iniget $NEUTRON_CORE_PLUGIN_CONF ml2 extension_drivers)
563 if [ $drivers ]; then
564 drivers+=","
565 fi
566 drivers+="${driver}"
567 iniset $NEUTRON_CORE_PLUGIN_CONF ml2 extension_drivers $drivers
568}
569
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900570function neutron_server_config_add_new {
571 _NEUTRON_SERVER_EXTRA_CONF_FILES_ABS+=($1)
572}
573
YAMAMOTO Takashic043b6f2017-02-23 22:30:08 -0500574# neutron_deploy_rootwrap_filters() - deploy rootwrap filters
575function neutron_deploy_rootwrap_filters_new {
576 local srcdir=$1
577 sudo install -d -o root -g root -m 755 $NEUTRON_CONF_DIR/rootwrap.d
578 sudo install -o root -g root -m 644 $srcdir/etc/neutron/rootwrap.d/*.filters $NEUTRON_CONF_DIR/rootwrap.d
579}
580
Sean M. Collins2a242512016-05-03 09:03:09 -0400581# Dispatch functions
582# These are needed for compatibility between the old and new implementations
583# where there are function name overlaps. These will be removed when
584# neutron-legacy is removed.
585# TODO(sc68cal) Remove when neutron-legacy is no more.
586function cleanup_neutron {
Kevin Benton66b361b2017-06-13 00:31:01 -0700587 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
588 stop_process neutron-api
589 stop_process neutron-rpc-server
590 remove_uwsgi_config "$NEUTRON_UWSGI_CONF" "$NEUTRON_BIN_DIR/neutron-api"
591 sudo rm -f $(apache_site_config_for neutron-api)
592 fi
593
Sean M. Collins2a242512016-05-03 09:03:09 -0400594 if is_neutron_legacy_enabled; then
595 # Call back to old function
596 cleanup_mutnauq "$@"
597 else
598 cleanup_neutron_new "$@"
599 fi
600}
601
602function configure_neutron {
603 if is_neutron_legacy_enabled; then
604 # Call back to old function
605 configure_mutnauq "$@"
606 else
607 configure_neutron_new "$@"
608 fi
Kevin Benton66b361b2017-06-13 00:31:01 -0700609
610 if [ "$NEUTRON_DEPLOY_MOD_WSGI" == "True" ]; then
611 write_uwsgi_config "$NEUTRON_UWSGI_CONF" "$NEUTRON_BIN_DIR/neutron-api" "/networking"
612 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400613}
614
615function configure_neutron_nova {
616 if is_neutron_legacy_enabled; then
617 # Call back to old function
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400618 create_nova_conf_neutron $NOVA_CONF
619 if [[ "${CELLSV2_SETUP}" == "superconductor" ]]; then
620 for i in $(seq 1 $NOVA_NUM_CELLS); do
621 local conf
622 conf=$(conductor_conf $i)
623 create_nova_conf_neutron $conf
624 done
625 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400626 else
Matt Riedemanne95f2a32018-06-18 16:17:29 -0400627 configure_neutron_nova_new $NOVA_CONF
628 if [[ "${CELLSV2_SETUP}" == "superconductor" ]]; then
629 for i in $(seq 1 $NOVA_NUM_CELLS); do
630 local conf
631 conf=$(conductor_conf $i)
632 configure_neutron_nova_new $conf
633 done
634 fi
Sean M. Collins2a242512016-05-03 09:03:09 -0400635 fi
636}
637
638function create_neutron_accounts {
639 if is_neutron_legacy_enabled; then
640 # Call back to old function
641 create_mutnauq_accounts "$@"
642 else
643 create_neutron_accounts_new "$@"
644 fi
645}
646
647function init_neutron {
648 if is_neutron_legacy_enabled; then
649 # Call back to old function
650 init_mutnauq "$@"
651 else
652 init_neutron_new "$@"
653 fi
654}
655
656function install_neutron {
657 if is_neutron_legacy_enabled; then
658 # Call back to old function
659 install_mutnauq "$@"
660 else
661 install_neutron_new "$@"
662 fi
663}
664
YAMAMOTO Takashid9ec4202016-07-21 16:14:52 +0900665function neutron_service_plugin_class_add {
666 if is_neutron_legacy_enabled; then
667 # Call back to old function
668 _neutron_service_plugin_class_add "$@"
669 else
670 neutron_service_plugin_class_add_new "$@"
671 fi
672}
673
Ihar Hrachyshkaf511c362017-03-07 06:31:49 +0000674function neutron_ml2_extension_driver_add {
675 if is_neutron_legacy_enabled; then
676 # Call back to old function
677 _neutron_ml2_extension_driver_add_old "$@"
678 else
679 _neutron_ml2_extension_driver_add "$@"
680 fi
681}
682
YAMAMOTO Takashic74315e2016-07-21 17:49:43 +0900683function install_neutron_agent_packages {
684 if is_neutron_legacy_enabled; then
685 # Call back to old function
686 install_neutron_agent_packages_mutnauq "$@"
687 else
688 :
689 fi
690}
691
YAMAMOTO Takashieede9dd2016-07-15 10:27:53 +0900692function neutron_server_config_add {
693 if is_neutron_legacy_enabled; then
694 # Call back to old function
695 mutnauq_server_config_add "$@"
696 else
697 neutron_server_config_add_new "$@"
698 fi
699}
700
Sean M. Collins2a242512016-05-03 09:03:09 -0400701function start_neutron {
702 if is_neutron_legacy_enabled; then
703 # Call back to old function
704 start_mutnauq_l2_agent "$@"
705 start_mutnauq_other_agents "$@"
706 else
707 start_neutron_new "$@"
708 fi
709}
710
711function stop_neutron {
712 if is_neutron_legacy_enabled; then
713 # Call back to old function
714 stop_mutnauq "$@"
715 else
716 stop_neutron_new "$@"
717 fi
718}
719
YAMAMOTO Takashic043b6f2017-02-23 22:30:08 -0500720function neutron_deploy_rootwrap_filters {
721 if is_neutron_legacy_enabled; then
722 # Call back to old function
723 _neutron_deploy_rootwrap_filters "$@"
724 else
725 neutron_deploy_rootwrap_filters_new "$@"
726 fi
727}
728
Sean M. Collins2a242512016-05-03 09:03:09 -0400729# Restore xtrace
730$XTRACE