Skip to content

Commit 5675d37

Browse files
rwellonrwellon
committed
MarkdownEdits
1 parent 68d3ba1 commit 5675d37

File tree

1 file changed

+68
-125
lines changed

1 file changed

+68
-125
lines changed

‎managing_providers/_topics/ansible_credentials.md

Lines changed: 68 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,217 +1,160 @@
11
# Credentials
2+
{: #ansible_credentials}
23

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.
4+
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.
65

76
## Adding Credentials
7+
{: #adding_credentials}
88

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.
9+
{{ 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.
1210

1311
1. Browse to menu: **Automation > Ansible > Credentials**.
1412

15-
2. Click **Configuration**, then
16-
![Add New Credential](../images/1862.png) (**Add New
17-
Credential**).
13+
2. Click **Configuration**, then ![Add New Credential](../images/1862.png) (**Add New Credential**).
1814

1915
3. Provide a **Name** for the credential.
2016

21-
4. Select the **Credential Type**. Additional fields will appear
22-
depending on the type chosen.
17+
4. Select the **Credential Type**. Additional fields will appear depending on the type chosen.
2318

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).
19+
- **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).
2620

2721
5. Click **Add**.
2822

2923
## Credential Types
24+
{: #credential_types}
3025

31-
Each credential type used by {{ site.data.product.title_short }} is detailed in the
32-
following sections.
26+
Each credential type used by {{ site.data.product.title_short }} is detailed in the following sections.
3327

3428
### Machine
29+
{: #machine}
3530

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.
31+
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.
4232

43-
- **Username**: The username to be used for SSH authentication.
33+
- **Username**: The username to be used for SSH authentication.
4434

45-
- **Password**: The actual password to be used for SSH authentication.
35+
- **Password**: The actual password to be used for SSH authentication.
4636

47-
- **SSH Private Key**: Copy or drag-and-drop the SSH private key for
48-
the machine credential.
37+
- **SSH Private Key**: Copy or drag-and-drop the SSH private key for the machine credential.
4938

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.
39+
- **Private Key Passphrase**: If the SSH Private Key used is protected by a password, you can configure a Key Password for the private key.
5240

53-
- **Privilege Escalation**: Specifies the type of escalation privilege
54-
to assign to specific users. Options include **sudo**, **su**,
55-
**pbrun**, **pfexec**.
41+
- **Privilege Escalation**: Specifies the type of escalation privilege to assign to specific users. Options include **sudo**, **su**, **pbrun**, **pfexec**.
5642

57-
- **Privilege Escalation Username**: Enter the username to use with
58-
escalation privileges on the remote system.
43+
- **Privilege Escalation Username**: Enter the username to use with escalation privileges on the remote system.
5944

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.
45+
- **Privilege Escalation Password**: Enter the actual password to be used to authenticate the user via the selected privilege escalation type on the remote system.
6346

6447
### Network
48+
{: #network}
6549

66-
Network credentials are used by Ansible networking modules to connect to
67-
and manage networking devices.
50+
Network credentials are used by Ansible networking modules to connect to and manage networking devices.
6851

6952
Network credentials have several attributes that may be configured:
7053

71-
- **Username**: The username to use in conjunction with the network
72-
device.
54+
- **Username**: The username to use in conjunction with the network device.
7355

74-
- **Password**: The password to use in conjunction with the network
75-
device.
56+
- **Password**: The password to use in conjunction with the network device.
7657

77-
- **Authorize**: Select this from the Options field to add an
78-
Authorize password which signs the RSA key with a password.
58+
- **Authorize**: Select this from the Options field to add an Authorize password which signs the RSA key with a password.
7959

80-
- **Authorize password**: If **Authorize** is checked, enter a
81-
password in the **Authorize Password** field.
60+
- **Authorize password**: If **Authorize** is checked, enter a password in the **Authorize Password** field.
8261

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.
62+
- **SSH Key**: Copy or drag-and-drop the actual SSH Private Key to be used to authenticate the user to the network via SSH.
8563

86-
- **Private key passphrase**: The actual passphrase for the private
87-
key to be used to authenticate the user to the network via SSH.
64+
- **Private key passphrase**: The actual passphrase for the private key to be used to authenticate the user to the network via SSH.
8865

8966
### SCM
67+
{: #scm}
9068

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.
69+
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.
9470

95-
Source Control credentials have several attributes that may be
96-
configured:
71+
Source Control credentials have several attributes that may be configured:
9772

98-
- **Username**: The username to use in conjunction with the source
99-
control system.
73+
- **Username**: The username to use in conjunction with the source control system.
10074

101-
- **Password**: The password to use in conjunction with the source
102-
control system.
75+
- **Password**: The password to use in conjunction with the source control system.
10376

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.
77+
- **Private key passphrase**: If the SSH private key used is protected by a passphrase, you may configure a key passphrase for the private key.
10778

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.
79+
- **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.
11180

11281
### Amazon
82+
{: #amazon}
11383

114-
Selecting this credential type enables synchronization of cloud
115-
inventory with Amazon Web Services.
84+
Selecting this credential type enables synchronization of cloud inventory with Amazon Web Services.
11685

117-
- **Access Key**: User credentials that allow for programmatic calls
118-
to Amazon Web Services.
86+
- **Access Key**: User credentials that allow for programmatic calls to Amazon Web Services.
11987

120-
- **Secret Key**: The secret key that corresponds to the user access
121-
key.
88+
- **Secret Key**: The secret key that corresponds to the user access key.
12289

123-
- **STS Token**: Token generated by Amazon Web Services Security Token
124-
Service.
90+
- **STS Token**: Token generated by Amazon Web Services Security Token Service.
12591

12692
### Azure
93+
{: #azure}
12794

128-
Selecting this credential type enables synchronization of cloud
129-
inventory with Microsoft Azure.
95+
Selecting this credential type enables synchronization of cloud inventory with Microsoft Azure.
13096

13197
Microsoft Azure credentials have several attributes to configure:
13298

133-
- **Username**: The username to use to connect to the Microsoft Azure
134-
account.
99+
- **Username**: The username to use to connect to the Microsoft Azure account.
135100

136-
- **Password**: The password to use to connect to the Microsoft Azure
137-
account.
101+
- **Password**: The password to use to connect to the Microsoft Azure account.
138102

139-
- **Subscription ID**: The Subscription UUID for the Microsoft Azure
140-
account.
103+
- **Subscription ID**: The Subscription UUID for the Microsoft Azure account.
141104

142-
- **Tenant ID**: The Tenant ID for the Microsoft Azure account.
105+
- **Tenant ID**: The Tenant ID for the Microsoft Azure account.
143106

144-
- **Client Secret**: The Client Secret for the Microsoft Azure
145-
account.
107+
- **Client Secret**: The Client Secret for the Microsoft Azure account.
146108

147-
- **Client ID**: The Client ID for the Microsoft Azure account.
109+
- **Client ID**: The Client ID for the Microsoft Azure account.
148110

149111
### OpenStack
112+
{: #openstack}
150113

151-
Selecting this credential type enables synchronization of cloud
152-
inventory with Red Hat OpenStack Platform.
114+
Selecting this credential type enables synchronization of cloud inventory with Red Hat OpenStack Platform.
153115

154116
OpenStack credentials have several attributes that may be configured:
155117

156-
- **Username**: The username to use to connect to OpenStack.
118+
- **Username**: The username to use to connect to OpenStack.
157119

158-
- **Password (API Key)**: The password or API key to use to connect to
159-
OpenStack.
120+
- **Password (API Key)**: The password or API key to use to connect to OpenStack.
160121

161-
- **Host (Authentication URL)**: The host to be used for
162-
authentication.
122+
- **Host (Authentication URL)**: The host to be used for authentication.
163123

164-
- **Project (Tenant Name)**: The Tenant name or Tenant ID used for
165-
OpenStack. This value is usually the same as the username.
124+
- **Project (Tenant Name)**: The Tenant name or Tenant ID used for OpenStack. This value is usually the same as the username.
166125

167-
- **Domain name**: The FQDN to be used to connect to OpenStack.
126+
- **Domain name**: The FQDN to be used to connect to OpenStack.
168127

169128
### Red Hat Virtualization
129+
{: #red_hat_virtualization}
170130

171-
Selecting this credential type enables synchronization of cloud
172-
inventory with Red Hat Virtualization.
131+
Selecting this credential type enables synchronization of cloud inventory with Red Hat Virtualization.
173132

174-
Red Hat Virtualization credentials have several attributes that may be
175-
configured:
133+
Red Hat Virtualization credentials have several attributes that may be configured:
176134

177-
- **Username**: The username to use to connect to Red Hat
178-
Virtualization.
135+
- **Username**: The username to use to connect to Red Hat Virtualization.
179136

180-
- **Password**: The password to use to connect to Red Hat
181-
Virtualization.
137+
- **Password**: The password to use to connect to Red Hat Virtualization.
182138

183-
- **Host (Authentication URL)**: The host to be used for
184-
authentication.
139+
- **Host (Authentication URL)**: The host to be used for authentication.
185140

186-
<div class="important">
141+
**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`
187142

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>
143+
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).
197144

198145
### VMware
146+
{: #vmware}
199147

200-
Selecting this credential type enables synchronization of inventory with
201-
VMware vCenter.
148+
Selecting this credential type enables synchronization of inventory with VMware vCenter.
202149

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.
150+
**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.
206151

207152
VMware credentials have several attributes that may be configured:
208153

209-
- **Username**: The username to use to connect to vCenter.
210-
211-
- **Password**: The password to use to connect to vCenter.
154+
- **Username**: The username to use to connect to vCenter.
212155

213-
- **vCenter Host**: The vCenter hostname or IP address to connect to.
156+
- **Password**: The password to use to connect to vCenter.
214157

215-
**Note:**
158+
- **vCenter Host**: The vCenter hostname or IP address to connect to.
216159

217-
If the VMware guest tools are not running on the instance, VMware inventory sync may not return an IP address for that instance.
160+
**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

Comments
 (0)