[yocto] [PATCH 07/13] README-GOOGLE-CLOUD: initial commit

[californialsullivan at gmail.com]

From: California Sullivan <california.l.sullivan at intel.com>

Goes over some limitations and gives an example of how to use it.

Signed-off-by: California Sullivan <california.l.sullivan at intel.com>
---
 README-GOOGLE-CLOUD | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README-GOOGLE-CLOUD

diff --git a/README-GOOGLE-CLOUD b/README-GOOGLE-CLOUD
new file mode 100644
index 0000000..30bf5b6
--- /dev/null
+++ b/README-GOOGLE-CLOUD
@@ -0,0 +1,54 @@
+Limitations
+------------
+The current implementation of the Google Cloud building has a couple of
+limitations.
+
+First of all, Google's gcloud command line tool is required for
+all functions (see https://developers.google.com/cloud/sdk/gcloud/).
+
+Next, the controller system is required to be authenticated with Google's cloud
+system (see https://developers.google.com/cloud/sdk/gcloud/reference/auth/).
+
+Third, the workers must be on a network which has the worker port
+(port 9989 by default) open. This can be done by setting up a network and
+using that network in the ProvisionGoogleVM builstep. Example commands to
+set up a network:
+
+gcloud compute networks create autobuilder-network
+gcloud compute firewall-rules autobuilder-allow --network autobuilder-network \
+    --allow tcp:8010 tcp:9989 tcp:80 tcp:22
+
+This sets up a network that is suitable for both controllers and workers, as
+it allows all default autobuilder connections, as well as ssh and http. The
+key:value pair 'network':'autobuilder-network' can then be added to your
+ProvisionGoogleVM buildstep for use.
+
+Fourth, additional workers must be added to yocto-controller/controller.cfg
+with the format:
+     BuildWorker("worker<N>", "<WORKER-PASSWORD>", max_builds=3)
+where N is 0...however many workers you want and WORKER-PASSWORD is the default
+password.
+
+Finally, the worker-init script is only an example and has a couple
+limitations. It has only been tested for debian VMs and will likely not work
+on others. Also, the <HOST_ADDR> and <PASS> fields will need to be manually
+edited in it if your autobuilder was created before the addition of the
+GoogleVM buildsteps or if the controller machine is behind a firewall.
+
+HowTo
+----------
+
+Assuming that the limitations above have been dealt with, this will provision
+one new VM and completely set it up, including connections
+
+{'ProvisionGoogleVM':{
+    'vmname':'autobuilder-worker-startup-test',
+    'vmcount':1,
+    'zone':'us-central1-a',
+    'machine':'n1-standard-4',
+    'disksize':'230GB',
+    'startupscript':'/home/autobuilder/yocto-autobuilder/bin/worker-init',
+    'network':'autobuilder-network'}}
+
+
+{'DeleteGoogleVM': {}}
-- 
1.9.1