From 82ef5bc291006b51207b9e32626251a03c776548 Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Mon, 19 Dec 2016 14:47:10 +0100 Subject: Add RPM checks as an adhoc playbook --- playbooks/adhoc/preflight/README.md | 51 +++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 playbooks/adhoc/preflight/README.md (limited to 'playbooks/adhoc/preflight/README.md') diff --git a/playbooks/adhoc/preflight/README.md b/playbooks/adhoc/preflight/README.md new file mode 100644 index 000000000..871c6af01 --- /dev/null +++ b/playbooks/adhoc/preflight/README.md @@ -0,0 +1,51 @@ +# Preflight checks + +Here we provide an Ansible playbook for detecting potential roadblocks prior to +an install or upgrade. + +Ansible's default operation mode is to fail fast, on the first error. However, +when performing checks, it is useful to gather as much information about +problems as possible in a single run. + +The `check.yml` playbook runs a battery of checks against the inventory hosts +and tells Ansible to ignore intermediate errors, thus giving a more complete +diagnostic of the state of each host. Still, if any check failed, the playbook +run will be marked as having failed. + +To facilitate understanding the problems that were encountered, we provide a +custom callback plugin to summarize execution errors at the end of a playbook +run. + +--- + +*Note that currently the `check.yml` playbook is only useful for RPM-based +installations. Containerized installs are excluded from checks for now, but +might be included in the future if there is demand for that.* + +--- + +## Running + +With an installation of Ansible 2.2 or greater, run the playbook directly +against your inventory file. Here is the step-by-step: + +1. If you haven't done it yet, clone this repository: + + ```console + $ git clone https://github.com/openshift/openshift-ansible + $ cd openshift-ansible + ``` + +2. Configure a custom callback plugin to get a summary of problems at the end of +the playbook run: + + ```console + $ export ANSIBLE_CALLBACK_PLUGINS=callback_plugins \ + ANSIBLE_STDOUT_CALLBACK=default_plus_summary + ``` + +3. Run the playbook: + + ```console + $ ansible-playbook -i playbooks/adhoc/preflight/check.yml + ``` -- cgit v1.2.3