Skip to content

Commit 27cba52

Browse files
committed
Merge pull request #1753 from rwellon/RW-IAE-Providers2
General markdown edits for provider topics
2 parents ace9e5a + 04ed18f commit 27cba52

File tree

6 files changed

+270
-542
lines changed

6 files changed

+270
-542
lines changed
Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,10 @@
11
## Installing Roles on an Embedded Ansible Appliance
22

3-
Roles are ways of automatically loading certain variable files, tasks,
4-
and handlers based on a known file structure. Grouping content by roles
5-
also allows easy sharing of roles with other users. Install roles on a
6-
{{ site.data.product.title_short }} appliance with the Embedded Ansible server role
7-
activated to optimize playbooks.
3+
Roles are ways of automatically loading certain variable files, tasks, and handlers based on a known file structure. Grouping content by roles also allows for easy sharing of roles with other users. Install roles on a {{ site.data.product.title_short }} appliance with the Embedded Ansible server role activated to optimize playbooks.
84

9-
When using this role in a playbook on a {{ site.data.product.title_short }}
10-
appliance, add an empty `roles` directory at the root of the playbook.
11-
In the `roles` directory, include a `requirements.yml` file with the
12-
following contents:
5+
When using this role in a playbook on a {{ site.data.product.title_short }} appliance, add an empty `roles` directory at the root of the playbook. In the `roles` directory, include a `requirements.yml` file with the following contents:
136

147
---
158
- src: <ansible-galaxy-role>
169

17-
{{ site.data.product.title_short }} will automatically install the role once it sees
18-
the `requirements.yml` file in the playbook.
10+
{{ site.data.product.title_short }} automatically installs the role once it sees the `requirements.yml` file in the playbook.
Lines changed: 57 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,217 +1,149 @@
11
# Credentials
22

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.
64

75
## Adding Credentials
86

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.
128

139
1. Browse to menu: **Automation > Ansible > Credentials**.
1410

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

1913
3. Provide a **Name** for the credential.
2014

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.
2316

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).
2618

2719
5. Click **Add**.
2820

2921
## Credential Types
3022

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.
3324

3425
### Machine
3526

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.
4228

43-
- **Username**: The username to be used for SSH authentication.
29+
- **Username**: The username to be used for SSH authentication.
4430

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

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.
4934

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.
5236

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**.
5638

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.
5940

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.
6342

6443
### Network
6544

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.
6846

6947
Network credentials have several attributes that may be configured:
7048

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.
7350

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.
7652

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.
7954

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.
8256

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.
8558

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.
8860

8961
### SCM
9062

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.
9464

95-
Source Control credentials have several attributes that may be
96-
configured:
65+
Source Control credentials have several attributes that may be configured:
9766

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.
10068

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.
10370

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.
10772

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.
11174

11275
### Amazon
11376

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.
11678

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.
11980

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.
12282

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.
12584

12685
### Azure
12786

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.
13088

13189
Microsoft Azure credentials have several attributes to configure:
13290

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.
13592

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.
13894

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

142-
- **Tenant ID**: The Tenant ID for the Microsoft Azure account.
97+
- **Tenant ID**: The Tenant ID for the Microsoft Azure account.
14398

144-
- **Client Secret**: The Client Secret for the Microsoft Azure
145-
account.
99+
- **Client Secret**: The Client Secret for the Microsoft Azure account.
146100

147-
- **Client ID**: The Client ID for the Microsoft Azure account.
101+
- **Client ID**: The Client ID for the Microsoft Azure account.
148102

149103
### OpenStack
150104

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.
153106

154107
OpenStack credentials have several attributes that may be configured:
155108

156-
- **Username**: The username to use to connect to OpenStack.
109+
- **Username**: The username to use to connect to OpenStack.
157110

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.
160112

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

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.
166116

167-
- **Domain name**: The FQDN to be used to connect to OpenStack.
117+
- **Domain name**: The FQDN to be used to connect to OpenStack.
168118

169119
### Red Hat Virtualization
170120

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.
173122

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:
176124

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.
179126

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.
182128

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

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`
187132

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).
197134

198135
### VMware
199136

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.
202138

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.
206140

207141
VMware credentials have several attributes that may be configured:
208142

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.
212144

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

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

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

Comments
 (0)