blsmith/dc-deployments-automation
1
0
Fork 0
mirror of https://bitbucket.org/atlassian/dc-deployments-automation.git synced 2025-12-14 08:53:07 -06:00
Code Issues Packages Projects Releases Wiki Activity

DC-224: Add some notes to README.

Browse Source
This commit is contained in:
Steve Smith
2019-04-23 15:10:46 +10:00
parent aa314abc6e
commit 7d720129c4
1 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -23,8 +23,9 @@ In practice, the Ansible roles require some information about the infrastructure
that was deployed (e.g. RDS endpoint/password). The way this is currently that was deployed (e.g. RDS endpoint/password). The way this is currently
achieved (on AWS) is that have the CloudFormation template dump this information achieved (on AWS) is that have the CloudFormation template dump this information
into the file `/etc/atl` as `RESOURCE_VAR=<resource>` lines. This can be then into the file `/etc/atl` as `RESOURCE_VAR=<resource>` lines. This can be then
sourced as environment variables to be retrieved at runtime. See the sourced as environment variables to be retrieved at runtime . See the
helper-script `bin/ansible-with-atl-env` for an example. helper-script `bin/ansible-with-atl-env` and the corresponding
`groups_vars/aws_node_local.yml` var-file.
### Maintenance playbooks ### Maintenance playbooks
@@ -49,14 +50,20 @@ should be run firs).
## Ansible layout ## Ansible layout
* Helper script are in `bin/`. In particular the `bin/ansible-with-atl-env`
wrapper is of use during AWS node initialisation. See _Usage_ above for more
* Global defaults in group_vars/all.yml information.
** This is where env-vars should be converted to Ansible vars. It also acts as a required-env list. * Inventory files are under `inv/`. For AWS `cfn-init` the inventory
** The CF env is usually stored in /etc/atl. The script `bin/ansible-with-atl-env` will run Ansible with that environment set. `inv/aws_node_local` inventory is probably what you want.
* Runtime information about the EC2 environment can be injected by depending on * Note that this expects the environment to be setup with infrastructure
`apws_common` in a role's `meta/main.yml` (or adding it to the playbook before information; see _Usage_ above.
the requiring role. * Global group vars loaded automatically from `group_vars/<group>.yml`. In
particular note `group_vars/aws_node_local.yml` which loads infrastructure
information from the environment.
* Roles are under `roles/`
* Platform specific roles start with `<platform-shortname>_...`,
e.g. `roles/aws_common/`.
* Similarly, product-specific roles should start with `<product>_...`.
## License ## License