Skip to content

Commit 22adb0a

Browse files
committed
Document environment variable setup
- inventory.md Signed-off-by: Sepehr-A <[email protected]>
1 parent 0657146 commit 22adb0a

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

docs/inventory.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@ auths:
6969
- name: suzieq-user-04
7070
key-passphrase: ask
7171
keyfile: path/to/key
72+
73+
- name: suzieq-user-05
74+
username: ask
75+
password: ask
76+
77+
- name: suzieq-user-06
78+
username: env:USERNAME_ENV_VAR
79+
password: ask
80+
81+
- name: suzieq-user-07
82+
username: env:USERNAME_ENV_VAR
83+
password: env:PASSWORD_ENV_VAR
84+
85+
- name: suzieq-user-08
86+
username: ask
87+
password: env:PASSWORD_ENV_VAR
7288

7389
namespaces:
7490
- name: testing
@@ -80,7 +96,7 @@ namespaces:
8096
!!! warning
8197
Some observations on the YAML file above:
8298
83-
- **This is just an example** that covers all the possible combinations, **not an real life inventory**
99+
- **This is just an example** that covers most of the possible combinations, **not an real life inventory**
84100
- **Do not specify device type unless you're using REST**. SuzieQ automatically determines device type with SSH
85101
- Most environments require setting the `ignore-known-hosts` option in the device section
86102
- The auths section shows all the different authorization methods supported by SuzieQ
@@ -95,7 +111,8 @@ For this reason, SuzieQ inventory now supports three different options to store
95111
- `env:<ENV_VARIABLE>`: the sensitive information is stored in an environment variable
96112
- `ask`: the user can write the sensitive information on the stdin
97113

98-
Currently this method is used to specify passwords, passphrases and tokens.
114+
This method is currently utilized for specifying usernames, passwords,
115+
passphrases, and tokens.
99116

100117
## <a name='inventory-sources'></a>Sources
101118

@@ -323,8 +340,10 @@ In case a private key is used to authenticate:
323340

324341
Where `key-passphrase` is the passphrase of the private key.
325342

326-
Both `passoword` and `key-passphrase` are considered [sensitive data](#sensitive-data).
327-
For this reason they can be set as plaintext, env variable or asked to the user via stdin.
343+
`Password`, `key-passphrase` and `username` are considered [sensitive
344+
data](#sensitive-data).
345+
For this reason they can be set as plaintext, env variable or
346+
asked to the user via stdin.
328347

329348
### <a name='cred-file'></a>Credential file
330349

0 commit comments

Comments
 (0)