Merge "Add a high level README explaining how to use the chef scripts"

dev_setup/README

@@ -0,0 +1,67 @@
+NOTE: This is an alpha release of these scripts.
+
+Description:
+This subdirectory contains the chef cookbooks to deploy and setup Cloud Foundry
+in a single or multiple host environment. The cookbooks assume that they are
+running on a freshly installed Ubuntu 10.04 server.
+
+Quick Start:
+-----------
+   To Deploy:
+      vcap/dev_setup/bin/vcap_dev_setup
+
+         It will download Cloud Foundry source code into
+            $HOME/cloudfoundry/vcap
+
+         It will create a default deployment named 'devbox' under
+            $HOME/cloudfoundry/.deployments/devbox
+
+   To Start:
+      vcap/dev_setup/bin/vcap_dev start
+
+   To Stop:
+      vcap/dev_setup/bin/vcap_dev stop
+
+
+More Options:
+------------
+
+o To use Cloud Foundry source code that you have already downloaded.
+   To Deploy:
+     e.g. If Cloud Foundry source is downloaded into $HOME/projects/vcap.
+
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev_setup -d $HOME/projects
+
+        It will not download Cloud Foundry source code. It will just setup the config files to
+        use the Cloud Foundry source code from $HOME/projects/vcap.
+
+        It will create a default deployment named 'devbox' under
+          $HOME/projects/.deployment/devbox
+
+   To Start:
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev -d $HOME/projects start
+
+   To Stop::
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev -d $HOME/projects stop
+
+o To use a custom deployment config
+  e.g. If you want to use the multihost sample config file
+  $HOME/projects/vcap/dev_setup/deployments/sample/multihost_mysql/dea.yml
+
+   To Deploy:
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev_setup -d $HOME/projects -c $HOME/projects/vcap/dev_setup/deployments/sample/multihost_mysql/dea.yml
+
+        It will not download Cloud Foundry source code. It will just setup the config files to
+        use the Cloud Foundry source code from $HOME/projects/vcap.
+
+        It will create a deployment named 'dea' under
+          $HOME/projects/.deployment/dea
+
+   To Start:
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev -d $HOME/projects -n dea start
+
+   To Stop:
+      $HOME/projects/vcap/dev_setup/bin/vcap_dev -d $HOME/projects -n dea stop
+
+NOTE: To learn more about custom deployment config files and multi host setups
+see the README file vcap/dev_setup/deployments/README.

dev_setup/deployments/README

@@ -70,8 +70,14 @@ Here is a sampling of the currently supported jobs
  - redis_gateway
  - mongodb
  - mongodb_gateway
- - postgresql
- - postgresql_gateway
 
 The easiest way to get started on your multihost setup is to start customizing
 the various example config files that exist in this directory.
+
+NOTE: Supported multi host setups
+These scripts currently support the following multihost setup. DEA, Services and
+Router can be configured to run on different hosts. The following components however
+should all run on the same host
+- cloud_controller
+- health_manager
+- service gateways i.e. mysql_gateway, mongodb_gateway and redis_gateway