summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/vault_guide/vault.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docsite/rst/vault_guide/vault.rst')
-rw-r--r--docs/docsite/rst/vault_guide/vault.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/docsite/rst/vault_guide/vault.rst b/docs/docsite/rst/vault_guide/vault.rst
new file mode 100644
index 0000000..3fa8d16
--- /dev/null
+++ b/docs/docsite/rst/vault_guide/vault.rst
@@ -0,0 +1,18 @@
+.. _vault:
+
+*************
+Ansible Vault
+*************
+
+Ansible Vault encrypts variables and files so you can protect sensitive content such as passwords or keys rather than leaving it visible as plaintext in playbooks or roles.
+To use Ansible Vault you need one or more passwords to encrypt and decrypt content.
+If you store your vault passwords in a third-party tool such as a secret manager, you need a script to access them.
+Use the passwords with the :ref:`ansible-vault` command-line tool to create and view encrypted variables, create encrypted files, encrypt existing files, or edit, re-key, or decrypt files.
+You can then place encrypted content under source control and share it more safely.
+
+.. warning::
+ * Encryption with Ansible Vault ONLY protects 'data at rest'.
+ Once the content is decrypted ('data in use'), play and plugin authors are responsible for avoiding any secret disclosure, see :ref:`no_log <keep_secret_data>` for details on hiding output and :ref:`vault_securing_editor` for security considerations on editors you use with Ansible Vault.
+
+You can use encrypted variables and files in ad hoc commands and playbooks by supplying the passwords you used to encrypt them.
+You can modify your ``ansible.cfg`` file to specify the location of a password file or to always prompt for the password. \ No newline at end of file