Browse code

Enable swift by default.

- Set by default SWIFT_REPLICAS to 1 since this is the most common use
case when using it in devstack.
- If we have swift_replicas to 1 launch the object container account and
proxy servers in foreground in screen.
- Allow any s- services if we have just 'swift' in service enabled
instead of having to specify all s- services to enable swift. This will be
removed in the future.

Change-Id: I496f79e14f99bd7e9f2c7deee12a4b6e935c3a5b

Chmouel Boudjnah authored on 2013/02/04 21:09:10
Showing 11 changed files
... ...
@@ -85,19 +85,21 @@ Example (Qpid):
85 85
 
86 86
 # Swift
87 87
 
88
-Swift is not installed by default, you can enable easily by adding this to your `localrc`:
88
+Swift is enabled by default configured with only one replica to avoid being IO/memory intensive on a small vm. When running with only one replica the account, container and object services will run directly in screen. The others services like replicator, updaters or auditor runs in background.
89 89
 
90
-    enable_service swift
90
+If you would like to disable Swift you can add this to your `localrc` :
91
+
92
+    disable_service s-proxy s-object s-container s-account
91 93
 
92 94
 If you want a minimal Swift install with only Swift and Keystone you can have this instead in your `localrc`:
93 95
 
94 96
     disable_all_services
95
-    enable_service key mysql swift
97
+    enable_service key mysql s-proxy s-object s-container s-account
98
+
99
+If you only want to do some testing of a real normal swift cluster with multiple replicas you can do so by customizing the variable `SWIFT_REPLICAS` in your `localrc` (usually to 3).
96 100
 
97
-If you use Swift with Keystone, Swift will authenticate against it. You will need to make sure to use the Keystone URL to auth against.
101
+# Swift S3
98 102
 
99 103
 If you are enabling `swift3` in `ENABLED_SERVICES` devstack will install the swift3 middleware emulation. Swift will be configured to act as a S3 endpoint for Keystone so effectively replacing the `nova-objectstore`.
100 104
 
101 105
 Only Swift proxy server is launched in the screen session all other services are started in background and managed by `swift-init` tool.
102
-
103
-By default Swift will configure 3 replicas (and one spare) which could be IO intensive on a small vm, if you only want to do some quick testing of the API you can choose to only have one replica by customizing the variable `SWIFT_REPLICAS` in your `localrc`.
... ...
@@ -136,7 +136,7 @@ fi
136 136
 # Swift client
137 137
 # ------------
138 138
 
139
-if [[ "$ENABLED_SERVICES" =~ "swift" ]]; then
139
+if [[ "$ENABLED_SERVICES" =~ "swift" || "$ENABLED_SERVICES" =~ "s-proxy" ]]; then
140 140
     if [[ "$SKIP_EXERCISES" =~ "swift" ]] ; then
141 141
         STATUS_SWIFT="Skipped"
142 142
     else
... ...
@@ -144,7 +144,8 @@ fi
144 144
 # Swift client
145 145
 # ------------
146 146
 
147
-if [[ "$ENABLED_SERVICES" =~ "swift" ]]; then
147
+
148
+if [[ "$ENABLED_SERVICES" =~ "swift" || "$ENABLED_SERVICES" =~ "s-proxy" ]]; then
148 149
     if [[ "$SKIP_EXERCISES" =~ "swift" ]] ; then
149 150
         STATUS_SWIFT="Skipped"
150 151
     else
... ...
@@ -35,7 +35,7 @@ source $TOP_DIR/exerciserc
35 35
 
36 36
 # If swift is not enabled we exit with exitcode 55 which mean
37 37
 # exercise is skipped.
38
-is_service_enabled swift || exit 55
38
+is_service_enabled s-proxy || exit 55
39 39
 
40 40
 # Container name
41 41
 CONTAINER=ex-swift
... ...
@@ -52,7 +52,7 @@ RESELLER_ROLE=$(get_id keystone role-create --name=ResellerAdmin)
52 52
 # Services
53 53
 # --------
54 54
 
55
-if [[ "$ENABLED_SERVICES" =~ "n-api" ]] && [[ "$ENABLED_SERVICES" =~ "swift" ]]; then
55
+if [[ "$ENABLED_SERVICES" =~ "n-api" ]] && [[ "$ENABLED_SERVICES" =~ "s-proxy" || "$ENABLED_SERVICES" =~ "swift" ]]; then
56 56
     NOVA_USER=$(keystone user-list | awk "/ nova / { print \$2 }")
57 57
     # Nova needs ResellerAdmin role to download images when accessing
58 58
     # swift through the s3 api.
... ...
@@ -123,7 +123,8 @@ if [[ "$ENABLED_SERVICES" =~ "g-api" ]]; then
123 123
 fi
124 124
 
125 125
 # Swift
126
-if [[ "$ENABLED_SERVICES" =~ "swift" ]]; then
126
+
127
+if [[ "$ENABLED_SERVICES" =~ "swift" || "$ENABLED_SERVICES" =~ "s-proxy" ]]; then
127 128
     SWIFT_USER=$(get_id keystone user-create \
128 129
         --name=swift \
129 130
         --pass="$SERVICE_PASSWORD" \
... ...
@@ -190,7 +191,7 @@ if [[ "$ENABLED_SERVICES" =~ "n-api" ]]; then
190 190
 fi
191 191
 
192 192
 # S3
193
-if [[ "$ENABLED_SERVICES" =~ "n-obj" || "$ENABLED_SERVICES" =~ "swift" ]]; then
193
+if [[ "$ENABLED_SERVICES" =~ "n-obj" || "$ENABLED_SERVICES" =~ "swift3" ]]; then
194 194
     if [[ "$KEYSTONE_CATALOG_BACKEND" = 'sql' ]]; then
195 195
         S3_SERVICE=$(get_id keystone service-create \
196 196
             --name=s3 \
... ...
@@ -562,6 +562,9 @@ $option = $value
562 562
 #   **ceilometer** returns true if any service enabled start with **ceilometer**
563 563
 #   **glance** returns true if any service enabled start with **g-**
564 564
 #   **quantum** returns true if any service enabled start with **q-**
565
+#   **swift** returns true if any service enabled start with **s-**
566
+#   For backward compatibility if we have **swift** in ENABLED_SERVICES all the
567
+#   **s-** services will be enabled. This will be deprecated in the future.
565 568
 #
566 569
 # Uses global ``ENABLED_SERVICES``
567 570
 # is_service_enabled service [service ...]
... ...
@@ -574,6 +577,8 @@ function is_service_enabled() {
574 574
         [[ ${service} == "ceilometer" && ${ENABLED_SERVICES} =~ "ceilometer-" ]] && return 0
575 575
         [[ ${service} == "glance" && ${ENABLED_SERVICES} =~ "g-" ]] && return 0
576 576
         [[ ${service} == "quantum" && ${ENABLED_SERVICES} =~ "q-" ]] && return 0
577
+        [[ ${service} == "swift" && ${ENABLED_SERVICES} =~ "s-" ]] && return 0
578
+        [[ ${service} == s-* && ${ENABLED_SERVICES} =~ "swift" ]] && return 0
577 579
     done
578 580
     return 1
579 581
 }
... ...
@@ -146,7 +146,7 @@ function configure_keystone() {
146 146
         cp -p $FILES/default_catalog.templates $KEYSTONE_CATALOG
147 147
 
148 148
         # Add swift endpoints to service catalog if swift is enabled
149
-        if is_service_enabled swift; then
149
+        if is_service_enabled s-proxy; then
150 150
             echo "catalog.RegionOne.object_store.publicURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
151 151
             echo "catalog.RegionOne.object_store.adminURL = http://%SERVICE_HOST%:8080/" >> $KEYSTONE_CATALOG
152 152
             echo "catalog.RegionOne.object_store.internalURL = http://%SERVICE_HOST%:8080/v1/AUTH_\$(tenant_id)s" >> $KEYSTONE_CATALOG
... ...
@@ -56,10 +56,11 @@ SWIFT_LOOPBACK_DISK_SIZE=${SWIFT_LOOPBACK_DISK_SIZE:-1000000}
56 56
 SWIFT_PARTITION_POWER_SIZE=${SWIFT_PARTITION_POWER_SIZE:-9}
57 57
 
58 58
 # Set ``SWIFT_REPLICAS`` to configure how many replicas are to be
59
-# configured for your Swift cluster.  By default the three replicas would need a
60
-# bit of IO and Memory on a VM you may want to lower that to 1 if you want to do
61
-# only some quick testing.
62
-SWIFT_REPLICAS=${SWIFT_REPLICAS:-3}
59
+# configured for your Swift cluster. By default we are configuring
60
+# only one replica since this is way less CPU and memory intensive. If
61
+# you are planning to test swift replication you may want to set this
62
+# up to 3.
63
+SWIFT_REPLICAS=${SWIFT_REPLICAS:-1}
63 64
 SWIFT_REPLICAS_SEQ=$(seq ${SWIFT_REPLICAS})
64 65
 
65 66
 # Set ``OBJECT_PORT_BASE``, ``CONTAINER_PORT_BASE``, ``ACCOUNT_PORT_BASE``
... ...
@@ -359,13 +360,26 @@ function start_swift() {
359 359
         sudo systemctl start xinetd.service
360 360
     fi
361 361
 
362
-   # First spawn all the swift services then kill the
363
-   # proxy service so we can run it in foreground in screen.
364
-   # ``swift-init ... {stop|restart}`` exits with '1' if no servers are running,
365
-   # ignore it just in case
362
+   # By default with only one replica we are launching the proxy,
363
+   # container, account and object server in screen in foreground and
364
+   # other services in background. If we have SWIFT_REPLICAS set to something
365
+   # greater than one we first spawn all the swift services then kill the proxy
366
+   # service so we can run it in foreground in screen.  ``swift-init ...
367
+   # {stop|restart}`` exits with '1' if no servers are running, ignore it just
368
+   # in case
366 369
    swift-init --run-dir=${SWIFT_DATA_DIR}/run all restart || true
367
-   swift-init --run-dir=${SWIFT_DATA_DIR}/run proxy stop || true
368
-   screen_it swift "cd $SWIFT_DIR && $SWIFT_DIR/bin/swift-proxy-server ${SWIFT_CONFIG_DIR}/proxy-server.conf -v"
370
+   if [[ ${SWIFT_REPLICAS} == 1 ]];then
371
+        todo="object container account"
372
+   fi
373
+   for type in proxy ${todo};do
374
+       swift-init --run-dir=${SWIFT_DATA_DIR}/run ${type} stop || true
375
+   done
376
+   screen_it s-proxy "cd $SWIFT_DIR && $SWIFT_DIR/bin/swift-proxy-server ${SWIFT_CONFIG_DIR}/proxy-server.conf -v"
377
+   if [[ ${SWIFT_REPLICAS} == 1 ]];then
378
+       for type in object container account;do
379
+           screen_it s-${type} "cd $SWIFT_DIR && $SWIFT_DIR/bin/swift-${type}-server ${SWIFT_CONFIG_DIR}/${type}-server/1.conf -v"
380
+       done
381
+   fi
369 382
 }
370 383
 
371 384
 # stop_swift() - Stop running processes (non-screen)
... ...
@@ -433,7 +433,7 @@ if is_service_enabled rabbit; then
433 433
     read_password RABBIT_PASSWORD "ENTER A PASSWORD TO USE FOR RABBIT."
434 434
 fi
435 435
 
436
-if is_service_enabled swift; then
436
+if is_service_enabled s-proxy; then
437 437
     # If we are using swift3, we can default the s3 port to swift instead
438 438
     # of nova-objectstore
439 439
     if is_service_enabled swift3;then
... ...
@@ -670,12 +670,12 @@ install_novaclient
670 670
 git_clone $OPENSTACKCLIENT_REPO $OPENSTACKCLIENT_DIR $OPENSTACKCLIENT_BRANCH
671 671
 
672 672
 # glance, swift middleware and nova api needs keystone middleware
673
-if is_service_enabled key g-api n-api swift; then
673
+if is_service_enabled key g-api n-api s-proxy; then
674 674
     # unified auth system (manages accounts/tokens)
675 675
     install_keystone
676 676
 fi
677 677
 
678
-if is_service_enabled swift; then
678
+if is_service_enabled s-proxy; then
679 679
     install_swiftclient
680 680
     install_swift
681 681
     if is_service_enabled swift3; then
... ...
@@ -732,10 +732,10 @@ echo_summary "Configuring OpenStack projects"
732 732
 configure_keystoneclient
733 733
 configure_novaclient
734 734
 setup_develop $OPENSTACKCLIENT_DIR
735
-if is_service_enabled key g-api n-api swift; then
735
+if is_service_enabled key g-api n-api s-proxy; then
736 736
     configure_keystone
737 737
 fi
738
-if is_service_enabled swift; then
738
+if is_service_enabled s-proxy; then
739 739
     configure_swift
740 740
     configure_swiftclient
741 741
     if is_service_enabled swift3; then
... ...
@@ -919,7 +919,7 @@ if is_service_enabled g-reg; then
919 919
     init_glance
920 920
 
921 921
     # Store the images in swift if enabled.
922
-    if is_service_enabled swift; then
922
+    if is_service_enabled s-proxy; then
923 923
         iniset $GLANCE_API_CONF DEFAULT default_store swift
924 924
         iniset $GLANCE_API_CONF DEFAULT swift_store_auth_address $KEYSTONE_SERVICE_PROTOCOL://$KEYSTONE_SERVICE_HOST:$KEYSTONE_SERVICE_PORT/v2.0/
925 925
         iniset $GLANCE_API_CONF DEFAULT swift_store_user $SERVICE_TENANT_NAME:glance
... ...
@@ -978,7 +978,7 @@ fi
978 978
 # Storage Service
979 979
 # ---------------
980 980
 
981
-if is_service_enabled swift; then
981
+if is_service_enabled s-proxy; then
982 982
     echo_summary "Configuring Swift"
983 983
     init_swift
984 984
 fi
... ...
@@ -1125,7 +1125,7 @@ fi
1125 1125
 # Only run the services specified in ``ENABLED_SERVICES``
1126 1126
 
1127 1127
 # Launch Swift Services
1128
-if is_service_enabled swift; then
1128
+if is_service_enabled s-proxy; then
1129 1129
     echo_summary "Starting Swift"
1130 1130
     start_swift
1131 1131
 fi
... ...
@@ -21,7 +21,7 @@ fi
21 21
 # ``disable_service`` functions in ``localrc``.
22 22
 # For example, to enable Swift add this to ``localrc``:
23 23
 # enable_service swift
24
-ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xvnc,n-cauth,horizon,rabbit,tempest,mysql
24
+ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,cinder,c-sch,c-api,c-vol,n-sch,n-novnc,n-xvnc,n-cauth,s-proxy,s-account,s-object,s-container,horizon,rabbit,tempest,mysql
25 25
 
26 26
 # Set the default Nova APIs to enable
27 27
 NOVA_ENABLED_APIS=ec2,osapi_compute,metadata
... ...
@@ -63,7 +63,7 @@ if [[ -n "$SCREEN" ]]; then
63 63
 fi
64 64
 
65 65
 # Swift runs daemons
66
-if is_service_enabled swift; then
66
+if is_service_enabled s-proxy; then
67 67
     stop_swift
68 68
     cleanup_swift
69 69
 fi