You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: managing_providers/_topics/adding_ansible_galaxy_roles.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
## Installing Roles on an Embedded Ansible Appliance
2
-
{: #installing_roles_embedded_ansible_appliance}
3
2
4
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.
Copy file name to clipboardExpand all lines: managing_providers/_topics/ansible_credentials.md
-11Lines changed: 0 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
1
# Credentials
2
-
{: #ansible_credentials}
3
2
4
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.
5
4
6
5
## Adding Credentials
7
-
{: #adding_credentials}
8
6
9
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.
10
8
@@ -21,12 +19,10 @@ Credentials are utilized by {{ site.data.product.title_short }} for authenticati
21
19
5. Click **Add**.
22
20
23
21
## Credential Types
24
-
{: #credential_types}
25
22
26
23
Each credential type used by {{ site.data.product.title_short }} is detailed in the following sections.
27
24
28
25
### Machine
29
-
{: #machine}
30
26
31
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.
-**Privilege Escalation Password**: Enter the actual password to be used to authenticate the user via the selected privilege escalation type on the remote system.
46
42
47
43
### Network
48
-
{: #network}
49
44
50
45
Network credentials are used by Ansible networking modules to connect to and manage networking devices.
51
46
@@ -64,7 +59,6 @@ Network credentials have several attributes that may be configured:
64
59
-**Private key passphrase**: The actual passphrase for the private key to be used to authenticate the user to the network via SSH.
65
60
66
61
### SCM
67
-
{: #scm}
68
62
69
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.
70
64
@@ -79,7 +73,6 @@ Source Control credentials have several attributes that may be configured:
79
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.
80
74
81
75
### Amazon
82
-
{: #amazon}
83
76
84
77
Selecting this credential type enables synchronization of cloud inventory with Amazon Web Services.
85
78
@@ -90,7 +83,6 @@ Selecting this credential type enables synchronization of cloud inventory with A
90
83
-**STS Token**: Token generated by Amazon Web Services Security Token Service.
91
84
92
85
### Azure
93
-
{: #azure}
94
86
95
87
Selecting this credential type enables synchronization of cloud inventory with Microsoft Azure.
96
88
@@ -109,7 +101,6 @@ Microsoft Azure credentials have several attributes to configure:
109
101
-**Client ID**: The Client ID for the Microsoft Azure account.
110
102
111
103
### OpenStack
112
-
{: #openstack}
113
104
114
105
Selecting this credential type enables synchronization of cloud inventory with Red Hat OpenStack Platform.
115
106
@@ -126,7 +117,6 @@ OpenStack credentials have several attributes that may be configured:
126
117
-**Domain name**: The FQDN to be used to connect to OpenStack.
127
118
128
119
### Red Hat Virtualization
129
-
{: #red_hat_virtualization}
130
120
131
121
Selecting this credential type enables synchronization of cloud inventory with Red Hat Virtualization.
132
122
@@ -143,7 +133,6 @@ Red Hat Virtualization credentials have several attributes that may be configure
143
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).
144
134
145
135
### VMware
146
-
{: #vmware}
147
136
148
137
Selecting this credential type enables synchronization of inventory with VMware vCenter.
Copy file name to clipboardExpand all lines: managing_providers/_topics/automation_management_providers.md
-14Lines changed: 0 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
# Automation Management Providers
2
-
{: #automation_management_providers}
3
2
4
3
In {{ site.data.product.title_short }}, an automation management provider is a management tool that integrates with {{ site.data.product.title_short }} to simplify automation operations for your resources. The following chapter describes the automation management providers that you can use with {{ site.data.product.title_short }}, and how to work with them.
5
4
@@ -12,7 +11,6 @@ In {{ site.data.product.title_short }}, an automation management provider is a m
12
11
**Ansible Tower** is a management tool that is integrated with {{ site.data.product.title_short }}, designed to help automate infrastructure operations utlizizing existing Ansible Tower providers in your inventory. {{ site.data.product.title_short }} allows you to execute Ansible Tower jobs by using service catalogs and Automate. Using Ansible Tower, you can schedule Ansible playbook runs and monitor current and historical results, allowing for troubleshooting or identification of issues before they occur.
13
12
14
13
## Ansible
15
-
{: #ansible}
16
14
17
15
Ansible integrates with {{ site.data.product.title_short }} to provide automation solutions, using playbooks, for Service, Policy and Alert actions. Ansible playbooks consist of series of *plays* or tasks that define automation across a set of hosts, which is known as the inventory.
18
16
@@ -35,7 +33,6 @@ Ansible is built into {{ site.data.product.title_short }} so there is nothing to
35
33
4. Back your services, alerts, and policies using available playbooks.
36
34
37
35
### Enabling the Embedded Ansible Server Role
38
-
{: #enabling_embedded_ansible_server_role}
39
36
40
37
In {{ site.data.product.title_short }}, the **Embedded Ansible** role is disabled by default. Enable this server role to utilize Ansible Automation Inside.
41
38
@@ -48,7 +45,6 @@ In {{ site.data.product.title_short }}, the **Embedded Ansible** role is disable
48
45
3. Set the **Server Role** for **Embedded Ansible** to **On**.
49
46
50
47
### Verifying the Embedded Ansible Worker State
51
-
{: #verifying_embedded_ansible_worker_state}
52
48
53
49
Verify that the Embedded Ansible worker has started to utilize its features.
54
50
@@ -59,7 +55,6 @@ Verify that the Embedded Ansible worker has started to utilize its features.
59
55
A table of all workers and current status will appear from which you can confirm the state of your embedded Ansible worker.
60
56
61
57
### Adding a Playbook Repository
62
-
{: #adding_playbook_repository}
63
58
64
59
Add a repository so that {{ site.data.product.title_short }} can discover and make available your playbooks.
65
60
@@ -82,7 +77,6 @@ Add a repository so that {{ site.data.product.title_short }} can discover and ma
82
77
Once you have synced a repository, its playbooks will become available to {{ site.data.product.title_short }}.
83
78
84
79
### Refreshing Repositories
85
-
{: #refreshing_repositories}
86
80
87
81
{{ site.data.product.title_short }} allows you to refresh a targeted playbook repository or all repositories in your inventory to ensure your playbooks are current.
88
82
@@ -109,7 +103,6 @@ Alternately, you can refresh some or all repositories from the list view:
Ansible Tower is a management tool integrated with {{ site.data.product.title_short }}, designed to help automate infrastructure operations. {{ site.data.product.title_short }} allows you to execute Ansible Tower jobs or workflows using service catalogs and Automate. No custom configuration or Ruby scripting is needed in {{ site.data.product.title_short }}, as configuration is done in Ansible Tower using playbooks.
115
108
@@ -120,7 +113,6 @@ Using Ansible Tower, you can schedule Ansible playbook runs and monitor current
120
113
{{ site.data.product.title_short }} supports Ansible Tower API v2 provider integration.
121
114
122
115
#### Working with an Ansible Tower Provider
123
-
{: #working_with_ansible_tower_provider}
124
116
125
117
The basic workflow when using {{ site.data.product.title_short }} with an Ansible Tower provider is as follows:
126
118
@@ -141,7 +133,6 @@ The basic workflow when using {{ site.data.product.title_short }} with an Ansibl
141
133
- For more information about worklows, see [Workflows](https://docs.ansible.com/ansible-tower/latest/html/userguide/workflows.html) in the Ansible Tower *User Guide*.
142
134
143
135
#### Adding an Ansible Tower Provider
144
-
{: #adding_ansible_tower_provider}
145
136
146
137
To access your Ansible Tower inventory from {{ site.data.product.title_short }}, you must add Ansible Tower as a provider.
147
138
@@ -176,7 +167,6 @@ To access your Ansible Tower inventory from {{ site.data.product.title_short }},
176
167
After adding the Ansible Tower provider, refresh its relationships and power states in order to view the current inventory.
177
168
178
169
#### Refreshing an Ansible Tower Provider
179
-
{: #refreshing_an_ansible_tower_provider}
180
170
181
171
Refresh relationships of all items related to an existing Ansible Tower configuration management provider including inventory, hosts, virtual machines, and clusters.
182
172
@@ -197,7 +187,6 @@ To refresh an Ansible Tower provider’s inventory in {{ site.data.product.title
197
187
{{ site.data.product.title_short }} then queries the Ansible Tower API and obtains an inventory of all available hosts, job, and workflow templates.
198
188
199
189
#### Viewing Ansible Tower Providers and Inventory
{{ site.data.product.title_short }} automatically updates its inventory from Ansible Tower. This includes system groups (known as Inventories in Ansible Tower), basic information about individual systems, and available Ansible Tower job or workflow templates to be executed from the service catalog or Automate.
203
192
@@ -214,7 +203,6 @@ To view a list of Ansible Tower providers and inventory:
214
203
Similarly, all discovered job and workflow templates are accessed under the provider by expanding the menu: **Automation > Ansible Tower > Explorer** and click the **Templates** accordion menu.
215
204
216
205
#### Viewing Ansible Tower Configured Systems
217
-
{: #viewing_ansible_tower_configured_systems}
218
206
219
207
To view the systems in your Ansible Tower inventory:
220
208
@@ -223,7 +211,6 @@ To view the systems in your Ansible Tower inventory:
223
211
2. Under **All Ansible Tower Configured Systems**, select **Ansible Tower Configured Systems** to display a list.
224
212
225
213
#### Executing an Ansible Tower Job or Workflow Template from a Service Catalog
You can execute an Ansible Tower playbook from {{ site.data.product.title_short }} by creating a service catalog item from an Ansible Tower job or workflow template.
229
216
@@ -288,7 +275,6 @@ The service item’s details can be viewed in menu: **Services > My Services** i
288
275
**Note:** Instead of running a single job at a time, multiple service catalog items can also be grouped together as a catalog bundle to create one deployment with multiple job templates. For more information, see [Catalogs and Services](../provisioning_virtual_machines_and_hosts/index.html#catalogs-and-services).
289
276
290
277
#### Executing an Ansible Tower Job Using a Custom Automate Button
Copy file name to clipboardExpand all lines: managing_providers/_topics/image_import.md
-11Lines changed: 0 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,17 @@
1
1
# Image Import Workflows
2
-
{: #image_import_workflows}
3
2
4
3
## IBM PowerVC to IBM Power Systems Virtual Server
5
-
{: #powervc_to_power_systems_virtual_server}
6
4
7
5
The image import functionality allows you to easily move an image from your on-prem PowerVC environment to an off-prem Power Systems Virtual Server environment using {{ site.data.product.title_short }} web interface. The enablement of the workflow in {{ site.data.product.title_short }} requires you to perform certain preparations that are described in detail below.
8
6
9
7
### Preparing {{ site.data.product.title_short }} hosting server (required once):
10
-
{: #preparing_hosting_server}
11
8
12
9
The following commands are to be run on a server (or in a corresponding docker container) that is dedicated to hosting your {{ site.data.product.title_short }} instance.
13
10
14
11
1. Install `ansible-runner` application using the installation [instructions](https://ansible-runner.readthedocs.io/en/stable/install.html). The application must be available in the the command line of the user under which the {{ site.data.product.title_short }} web-server is running.
15
12
16
13
17
14
### Preparing IBM PowerVC Server (required once):
18
-
{: #preparing_powervc_server}
19
15
20
16
The following commands are to be run on a PowerVC server that is dedicated to supporting the image import workflow.
21
17
@@ -99,7 +95,6 @@ The following commands are to be run on a PowerVC server that is dedicated to su
99
95
rm /home/sessions/image.ova
100
96
101
97
### Add a Cloud Object Storage provider in {{ site.data.product.title_short }}:
102
-
{: #add_cloud_object_storage_provider}
103
98
104
99
1. See the corresponding instructions [here](storage_providers/ibm_cloud_object_storage_managers.html).
105
100
@@ -111,12 +106,10 @@ The following commands are to be run on a PowerVC server that is dedicated to su
111
106
**NOTE**: The "root" user as well as the workflow dedicated user of the PowerVC server from step [5](#preparing-ibm-powervc-server-required-once) would both be able to decrypt the Cloud Object Storage's credentials during the execution of the import workflow and therefore make sure to take this into consideration in your security setup.
112
107
113
108
### Add an IBM Power Systems Virtual Server provider in {{ site.data.product.title_short }}:
114
-
{: #add_power_systems_virtual_server_provider}
115
109
116
110
1. See the corresponding instructions [here](cloud_providers/ibm_power_systems_virtual_servers_providers.html).
117
111
118
112
### Add an IBM PowerVC provider in {{ site.data.product.title_short }}:
119
-
{: #add_powervc_provider}
120
113
121
114
1. See the corresponding instructions [here](cloud_providers/ibm_power_vc_providers.html).
122
115
@@ -129,20 +122,17 @@ The following commands are to be run on a PowerVC server that is dedicated to su
129
122
130
123
131
124
### Grant Image Import Permissions in {{ site.data.product.title_short }}:
132
-
{: #grant_image_import_permissions}
133
125
134
126
User performing image import needs a corresponding permission in {{ site.data.product.title_short }} in order to perform this operation. For granting permissions, log-in through an administrative account and navigate to `Settings -> Application Settings -> Access Control`. Make sure the user of your choice has permissions for `Import Cloud Template` action through the user's corresponding group and role.
### Enable Embedded Ansible in {{ site.data.product.title_short }}:
138
-
{: #enable_embedded_ansible}
139
130
140
131
Currently the workflow event is queued as Embedded Ansible playbook upon request submission and as such the corresponding functionality has to be enabled in {{ site.data.product.title_short }} by navigating to: `Settings -> Application Settings -> Settings`
The workflow operates by exporting the image as an OVA file onto a PowerVC local storage, uploading it to the Cloud Object Storage bucket and then transferring it into Power Systems Virtual Server image registry. In order to initiate the workflow:
148
138
@@ -180,7 +170,6 @@ The workflow operates by exporting the image as an OVA file onto a PowerVC local
180
170
14. Initiate the refreshing of the Power Systems Virtual Server provider upon workflow completion and wait for the newly imported image to appear.
181
171
182
172
### Troubleshooting
183
-
{: #troubleshooting}
184
173
185
174
* If the {{site.data.product.title_short}} UI shows no detailed error description then make sure to check the latest logs with `journalctl -t evm` or `oc logs` on a server or pod that hosts your {{site.data.product.title_short}} instance.
The `manageiq-automate` role allows users of {{ site.data.product.title_short }} Automate to modify and add to the automate workspace via an Ansible playbook.
5
4
@@ -11,7 +10,6 @@ The `manageiq-automate` role allows users of {{ site.data.product.title_short }}
11
10
{{ site.data.product.title_short }} will automatically install the role once it sees the `requirements.yml` file in the playbook.
12
11
13
12
#### Role Variables
14
-
{: #role_variables}
15
13
16
14
The `manageiq_automate` role employs the following variables when implemented in a playbook run on a {{ site.data.product.title_short }} appliance. Variables are defined in `defaults/main.yml` and `vars/main.yml`.
17
15
@@ -20,7 +18,6 @@ The `manageiq_automate` role employs the following variables when implemented in
20
18
`manageiq_validate_certs`: By default is set to `True`. If passed in with `extra_vars` or assigned in the playbook variables then the lookup allows self-signed certificates to be used when using SSL REST API connection URLs.
21
19
22
20
#### Example Playbook
23
-
{: #example_playbook}
24
21
25
22
The following example utilizes the `manageiq-automate` role. Using variable substitution, playbook tasks retrieve method parameters which are then used to modify object attributes. A final task uses the `set_retry` module to update the retry interval.
Copy file name to clipboardExpand all lines: managing_providers/index.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,6 @@
2
2
---
3
3
4
4
# Managing Providers
5
-
{: #managing_providers}
6
5
7
6
{{ site.data.product.title_short }} can manage a variety of external environments, which are known as providers and managers. A provider or manager is any system that {{ site.data.product.title_short }} integrates with for the purpose of collecting data and performing operations.
8
7
@@ -49,6 +48,5 @@ For information on working with the resources that are contained by a provider o
0 commit comments