Skip to content

Commit 04ed18f

Browse files
committed
FixLinks
Removed anchors to avoid broken links.
1 parent 74c750e commit 04ed18f

File tree

6 files changed

+0
-42
lines changed

6 files changed

+0
-42
lines changed

managing_providers/_topics/adding_ansible_galaxy_roles.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
## Installing Roles on an Embedded Ansible Appliance
2-
{: #installing_roles_embedded_ansible_appliance}
32

43
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.
54

managing_providers/_topics/ansible_credentials.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Credentials
2-
{: #ansible_credentials}
32

43
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.
54

65
## Adding Credentials
7-
{: #adding_credentials}
86

97
{{ 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.
108

@@ -21,12 +19,10 @@ Credentials are utilized by {{ site.data.product.title_short }} for authenticati
2119
5. Click **Add**.
2220

2321
## Credential Types
24-
{: #credential_types}
2522

2623
Each credential type used by {{ site.data.product.title_short }} is detailed in the following sections.
2724

2825
### Machine
29-
{: #machine}
3026

3127
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.
3228

@@ -45,7 +41,6 @@ Machine credentials enable {{ site.data.product.title_short }} to invoke Ansible
4541
- **Privilege Escalation Password**: Enter the actual password to be used to authenticate the user via the selected privilege escalation type on the remote system.
4642

4743
### Network
48-
{: #network}
4944

5045
Network credentials are used by Ansible networking modules to connect to and manage networking devices.
5146

@@ -64,7 +59,6 @@ Network credentials have several attributes that may be configured:
6459
- **Private key passphrase**: The actual passphrase for the private key to be used to authenticate the user to the network via SSH.
6560

6661
### SCM
67-
{: #scm}
6862

6963
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.
7064

@@ -79,7 +73,6 @@ Source Control credentials have several attributes that may be configured:
7973
- **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.
8074

8175
### Amazon
82-
{: #amazon}
8376

8477
Selecting this credential type enables synchronization of cloud inventory with Amazon Web Services.
8578

@@ -90,7 +83,6 @@ Selecting this credential type enables synchronization of cloud inventory with A
9083
- **STS Token**: Token generated by Amazon Web Services Security Token Service.
9184

9285
### Azure
93-
{: #azure}
9486

9587
Selecting this credential type enables synchronization of cloud inventory with Microsoft Azure.
9688

@@ -109,7 +101,6 @@ Microsoft Azure credentials have several attributes to configure:
109101
- **Client ID**: The Client ID for the Microsoft Azure account.
110102

111103
### OpenStack
112-
{: #openstack}
113104

114105
Selecting this credential type enables synchronization of cloud inventory with Red Hat OpenStack Platform.
115106

@@ -126,7 +117,6 @@ OpenStack credentials have several attributes that may be configured:
126117
- **Domain name**: The FQDN to be used to connect to OpenStack.
127118

128119
### Red Hat Virtualization
129-
{: #red_hat_virtualization}
130120

131121
Selecting this credential type enables synchronization of cloud inventory with Red Hat Virtualization.
132122

@@ -143,7 +133,6 @@ Red Hat Virtualization credentials have several attributes that may be configure
143133
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).
144134

145135
### VMware
146-
{: #vmware}
147136

148137
Selecting this credential type enables synchronization of inventory with VMware vCenter.
149138

managing_providers/_topics/automation_management_providers.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Automation Management Providers
2-
{: #automation_management_providers}
32

43
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.
54

@@ -12,7 +11,6 @@ In {{ site.data.product.title_short }}, an automation management provider is a m
1211
**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.
1312

1413
## Ansible
15-
{: #ansible}
1614

1715
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.
1816

@@ -35,7 +33,6 @@ Ansible is built into {{ site.data.product.title_short }} so there is nothing to
3533
4. Back your services, alerts, and policies using available playbooks.
3634

3735
### Enabling the Embedded Ansible Server Role
38-
{: #enabling_embedded_ansible_server_role}
3936

4037
In {{ site.data.product.title_short }}, the **Embedded Ansible** role is disabled by default. Enable this server role to utilize Ansible Automation Inside.
4138

@@ -48,7 +45,6 @@ In {{ site.data.product.title_short }}, the **Embedded Ansible** role is disable
4845
3. Set the **Server Role** for **Embedded Ansible** to **On**.
4946

5047
### Verifying the Embedded Ansible Worker State
51-
{: #verifying_embedded_ansible_worker_state}
5248

5349
Verify that the Embedded Ansible worker has started to utilize its features.
5450

@@ -59,7 +55,6 @@ Verify that the Embedded Ansible worker has started to utilize its features.
5955
A table of all workers and current status will appear from which you can confirm the state of your embedded Ansible worker.
6056

6157
### Adding a Playbook Repository
62-
{: #adding_playbook_repository}
6358

6459
Add a repository so that {{ site.data.product.title_short }} can discover and make available your playbooks.
6560

@@ -82,7 +77,6 @@ Add a repository so that {{ site.data.product.title_short }} can discover and ma
8277
Once you have synced a repository, its playbooks will become available to {{ site.data.product.title_short }}.
8378

8479
### Refreshing Repositories
85-
{: #refreshing_repositories}
8680

8781
{{ 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.
8882

@@ -109,7 +103,6 @@ Alternately, you can refresh some or all repositories from the list view:
109103
{% include_relative _topics/optimizing_playbooks.md %}
110104

111105
### Ansible Tower
112-
{: #ansible_tower}
113106

114107
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.
115108

@@ -120,7 +113,6 @@ Using Ansible Tower, you can schedule Ansible playbook runs and monitor current
120113
{{ site.data.product.title_short }} supports Ansible Tower API v2 provider integration.
121114

122115
#### Working with an Ansible Tower Provider
123-
{: #working_with_ansible_tower_provider}
124116

125117
The basic workflow when using {{ site.data.product.title_short }} with an Ansible Tower provider is as follows:
126118

@@ -141,7 +133,6 @@ The basic workflow when using {{ site.data.product.title_short }} with an Ansibl
141133
- For more information about worklows, see [Workflows](https://docs.ansible.com/ansible-tower/latest/html/userguide/workflows.html) in the Ansible Tower *User Guide*.
142134

143135
#### Adding an Ansible Tower Provider
144-
{: #adding_ansible_tower_provider}
145136

146137
To access your Ansible Tower inventory from {{ site.data.product.title_short }}, you must add Ansible Tower as a provider.
147138

@@ -176,7 +167,6 @@ To access your Ansible Tower inventory from {{ site.data.product.title_short }},
176167
After adding the Ansible Tower provider, refresh its relationships and power states in order to view the current inventory.
177168

178169
#### Refreshing an Ansible Tower Provider
179-
{: #refreshing_an_ansible_tower_provider}
180170

181171
Refresh relationships of all items related to an existing Ansible Tower configuration management provider including inventory, hosts, virtual machines, and clusters.
182172

@@ -197,7 +187,6 @@ To refresh an Ansible Tower provider’s inventory in {{ site.data.product.title
197187
{{ site.data.product.title_short }} then queries the Ansible Tower API and obtains an inventory of all available hosts, job, and workflow templates.
198188

199189
#### Viewing Ansible Tower Providers and Inventory
200-
{: #viewing_ansible_tower_providers_and_inventory}
201190

202191
{{ 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.
203192

@@ -214,7 +203,6 @@ To view a list of Ansible Tower providers and inventory:
214203
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.
215204

216205
#### Viewing Ansible Tower Configured Systems
217-
{: #viewing_ansible_tower_configured_systems}
218206

219207
To view the systems in your Ansible Tower inventory:
220208

@@ -223,7 +211,6 @@ To view the systems in your Ansible Tower inventory:
223211
2. Under **All Ansible Tower Configured Systems**, select **Ansible Tower Configured Systems** to display a list.
224212

225213
#### Executing an Ansible Tower Job or Workflow Template from a Service Catalog
226-
{: #executing_ansible_tower_job_or_workflow_template_from_service_catalog}
227214

228215
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.
229216

@@ -288,7 +275,6 @@ The service item’s details can be viewed in menu: **Services > My Services** i
288275
**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).
289276

290277
#### Executing an Ansible Tower Job Using a Custom Automate Button
291-
{: #executing_ansible_tower_job_using_custom_automate_button}
292278

293279
{{ site.data.product.title_short }} can execute Ansible Tower jobs on virtual machines or instances using custom buttons in Automate.
294280

managing_providers/_topics/image_import.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
# Image Import Workflows
2-
{: #image_import_workflows}
32

43
## IBM PowerVC to IBM Power Systems Virtual Server
5-
{: #powervc_to_power_systems_virtual_server}
64

75
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.
86

97
### Preparing {{ site.data.product.title_short }} hosting server (required once):
10-
{: #preparing_hosting_server}
118

129
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.
1310

1411
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.
1512

1613

1714
### Preparing IBM PowerVC Server (required once):
18-
{: #preparing_powervc_server}
1915

2016
The following commands are to be run on a PowerVC server that is dedicated to supporting the image import workflow.
2117

@@ -99,7 +95,6 @@ The following commands are to be run on a PowerVC server that is dedicated to su
9995
rm /home/sessions/image.ova
10096

10197
### Add a Cloud Object Storage provider in {{ site.data.product.title_short }}:
102-
{: #add_cloud_object_storage_provider}
10398

10499
1. See the corresponding instructions [here](storage_providers/ibm_cloud_object_storage_managers.html).
105100

@@ -111,12 +106,10 @@ The following commands are to be run on a PowerVC server that is dedicated to su
111106
**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.
112107

113108
### Add an IBM Power Systems Virtual Server provider in {{ site.data.product.title_short }}:
114-
{: #add_power_systems_virtual_server_provider}
115109

116110
1. See the corresponding instructions [here](cloud_providers/ibm_power_systems_virtual_servers_providers.html).
117111

118112
### Add an IBM PowerVC provider in {{ site.data.product.title_short }}:
119-
{: #add_powervc_provider}
120113

121114
1. See the corresponding instructions [here](cloud_providers/ibm_power_vc_providers.html).
122115

@@ -129,20 +122,17 @@ The following commands are to be run on a PowerVC server that is dedicated to su
129122

130123

131124
### Grant Image Import Permissions in {{ site.data.product.title_short }}:
132-
{: #grant_image_import_permissions}
133125

134126
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.
135127
![import_access_control](../images/import_access_control.png)
136128

137129
### Enable Embedded Ansible in {{ site.data.product.title_short }}:
138-
{: #enable_embedded_ansible}
139130

140131
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`
141132

142133
![Enable Embedded Ansible](../images/import_emb_ansible.png)
143134

144135
### Start the workflow
145-
{: #start_the_workflow}
146136

147137
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:
148138

@@ -180,7 +170,6 @@ The workflow operates by exporting the image as an OVA file onto a PowerVC local
180170
14. Initiate the refreshing of the Power Systems Virtual Server provider upon workflow completion and wait for the newly imported image to appear.
181171

182172
### Troubleshooting
183-
{: #troubleshooting}
184173

185174
* 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.
186175

managing_providers/_topics/manageiq-automate-role.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
### Modifying the Automate Workspace Using the `manageiq-automate` Role.
2-
{: #modifying_automate_workspace_using_manageiq_automate_role}
32

43
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.
54

@@ -11,7 +10,6 @@ The `manageiq-automate` role allows users of {{ site.data.product.title_short }}
1110
{{ site.data.product.title_short }} will automatically install the role once it sees the `requirements.yml` file in the playbook.
1211

1312
#### Role Variables
14-
{: #role_variables}
1513

1614
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`.
1715

@@ -20,7 +18,6 @@ The `manageiq_automate` role employs the following variables when implemented in
2018
`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.
2119

2220
#### Example Playbook
23-
{: #example_playbook}
2421

2522
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.
2623

managing_providers/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
---
33

44
# Managing Providers
5-
{: #managing_providers}
65

76
{{ 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.
87

@@ -49,6 +48,5 @@ For information on working with the resources that are contained by a provider o
4948
{% include_relative _topics/storage_providers.md %}
5049

5150
## Appendix
52-
{: #appendix}
5351

5452
{% include app-self_signed_ca.md %}

0 commit comments

Comments
 (0)