Browse code

Clarify deprecation of EXTRA_xxx_OPTS

The various EXTRA_xxx_OPTS variables will be removed in the Juno
development cycle, change the README to reflect the new way for
the Neutron variables.

Change-Id: Ic84da4a9b5a83e66cf0b57d643a87691f15517f0

Dean Troyer authored on 2014/03/01 02:11:45
Showing 2 changed files
... ...
@@ -163,7 +163,7 @@ services are started in background and managed by `swift-init` tool.
163 163
 Basic Setup
164 164
 
165 165
 In order to enable Neutron a single node setup, you'll need the
166
-following settings in your `localrc` section:
166
+following settings in your `local.conf`:
167 167
 
168 168
     disable_service n-net
169 169
     enable_service q-svc
... ...
@@ -172,7 +172,6 @@ following settings in your `localrc` section:
172 172
     enable_service q-l3
173 173
     enable_service q-meta
174 174
     enable_service q-metering
175
-    enable_service neutron
176 175
     # Optional, to enable tempest configuration as part of DevStack
177 176
     enable_service tempest
178 177
 
... ...
@@ -180,24 +179,44 @@ Then run `stack.sh` as normal.
180 180
 
181 181
 DevStack supports setting specific Neutron configuration flags to the
182 182
 service, Open vSwitch plugin and LinuxBridge plugin configuration files.
183
-To make use of this feature, the following variables are defined and can
184
-be configured in your `localrc` section:
183
+To make use of this feature, the settings can be added to ``local.conf``.
184
+The old ``Q_XXX_EXTRA_XXX_OPTS`` variables are deprecated and will be removed
185
+in the near future.  The ``local.conf`` headers for the replacements are:
185 186
 
186
-    Variable Name             Config File  Section Modified
187
-    -------------------------------------------------------------------------------------
188
-    Q_SRV_EXTRA_OPTS          Plugin       `OVS` (for Open Vswitch) or `LINUX_BRIDGE` (for LinuxBridge)
189
-    Q_AGENT_EXTRA_AGENT_OPTS  Plugin       AGENT
190
-    Q_AGENT_EXTRA_SRV_OPTS    Plugin       `OVS` (for Open Vswitch) or `LINUX_BRIDGE` (for LinuxBridge)
191
-    Q_SRV_EXTRA_DEFAULT_OPTS  Service      DEFAULT
187
+* ``Q_SRV_EXTRA_OPTS``:
188
+
189
+    [[post-config|/$Q_PLUGIN_CONF_FILE]]
190
+    [linuxbridge]   # or [ovs]
191
+
192
+* ``Q_AGENT_EXTRA_AGENT_OPTS``:
193
+
194
+    [[post-config|/$Q_PLUGIN_CONF_FILE]]
195
+    [agent]
196
+
197
+* ``Q_AGENT_EXTRA_SRV_OPTS``:
192 198
 
193
-An example of using the variables in your `localrc` section is below:
199
+    [[post-config|/$Q_PLUGIN_CONF_FILE]]
200
+    [linuxbridge]   # or [ovs]
201
+
202
+* ``Q_SRV_EXTRA_DEFAULT_OPTS``:
203
+
204
+    [[post-config|$NEUTRON_CONF]]
205
+    [DEFAULT]
194 206
 
195
-    Q_AGENT_EXTRA_AGENT_OPTS=(tunnel_type=vxlan vxlan_udp_port=8472)
196
-    Q_SRV_EXTRA_OPTS=(tenant_network_type=vxlan)
207
+Example extra config in `local.conf`:
208
+
209
+    [[post-config|/$Q_PLUGIN_CONF_FILE]]
210
+    [agent]
211
+    tunnel_type=vxlan
212
+    vxlan_udp_port=8472
213
+
214
+    [[post-config|$NEUTRON_CONF]]
215
+    [DEFAULT]
216
+    tenant_network_type=vxlan
197 217
 
198 218
 DevStack also supports configuring the Neutron ML2 plugin. The ML2 plugin
199
-can run with the OVS, LinuxBridge, or Hyper-V agents on compute hosts. A
200
-simple way to configure the ml2 plugin is shown below:
219
+can run with the OVS, LinuxBridge, or Hyper-V agents on compute hosts. This
220
+is a simple way to configure the ml2 plugin:
201 221
 
202 222
     # VLAN configuration
203 223
     Q_PLUGIN=ml2
... ...
@@ -223,7 +242,6 @@ To change this, set the `Q_AGENT` variable to the agent you want to run
223 223
     Q_ML2_PLUGIN_GRE_TYPE_OPTIONS    GRE TypeDriver options. Defaults to none.
224 224
     Q_ML2_PLUGIN_VXLAN_TYPE_OPTIONS  VXLAN TypeDriver options. Defaults to none.
225 225
     Q_ML2_PLUGIN_VLAN_TYPE_OPTIONS   VLAN TypeDriver options. Defaults to none.
226
-    Q_AGENT_EXTRA_AGENT_OPTS         Extra configuration options to pass to the OVS or LinuxBridge Agent.
227 226
 
228 227
 # Heat
229 228
 
... ...
@@ -1359,12 +1359,14 @@ if [[ -n "$DEPRECATED_TEXT" ]]; then
1359 1359
     echo_summary "WARNING: $DEPRECATED_TEXT"
1360 1360
 fi
1361 1361
 
1362
+# TODO(dtroyer): Remove EXTRA_OPTS after stable/icehouse branch is cut
1362 1363
 # Specific warning for deprecated configs
1363 1364
 if [[ -n "$EXTRA_OPTS" ]]; then
1364 1365
     echo ""
1365 1366
     echo_summary "WARNING: EXTRA_OPTS is used"
1366 1367
     echo "You are using EXTRA_OPTS to pass configuration into nova.conf."
1367 1368
     echo "Please convert that configuration in localrc to a nova.conf section in local.conf:"
1369
+    echo "EXTRA_OPTS will be removed early in the Juno development cycle"
1368 1370
     echo "
1369 1371
 [[post-config|\$NOVA_CONF]]
1370 1372
 [DEFAULT]
... ...
@@ -1375,11 +1377,13 @@ if [[ -n "$EXTRA_OPTS" ]]; then
1375 1375
     done
1376 1376
 fi
1377 1377
 
1378
+# TODO(dtroyer): Remove EXTRA_BAREMETAL_OPTS after stable/icehouse branch is cut
1378 1379
 if [[ -n "$EXTRA_BAREMETAL_OPTS" ]]; then
1379 1380
     echo ""
1380
-    echo_summary "WARNING: EXTRA_OPTS is used"
1381
-    echo "You are using EXTRA_OPTS to pass configuration into nova.conf."
1381
+    echo_summary "WARNING: EXTRA_BAREMETAL_OPTS is used"
1382
+    echo "You are using EXTRA_BAREMETAL_OPTS to pass configuration into nova.conf."
1382 1383
     echo "Please convert that configuration in localrc to a nova.conf section in local.conf:"
1384
+    echo "EXTRA_BAREMETAL_OPTS will be removed early in the Juno development cycle"
1383 1385
     echo "
1384 1386
 [[post-config|\$NOVA_CONF]]
1385 1387
 [baremetal]
... ...
@@ -1390,13 +1394,49 @@ if [[ -n "$EXTRA_BAREMETAL_OPTS" ]]; then
1390 1390
     done
1391 1391
 fi
1392 1392
 
1393
+# TODO(dtroyer): Remove Q_AGENT_EXTRA_AGENT_OPTS after stable/juno branch is cut
1394
+if [[ -n "$Q_AGENT_EXTRA_AGENT_OPTS" ]]; then
1395
+    echo ""
1396
+    echo_summary "WARNING: Q_AGENT_EXTRA_AGENT_OPTS is used"
1397
+    echo "You are using Q_AGENT_EXTRA_AGENT_OPTS to pass configuration into $NEUTRON_CONF."
1398
+    echo "Please convert that configuration in localrc to a $NEUTRON_CONF section in local.conf:"
1399
+    echo "Q_AGENT_EXTRA_AGENT_OPTS will be removed early in the 'K' development cycle"
1400
+    echo "
1401
+[[post-config|/\$Q_PLUGIN_CONF_FILE]]
1402
+[DEFAULT]
1403
+"
1404
+    for I in "${Q_AGENT_EXTRA_AGENT_OPTS[@]}"; do
1405
+        # Replace the first '=' with ' ' for iniset syntax
1406
+        echo ${I}
1407
+    done
1408
+fi
1409
+
1410
+# TODO(dtroyer): Remove Q_AGENT_EXTRA_SRV_OPTS after stable/juno branch is cut
1411
+if [[ -n "$Q_AGENT_EXTRA_SRV_OPTS" ]]; then
1412
+    echo ""
1413
+    echo_summary "WARNING: Q_AGENT_EXTRA_SRV_OPTS is used"
1414
+    echo "You are using Q_AGENT_EXTRA_SRV_OPTS to pass configuration into $NEUTRON_CONF."
1415
+    echo "Please convert that configuration in localrc to a $NEUTRON_CONF section in local.conf:"
1416
+    echo "Q_AGENT_EXTRA_AGENT_OPTS will be removed early in the 'K' development cycle"
1417
+    echo "
1418
+[[post-config|/\$Q_PLUGIN_CONF_FILE]]
1419
+[DEFAULT]
1420
+"
1421
+    for I in "${Q_AGENT_EXTRA_SRV_OPTS[@]}"; do
1422
+        # Replace the first '=' with ' ' for iniset syntax
1423
+        echo ${I}
1424
+    done
1425
+fi
1426
+
1427
+# TODO(dtroyer): Remove Q_DHCP_EXTRA_DEFAULT_OPTS after stable/icehouse branch is cut
1393 1428
 if [[ -n "$Q_DHCP_EXTRA_DEFAULT_OPTS" ]]; then
1394 1429
     echo ""
1395 1430
     echo_summary "WARNING: Q_DHCP_EXTRA_DEFAULT_OPTS is used"
1396 1431
     echo "You are using Q_DHCP_EXTRA_DEFAULT_OPTS to pass configuration into $Q_DHCP_CONF_FILE."
1397 1432
     echo "Please convert that configuration in localrc to a $Q_DHCP_CONF_FILE section in local.conf:"
1433
+    echo "Q_DHCP_EXTRA_DEFAULT_OPTS will be removed early in the Juno development cycle"
1398 1434
     echo "
1399
-[[post-config|\$Q_DHCP_CONF_FILE]]
1435
+[[post-config|/\$Q_DHCP_CONF_FILE]]
1400 1436
 [DEFAULT]
1401 1437
 "
1402 1438
     for I in "${Q_DHCP_EXTRA_DEFAULT_OPTS[@]}"; do
... ...
@@ -1405,11 +1445,13 @@ if [[ -n "$Q_DHCP_EXTRA_DEFAULT_OPTS" ]]; then
1405 1405
     done
1406 1406
 fi
1407 1407
 
1408
+# TODO(dtroyer): Remove Q_SRV_EXTRA_DEFAULT_OPTS after stable/icehouse branch is cut
1408 1409
 if [[ -n "$Q_SRV_EXTRA_DEFAULT_OPTS" ]]; then
1409 1410
     echo ""
1410 1411
     echo_summary "WARNING: Q_SRV_EXTRA_DEFAULT_OPTS is used"
1411 1412
     echo "You are using Q_SRV_EXTRA_DEFAULT_OPTS to pass configuration into $NEUTRON_CONF."
1412 1413
     echo "Please convert that configuration in localrc to a $NEUTRON_CONF section in local.conf:"
1414
+    echo "Q_SRV_EXTRA_DEFAULT_OPTS will be removed early in the Juno development cycle"
1413 1415
     echo "
1414 1416
 [[post-config|\$NEUTRON_CONF]]
1415 1417
 [DEFAULT]