blob: 8ea96bdde62127cf5e8faa8bc7408b44a1deb9a1 [file] [log] [blame]
Mark McClainb05c8762013-07-06 23:29:39 -04001# lib/neutron
Joe Gordon23946052014-01-15 21:42:32 +00002# functions - functions specific to neutron
Mark McClainb05c8762013-07-06 23:29:39 -04003
4# Dependencies:
5# ``functions`` file
6# ``DEST`` must be defined
Stephan Renatuse578eff2013-11-19 13:31:04 +01007# ``STACK_USER`` must be defined
Mark McClainb05c8762013-07-06 23:29:39 -04008
9# ``stack.sh`` calls the entry points in this order:
10#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010011# - install_neutron
12# - install_neutronclient
13# - install_neutron_agent_packages
14# - install_neutron_third_party
15# - configure_neutron
16# - init_neutron
17# - configure_neutron_third_party
18# - init_neutron_third_party
19# - start_neutron_third_party
Emilien Macchia677b7f2013-11-25 23:40:20 +010020# - create_neutron_cache_dir
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010021# - create_nova_conf_neutron
22# - start_neutron_service_and_check
23# - create_neutron_initial_network
24# - setup_neutron_debug
25# - start_neutron_agents
Mark McClainb05c8762013-07-06 23:29:39 -040026#
27# ``unstack.sh`` calls the entry points in this order:
28#
Adam Spiers6a5aa7c2013-10-24 11:27:02 +010029# - stop_neutron
Mark McClainb05c8762013-07-06 23:29:39 -040030
31# Functions in lib/neutron are classified into the following categories:
32#
33# - entry points (called from stack.sh or unstack.sh)
34# - internal functions
35# - neutron exercises
36# - 3rd party programs
37
38
39# Neutron Networking
40# ------------------
41
42# Make sure that neutron is enabled in ``ENABLED_SERVICES``. If you want
43# to run Neutron on this host, make sure that q-svc is also in
44# ``ENABLED_SERVICES``.
45#
46# If you're planning to use the Neutron openvswitch plugin, set
47# ``Q_PLUGIN`` to "openvswitch" and make sure the q-agt service is enabled
48# in ``ENABLED_SERVICES``. If you're planning to use the Neutron
49# linuxbridge plugin, set ``Q_PLUGIN`` to "linuxbridge" and make sure the
50# q-agt service is enabled in ``ENABLED_SERVICES``.
51#
52# See "Neutron Network Configuration" below for additional variables
53# that must be set in localrc for connectivity across hosts with
54# Neutron.
55#
56# With Neutron networking the NETWORK_MANAGER variable is ignored.
57#
58# To enable specific configuration options for either the Open vSwitch or
59# LinuxBridge plugin, please see the top level README file under the
60# Neutron section.
61
Mark McClainb05c8762013-07-06 23:29:39 -040062
63# Neutron Network Configuration
64# -----------------------------
65
66# Gateway and subnet defaults, in case they are not customized in localrc
67NETWORK_GATEWAY=${NETWORK_GATEWAY:-10.0.0.1}
Salvatore Orlando90234ac2013-11-25 05:44:10 -080068PUBLIC_NETWORK_GATEWAY=${PUBLIC_NETWORK_GATEWAY:-172.24.4.1}
Mark McClainb05c8762013-07-06 23:29:39 -040069PRIVATE_SUBNET_NAME=${PRIVATE_SUBNET_NAME:-"private-subnet"}
70PUBLIC_SUBNET_NAME=${PUBLIC_SUBNET_NAME:-"public-subnet"}
71
72# Set up default directories
73NEUTRON_DIR=$DEST/neutron
74NEUTRONCLIENT_DIR=$DEST/python-neutronclient
75NEUTRON_AUTH_CACHE_DIR=${NEUTRON_AUTH_CACHE_DIR:-/var/cache/neutron}
76
77# Support entry points installation of console scripts
78if [[ -d $NEUTRON_DIR/bin/neutron-server ]]; then
79 NEUTRON_BIN_DIR=$NEUTRON_DIR/bin
Sean Dague3bdb9222013-10-22 08:36:16 -040080else
81 NEUTRON_BIN_DIR=$(get_python_exec_prefix)
Mark McClainb05c8762013-07-06 23:29:39 -040082fi
83
84NEUTRON_CONF_DIR=/etc/neutron
85NEUTRON_CONF=$NEUTRON_CONF_DIR/neutron.conf
86export NEUTRON_TEST_CONFIG_FILE=${NEUTRON_TEST_CONFIG_FILE:-"$NEUTRON_CONF_DIR/debug.ini"}
87
88# Default Neutron Plugin
Kyle Mestery6d235002013-09-18 20:27:08 +000089Q_PLUGIN=${Q_PLUGIN:-ml2}
Mark McClainb05c8762013-07-06 23:29:39 -040090# Default Neutron Port
91Q_PORT=${Q_PORT:-9696}
92# Default Neutron Host
93Q_HOST=${Q_HOST:-$SERVICE_HOST}
94# Default admin username
95Q_ADMIN_USERNAME=${Q_ADMIN_USERNAME:-neutron}
96# Default auth strategy
97Q_AUTH_STRATEGY=${Q_AUTH_STRATEGY:-keystone}
98# Use namespace or not
99Q_USE_NAMESPACE=${Q_USE_NAMESPACE:-True}
100# RHEL's support for namespaces requires using veths with ovs
101Q_OVS_USE_VETH=${Q_OVS_USE_VETH:-False}
102Q_USE_ROOTWRAP=${Q_USE_ROOTWRAP:-True}
103# Meta data IP
104Q_META_DATA_IP=${Q_META_DATA_IP:-$SERVICE_HOST}
105# Allow Overlapping IP among subnets
106Q_ALLOW_OVERLAPPING_IP=${Q_ALLOW_OVERLAPPING_IP:-True}
107# Use neutron-debug command
108Q_USE_DEBUG_COMMAND=${Q_USE_DEBUG_COMMAND:-False}
109# The name of the default q-l3 router
110Q_ROUTER_NAME=${Q_ROUTER_NAME:-router1}
Aaron Rosen4540d002013-10-24 13:59:33 -0700111# nova vif driver that all plugins should use
112NOVA_VIF_DRIVER=${NOVA_VIF_DRIVER:-"nova.virt.libvirt.vif.LibvirtGenericVIFDriver"}
Terry Wilsonf06c4432014-05-20 10:54:51 -0500113Q_NOTIFY_NOVA_PORT_STATUS_CHANGES=${Q_NOTIFY_NOVA_PORT_STATUS_CHANGES:-True}
114Q_NOTIFY_NOVA_PORT_DATA_CHANGES=${Q_NOTIFY_NOVA_PORT_DATA_CHANGES:-True}
Aaron Rosencea32b12014-03-04 16:20:14 -0800115VIF_PLUGGING_IS_FATAL=${VIF_PLUGGING_IS_FATAL:-True}
116VIF_PLUGGING_TIMEOUT=${VIF_PLUGGING_TIMEOUT:-300}
Aaron Rosen4540d002013-10-24 13:59:33 -0700117
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400118## Provider Network Information
119PROVIDER_SUBNET_NAME=${PROVIDER_SUBNET_NAME:-"provider_net"}
120
Tomoe Sugiharaafbc6312013-11-14 20:02:47 +0000121# The next two variables are configured by plugin
122# e.g. _configure_neutron_l3_agent or lib/neutron_plugins/*
123#
124# The plugin supports L3.
125Q_L3_ENABLED=${Q_L3_ENABLED:-False}
126# L3 routers exist per tenant
127Q_L3_ROUTER_PER_TENANT=${Q_L3_ROUTER_PER_TENANT:-False}
Aaron Rosen4540d002013-10-24 13:59:33 -0700128
Mark McClainb05c8762013-07-06 23:29:39 -0400129# List of config file names in addition to the main plugin config file
130# See _configure_neutron_common() for details about setting it up
131declare -a Q_PLUGIN_EXTRA_CONF_FILES
132
Paul Michali746dcee2014-04-02 19:12:22 +0000133# List of (optional) config files for VPN device drivers to use with
134# the neutron-q-vpn agent
135declare -a Q_VPN_EXTRA_CONF_FILES
136
Mark McClainb05c8762013-07-06 23:29:39 -0400137
Dean Troyere2907b42014-02-26 17:35:37 -0600138Q_RR_CONF_FILE=$NEUTRON_CONF_DIR/rootwrap.conf
139if [[ "$Q_USE_ROOTWRAP" == "False" ]]; then
140 Q_RR_COMMAND="sudo"
141else
142 NEUTRON_ROOTWRAP=$(get_rootwrap_location neutron)
143 Q_RR_COMMAND="sudo $NEUTRON_ROOTWRAP $Q_RR_CONF_FILE"
Mark McClainb05c8762013-07-06 23:29:39 -0400144fi
145
Brian Haleyeea76212014-06-27 11:45:50 -0400146
147# Distributed Virtual Router (DVR) configuration
148# Can be:
149# legacy - No DVR functionality
150# dvr_snat - Controller or single node DVR
151# dvr - Compute node in multi-node DVR
152Q_DVR_MODE=${Q_DVR_MODE:-legacy}
153if [[ "$Q_DVR_MODE" != "legacy" ]]; then
154 Q_ML2_PLUGIN_MECHANISM_DRIVERS=openvswitch,linuxbridge,l2population
155fi
156
Dean Troyere2907b42014-02-26 17:35:37 -0600157# Provider Network Configurations
158# --------------------------------
159
160# The following variables control the Neutron openvswitch and
161# linuxbridge plugins' allocation of tenant networks and
162# availability of provider networks. If these are not configured
163# in ``localrc``, tenant networks will be local to the host (with no
164# remote connectivity), and no physical resources will be
165# available for the allocation of provider networks.
166
167# To use GRE tunnels for tenant networks, set to True in
168# ``localrc``. GRE tunnels are only supported by the openvswitch
169# plugin, and currently only on Ubuntu.
170ENABLE_TENANT_TUNNELS=${ENABLE_TENANT_TUNNELS:-False}
171
172# If using GRE tunnels for tenant networks, specify the range of
173# tunnel IDs from which tenant networks are allocated. Can be
174# overriden in ``localrc`` in necesssary.
Anant Patil3827dc02014-07-03 21:38:16 +0530175TENANT_TUNNEL_RANGES=${TENANT_TUNNEL_RANGES:-1:1000}
Dean Troyere2907b42014-02-26 17:35:37 -0600176
177# To use VLANs for tenant networks, set to True in localrc. VLANs
178# are supported by the openvswitch and linuxbridge plugins, each
179# requiring additional configuration described below.
180ENABLE_TENANT_VLANS=${ENABLE_TENANT_VLANS:-False}
181
182# If using VLANs for tenant networks, set in ``localrc`` to specify
183# the range of VLAN VIDs from which tenant networks are
184# allocated. An external network switch must be configured to
185# trunk these VLANs between hosts for multi-host connectivity.
186#
187# Example: ``TENANT_VLAN_RANGE=1000:1999``
188TENANT_VLAN_RANGE=${TENANT_VLAN_RANGE:-}
189
190# If using VLANs for tenant networks, or if using flat or VLAN
191# provider networks, set in ``localrc`` to the name of the physical
192# network, and also configure ``OVS_PHYSICAL_BRIDGE`` for the
193# openvswitch agent or ``LB_PHYSICAL_INTERFACE`` for the linuxbridge
194# agent, as described below.
195#
196# Example: ``PHYSICAL_NETWORK=default``
197PHYSICAL_NETWORK=${PHYSICAL_NETWORK:-}
198
199# With the openvswitch plugin, if using VLANs for tenant networks,
200# or if using flat or VLAN provider networks, set in ``localrc`` to
201# the name of the OVS bridge to use for the physical network. The
202# bridge will be created if it does not already exist, but a
203# physical interface must be manually added to the bridge as a
204# port for external connectivity.
205#
206# Example: ``OVS_PHYSICAL_BRIDGE=br-eth1``
207OVS_PHYSICAL_BRIDGE=${OVS_PHYSICAL_BRIDGE:-}
208
209# With the linuxbridge plugin, if using VLANs for tenant networks,
210# or if using flat or VLAN provider networks, set in ``localrc`` to
211# the name of the network interface to use for the physical
212# network.
213#
214# Example: ``LB_PHYSICAL_INTERFACE=eth1``
215LB_PHYSICAL_INTERFACE=${LB_PHYSICAL_INTERFACE:-}
216
Edgar Magana6f335b92014-07-10 15:42:44 -0700217# When Neutron tunnels are enabled it is needed to specify the
218# IP address of the end point in the local server. This IP is set
219# by default to the same IP address that the HOST IP.
220# This variable can be used to specify a different end point IP address
221# Example: ``TUNNEL_ENDPOINT_IP=1.1.1.1``
222TUNNEL_ENDPOINT_IP=${TUNNEL_ENDPOINT_IP:-$HOST_IP}
223
Dean Troyere2907b42014-02-26 17:35:37 -0600224# With the openvswitch plugin, set to True in ``localrc`` to enable
225# provider GRE tunnels when ``ENABLE_TENANT_TUNNELS`` is False.
226#
227# Example: ``OVS_ENABLE_TUNNELING=True``
228OVS_ENABLE_TUNNELING=${OVS_ENABLE_TUNNELING:-$ENABLE_TENANT_TUNNELS}
229
Mark McClainb05c8762013-07-06 23:29:39 -0400230# Neutron plugin specific functions
231# ---------------------------------
232
233# Please refer to ``lib/neutron_plugins/README.md`` for details.
234source $TOP_DIR/lib/neutron_plugins/$Q_PLUGIN
235
236# Agent loadbalancer service plugin functions
237# -------------------------------------------
238
239# Hardcoding for 1 service plugin for now
240source $TOP_DIR/lib/neutron_plugins/services/loadbalancer
241
Emilien Macchi40546f72013-09-24 15:10:25 +0200242# Agent metering service plugin functions
243# -------------------------------------------
244
245# Hardcoding for 1 service plugin for now
246source $TOP_DIR/lib/neutron_plugins/services/metering
247
Nachi Ueno69b3ff62013-06-07 10:28:33 -0700248# VPN service plugin functions
249# -------------------------------------------
250# Hardcoding for 1 service plugin for now
251source $TOP_DIR/lib/neutron_plugins/services/vpn
252
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700253# Firewall Service Plugin functions
Adam Spierscb961592013-10-05 12:11:07 +0100254# ---------------------------------
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700255source $TOP_DIR/lib/neutron_plugins/services/firewall
256
Mark McClainb05c8762013-07-06 23:29:39 -0400257# Use security group or not
258if has_neutron_plugin_security_group; then
259 Q_USE_SECGROUP=${Q_USE_SECGROUP:-True}
260else
261 Q_USE_SECGROUP=False
262fi
263
Dean Troyer4237f592014-01-29 16:22:11 -0600264# Tell Tempest this project is present
265TEMPEST_SERVICES+=,neutron
266
267
Dean Troyere2907b42014-02-26 17:35:37 -0600268# Save trace setting
269XTRACE=$(set +o | grep xtrace)
270set +o xtrace
271
272
Mark McClainb05c8762013-07-06 23:29:39 -0400273# Functions
274# ---------
275
Dean Troyere4fa7212014-01-15 15:04:49 -0600276# Test if any Neutron services are enabled
277# is_neutron_enabled
278function is_neutron_enabled {
279 [[ ,${ENABLED_SERVICES} =~ ,"q-" ]] && return 0
280 return 1
281}
282
Mark McClainb05c8762013-07-06 23:29:39 -0400283# configure_neutron()
284# Set common config for all neutron server and agents.
Ian Wienandaee18c72014-02-21 15:35:08 +1100285function configure_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400286 _configure_neutron_common
287 iniset_rpc_backend neutron $NEUTRON_CONF DEFAULT
288
289 # goes before q-svc to init Q_SERVICE_PLUGIN_CLASSES
290 if is_service_enabled q-lbaas; then
291 _configure_neutron_lbaas
292 fi
Emilien Macchi40546f72013-09-24 15:10:25 +0200293 if is_service_enabled q-metering; then
294 _configure_neutron_metering
295 fi
Nachi Ueno69b3ff62013-06-07 10:28:33 -0700296 if is_service_enabled q-vpn; then
297 _configure_neutron_vpn
298 fi
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700299 if is_service_enabled q-fwaas; then
300 _configure_neutron_fwaas
301 fi
Stephen Ma9b38eb22014-04-02 02:13:09 +0000302 if is_service_enabled q-agt q-svc; then
Mark McClainb05c8762013-07-06 23:29:39 -0400303 _configure_neutron_service
304 fi
305 if is_service_enabled q-agt; then
306 _configure_neutron_plugin_agent
307 fi
308 if is_service_enabled q-dhcp; then
309 _configure_neutron_dhcp_agent
310 fi
311 if is_service_enabled q-l3; then
312 _configure_neutron_l3_agent
313 fi
314 if is_service_enabled q-meta; then
315 _configure_neutron_metadata_agent
316 fi
317
Brian Haleyeea76212014-06-27 11:45:50 -0400318 if [[ "$Q_DVR_MODE" != "legacy" ]]; then
319 _configure_dvr
320 fi
321
Mark McClainb05c8762013-07-06 23:29:39 -0400322 _configure_neutron_debug_command
323}
324
Ian Wienandaee18c72014-02-21 15:35:08 +1100325function create_nova_conf_neutron {
Yong Sheng Gong032e4542013-08-25 10:21:10 +0800326 iniset $NOVA_CONF DEFAULT network_api_class "nova.network.neutronv2.api.API"
Gary Kotton13d385e2014-06-17 23:24:53 -0700327 iniset $NOVA_CONF neutron admin_username "$Q_ADMIN_USERNAME"
328 iniset $NOVA_CONF neutron admin_password "$SERVICE_PASSWORD"
329 iniset $NOVA_CONF neutron admin_auth_url "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_AUTH_PORT/v2.0"
330 iniset $NOVA_CONF neutron auth_strategy "$Q_AUTH_STRATEGY"
331 iniset $NOVA_CONF neutron admin_tenant_name "$SERVICE_TENANT_NAME"
Bartosz Górski0abde392014-02-28 14:15:19 +0100332 iniset $NOVA_CONF neutron region_name "$REGION_NAME"
Gary Kotton13d385e2014-06-17 23:24:53 -0700333 iniset $NOVA_CONF neutron url "http://$Q_HOST:$Q_PORT"
Mark McClainb05c8762013-07-06 23:29:39 -0400334
335 if [[ "$Q_USE_SECGROUP" == "True" ]]; then
336 LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver
Jeff Peeler1143f7e2013-10-31 16:21:52 -0400337 iniset $NOVA_CONF DEFAULT firewall_driver $LIBVIRT_FIREWALL_DRIVER
Yong Sheng Gong032e4542013-08-25 10:21:10 +0800338 iniset $NOVA_CONF DEFAULT security_group_api neutron
Mark McClainb05c8762013-07-06 23:29:39 -0400339 fi
340
341 # set NOVA_VIF_DRIVER and optionally set options in nova_conf
342 neutron_plugin_create_nova_conf
343
Gary Kotton51c681d2014-04-22 01:40:56 -0700344 iniset $NOVA_CONF libvirt vif_driver "$NOVA_VIF_DRIVER"
Mark McClainb05c8762013-07-06 23:29:39 -0400345 iniset $NOVA_CONF DEFAULT linuxnet_interface_driver "$LINUXNET_VIF_DRIVER"
346 if is_service_enabled q-meta; then
Yong Sheng Gong032e4542013-08-25 10:21:10 +0800347 iniset $NOVA_CONF DEFAULT service_neutron_metadata_proxy "True"
Mark McClainb05c8762013-07-06 23:29:39 -0400348 fi
Aaron Rosencea32b12014-03-04 16:20:14 -0800349
350 iniset $NOVA_CONF DEFAULT vif_plugging_is_fatal "$VIF_PLUGGING_IS_FATAL"
351 iniset $NOVA_CONF DEFAULT vif_plugging_timeout "$VIF_PLUGGING_TIMEOUT"
Mark McClainb05c8762013-07-06 23:29:39 -0400352}
353
Emilien Macchia677b7f2013-11-25 23:40:20 +0100354# create_neutron_cache_dir() - Part of the _neutron_setup_keystone() process
Ian Wienandaee18c72014-02-21 15:35:08 +1100355function create_neutron_cache_dir {
Emilien Macchia677b7f2013-11-25 23:40:20 +0100356 # Create cache dir
357 sudo mkdir -p $NEUTRON_AUTH_CACHE_DIR
358 sudo chown $STACK_USER $NEUTRON_AUTH_CACHE_DIR
359 rm -f $NEUTRON_AUTH_CACHE_DIR/*
360}
361
Mark McClainb05c8762013-07-06 23:29:39 -0400362# create_neutron_accounts() - Set up common required neutron accounts
363
364# Tenant User Roles
365# ------------------------------------------------------------------
366# service neutron admin # if enabled
367
368# Migrated from keystone_data.sh
Ian Wienandaee18c72014-02-21 15:35:08 +1100369function create_neutron_accounts {
Mark McClainb05c8762013-07-06 23:29:39 -0400370
Steve Martinelli19685422014-01-24 13:02:26 -0600371 SERVICE_TENANT=$(openstack project list | awk "/ $SERVICE_TENANT_NAME / { print \$2 }")
372 ADMIN_ROLE=$(openstack role list | awk "/ admin / { print \$2 }")
Mark McClainb05c8762013-07-06 23:29:39 -0400373
374 if [[ "$ENABLED_SERVICES" =~ "q-svc" ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100375
376 NEUTRON_USER=$(get_or_create_user "neutron" \
377 "$SERVICE_PASSWORD" $SERVICE_TENANT "neutron@example.com")
378 get_or_add_user_role $ADMIN_ROLE $NEUTRON_USER $SERVICE_TENANT
379
Mark McClainb05c8762013-07-06 23:29:39 -0400380 if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
Bartosz Górski0abde392014-02-28 14:15:19 +0100381
382 NEUTRON_SERVICE=$(get_or_create_service "neutron" \
383 "network" "Neutron Service")
384 get_or_create_endpoint $NEUTRON_SERVICE \
385 "$REGION_NAME" \
386 "http://$SERVICE_HOST:9696/" \
387 "http://$SERVICE_HOST:9696/" \
388 "http://$SERVICE_HOST:9696/"
Mark McClainb05c8762013-07-06 23:29:39 -0400389 fi
390 fi
391}
392
Ian Wienandaee18c72014-02-21 15:35:08 +1100393function create_neutron_initial_network {
Steve Martinelli19685422014-01-24 13:02:26 -0600394 TENANT_ID=$(openstack project list | grep " demo " | get_field 1)
DennyZhang23178a92013-10-22 17:07:32 -0500395 die_if_not_set $LINENO TENANT_ID "Failure retrieving TENANT_ID for demo"
Mark McClainb05c8762013-07-06 23:29:39 -0400396
397 # Create a small network
398 # Since neutron command is executed in admin context at this point,
Dirk Mueller25049cd2014-01-09 13:53:52 +0100399 # ``--tenant-id`` needs to be specified.
Mark McClainb05c8762013-07-06 23:29:39 -0400400 if is_baremetal; then
sbauzae2c4ee22013-08-29 17:29:46 +0200401 if [[ "$PUBLIC_INTERFACE" == '' || "$OVS_PHYSICAL_BRIDGE" == '' ]]; then
402 die $LINENO "Neutron settings for baremetal not set.. exiting"
403 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400404 sudo ovs-vsctl add-port $OVS_PHYSICAL_BRIDGE $PUBLIC_INTERFACE
405 for IP in $(ip addr show dev $PUBLIC_INTERFACE | grep ' inet ' | awk '{print $2}'); do
406 sudo ip addr del $IP dev $PUBLIC_INTERFACE
407 sudo ip addr add $IP dev $OVS_PHYSICAL_BRIDGE
408 done
Dirk Mueller25049cd2014-01-09 13:53:52 +0100409 NET_ID=$(neutron net-create $PHYSICAL_NETWORK --tenant-id $TENANT_ID --provider:network_type flat --provider:physical_network "$PHYSICAL_NETWORK" | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500410 die_if_not_set $LINENO NET_ID "Failure creating NET_ID for $PHYSICAL_NETWORK $TENANT_ID"
Dirk Mueller25049cd2014-01-09 13:53:52 +0100411 SUBNET_ID=$(neutron subnet-create --tenant-id $TENANT_ID --ip_version 4 ${ALLOCATION_POOL:+--allocation-pool $ALLOCATION_POOL} --gateway $NETWORK_GATEWAY --name $PRIVATE_SUBNET_NAME $NET_ID $FIXED_RANGE | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500412 die_if_not_set $LINENO SUBNET_ID "Failure creating SUBNET_ID for $TENANT_ID"
Mark McClainb05c8762013-07-06 23:29:39 -0400413 sudo ifconfig $OVS_PHYSICAL_BRIDGE up
sbauzae2c4ee22013-08-29 17:29:46 +0200414 sudo route add default gw $NETWORK_GATEWAY dev $OVS_PHYSICAL_BRIDGE
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400415 elif is_provider_network; then
416 die_if_not_set $LINENO SEGMENTATION_ID "A SEGMENTATION_ID is required to use provider networking"
417 die_if_not_set $LINENO PROVIDER_NETWORK_TYPE "You must specifiy the PROVIDER_NETWORK_TYPE"
Sean M. Collins21e6c622014-06-16 11:19:48 -0400418 NET_ID=$(neutron net-create $PHYSICAL_NETWORK --tenant_id $TENANT_ID --provider:network_type $PROVIDER_NETWORK_TYPE --provider:physical_network "$PHYSICAL_NETWORK" --provider:segmentation_id "$SEGMENTATION_ID" --shared | grep ' id ' | get_field 2)
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400419 SUBNET_ID=$(neutron subnet-create --tenant_id $TENANT_ID --ip_version 4 ${ALLOCATION_POOL:+--allocation-pool $ALLOCATION_POOL} --name $PROVIDER_SUBNET_NAME $NET_ID $FIXED_RANGE | grep ' id ' | get_field 2)
Sean M. Collinse13fd602014-05-14 17:01:53 -0400420 SUBNET_V6_ID=$(neutron subnet-create --tenant_id $TENANT_ID --ip_version 6 --ipv6-address-mode slaac --gateway $V6_NETWORK_GATEWAY --name $PROVIDER_SUBNET_NAME_V6 $NET_ID $FIXED_RANGE_V6 | grep 'id' | get_field 2)
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400421 sudo ip link set $OVS_PHYSICAL_BRIDGE up
422 sudo ip link set br-int up
423 sudo ip link set $PUBLIC_INTERFACE up
Mark McClainb05c8762013-07-06 23:29:39 -0400424 else
Dirk Mueller25049cd2014-01-09 13:53:52 +0100425 NET_ID=$(neutron net-create --tenant-id $TENANT_ID "$PRIVATE_NETWORK_NAME" | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500426 die_if_not_set $LINENO NET_ID "Failure creating NET_ID for $PHYSICAL_NETWORK $TENANT_ID"
Dirk Mueller25049cd2014-01-09 13:53:52 +0100427 SUBNET_ID=$(neutron subnet-create --tenant-id $TENANT_ID --ip_version 4 --gateway $NETWORK_GATEWAY --name $PRIVATE_SUBNET_NAME $NET_ID $FIXED_RANGE | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500428 die_if_not_set $LINENO SUBNET_ID "Failure creating SUBNET_ID for $TENANT_ID"
Mark McClainb05c8762013-07-06 23:29:39 -0400429 fi
430
431 if [[ "$Q_L3_ENABLED" == "True" ]]; then
432 # Create a router, and add the private subnet as one of its interfaces
433 if [[ "$Q_L3_ROUTER_PER_TENANT" == "True" ]]; then
434 # create a tenant-owned router.
Dirk Mueller25049cd2014-01-09 13:53:52 +0100435 ROUTER_ID=$(neutron router-create --tenant-id $TENANT_ID $Q_ROUTER_NAME | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500436 die_if_not_set $LINENO ROUTER_ID "Failure creating ROUTER_ID for $TENANT_ID $Q_ROUTER_NAME"
Mark McClainb05c8762013-07-06 23:29:39 -0400437 else
438 # Plugin only supports creating a single router, which should be admin owned.
439 ROUTER_ID=$(neutron router-create $Q_ROUTER_NAME | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500440 die_if_not_set $LINENO ROUTER_ID "Failure creating ROUTER_ID for $Q_ROUTER_NAME"
Mark McClainb05c8762013-07-06 23:29:39 -0400441 fi
442 neutron router-interface-add $ROUTER_ID $SUBNET_ID
443 # Create an external network, and a subnet. Configure the external network as router gw
444 EXT_NET_ID=$(neutron net-create "$PUBLIC_NETWORK_NAME" -- --router:external=True | grep ' id ' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500445 die_if_not_set $LINENO EXT_NET_ID "Failure creating EXT_NET_ID for $PUBLIC_NETWORK_NAME"
Mark McClainb05c8762013-07-06 23:29:39 -0400446 EXT_GW_IP=$(neutron subnet-create --ip_version 4 ${Q_FLOATING_ALLOCATION_POOL:+--allocation-pool $Q_FLOATING_ALLOCATION_POOL} --gateway $PUBLIC_NETWORK_GATEWAY --name $PUBLIC_SUBNET_NAME $EXT_NET_ID $FLOATING_RANGE -- --enable_dhcp=False | grep 'gateway_ip' | get_field 2)
DennyZhang23178a92013-10-22 17:07:32 -0500447 die_if_not_set $LINENO EXT_GW_IP "Failure creating EXT_GW_IP"
Mark McClainb05c8762013-07-06 23:29:39 -0400448 neutron router-gateway-set $ROUTER_ID $EXT_NET_ID
449
450 if is_service_enabled q-l3; then
451 # logic is specific to using the l3-agent for l3
452 if is_neutron_ovs_base_plugin && [[ "$Q_USE_NAMESPACE" = "True" ]]; then
453 CIDR_LEN=${FLOATING_RANGE#*/}
454 sudo ip addr add $EXT_GW_IP/$CIDR_LEN dev $PUBLIC_BRIDGE
455 sudo ip link set $PUBLIC_BRIDGE up
456 ROUTER_GW_IP=`neutron port-list -c fixed_ips -c device_owner | grep router_gateway | awk -F '"' '{ print $8; }'`
DennyZhang23178a92013-10-22 17:07:32 -0500457 die_if_not_set $LINENO ROUTER_GW_IP "Failure retrieving ROUTER_GW_IP"
Mark McClainb05c8762013-07-06 23:29:39 -0400458 sudo route add -net $FIXED_RANGE gw $ROUTER_GW_IP
459 fi
460 if [[ "$Q_USE_NAMESPACE" == "False" ]]; then
461 # Explicitly set router id in l3 agent configuration
462 iniset $Q_L3_CONF_FILE DEFAULT router_id $ROUTER_ID
463 fi
464 fi
Sean Dague3bdb9222013-10-22 08:36:16 -0400465 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400466}
467
468# init_neutron() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +1100469function init_neutron {
Salvatore Orlandodd649882013-08-05 08:56:17 -0700470 recreate_database $Q_DB_NAME utf8
471 # Run Neutron db migrations
472 $NEUTRON_BIN_DIR/neutron-db-manage --config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE upgrade head
Mark McClainb05c8762013-07-06 23:29:39 -0400473}
474
475# install_neutron() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100476function install_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400477 git_clone $NEUTRON_REPO $NEUTRON_DIR $NEUTRON_BRANCH
478 setup_develop $NEUTRON_DIR
479}
480
481# install_neutronclient() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100482function install_neutronclient {
Mark McClainb05c8762013-07-06 23:29:39 -0400483 git_clone $NEUTRONCLIENT_REPO $NEUTRONCLIENT_DIR $NEUTRONCLIENT_BRANCH
484 setup_develop $NEUTRONCLIENT_DIR
Attila Fazekasfac533e2013-08-14 16:04:01 +0200485 sudo install -D -m 0644 -o $STACK_USER {$NEUTRONCLIENT_DIR/tools/,/etc/bash_completion.d/}neutron.bash_completion
Mark McClainb05c8762013-07-06 23:29:39 -0400486}
487
488# install_neutron_agent_packages() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +1100489function install_neutron_agent_packages {
Mark McClainb05c8762013-07-06 23:29:39 -0400490 # install packages that are specific to plugin agent(s)
491 if is_service_enabled q-agt q-dhcp q-l3; then
492 neutron_plugin_install_agent_packages
493 fi
494
495 if is_service_enabled q-lbaas; then
Sean Dague3bdb9222013-10-22 08:36:16 -0400496 neutron_agent_lbaas_install_agent_packages
Mark McClainb05c8762013-07-06 23:29:39 -0400497 fi
498}
499
500# Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100501function start_neutron_service_and_check {
Mark McClainb05c8762013-07-06 23:29:39 -0400502 # build config-file options
503 local cfg_file
504 local CFG_FILE_OPTIONS="--config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE"
505 for cfg_file in ${Q_PLUGIN_EXTRA_CONF_FILES[@]}; do
Sean Dague3bdb9222013-10-22 08:36:16 -0400506 CFG_FILE_OPTIONS+=" --config-file /$cfg_file"
Mark McClainb05c8762013-07-06 23:29:39 -0400507 done
508 # Start the Neutron service
509 screen_it q-svc "cd $NEUTRON_DIR && python $NEUTRON_BIN_DIR/neutron-server $CFG_FILE_OPTIONS"
510 echo "Waiting for Neutron to start..."
JUN JIE NAN0aa85342013-09-13 15:47:09 +0800511 if ! timeout $SERVICE_TIMEOUT sh -c "while ! wget --no-proxy -q -O- http://$Q_HOST:$Q_PORT; do sleep 1; done"; then
Sean Dague3bdb9222013-10-22 08:36:16 -0400512 die $LINENO "Neutron did not start"
Mark McClainb05c8762013-07-06 23:29:39 -0400513 fi
514}
515
516# Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +1100517function start_neutron_agents {
Mark McClainb05c8762013-07-06 23:29:39 -0400518 # Start up the neutron agents if enabled
519 screen_it q-agt "cd $NEUTRON_DIR && python $AGENT_BINARY --config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE"
520 screen_it q-dhcp "cd $NEUTRON_DIR && python $AGENT_DHCP_BINARY --config-file $NEUTRON_CONF --config-file=$Q_DHCP_CONF_FILE"
Nachi Ueno584750f2013-07-15 18:22:21 -0700521
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700522 L3_CONF_FILES="--config-file $NEUTRON_CONF --config-file=$Q_L3_CONF_FILE"
523
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -0400524 if is_provider_network; then
525 sudo ovs-vsctl add-port $OVS_PHYSICAL_BRIDGE $PUBLIC_INTERFACE
526 sudo ip link set $OVS_PHYSICAL_BRIDGE up
527 sudo ip link set br-int up
528 sudo ip link set $PUBLIC_INTERFACE up
529 fi
530
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700531 if is_service_enabled q-fwaas; then
532 L3_CONF_FILES="$L3_CONF_FILES --config-file $Q_FWAAS_CONF_FILE"
Adam Gandelmancf1ef232014-04-21 17:09:52 -0700533 VPN_CONF_FILES="$VPN_CONF_FILES --config-file $Q_FWAAS_CONF_FILE"
Nachi Ueno584750f2013-07-15 18:22:21 -0700534 fi
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700535 if is_service_enabled q-vpn; then
Paul Michali746dcee2014-04-02 19:12:22 +0000536 screen_it q-vpn "cd $NEUTRON_DIR && $AGENT_VPN_BINARY $VPN_CONF_FILES"
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700537 else
538 screen_it q-l3 "cd $NEUTRON_DIR && python $AGENT_L3_BINARY $L3_CONF_FILES"
539 fi
540
Mark McClainb05c8762013-07-06 23:29:39 -0400541 screen_it q-meta "cd $NEUTRON_DIR && python $AGENT_META_BINARY --config-file $NEUTRON_CONF --config-file=$Q_META_CONF_FILE"
542
543 if [ "$VIRT_DRIVER" = 'xenserver' ]; then
544 # For XenServer, start an agent for the domU openvswitch
545 screen_it q-domua "cd $NEUTRON_DIR && python $AGENT_BINARY --config-file $NEUTRON_CONF --config-file /$Q_PLUGIN_CONF_FILE.domU"
546 fi
547
548 if is_service_enabled q-lbaas; then
549 screen_it q-lbaas "cd $NEUTRON_DIR && python $AGENT_LBAAS_BINARY --config-file $NEUTRON_CONF --config-file=$LBAAS_AGENT_CONF_FILENAME"
550 fi
Emilien Macchi40546f72013-09-24 15:10:25 +0200551
552 if is_service_enabled q-metering; then
553 screen_it q-metering "cd $NEUTRON_DIR && python $AGENT_METERING_BINARY --config-file $NEUTRON_CONF --config-file $METERING_AGENT_CONF_FILENAME"
554 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400555}
556
557# stop_neutron() - Stop running processes (non-screen)
Ian Wienandaee18c72014-02-21 15:35:08 +1100558function stop_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400559 if is_service_enabled q-dhcp; then
560 pid=$(ps aux | awk '/[d]nsmasq.+interface=(tap|ns-)/ { print $2 }')
561 [ ! -z "$pid" ] && sudo kill -9 $pid
562 fi
563 if is_service_enabled q-meta; then
Jakub Libosvar1f763282014-01-28 23:01:38 +0100564 sudo pkill -9 -f neutron-ns-metadata-proxy || :
Mark McClainb05c8762013-07-06 23:29:39 -0400565 fi
Akihiro Motokiedddb1f2013-12-09 20:21:06 +0900566
567 if is_service_enabled q-lbaas; then
568 neutron_lbaas_stop
569 fi
570 if is_service_enabled q-fwaas; then
571 neutron_fwaas_stop
572 fi
573 if is_service_enabled q-vpn; then
574 neutron_vpn_stop
575 fi
576 if is_service_enabled q-metering; then
577 neutron_metering_stop
578 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400579}
580
581# cleanup_neutron() - Remove residual data files, anything left over from previous
582# runs that a clean run would need to clean up
Ian Wienandaee18c72014-02-21 15:35:08 +1100583function cleanup_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400584 if is_neutron_ovs_base_plugin; then
585 neutron_ovs_base_cleanup
586 fi
587
588 # delete all namespaces created by neutron
Brian Haleyeea76212014-06-27 11:45:50 -0400589 for ns in $(sudo ip netns list | grep -o -E '(qdhcp|qrouter|qlbaas|fip|snat)-[0-9a-f-]*'); do
Mark McClainb05c8762013-07-06 23:29:39 -0400590 sudo ip netns delete ${ns}
591 done
592}
593
594# _configure_neutron_common()
595# Set common config for all neutron server and agents.
596# This MUST be called before other ``_configure_neutron_*`` functions.
Ian Wienandaee18c72014-02-21 15:35:08 +1100597function _configure_neutron_common {
Mark McClainb05c8762013-07-06 23:29:39 -0400598 # Put config files in ``NEUTRON_CONF_DIR`` for everyone to find
599 if [[ ! -d $NEUTRON_CONF_DIR ]]; then
600 sudo mkdir -p $NEUTRON_CONF_DIR
601 fi
602 sudo chown $STACK_USER $NEUTRON_CONF_DIR
603
604 cp $NEUTRON_DIR/etc/neutron.conf $NEUTRON_CONF
605
606 # Set plugin-specific variables ``Q_DB_NAME``, ``Q_PLUGIN_CLASS``.
607 # For main plugin config file, set ``Q_PLUGIN_CONF_PATH``, ``Q_PLUGIN_CONF_FILENAME``.
608 # For addition plugin config files, set ``Q_PLUGIN_EXTRA_CONF_PATH``,
609 # ``Q_PLUGIN_EXTRA_CONF_FILES``. For example:
Adam Spierscb961592013-10-05 12:11:07 +0100610 #
Mark McClainb05c8762013-07-06 23:29:39 -0400611 # ``Q_PLUGIN_EXTRA_CONF_FILES=(file1, file2)``
612 neutron_plugin_configure_common
613
sbauzae2c4ee22013-08-29 17:29:46 +0200614 if [[ "$Q_PLUGIN_CONF_PATH" == '' || "$Q_PLUGIN_CONF_FILENAME" == '' || "$Q_PLUGIN_CLASS" == '' ]]; then
Mark McClainb05c8762013-07-06 23:29:39 -0400615 die $LINENO "Neutron plugin not set.. exiting"
616 fi
617
618 # If needed, move config file from ``$NEUTRON_DIR/etc/neutron`` to ``NEUTRON_CONF_DIR``
619 mkdir -p /$Q_PLUGIN_CONF_PATH
620 Q_PLUGIN_CONF_FILE=$Q_PLUGIN_CONF_PATH/$Q_PLUGIN_CONF_FILENAME
621 cp $NEUTRON_DIR/$Q_PLUGIN_CONF_FILE /$Q_PLUGIN_CONF_FILE
622
623 iniset /$Q_PLUGIN_CONF_FILE database connection `database_connection_url $Q_DB_NAME`
624 iniset $NEUTRON_CONF DEFAULT state_path $DATA_DIR/neutron
625
626 # If addition config files are set, make sure their path name is set as well
627 if [[ ${#Q_PLUGIN_EXTRA_CONF_FILES[@]} > 0 && $Q_PLUGIN_EXTRA_CONF_PATH == '' ]]; then
628 die $LINENO "Neutron additional plugin config not set.. exiting"
629 fi
630
631 # If additional config files exist, copy them over to neutron configuration
632 # directory
633 if [[ $Q_PLUGIN_EXTRA_CONF_PATH != '' ]]; then
Mark McClainb05c8762013-07-06 23:29:39 -0400634 local f
635 for (( f=0; $f < ${#Q_PLUGIN_EXTRA_CONF_FILES[@]}; f+=1 )); do
636 Q_PLUGIN_EXTRA_CONF_FILES[$f]=$Q_PLUGIN_EXTRA_CONF_PATH/${Q_PLUGIN_EXTRA_CONF_FILES[$f]}
Mark McClainb05c8762013-07-06 23:29:39 -0400637 done
638 fi
639
Joe Gordonbee5c502013-08-30 13:48:08 -0400640 if [ "$VIRT_DRIVER" = 'fake' ]; then
641 # Disable arbitrary limits
642 iniset $NEUTRON_CONF quotas quota_network -1
643 iniset $NEUTRON_CONF quotas quota_subnet -1
644 iniset $NEUTRON_CONF quotas quota_port -1
645 iniset $NEUTRON_CONF quotas quota_security_group -1
646 iniset $NEUTRON_CONF quotas quota_security_group_rule -1
647 fi
648
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700649 # Format logging
650 if [ "$LOG_COLOR" == "True" ] && [ "$SYSLOG" == "False" ]; then
Salvatore Orlandobc7f6432013-11-25 10:11:14 -0800651 setup_colorized_logging $NEUTRON_CONF DEFAULT project_id
Salvatore Orlando05ae8332013-08-20 14:51:08 -0700652 fi
653
Mark McClainb05c8762013-07-06 23:29:39 -0400654 _neutron_setup_rootwrap
655}
656
Ian Wienandaee18c72014-02-21 15:35:08 +1100657function _configure_neutron_debug_command {
Mark McClainb05c8762013-07-06 23:29:39 -0400658 if [[ "$Q_USE_DEBUG_COMMAND" != "True" ]]; then
659 return
660 fi
661
662 cp $NEUTRON_DIR/etc/l3_agent.ini $NEUTRON_TEST_CONFIG_FILE
663
664 iniset $NEUTRON_TEST_CONFIG_FILE DEFAULT verbose False
665 iniset $NEUTRON_TEST_CONFIG_FILE DEFAULT debug False
666 iniset $NEUTRON_TEST_CONFIG_FILE DEFAULT use_namespaces $Q_USE_NAMESPACE
Mark McClainb05c8762013-07-06 23:29:39 -0400667 iniset $NEUTRON_TEST_CONFIG_FILE agent root_helper "$Q_RR_COMMAND"
668
Mark McClainb05c8762013-07-06 23:29:39 -0400669 _neutron_setup_interface_driver $NEUTRON_TEST_CONFIG_FILE
670
671 neutron_plugin_configure_debug_command
672}
673
Ian Wienandaee18c72014-02-21 15:35:08 +1100674function _configure_neutron_dhcp_agent {
Mark McClainb05c8762013-07-06 23:29:39 -0400675 AGENT_DHCP_BINARY="$NEUTRON_BIN_DIR/neutron-dhcp-agent"
676 Q_DHCP_CONF_FILE=$NEUTRON_CONF_DIR/dhcp_agent.ini
677
678 cp $NEUTRON_DIR/etc/dhcp_agent.ini $Q_DHCP_CONF_FILE
679
680 iniset $Q_DHCP_CONF_FILE DEFAULT verbose True
Ben Nemec03997942013-08-10 09:56:16 -0500681 iniset $Q_DHCP_CONF_FILE DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400682 iniset $Q_DHCP_CONF_FILE DEFAULT use_namespaces $Q_USE_NAMESPACE
683 iniset $Q_DHCP_CONF_FILE DEFAULT root_helper "$Q_RR_COMMAND"
684
Kyle Mestery73b21912013-08-22 11:25:21 +0000685 # Define extra "DEFAULT" configuration options when q-dhcp is configured by
686 # defining the array ``Q_DHCP_EXTRA_DEFAULT_OPTS``.
687 # For Example: ``Q_DHCP_EXTRA_DEFAULT_OPTS=(foo=true bar=2)``
688 for I in "${Q_DHCP_EXTRA_DEFAULT_OPTS[@]}"; do
689 # Replace the first '=' with ' ' for iniset syntax
690 iniset $Q_DHCP_CONF_FILE DEFAULT ${I/=/ }
691 done
692
Mark McClainb05c8762013-07-06 23:29:39 -0400693 _neutron_setup_interface_driver $Q_DHCP_CONF_FILE
694
695 neutron_plugin_configure_dhcp_agent
696}
697
Ian Wienandaee18c72014-02-21 15:35:08 +1100698function _configure_neutron_l3_agent {
Paul Michali746dcee2014-04-02 19:12:22 +0000699 local cfg_file
Mark McClainb05c8762013-07-06 23:29:39 -0400700 Q_L3_ENABLED=True
701 # for l3-agent, only use per tenant router if we have namespaces
702 Q_L3_ROUTER_PER_TENANT=$Q_USE_NAMESPACE
Nachi Ueno69b3ff62013-06-07 10:28:33 -0700703
704 AGENT_L3_BINARY=${AGENT_L3_BINARY:-"$NEUTRON_BIN_DIR/neutron-l3-agent"}
Mark McClainb05c8762013-07-06 23:29:39 -0400705 Q_L3_CONF_FILE=$NEUTRON_CONF_DIR/l3_agent.ini
706
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700707 if is_service_enabled q-fwaas; then
708 Q_FWAAS_CONF_FILE=$NEUTRON_CONF_DIR/fwaas_driver.ini
709 fi
710
Paul Michali746dcee2014-04-02 19:12:22 +0000711 if is_service_enabled q-vpn; then
712 Q_VPN_CONF_FILE=$NEUTRON_CONF_DIR/vpn_agent.ini
713 cp $NEUTRON_DIR/etc/vpn_agent.ini $Q_VPN_CONF_FILE
714 VPN_CONF_FILES="--config-file $NEUTRON_CONF --config-file=$Q_L3_CONF_FILE --config-file=$Q_VPN_CONF_FILE"
715 for cfg_file in ${Q_VPN_EXTRA_CONF_FILES[@]}; do
716 VPN_CONF_FILES+=" --config-file $cfg_file"
717 done
718 fi
719
Mark McClainb05c8762013-07-06 23:29:39 -0400720 cp $NEUTRON_DIR/etc/l3_agent.ini $Q_L3_CONF_FILE
721
722 iniset $Q_L3_CONF_FILE DEFAULT verbose True
Ben Nemec03997942013-08-10 09:56:16 -0500723 iniset $Q_L3_CONF_FILE DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400724 iniset $Q_L3_CONF_FILE DEFAULT use_namespaces $Q_USE_NAMESPACE
725 iniset $Q_L3_CONF_FILE DEFAULT root_helper "$Q_RR_COMMAND"
726
Mark McClainb05c8762013-07-06 23:29:39 -0400727 _neutron_setup_interface_driver $Q_L3_CONF_FILE
728
729 neutron_plugin_configure_l3_agent
730}
731
Ian Wienandaee18c72014-02-21 15:35:08 +1100732function _configure_neutron_metadata_agent {
Mark McClainb05c8762013-07-06 23:29:39 -0400733 AGENT_META_BINARY="$NEUTRON_BIN_DIR/neutron-metadata-agent"
734 Q_META_CONF_FILE=$NEUTRON_CONF_DIR/metadata_agent.ini
735
736 cp $NEUTRON_DIR/etc/metadata_agent.ini $Q_META_CONF_FILE
737
738 iniset $Q_META_CONF_FILE DEFAULT verbose True
Ben Nemec03997942013-08-10 09:56:16 -0500739 iniset $Q_META_CONF_FILE DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400740 iniset $Q_META_CONF_FILE DEFAULT nova_metadata_ip $Q_META_DATA_IP
741 iniset $Q_META_CONF_FILE DEFAULT root_helper "$Q_RR_COMMAND"
742
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000743 _neutron_setup_keystone $Q_META_CONF_FILE DEFAULT True True
Maru Newbybf10ac52013-08-10 21:27:54 +0000744
Mark McClainb05c8762013-07-06 23:29:39 -0400745}
746
Ian Wienandaee18c72014-02-21 15:35:08 +1100747function _configure_neutron_lbaas {
Mark McClainb05c8762013-07-06 23:29:39 -0400748 neutron_agent_lbaas_configure_common
749 neutron_agent_lbaas_configure_agent
750}
751
Ian Wienandaee18c72014-02-21 15:35:08 +1100752function _configure_neutron_metering {
Emilien Macchi40546f72013-09-24 15:10:25 +0200753 neutron_agent_metering_configure_common
754 neutron_agent_metering_configure_agent
755}
756
Ian Wienandaee18c72014-02-21 15:35:08 +1100757function _configure_neutron_fwaas {
Ravi Chunduru95c93e22013-07-16 04:18:47 -0700758 neutron_fwaas_configure_common
759 neutron_fwaas_configure_driver
760}
761
Ian Wienandaee18c72014-02-21 15:35:08 +1100762function _configure_neutron_vpn {
Nachi Ueno69b3ff62013-06-07 10:28:33 -0700763 neutron_vpn_install_agent_packages
764 neutron_vpn_configure_common
Nachi Ueno69b3ff62013-06-07 10:28:33 -0700765}
766
Brian Haleyeea76212014-06-27 11:45:50 -0400767function _configure_dvr {
768 iniset $NEUTRON_CONF DEFAULT router_distributed True
769 iniset $Q_L3_CONF_FILE DEFAULT agent_mode $Q_DVR_MODE
770}
771
772
Mark McClainb05c8762013-07-06 23:29:39 -0400773# _configure_neutron_plugin_agent() - Set config files for neutron plugin agent
774# It is called when q-agt is enabled.
Ian Wienandaee18c72014-02-21 15:35:08 +1100775function _configure_neutron_plugin_agent {
Mark McClainb05c8762013-07-06 23:29:39 -0400776 # Specify the default root helper prior to agent configuration to
777 # ensure that an agent's configuration can override the default
778 iniset /$Q_PLUGIN_CONF_FILE agent root_helper "$Q_RR_COMMAND"
779 iniset $NEUTRON_CONF DEFAULT verbose True
Ben Nemec03997942013-08-10 09:56:16 -0500780 iniset $NEUTRON_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400781
782 # Configure agent for plugin
783 neutron_plugin_configure_plugin_agent
784}
785
786# _configure_neutron_service() - Set config files for neutron service
787# It is called when q-svc is enabled.
Ian Wienandaee18c72014-02-21 15:35:08 +1100788function _configure_neutron_service {
Mark McClainb05c8762013-07-06 23:29:39 -0400789 Q_API_PASTE_FILE=$NEUTRON_CONF_DIR/api-paste.ini
790 Q_POLICY_FILE=$NEUTRON_CONF_DIR/policy.json
791
792 cp $NEUTRON_DIR/etc/api-paste.ini $Q_API_PASTE_FILE
793 cp $NEUTRON_DIR/etc/policy.json $Q_POLICY_FILE
794
Mark McClainb05c8762013-07-06 23:29:39 -0400795 # Update either configuration file with plugin
796 iniset $NEUTRON_CONF DEFAULT core_plugin $Q_PLUGIN_CLASS
797
798 if [[ $Q_SERVICE_PLUGIN_CLASSES != '' ]]; then
799 iniset $NEUTRON_CONF DEFAULT service_plugins $Q_SERVICE_PLUGIN_CLASSES
800 fi
801
802 iniset $NEUTRON_CONF DEFAULT verbose True
Ben Nemec03997942013-08-10 09:56:16 -0500803 iniset $NEUTRON_CONF DEFAULT debug $ENABLE_DEBUG_LOG_LEVEL
Mark McClainb05c8762013-07-06 23:29:39 -0400804 iniset $NEUTRON_CONF DEFAULT policy_file $Q_POLICY_FILE
805 iniset $NEUTRON_CONF DEFAULT allow_overlapping_ips $Q_ALLOW_OVERLAPPING_IP
806
807 iniset $NEUTRON_CONF DEFAULT auth_strategy $Q_AUTH_STRATEGY
808 _neutron_setup_keystone $NEUTRON_CONF keystone_authtoken
809
Simon Pasquierca96b0a2013-07-09 16:59:12 +0200810 # Define extra "DEFAULT" configuration options when q-svc is configured by
811 # defining the array ``Q_SRV_EXTRA_DEFAULT_OPTS``.
812 # For Example: ``Q_SRV_EXTRA_DEFAULT_OPTS=(foo=true bar=2)``
813 for I in "${Q_SRV_EXTRA_DEFAULT_OPTS[@]}"; do
814 # Replace the first '=' with ' ' for iniset syntax
815 iniset $NEUTRON_CONF DEFAULT ${I/=/ }
816 done
817
Aaron Rosencea32b12014-03-04 16:20:14 -0800818 # Configuration for neutron notifations to nova.
Terry Wilsonf06c4432014-05-20 10:54:51 -0500819 iniset $NEUTRON_CONF DEFAULT notify_nova_on_port_status_changes $Q_NOTIFY_NOVA_PORT_STATUS_CHANGES
820 iniset $NEUTRON_CONF DEFAULT notify_nova_on_port_data_changes $Q_NOTIFY_NOVA_PORT_DATA_CHANGES
Aaron Rosencea32b12014-03-04 16:20:14 -0800821 iniset $NEUTRON_CONF DEFAULT nova_url "$NOVA_SERVICE_PROTOCOL://$NOVA_SERVICE_HOST:$NOVA_SERVICE_PORT/v2"
Dirk Mueller5ca261a2014-04-04 22:48:02 +0200822 iniset $NEUTRON_CONF DEFAULT nova_admin_username nova
Aaron Rosencea32b12014-03-04 16:20:14 -0800823 iniset $NEUTRON_CONF DEFAULT nova_admin_password $SERVICE_PASSWORD
824 ADMIN_TENANT_ID=$(openstack project list | awk "/ service / { print \$2 }")
825 iniset $NEUTRON_CONF DEFAULT nova_admin_tenant_id $ADMIN_TENANT_ID
826 iniset $NEUTRON_CONF DEFAULT nova_admin_auth_url "$KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_AUTH_PORT/v2.0"
827
Mark McClainb05c8762013-07-06 23:29:39 -0400828 # Configure plugin
829 neutron_plugin_configure_service
830}
831
832# Utility Functions
833#------------------
834
Isaku Yamahata9e136b42013-12-16 15:52:03 +0900835# _neutron_service_plugin_class_add() - add service plugin class
Ian Wienandaee18c72014-02-21 15:35:08 +1100836function _neutron_service_plugin_class_add {
Isaku Yamahata9e136b42013-12-16 15:52:03 +0900837 local service_plugin_class=$1
838 if [[ $Q_SERVICE_PLUGIN_CLASSES == '' ]]; then
839 Q_SERVICE_PLUGIN_CLASSES=$service_plugin_class
840 elif [[ ! ,${Q_SERVICE_PLUGIN_CLASSES}, =~ ,${service_plugin_class}, ]]; then
841 Q_SERVICE_PLUGIN_CLASSES="$Q_SERVICE_PLUGIN_CLASSES,$service_plugin_class"
842 fi
843}
844
Mark McClainb05c8762013-07-06 23:29:39 -0400845# _neutron_setup_rootwrap() - configure Neutron's rootwrap
Ian Wienandaee18c72014-02-21 15:35:08 +1100846function _neutron_setup_rootwrap {
Mark McClainb05c8762013-07-06 23:29:39 -0400847 if [[ "$Q_USE_ROOTWRAP" == "False" ]]; then
848 return
849 fi
850 # Deploy new rootwrap filters files (owned by root).
851 # Wipe any existing ``rootwrap.d`` files first
852 Q_CONF_ROOTWRAP_D=$NEUTRON_CONF_DIR/rootwrap.d
853 if [[ -d $Q_CONF_ROOTWRAP_D ]]; then
854 sudo rm -rf $Q_CONF_ROOTWRAP_D
855 fi
856 # Deploy filters to ``$NEUTRON_CONF_DIR/rootwrap.d``
857 mkdir -p -m 755 $Q_CONF_ROOTWRAP_D
858 cp -pr $NEUTRON_DIR/etc/neutron/rootwrap.d/* $Q_CONF_ROOTWRAP_D/
859 sudo chown -R root:root $Q_CONF_ROOTWRAP_D
860 sudo chmod 644 $Q_CONF_ROOTWRAP_D/*
861 # Set up ``rootwrap.conf``, pointing to ``$NEUTRON_CONF_DIR/rootwrap.d``
862 # location moved in newer versions, prefer new location
863 if test -r $NEUTRON_DIR/etc/neutron/rootwrap.conf; then
Sean Dague3bdb9222013-10-22 08:36:16 -0400864 sudo cp -p $NEUTRON_DIR/etc/neutron/rootwrap.conf $Q_RR_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400865 else
Sean Dague3bdb9222013-10-22 08:36:16 -0400866 sudo cp -p $NEUTRON_DIR/etc/rootwrap.conf $Q_RR_CONF_FILE
Mark McClainb05c8762013-07-06 23:29:39 -0400867 fi
868 sudo sed -e "s:^filters_path=.*$:filters_path=$Q_CONF_ROOTWRAP_D:" -i $Q_RR_CONF_FILE
869 sudo chown root:root $Q_RR_CONF_FILE
870 sudo chmod 0644 $Q_RR_CONF_FILE
871 # Specify ``rootwrap.conf`` as first parameter to neutron-rootwrap
872 ROOTWRAP_SUDOER_CMD="$NEUTRON_ROOTWRAP $Q_RR_CONF_FILE *"
873
874 # Set up the rootwrap sudoers for neutron
875 TEMPFILE=`mktemp`
Stephan Renatuse578eff2013-11-19 13:31:04 +0100876 echo "$STACK_USER ALL=(root) NOPASSWD: $ROOTWRAP_SUDOER_CMD" >$TEMPFILE
Mark McClainb05c8762013-07-06 23:29:39 -0400877 chmod 0440 $TEMPFILE
878 sudo chown root:root $TEMPFILE
879 sudo mv $TEMPFILE /etc/sudoers.d/neutron-rootwrap
880
881 # Update the root_helper
882 iniset $NEUTRON_CONF agent root_helper "$Q_RR_COMMAND"
883}
884
885# Configures keystone integration for neutron service and agents
Ian Wienandaee18c72014-02-21 15:35:08 +1100886function _neutron_setup_keystone {
Mark McClainb05c8762013-07-06 23:29:39 -0400887 local conf_file=$1
888 local section=$2
889 local use_auth_url=$3
Maru Newbybf10ac52013-08-10 21:27:54 +0000890 local skip_auth_cache=$4
Jamie Lennox3561d7f2014-05-21 17:18:43 +1000891
892 iniset $conf_file $section auth_uri $KEYSTONE_SERVICE_URI
893 iniset $conf_file $section identity_uri $KEYSTONE_AUTH_URI
Mark McClainb05c8762013-07-06 23:29:39 -0400894 iniset $conf_file $section admin_tenant_name $SERVICE_TENANT_NAME
895 iniset $conf_file $section admin_user $Q_ADMIN_USERNAME
896 iniset $conf_file $section admin_password $SERVICE_PASSWORD
Maru Newbybf10ac52013-08-10 21:27:54 +0000897 if [[ -z $skip_auth_cache ]]; then
898 iniset $conf_file $section signing_dir $NEUTRON_AUTH_CACHE_DIR
899 # Create cache dir
Emilien Macchia677b7f2013-11-25 23:40:20 +0100900 create_neutron_cache_dir
Maru Newbybf10ac52013-08-10 21:27:54 +0000901 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400902}
903
Ian Wienandaee18c72014-02-21 15:35:08 +1100904function _neutron_setup_interface_driver {
Mark McClainb05c8762013-07-06 23:29:39 -0400905
906 # ovs_use_veth needs to be set before the plugin configuration
907 # occurs to allow plugins to override the setting.
908 iniset $1 DEFAULT ovs_use_veth $Q_OVS_USE_VETH
909
910 neutron_plugin_setup_interface_driver $1
911}
912
913# Functions for Neutron Exercises
914#--------------------------------
915
Ian Wienandaee18c72014-02-21 15:35:08 +1100916function delete_probe {
Mark McClainb05c8762013-07-06 23:29:39 -0400917 local from_net="$1"
918 net_id=`_get_net_id $from_net`
919 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}'`
920 neutron-debug --os-tenant-name admin --os-username admin probe-delete $probe_id
921}
922
Ian Wienandaee18c72014-02-21 15:35:08 +1100923function setup_neutron_debug {
Mark McClainb05c8762013-07-06 23:29:39 -0400924 if [[ "$Q_USE_DEBUG_COMMAND" == "True" ]]; then
925 public_net_id=`_get_net_id $PUBLIC_NETWORK_NAME`
926 neutron-debug --os-tenant-name admin --os-username admin --os-password $ADMIN_PASSWORD probe-create --device-owner compute $public_net_id
927 private_net_id=`_get_net_id $PRIVATE_NETWORK_NAME`
928 neutron-debug --os-tenant-name admin --os-username admin --os-password $ADMIN_PASSWORD probe-create --device-owner compute $private_net_id
929 fi
930}
931
Ian Wienandaee18c72014-02-21 15:35:08 +1100932function teardown_neutron_debug {
Mark McClainb05c8762013-07-06 23:29:39 -0400933 delete_probe $PUBLIC_NETWORK_NAME
934 delete_probe $PRIVATE_NETWORK_NAME
935}
936
Ian Wienandaee18c72014-02-21 15:35:08 +1100937function _get_net_id {
Mark McClainb05c8762013-07-06 23:29:39 -0400938 neutron --os-tenant-name admin --os-username admin --os-password $ADMIN_PASSWORD net-list | grep $1 | awk '{print $2}'
939}
940
Ian Wienandaee18c72014-02-21 15:35:08 +1100941function _get_probe_cmd_prefix {
Mark McClainb05c8762013-07-06 23:29:39 -0400942 local from_net="$1"
943 net_id=`_get_net_id $from_net`
944 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`
945 echo "$Q_RR_COMMAND ip netns exec qprobe-$probe_id"
946}
947
Ian Wienandaee18c72014-02-21 15:35:08 +1100948function _ping_check_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400949 local from_net=$1
950 local ip=$2
951 local timeout_sec=$3
952 local expected=${4:-"True"}
953 local check_command=""
954 probe_cmd=`_get_probe_cmd_prefix $from_net`
955 if [[ "$expected" = "True" ]]; then
956 check_command="while ! $probe_cmd ping -w 1 -c 1 $ip; do sleep 1; done"
957 else
958 check_command="while $probe_cmd ping -w 1 -c 1 $ip; do sleep 1; done"
959 fi
960 if ! timeout $timeout_sec sh -c "$check_command"; then
961 if [[ "$expected" = "True" ]]; then
962 die $LINENO "[Fail] Couldn't ping server"
963 else
964 die $LINENO "[Fail] Could ping server"
965 fi
966 fi
967}
968
969# ssh check
Ian Wienandaee18c72014-02-21 15:35:08 +1100970function _ssh_check_neutron {
Mark McClainb05c8762013-07-06 23:29:39 -0400971 local from_net=$1
972 local key_file=$2
973 local ip=$3
974 local user=$4
975 local timeout_sec=$5
976 local probe_cmd = ""
977 probe_cmd=`_get_probe_cmd_prefix $from_net`
978 if ! timeout $timeout_sec sh -c "while ! $probe_cmd ssh -o StrictHostKeyChecking=no -i $key_file ${user}@$ip echo success; do sleep 1; done"; then
979 die $LINENO "server didn't become ssh-able!"
980 fi
981}
982
983# Neutron 3rd party programs
984#---------------------------
985
986# please refer to ``lib/neutron_thirdparty/README.md`` for details
987NEUTRON_THIRD_PARTIES=""
988for f in $TOP_DIR/lib/neutron_thirdparty/*; do
Sean Dague3bdb9222013-10-22 08:36:16 -0400989 third_party=$(basename $f)
990 if is_service_enabled $third_party; then
991 source $TOP_DIR/lib/neutron_thirdparty/$third_party
992 NEUTRON_THIRD_PARTIES="$NEUTRON_THIRD_PARTIES,$third_party"
993 fi
Mark McClainb05c8762013-07-06 23:29:39 -0400994done
995
Ian Wienandaee18c72014-02-21 15:35:08 +1100996function _neutron_third_party_do {
Mark McClainb05c8762013-07-06 23:29:39 -0400997 for third_party in ${NEUTRON_THIRD_PARTIES//,/ }; do
998 ${1}_${third_party}
999 done
1000}
1001
1002# configure_neutron_third_party() - Set config files, create data dirs, etc
Ian Wienandaee18c72014-02-21 15:35:08 +11001003function configure_neutron_third_party {
Mark McClainb05c8762013-07-06 23:29:39 -04001004 _neutron_third_party_do configure
1005}
1006
1007# init_neutron_third_party() - Initialize databases, etc.
Ian Wienandaee18c72014-02-21 15:35:08 +11001008function init_neutron_third_party {
Mark McClainb05c8762013-07-06 23:29:39 -04001009 _neutron_third_party_do init
1010}
1011
1012# install_neutron_third_party() - Collect source and prepare
Ian Wienandaee18c72014-02-21 15:35:08 +11001013function install_neutron_third_party {
Mark McClainb05c8762013-07-06 23:29:39 -04001014 _neutron_third_party_do install
1015}
1016
1017# start_neutron_third_party() - Start running processes, including screen
Ian Wienandaee18c72014-02-21 15:35:08 +11001018function start_neutron_third_party {
Mark McClainb05c8762013-07-06 23:29:39 -04001019 _neutron_third_party_do start
1020}
1021
1022# stop_neutron_third_party - Stop running processes (non-screen)
Ian Wienandaee18c72014-02-21 15:35:08 +11001023function stop_neutron_third_party {
Mark McClainb05c8762013-07-06 23:29:39 -04001024 _neutron_third_party_do stop
1025}
1026
armando-migliaccioef1e0802014-01-02 16:33:53 -08001027# check_neutron_third_party_integration() - Check that third party integration is sane
Ian Wienandaee18c72014-02-21 15:35:08 +11001028function check_neutron_third_party_integration {
armando-migliaccioef1e0802014-01-02 16:33:53 -08001029 _neutron_third_party_do check
1030}
1031
Sean M. Collins5ec6f8f2014-05-14 17:01:03 -04001032function is_provider_network {
1033 if [ "$Q_USE_PROVIDER_NETWORKING" == "True" ] && [ "$Q_L3_ENABLED" == "False" ]; then
1034 return 0
1035 fi
1036 return 1
1037}
1038
Mark McClainb05c8762013-07-06 23:29:39 -04001039
1040# Restore xtrace
1041$XTRACE
1042
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01001043# Tell emacs to use shell-script-mode
1044## Local variables:
1045## mode: shell-script
1046## End: