From 40723f8705fb6c10913b51718a465c09d170f9b4 Mon Sep 17 00:00:00 2001 From: James Shubin Date: Wed, 31 Aug 2016 22:07:57 -0400 Subject: [PATCH] docs: Add additional documentation about remote execution --- DOCUMENTATION.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 33e9662e..474ca4a5 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -160,6 +160,11 @@ leaving no residual agent. This mode can also be useful for bootstrapping a new host where you'd like to have the service run continuously and as part of an mgmt cluster normally. +In particular, when combined with the `--converged-timeout` parameter, the +entire set of running mgmt agents will need to all simultaneously converge for +the group to exit. This is particularly useful for bootstrapping new clusters +which need to exchange information that is only available at run time. + ####Blog post An introductory blog post about this topic will follow soon. @@ -267,6 +272,23 @@ Point to a graph file to run on the remote host specified within. This parameter can be used multiple times if you'd like to remotely run on multiple hosts in parallel. +####`--allow-interactive` +Allow interactive prompting for SSH passwords if there is no authentication +method that works. + +####`--ssh-priv-id-rsa` +Specify the path for finding SSH keys. This defaults to `~/.ssh/id_rsa`. To +never use this method of authentication, set this to the empty string. + +####`--cconns` +The maximum number of concurrent remote ssh connections to run. This defaults +to `0`, which means unlimited. + +####`--no-caching` +Don't allow remote caching of the remote execution binary. This will require +the binary to be copied over for every remote execution, but it limits the +likelihood that there is leftover information from the configuration process. + ####`--prefix ` Specify a path to a custom working directory prefix. This directory will get created if it does not exist. This usually defaults to `/var/lib/mgmt/`. This