From e2621a42fc8774a68937451d12c50bce79345fdb Mon Sep 17 00:00:00 2001 From: Gilles Cornu Date: Thu, 24 Aug 2017 18:30:11 +0200 Subject: [PATCH] docs/ansible: Align the "warn/info" notices style Motivated by the 4d546a58e1243168f58e20ca53cab71b31e44ae9 changes. --- .../source/docs/provisioning/ansible.html.md | 18 ++++++++++-------- .../docs/provisioning/ansible_common.html.md | 5 ++++- .../docs/provisioning/ansible_local.html.md | 16 ++++++++++------ 3 files changed, 24 insertions(+), 15 deletions(-) diff --git a/website/source/docs/provisioning/ansible.html.md b/website/source/docs/provisioning/ansible.html.md index ead77573c..af13bb6f6 100644 --- a/website/source/docs/provisioning/ansible.html.md +++ b/website/source/docs/provisioning/ansible.html.md @@ -14,10 +14,8 @@ description: |- The Vagrant Ansible provisioner allows you to provision the guest using [Ansible](http://ansible.com) playbooks by executing **`ansible-playbook` from the Vagrant host**.
- Warning: If you are not familiar with Ansible and Vagrant already, - I recommend starting with the shell - provisioner. However, if you are comfortable with Vagrant already, Vagrant - is a great way to learn Ansible. + Warning: + If you are not familiar with Ansible and Vagrant already, I recommend starting with the shell provisioner. However, if you are comfortable with Vagrant already, Vagrant is a great way to learn Ansible.
## Setup Requirements @@ -74,7 +72,10 @@ This section lists the _specific_ options for the Ansible (remote) provisioner. The default value is `true`. - **Note:** This option was introduced in Vagrant 1.8.0. Previous Vagrant versions behave like if this option was set to `false`. +
+ Compatibility Note: + This option was introduced in Vagrant 1.8.0. Previous Vagrant versions behave like if this option was set to `false`. +
- `host_key_checking` (boolean) - require Ansible to [enable SSH host key checking](https://docs.ansible.com/intro_getting_started.html#host-key-checking). @@ -122,9 +123,10 @@ N = 3 end ``` -**Caveats:** - -If you apply this parallel provisioning pattern with a static Ansible inventory, you will have to organize the things so that [all the relevant private keys are provided to the `ansible-playbook` command](https://github.com/mitchellh/vagrant/pull/5765#issuecomment-120247738). The same kind of considerations applies if you are using multiple private keys for a same machine (see [`config.ssh.private_key_path` SSH setting](/docs/vagrantfile/ssh_settings.html)). +
+ Tip: + If you apply this parallel provisioning pattern with a static Ansible inventory, you will have to organize the things so that [all the relevant private keys are provided to the `ansible-playbook` command](https://github.com/mitchellh/vagrant/pull/5765#issuecomment-120247738). The same kind of considerations applies if you are using multiple private keys for a same machine (see [`config.ssh.private_key_path` SSH setting](/docs/vagrantfile/ssh_settings.html)). +
### Force Paramiko Connection Mode diff --git a/website/source/docs/provisioning/ansible_common.html.md b/website/source/docs/provisioning/ansible_common.html.md index 5d0536520..a8adf2399 100644 --- a/website/source/docs/provisioning/ansible_common.html.md +++ b/website/source/docs/provisioning/ansible_common.html.md @@ -150,7 +150,10 @@ Some of these options are for advanced usage only and should not be used unless - `['--check', '-M', '/my/modules']` - `["--connection=paramiko", "--forks=10"]` - **Caveat:** The `ansible` provisioner does not support whitespace characters in `raw_arguments` elements. Therefore **don't write** something like `["-c paramiko"]`, which will result with an invalid `" parmiko"` parameter value. +
+ Attention: + The `ansible` provisioner does not support whitespace characters in `raw_arguments` elements. Therefore **don't write** something like `["-c paramiko"]`, which will result with an invalid `" parmiko"` parameter value. +
- `skip_tags` (string or array of strings) - Only plays, roles and tasks that [*do not match* these values will be executed](https://docs.ansible.com/playbooks_tags.html). diff --git a/website/source/docs/provisioning/ansible_local.html.md b/website/source/docs/provisioning/ansible_local.html.md index c506fbd7e..20b5b42b2 100644 --- a/website/source/docs/provisioning/ansible_local.html.md +++ b/website/source/docs/provisioning/ansible_local.html.md @@ -14,10 +14,8 @@ description: |- The Vagrant Ansible Local provisioner allows you to provision the guest using [Ansible](http://ansible.com) playbooks by executing **`ansible-playbook` directly on the guest machine**.
- Warning: If you are not familiar with Ansible and Vagrant already, - I recommend starting with the shell - provisioner. However, if you are comfortable with Vagrant already, Vagrant - is a great way to learn Ansible. + Warning: + If you are not familiar with Ansible and Vagrant already, I recommend starting with the shell provisioner. However, if you are comfortable with Vagrant already, Vagrant is a great way to learn Ansible.
## Setup Requirements @@ -67,7 +65,10 @@ This section lists the _specific_ options for the Ansible Local provisioner. In - The `version` option is set to `"latest"`. - The current Ansible version does not correspond to the `version` option. - **Attention:** There is no guarantee that this automated installation will replace a custom Ansible setup, that might be already present on the Vagrant box. +
+ Attention: + There is no guarantee that this automated installation will replace a custom Ansible setup, that might be already present on the Vagrant box. +
- `install_mode` (`:default`, `:pip`, or `:pip_args_only`) - Select the way to automatically install Ansible on the guest system. @@ -148,7 +149,10 @@ This section lists the _specific_ options for the Ansible Local provisioner. In When this option is set to `"latest"`, no version check is applied. - **Warning:** It is currently possible to use this option to specify which version of Ansible must be automatically installed, but only in combination with the `install_mode` set to `:pip`. +
+ Tip: + It is currently possible to use this option to specify which version of Ansible must be automatically installed, but only in combination with the `install_mode` set to `:pip`. +
## Tips and Tricks