Merge pull request #54 from kwoodson/ossh

Adding ssh dynamic hosts capabilities

1 files changed, 33 insertions, 0 deletions

diff --git a/bin/README_SHELL_COMPLETION b/bin/README_SHELL_COMPLETION
new file mode 100644
index 000000000..e17b4b205
--- /dev/null
+++ b/bin/README_SHELL_COMPLETION
@@ -0,0 +1,33 @@
+# ossh is an ssh replacement.
+
+
+ossh uses a dynamic inventory cache in order to lookup hostnames and translate them
+to something meaningful such as an IP address or dns name.
+
+This allows us to treat our servers as cattle and not as pets.
+
+If you have not run the ossh command and it has not laid down
+a cache file the completions will not be available.
+
+You can populate the cache by running `ossh --list`.  This
+will populate the cache file and the completions should
+become available.
+
+This script will look at the cached version of your
+multi_ec2 results in ~/.ansible/tmp/multi_ec2_inventory.cache.
+It will then parse a few {host}.{env} out of the json
+and return them to be completable.
+
+# BASH
+In order to setup bash completion, source the following script:
+/path/to/repository/openshift-online-ansible/bin/ossh_bash_completion
+
+# ZSH
+In order to setup zsh completion, you will need to verify
+that the _ossh_zsh_completion script is somewhere in the path
+of $fpath.
+
+Once $fpath includes the _ossh_zsh_completion script then you should
+run `exec zsh`.  This will then allow you to call `ossh host[TAB]`
+for a list of completions.
+