Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for specifying CLI flags for Ansible integration #350

Merged
merged 2 commits into from
Sep 27, 2023
Merged

Docs for specifying CLI flags for Ansible integration #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf3169f
Docs for specifying CLI flags for Ansible integration
michalg9 Sep 27, 2023
acfbbfe
oxipng
michalg9 Sep 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/screenshots/ansible/ansible_cli_flags.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/vendors/ansible/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ Ansible uses `ControlMaster` and `ControlPath` SSH options to speed up playbook

The default value for [`ANSIBLE_SSH_CONTROL_PATH_DIR`](https://docs.ansible.com/ansible/2.5/reference_appendices/config.html#ansible-ssh-control-path-dir){: rel="nofollow"} is `/tmp/.ansible/cp`.

### Specifying additional CLI flags

You can specify addtional [CLI flags](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html#common-options) using the following environment variables:

- `SPACELIFT_ANSIBLE_CLI_ARGS` - will take effect for both planning and applying phases
- `SPACELIFT_ANSIBLE_CLI_ARGS_plan` - will take effect only for the planning phase
- `SPACELIFT_ANSIBLE_CLI_ARGS_apply` - will take effect only for the applying phase

If both phase specific and generic flags are used, both will take effect.

![Ansible CLI flags](../../assets/screenshots/ansible/ansible_cli_flags.png)

## File permissions

There are a few nuances with certain files' permissions when using Ansible.
Expand Down