|
1 | 1 | # Credentials
|
2 | 2 |
|
3 |
| -Credentials are utilized by {{ site.data.product.title_short }} for authentication when |
4 |
| -running Ansible playbooks against machines, synchronizing with inventory |
5 |
| -sources, and importing project content from a version control system. |
| 3 | +Credentials are utilized by {{ site.data.product.title_short }} for authentication when running Ansible playbooks against machines, synchronizing with inventory sources, and importing project content from a version control system. |
6 | 4 |
|
7 | 5 | ## Adding Credentials
|
8 | 6 |
|
9 |
| -{{ site.data.product.title_short }} can store credentials used by playbooks. Credentials |
10 |
| -saved in {{ site.data.product.title_short }} are matched and executed with a playbook |
11 |
| -when run. |
| 7 | +{{ site.data.product.title_short }} can store credentials used by playbooks. Credentials saved in {{ site.data.product.title_short }} are matched and executed with a playbook when run. |
12 | 8 |
|
13 | 9 | 1. Browse to menu: **Automation > Ansible > Credentials**.
|
14 | 10 |
|
15 |
| -2. Click **Configuration**, then |
16 |
| -  (**Add New |
17 |
| - Credential**). |
| 11 | +2. Click **Configuration**, then  (**Add New Credential**). |
18 | 12 |
|
19 | 13 | 3. Provide a **Name** for the credential.
|
20 | 14 |
|
21 |
| -4. Select the **Credential Type**. Additional fields will appear |
22 |
| - depending on the type chosen. |
| 15 | +4. Select the **Credential Type**. Additional fields will appear depending on the type chosen. |
23 | 16 |
|
24 |
| - - **Vault Password**: Ansible Vault credentials have only the **Vault |
25 |
| - Password** attribute that may be configured. For more information on Ansible Vault, see [Using Vault in playbooks](http://docs.ansible.com/ansible/latest/playbooks_vault.html). |
| 17 | + - **Vault Password**: Ansible Vault credentials have only the **Vault Password** attribute that may be configured. For more information on Ansible Vault, see [Using Vault in playbooks](http://docs.ansible.com/ansible/latest/playbooks_vault.html). |
26 | 18 |
|
27 | 19 | 5. Click **Add**.
|
28 | 20 |
|
29 | 21 | ## Credential Types
|
30 | 22 |
|
31 |
| -Each credential type used by {{ site.data.product.title_short }} is detailed in the |
32 |
| -following sections. |
| 23 | +Each credential type used by {{ site.data.product.title_short }} is detailed in the following sections. |
33 | 24 |
|
34 | 25 | ### Machine
|
35 | 26 |
|
36 |
| -Machine credentials enable {{ site.data.product.title_short }} to invoke Ansible on |
37 |
| -hosts under your management. Just like using Ansible on the command |
38 |
| -line, you can specify the SSH username, optionally provide a password, |
39 |
| -an SSH key, or a key password. They define SSH and user-level privilege |
40 |
| -escalation access for playbooks, and are used when running playbooks on |
41 |
| -a remote host. |
| 27 | +Machine credentials enable {{ site.data.product.title_short }} to invoke Ansible on hosts under your management. Just like using Ansible on the command line, you can specify the SSH username, optionally provide a password, an SSH key, or a key password. They define SSH and user-level privilege escalation access for playbooks, and are used when running playbooks on a remote host. |
42 | 28 |
|
43 |
| - - **Username**: The username to be used for SSH authentication. |
| 29 | +- **Username**: The username to be used for SSH authentication. |
44 | 30 |
|
45 |
| - - **Password**: The actual password to be used for SSH authentication. |
| 31 | +- **Password**: The actual password to be used for SSH authentication. |
46 | 32 |
|
47 |
| - - **SSH Private Key**: Copy or drag-and-drop the SSH private key for |
48 |
| - the machine credential. |
| 33 | +- **SSH Private Key**: Copy or drag-and-drop the SSH private key for the machine credential. |
49 | 34 |
|
50 |
| - - **Private Key Passphrase**: If the SSH Private Key used is protected |
51 |
| - by a password, you can configure a Key Password for the private key. |
| 35 | +- **Private Key Passphrase**: If the SSH Private Key used is protected by a password, you can configure a Key Password for the private key. |
52 | 36 |
|
53 |
| - - **Privilege Escalation**: Specifies the type of escalation privilege |
54 |
| - to assign to specific users. Options include **sudo**, **su**, |
55 |
| - **pbrun**, **pfexec**. |
| 37 | +- **Privilege Escalation**: Specifies the type of escalation privilege to assign to specific users. Options include **sudo**, **su**, **pbrun**, **pfexec**. |
56 | 38 |
|
57 |
| - - **Privilege Escalation Username**: Enter the username to use with |
58 |
| - escalation privileges on the remote system. |
| 39 | +- **Privilege Escalation Username**: Enter the username to use with escalation privileges on the remote system. |
59 | 40 |
|
60 |
| - - **Privilege Escalation Password**: Enter the actual password to be |
61 |
| - used to authenticate the user via the selected privilege escalation |
62 |
| - type on the remote system. |
| 41 | +- **Privilege Escalation Password**: Enter the actual password to be used to authenticate the user via the selected privilege escalation type on the remote system. |
63 | 42 |
|
64 | 43 | ### Network
|
65 | 44 |
|
66 |
| -Network credentials are used by Ansible networking modules to connect to |
67 |
| -and manage networking devices. |
| 45 | +Network credentials are used by Ansible networking modules to connect to and manage networking devices. |
68 | 46 |
|
69 | 47 | Network credentials have several attributes that may be configured:
|
70 | 48 |
|
71 |
| - - **Username**: The username to use in conjunction with the network |
72 |
| - device. |
| 49 | +- **Username**: The username to use in conjunction with the network device. |
73 | 50 |
|
74 |
| - - **Password**: The password to use in conjunction with the network |
75 |
| - device. |
| 51 | +- **Password**: The password to use in conjunction with the network device. |
76 | 52 |
|
77 |
| - - **Authorize**: Select this from the Options field to add an |
78 |
| - Authorize password which signs the RSA key with a password. |
| 53 | +- **Authorize**: Select this from the Options field to add an Authorize password which signs the RSA key with a password. |
79 | 54 |
|
80 |
| - - **Authorize password**: If **Authorize** is checked, enter a |
81 |
| - password in the **Authorize Password** field. |
| 55 | +- **Authorize password**: If **Authorize** is checked, enter a password in the **Authorize Password** field. |
82 | 56 |
|
83 |
| - - **SSH Key**: Copy or drag-and-drop the actual SSH Private Key to be |
84 |
| - used to authenticate the user to the network via SSH. |
| 57 | +- **SSH Key**: Copy or drag-and-drop the actual SSH Private Key to be used to authenticate the user to the network via SSH. |
85 | 58 |
|
86 |
| - - **Private key passphrase**: The actual passphrase for the private |
87 |
| - key to be used to authenticate the user to the network via SSH. |
| 59 | +- **Private key passphrase**: The actual passphrase for the private key to be used to authenticate the user to the network via SSH. |
88 | 60 |
|
89 | 61 | ### SCM
|
90 | 62 |
|
91 |
| -SCM (source control) credentials are used with Projects to clone and |
92 |
| -update local source code repositories from a remote revision control |
93 |
| -system such as Git, Subversion, or Mercurial. |
| 63 | +SCM (source control) credentials are used with Projects to clone and update local source code repositories from a remote revision control system such as Git, Subversion, or Mercurial. |
94 | 64 |
|
95 |
| -Source Control credentials have several attributes that may be |
96 |
| -configured: |
| 65 | +Source Control credentials have several attributes that may be configured: |
97 | 66 |
|
98 |
| - - **Username**: The username to use in conjunction with the source |
99 |
| - control system. |
| 67 | +- **Username**: The username to use in conjunction with the source control system. |
100 | 68 |
|
101 |
| - - **Password**: The password to use in conjunction with the source |
102 |
| - control system. |
| 69 | +- **Password**: The password to use in conjunction with the source control system. |
103 | 70 |
|
104 |
| - - **Private key passphrase**: If the SSH private key used is protected |
105 |
| - by a passphrase, you may configure a key passphrase for the private |
106 |
| - key. |
| 71 | +- **Private key passphrase**: If the SSH private key used is protected by a passphrase, you may configure a key passphrase for the private key. |
107 | 72 |
|
108 |
| - - **Private Key**: Copy or drag-and-drop the actual SSH Private Key to |
109 |
| - be used to authenticate the user to the source control system via |
110 |
| - SSH. |
| 73 | +- **Private Key**: Copy or drag-and-drop the actual SSH Private Key to be used to authenticate the user to the source control system via SSH. |
111 | 74 |
|
112 | 75 | ### Amazon
|
113 | 76 |
|
114 |
| -Selecting this credential type enables synchronization of cloud |
115 |
| -inventory with Amazon Web Services. |
| 77 | +Selecting this credential type enables synchronization of cloud inventory with Amazon Web Services. |
116 | 78 |
|
117 |
| - - **Access Key**: User credentials that allow for programmatic calls |
118 |
| - to Amazon Web Services. |
| 79 | +- **Access Key**: User credentials that allow for programmatic calls to Amazon Web Services. |
119 | 80 |
|
120 |
| - - **Secret Key**: The secret key that corresponds to the user access |
121 |
| - key. |
| 81 | +- **Secret Key**: The secret key that corresponds to the user access key. |
122 | 82 |
|
123 |
| - - **STS Token**: Token generated by Amazon Web Services Security Token |
124 |
| - Service. |
| 83 | +- **STS Token**: Token generated by Amazon Web Services Security Token Service. |
125 | 84 |
|
126 | 85 | ### Azure
|
127 | 86 |
|
128 |
| -Selecting this credential type enables synchronization of cloud |
129 |
| -inventory with Microsoft Azure. |
| 87 | +Selecting this credential type enables synchronization of cloud inventory with Microsoft Azure. |
130 | 88 |
|
131 | 89 | Microsoft Azure credentials have several attributes to configure:
|
132 | 90 |
|
133 |
| - - **Username**: The username to use to connect to the Microsoft Azure |
134 |
| - account. |
| 91 | +- **Username**: The username to use to connect to the Microsoft Azure account. |
135 | 92 |
|
136 |
| - - **Password**: The password to use to connect to the Microsoft Azure |
137 |
| - account. |
| 93 | +- **Password**: The password to use to connect to the Microsoft Azure account. |
138 | 94 |
|
139 |
| - - **Subscription ID**: The Subscription UUID for the Microsoft Azure |
140 |
| - account. |
| 95 | +- **Subscription ID**: The Subscription UUID for the Microsoft Azure account. |
141 | 96 |
|
142 |
| - - **Tenant ID**: The Tenant ID for the Microsoft Azure account. |
| 97 | +- **Tenant ID**: The Tenant ID for the Microsoft Azure account. |
143 | 98 |
|
144 |
| - - **Client Secret**: The Client Secret for the Microsoft Azure |
145 |
| - account. |
| 99 | +- **Client Secret**: The Client Secret for the Microsoft Azure account. |
146 | 100 |
|
147 |
| - - **Client ID**: The Client ID for the Microsoft Azure account. |
| 101 | +- **Client ID**: The Client ID for the Microsoft Azure account. |
148 | 102 |
|
149 | 103 | ### OpenStack
|
150 | 104 |
|
151 |
| -Selecting this credential type enables synchronization of cloud |
152 |
| -inventory with Red Hat OpenStack Platform. |
| 105 | +Selecting this credential type enables synchronization of cloud inventory with Red Hat OpenStack Platform. |
153 | 106 |
|
154 | 107 | OpenStack credentials have several attributes that may be configured:
|
155 | 108 |
|
156 |
| - - **Username**: The username to use to connect to OpenStack. |
| 109 | +- **Username**: The username to use to connect to OpenStack. |
157 | 110 |
|
158 |
| - - **Password (API Key)**: The password or API key to use to connect to |
159 |
| - OpenStack. |
| 111 | +- **Password (API Key)**: The password or API key to use to connect to OpenStack. |
160 | 112 |
|
161 |
| - - **Host (Authentication URL)**: The host to be used for |
162 |
| - authentication. |
| 113 | +- **Host (Authentication URL)**: The host to be used for authentication. |
163 | 114 |
|
164 |
| - - **Project (Tenant Name)**: The Tenant name or Tenant ID used for |
165 |
| - OpenStack. This value is usually the same as the username. |
| 115 | +- **Project (Tenant Name)**: The Tenant name or Tenant ID used for OpenStack. This value is usually the same as the username. |
166 | 116 |
|
167 |
| - - **Domain name**: The FQDN to be used to connect to OpenStack. |
| 117 | +- **Domain name**: The FQDN to be used to connect to OpenStack. |
168 | 118 |
|
169 | 119 | ### Red Hat Virtualization
|
170 | 120 |
|
171 |
| -Selecting this credential type enables synchronization of cloud |
172 |
| -inventory with Red Hat Virtualization. |
| 121 | +Selecting this credential type enables synchronization of cloud inventory with Red Hat Virtualization. |
173 | 122 |
|
174 |
| -Red Hat Virtualization credentials have several attributes that may be |
175 |
| -configured: |
| 123 | +Red Hat Virtualization credentials have several attributes that may be configured: |
176 | 124 |
|
177 |
| - - **Username**: The username to use to connect to Red Hat |
178 |
| - Virtualization. |
| 125 | +- **Username**: The username to use to connect to Red Hat Virtualization. |
179 | 126 |
|
180 |
| - - **Password**: The password to use to connect to Red Hat |
181 |
| - Virtualization. |
| 127 | +- **Password**: The password to use to connect to Red Hat Virtualization. |
182 | 128 |
|
183 |
| - - **Host (Authentication URL)**: The host to be used for |
184 |
| - authentication. |
| 129 | +- **Host (Authentication URL)**: The host to be used for authentication. |
185 | 130 |
|
186 |
| - <div class="important"> |
| 131 | + **Important**: Enter in **Host** the Red Hat Virtualization provider URL, followed by the path `/ovirt_engine/api`. Example: `https://your.rhv.com/ovirt_engine/api` |
187 | 132 |
|
188 |
| - - Enter in **Host** the Red Hat Virtualization provider URL, |
189 |
| - followed by the path `/ovirt_engine/api`. Example: |
190 |
| - `https://your.rhv.com/ovirt_engine/api` |
191 |
| - |
192 |
| - - See [Ansible Roles](https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/administration_guide/chap-automating_rhv_configuration_using_ansible#Ansible_Roles) |
193 |
| - for more information on Ansible Roles available for Red Hat |
194 |
| - Virtualization. |
195 |
| - |
196 |
| - </div> |
| 133 | + For more information on the Ansible Roles that are available for Red Hat Virtualization, see [Ansible Roles](https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/administration_guide/chap-automating_rhv_configuration_using_ansible#Ansible_Roles). |
197 | 134 |
|
198 | 135 | ### VMware
|
199 | 136 |
|
200 |
| -Selecting this credential type enables synchronization of inventory with |
201 |
| -VMware vCenter. |
| 137 | +Selecting this credential type enables synchronization of inventory with VMware vCenter. |
202 | 138 |
|
203 |
| -**Important:** |
204 |
| - |
205 |
| -If both {{ site.data.product.title_short }} and a VMware provider are located in the same IPv6-only network, use a DNS-resolvable hostname for the VMware provider in the **vCenter Host** field when adding credentials. |
| 139 | +**Important:** If both {{ site.data.product.title_short }} and a VMware provider are located in the same IPv6-only network, use a DNS-resolvable hostname for the VMware provider in the **vCenter Host** field when adding credentials. |
206 | 140 |
|
207 | 141 | VMware credentials have several attributes that may be configured:
|
208 | 142 |
|
209 |
| - - **Username**: The username to use to connect to vCenter. |
210 |
| - |
211 |
| - - **Password**: The password to use to connect to vCenter. |
| 143 | +- **Username**: The username to use to connect to vCenter. |
212 | 144 |
|
213 |
| - - **vCenter Host**: The vCenter hostname or IP address to connect to. |
| 145 | +- **Password**: The password to use to connect to vCenter. |
214 | 146 |
|
215 |
| -**Note:** |
| 147 | +- **vCenter Host**: The vCenter hostname or IP address to connect to. |
216 | 148 |
|
217 |
| -If the VMware guest tools are not running on the instance, VMware inventory sync may not return an IP address for that instance. |
| 149 | +**Note:** If the VMware guest tools are not running on the instance, VMware inventory sync may not return an IP address for that instance. |
0 commit comments