summaryrefslogtreecommitdiffstats
path: root/images/installer/root/usr/local/bin/usage
diff options
context:
space:
mode:
authorjuanvallejo <jvallejo@redhat.com>2017-07-12 15:18:48 -0400
committerLuke Meyer <lmeyer@redhat.com>2017-07-18 14:02:10 -0400
commit5497673a7b5a7c07d3e99d77d028447acbdd36a5 (patch)
treecfda08c072b85c36570c218e6c2020621f264dba /images/installer/root/usr/local/bin/usage
parent742203529902ba278c213e326f81f667304b9625 (diff)
downloadopenshift-5497673a7b5a7c07d3e99d77d028447acbdd36a5.tar.gz
openshift-5497673a7b5a7c07d3e99d77d028447acbdd36a5.tar.bz2
openshift-5497673a7b5a7c07d3e99d77d028447acbdd36a5.tar.xz
openshift-5497673a7b5a7c07d3e99d77d028447acbdd36a5.zip
image builds: remove dependency on playbook2image
We do not need the builder functionality from playbook2image and the resulting image was overly complicated, so this simply builds on Centos/RHEL.
Diffstat (limited to 'images/installer/root/usr/local/bin/usage')
-rwxr-xr-ximages/installer/root/usr/local/bin/usage33
1 files changed, 33 insertions, 0 deletions
diff --git a/images/installer/root/usr/local/bin/usage b/images/installer/root/usr/local/bin/usage
new file mode 100755
index 000000000..3518d7f19
--- /dev/null
+++ b/images/installer/root/usr/local/bin/usage
@@ -0,0 +1,33 @@
+#!/bin/bash -e
+cat <<"EOF"
+
+The origin-ansible image provides several options to control the behaviour of the containers.
+For more details on these options see the documentation:
+
+ https://github.com/openshift/openshift-ansible/blob/master/README_CONTAINER_IMAGE.md
+
+At a minimum, when running a container using this image you must provide:
+
+* ssh keys so that Ansible can reach your hosts. These should be mounted as a volume under
+ /opt/app-root/src/.ssh
+* An inventory file. This can be mounted inside the container as a volume and specified with the
+ INVENTORY_FILE environment variable. Alternatively you can serve the inventory file from a web
+ server and use the INVENTORY_URL environment variable to fetch it.
+* The playbook to run. This is set using the PLAYBOOK_FILE environment variable.
+
+Here is an example of how to run a containerized origin-ansible with
+the openshift_facts playbook, which collects and displays facts about your
+OpenShift environment. The inventory and ssh keys are mounted as volumes
+(the latter requires setting the uid in the container and SELinux label
+in the key file via :Z so they can be accessed) and the PLAYBOOK_FILE
+environment variable is set to point to the playbook within the image:
+
+docker run -tu `id -u` \
+ -v $HOME/.ssh/id_rsa:/opt/app-root/src/.ssh/id_rsa:Z,ro \
+ -v /etc/ansible/hosts:/tmp/inventory:Z,ro \
+ -e INVENTORY_FILE=/tmp/inventory \
+ -e OPTS="-v" \
+ -e PLAYBOOK_FILE=playbooks/byo/openshift_facts.yml \
+ openshift/origin-ansible
+
+EOF