summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Fotheringham <pete.fotheringham@codethink.co.uk>2014-12-01 13:43:44 +0000
committerPete Fotheringham <pete.fotheringham@codethink.co.uk>2014-12-01 13:43:44 +0000
commit3a3b4f7a31457fa9afd5d47d11d20c5ed4b79683 (patch)
treed60af73ca591dbcd688b0b566ab50f54797b9902
parent1aa3d42435bad2fac2fa18726abfa2cc7b3d822e (diff)
downloadmorph-3a3b4f7a31457fa9afd5d47d11d20c5ed4b79683.tar.gz
Action review comments
- Document different ways of calling parameters - Allowed values for boolean parameters
-rw-r--r--morphlib/exts/virtualbox-ssh.write.help11
-rw-r--r--morphlib/plugins/deploy_plugin.py23
2 files changed, 28 insertions, 6 deletions
diff --git a/morphlib/exts/virtualbox-ssh.write.help b/morphlib/exts/virtualbox-ssh.write.help
index 95b2e247..a19d8fb2 100644
--- a/morphlib/exts/virtualbox-ssh.write.help
+++ b/morphlib/exts/virtualbox-ssh.write.help
@@ -41,13 +41,12 @@ help: |
* INITRAMFS_PATH=path: the location of an initramfs for the bootloader to
tell Linux to use, rather than booting the rootfs directly.
- * AUTOSTART=<VALUE> - allowed values are `yes` and `no` (default). If the
- value is 'yes', the VM will be started when it has been deployed.
+ * AUTOSTART=<VALUE> - boolean. If it is set, the VM will be started when
+ it has been deployed.
- * VAGRANT=<VALUE> - allowed values are `yes` and `no` (default). If the
- value is 'yes', then networking is configured so that the VM will work
- with Vagrant. Otherwise networking is configured to run directly in
- VirtualBox.
+ * VAGRANT=<VALUE> - boolean. If it is set, then networking is configured
+ so that the VM will work with Vagrant. Otherwise networking is configured
+ to run directly in VirtualBox.
* HOST_IPADDR=<ip_address> - the IP address of the VM host.
diff --git a/morphlib/plugins/deploy_plugin.py b/morphlib/plugins/deploy_plugin.py
index dd0ba903..f7bb4ffa 100644
--- a/morphlib/plugins/deploy_plugin.py
+++ b/morphlib/plugins/deploy_plugin.py
@@ -177,6 +177,29 @@ class DeployPlugin(cliapp.Plugin):
the _address_ of the trove, _not_ `user@...`, since `root@` will
automatically be prepended to the server address.)
+ In addition to the `location`parameter, deployments can take additional
+ `KEY=VALUE` parameters. These can be provided in the following ways:
+
+ 1. In the cluster definition file, e.g.
+
+ …
+ systems:
+ - morph: systems/foo-system.morph
+ deploy:
+ foo:
+ HOSTNAME: foo
+
+ 2. In the environment before running e.g. `HOSTNAME=foo morph deploy …`
+
+ 3. On the command-line e.g.
+ `morph deploy clusters/foo.morph foo.HOSTNAME=foo`
+
+ For any boolean `KEY=VALUE` parameters, allowed values are:
+
+ +ve `yes`, `1`, `true`;
+
+ -ve `no`, `0`, `false`;
+
The following `KEY=VALUE` parameters are supported for `rawdisk`,
`virtualbox-ssh` and `kvm` and deployment types: