From b7c3af2461427aa945ac0cdb220d7c89ebf0138f Mon Sep 17 00:00:00 2001 From: Steve Smith Date: Tue, 17 Sep 2019 15:44:02 +1000 Subject: [PATCH] DCD-658: README updates from review. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 864da44..bfdf3dd 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,14 @@ helper-script `bin/ansible-with-atl-env` and the corresponding #### Overriding parameters If you want to customise the playbook behaviour the simplest method is to fork -this repository and add your own. However for some one-off tasks may be OK to -override the default and calculated settings with special values. This can be -done by providing command-line overrides to +this repository and add your own. However, for some one-off tasks you can also +override the default and calculated settings with special values. To do this, +provide command-line overrides to [ansible-playbook](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html). The most likely use-case for this is to download a custom product distribution -for testing, e.g. a Jira pre-release. If you are running `ansible-playbook` -directly, the command-line would look like e.g: +for testing (for example, a pre-release version of Jira). If you are running +ansible-playbook directly, the command for this would look like the following: ansible-playbook \ -e atl_product_download_url=http://s3.amazon.com/atlassian/jira-9.0.0-PRE-TEST.tar.gz \ @@ -46,10 +46,10 @@ directly, the command-line would look like e.g: \ -i inv/aws_node_local aws_jira_dc_node.yml -If you are using a CloudFormation template with places the stack details in -`/etc/atl`, the special variable `ATL_ANSIBLE_EXTRA_PARAMS` is added to the -`ansible-playbook` parameters in `bin/ansible-with-alt-env`. In this case you -would only need to set it to: +You can also do this on a CloudFormation template where the stack details are in +/etc/atl. On such templates, the variable `ATL_ANSIBLE_EXTRA_PARAMS` is added +to the `ansible-playbook` parameters in `bin/ansible-with-alt-env`. In this case +you need to set it to: ATL_ANSIBLE_EXTRA_PARAMS="-e atl_product_download_url=http://s3.amazon.com/atlassian/jira-9.0.0-PRE-TEST.tar.gz -e atl_use_system_jdk=true -e atl_download_format=tarball"