1. devstack
  2. Commit 0352f584abe0e88f372b9b8898b10e2ac25842f0
Browse code

Update README for swift off by default

Change 11277b1f3cfa850c074d3effbb43987b6e6e6391 disabled swift due to
port conflicts but the documentation still states that it is enabled
by default, which can be quite confusing.

While we're there, wrap affected lines to 80 chars.

Change-Id: I9d543f3368bdadadae482c163d814065009ab395

Ian Wienand authored on 2013/07/24 12:01:32
Showing 1 changed files
README.md
History View file @ 0352f58
... ... 
@@ -85,30 +85,42 @@ Example (Qpid):
85 85
86 86 
 # Swift
87 87
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.
88 
+Swift is disabled by default.  When enabled, it is configured with
89 
+only one replica to avoid being IO/memory intensive on a small
90 
+vm. When running with only one replica the account, container and
91 
+object services will run directly in screen. The others services like
92 
+replicator, updaters or auditor runs in background.
89 93
90 
-If you would like to disable Swift you can add this to your `localrc` :
94 
+If you would like to enable Swift you can add this to your `localrc` :
91 95
92 
-    disable_service s-proxy s-object s-container s-account
96 
+    enable_service s-proxy s-object s-container s-account
93 97
94 
-If you want a minimal Swift install with only Swift and Keystone you can have this instead in your `localrc`:
98 
+If you want a minimal Swift install with only Swift and Keystone you
99 
+can have this instead in your `localrc`:
95 100
96 101 
     disable_all_services
97 102 
     enable_service key mysql s-proxy s-object s-container s-account
98 103
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).
104 
+If you only want to do some testing of a real normal swift cluster
105 
+with multiple replicas you can do so by customizing the variable
106 
+`SWIFT_REPLICAS` in your `localrc` (usually to 3).
100 107
101 108 
 # Swift S3
102 109
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`.
110 
+If you are enabling `swift3` in `ENABLED_SERVICES` devstack will
111 
+install the swift3 middleware emulation. Swift will be configured to
112 
+act as a S3 endpoint for Keystone so effectively replacing the
113 
+`nova-objectstore`.
104 114
105 
-Only Swift proxy server is launched in the screen session all other services are started in background and managed by `swift-init` tool.
115 
+Only Swift proxy server is launched in the screen session all other
116 
+services are started in background and managed by `swift-init` tool.
106 117
107 118 
 # Neutron
108 119
109 120 
 Basic Setup
110 121
111 
-In order to enable Neutron a single node setup, you'll need the following settings in your `localrc` :
122 
+In order to enable Neutron a single node setup, you'll need the
123 
+following settings in your `localrc` :
112 124
113 125 
     disable_service n-net
114 126 
     enable_service q-svc