torwachter: rm d3 key as he does no longer want access as told by ruru. Also better...
[noc.git] / ansible / README_vault.md
index 311cc2a..c930a1d 100644 (file)
@@ -1,9 +1,10 @@
 Secrets and Vaults
 ==================
 
-All secrets are stored inside encrypted ansible vault files which live
-inside the secrets directory. Access to the vault files is controlled via
-GPG keys. Anybody who uses this ansible repository needs to have a GPG key.
+All secrets are stored inside encrypted ansible vault files which live in
+`host_vars`, `group_vars` or inside the `secrets` directory.
+Access to the vault files is controlled via GPG keys. Anybody who uses this
+ansible repository needs to have a GPG key.
 
 
 Creating a GPG key
@@ -16,11 +17,11 @@ You can use the following command to generate a new GPG key:
    - select "RSA and RSA" as kind (should be option: 1)
    - set keysize to: 4096
    - set key expiration to: 2y
-   - set Real name and eMail adress
+   - set Real name and eMail address
    - set a passphrase for the key (please use a strong passphrase!!!)
 ```
 
-This command prints the fingerprint and other inforamtion about the newly
+This command prints the fingerprint and other information about the newly
 generated key. In the line starting with pub you can find the key ID. This
 ID can be used to uniquely identify your key. Here is a sample output:
 
@@ -55,7 +56,7 @@ following command:
 ```
 
 This will add the new key to the keyring stored inside the repository and
-reencrypt the secret to unlock the vault for all keys inside the keyring.
+re-encrypt the secret to unlock the vault for all keys inside the keyring.
 
 
 
@@ -70,7 +71,7 @@ following command:
 ```
 
 This will remove the key from the keyring stored inside the repository and
-reencrypt the secret to unlock the vault for all remaining keys inside the
+re-encrypt the secret to unlock the vault for all remaining keys inside the
 keyring.
 
 You can find out the key ID using the command:
@@ -98,20 +99,20 @@ Working with Vault files
 
  * create new vault:
    ```
-# ansible-vault create secrets/foo.vault.yml
+   # ansible-vault create host_vars/foo/vault.yml
    ```
    This will open up an editor which allows you to add variables. Once you
    store and close the file the content is automatically encrypted.
 
  * edit a vault file:
    ```
-# ansible-vault edit secrets/foo.vault.yml
+   # ansible-vault edit group_vars/foo/vault.yml
    ```
    This will open up an editor which allows you to add/remove/change variables.
    Once you store and close the file the content is automatically encrypted.
 
  * show the contents of a vault file:
    ```
-# ansible-vault view secrets/foo.vault.yml
+   # ansible-vault view secrets/foo.vault.yml
    ```
-   This will automatially decrypt the file and print it's contents.
+   This will automatically decrypt the file and print it's contents.