Skip to content

Commit 3be0703

Browse files
authored
DITA migration changes. CUG Ch 22 (#3843)
* DITA migration changes. CUG Ch 22 Changed modules. Tidied assembly Using automation execution UI and modular compliance chapter 22 https://issues.redhat.com/browse/AAP-45156 * DITA migration changes: CUG Ch 22 New modules and corrections Using automation execution UI and modular compliance chapter 22 https://issues.redhat.com/browse/AAP-45156 * DITA migration changes. CUG Ch22 Corrections Using automation execution UI and modular compliance chapter 22 https://issues.redhat.com/browse/AAP-45156
1 parent a3c8921 commit 3be0703

File tree

35 files changed

+308
-241
lines changed

35 files changed

+308
-241
lines changed

downstream/assemblies/platform/assembly-controller-credentials.adoc

Lines changed: 51 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,6 @@
22

33
[id="controller-credentials"]
44

5-
//ifdef::controller-GS[]
6-
//= Managing credentials
7-
8-
9-
//Credentials authenticate the controller user to launch Ansible playbooks. The passwords and SSH keys are used to authenticate against inventory hosts.
10-
//By using the credentials feature of {ControllerName}, you can require the {ControllerName} user to enter a password or key phrase when a playbook launches.
11-
12-
//include::platform/proc-controller-create-credential.adoc[leveloffset=+1]
13-
//include::platform/proc-controller-edit-credential.adoc[leveloffset=+1]
14-
//endif::controller-GS[]
15-
//ifdef::controller-UG[]
16-
175
= Managing user credentials
186

197
Credentials authenticate the {ControllerName} user when launching jobs against machines, synchronizing with inventory sources, and importing project content from a version control system.
@@ -27,70 +15,96 @@ If a user moves to a different team or leaves the organization, you do not have
2715
For further information, see link:{URLControllerAdminGuide}[_{ControllerAG}_].
2816
====
2917

30-
== How credentials work
31-
{ControllerNameStart} uses SSH to connect to remote hosts.
32-
To pass the key from {ControllerName} to SSH, the key must be decrypted before it can be written to a named pipe.
33-
{ControllerNameStart} uses that pipe to send the key to SSH, so that the key is never written to disk.
34-
If passwords are used, {ControllerName} handles them by responding directly to the password prompt and decrypting the password before writing it to the prompt.
18+
//Removed as part of editorial review - include::platform/ref-controller-credentials-getting-started.adoc[leveloffset=+1]
19+
include::platform/con-controller-how-credentials-work.adoc[leveloffset=+1]
3520

36-
The *Credentials* page shows credentials that are currently available.
37-
The default view is collapsed (Compact), showing the credential name, and credential type.
38-
From this screen you can edit image:leftpencil.png[Edit,15,15], duplicate image:copy.png[Copy,15,15] or delete {MoreActionsIcon} a credential.
21+
include::platform/proc-controller-create-credential.adoc[leveloffset=+1]
3922

40-
[NOTE]
41-
====
42-
It is possible to create duplicate credentials with the same name and without an organization.
43-
However, it is not possible to create two duplicate credentials in the same organization.
23+
include::platform/proc-controller-add-users-job-templates.adoc[leveloffset=+1]
4424

45-
.Example
25+
include::platform/ref-controller-credential-types.adoc[leveloffset=+1]
4626

47-
. Create two machine credentials with the same name but without an organization.
48-
. Use the module `ansible.controller.export` to export the credentials.
49-
. Use the module `ansible.controller.import` in a different automation execution node.
50-
. Check the imported credentials.
27+
include::platform/ref-controller-credential-aws.adoc[leveloffset=+2]
5128

52-
When you export two duplicate credentials and then import them in a different node, only one credential is imported.
53-
====
29+
include::platform/ref-controller-access-ec2-credentials-in-playbook.adoc[leveloffset=+3]
5430

55-
//Removed as part of editorial review - include::platform/ref-controller-credentials-getting-started.adoc[leveloffset=+1]
56-
include::platform/proc-controller-create-credential.adoc[leveloffset=+1]
57-
include::platform/proc-controller-add-users-job-templates.adoc[leveloffset=+1]
58-
include::platform/ref-controller-credential-types.adoc[leveloffset=+1]
59-
include::platform/ref-controller-credential-aws.adoc[leveloffset=+2]
6031
include::platform/ref-controller-credential-galaxy-hub.adoc[leveloffset=+2]
6132
//AWS Secrets Manager Lookup
6233
include::platform/ref-controller-aws-secrets-lookup.adoc[leveloffset=+2]
6334
//Bitbucket
6435
include::platform/ref-controller-credential-bitbucket.adoc[leveloffset=+2]
36+
6537
include::platform/ref-controller-credential-centrify-vault.adoc[leveloffset=+2]
38+
6639
include::platform/ref-controller-credential-container-registry.adoc[leveloffset=+2]
40+
6741
include::platform/ref-controller-credential-cyberark-central.adoc[leveloffset=+2]
42+
6843
include::platform/ref-controller-credential-cyberark-conjur.adoc[leveloffset=+2]
44+
6945
include::platform/ref-controller-credential-gitHub-pat.adoc[leveloffset=+2]
46+
7047
include::platform/ref-controller-credential-gitLab-pat.adoc[leveloffset=+2]
48+
7149
include::platform/ref-controller-credential-GCE.adoc[leveloffset=+2]
50+
51+
include::platform/con-controller-access-GCE-in-a-playbook.adoc[leveloffset=+3]
52+
7253
include::platform/ref-controller-credential-GPG-public-key.adoc[leveloffset=+2]
54+
7355
include::platform/ref-controller-credential-hashiCorp-secret.adoc[leveloffset=+2]
56+
7457
include::platform/ref-controller-credential-hashiCorp-vault.adoc[leveloffset=+2]
58+
7559
include::platform/ref-controller-credential-insights.adoc[leveloffset=+2]
60+
7661
include::platform/ref-controller-credential-machine.adoc[leveloffset=+2]
62+
63+
include::platform/con-controller-access-machine-credentials-playbook.adoc[leveloffset=+3]
64+
7765
include::platform/ref-controller-credential-azure-key.adoc[leveloffset=+2]
66+
7867
include::platform/ref-controller-credential-azure-resource.adoc[leveloffset=+2]
68+
69+
include::platform/ref-controller-access-azure-resources-in-playbook.adoc[leveloffset=+3]
70+
7971
include::platform/ref-controller-credential-network.adoc[leveloffset=+2]
72+
73+
include::platform/ref-controller-access-network-creds-playbook.adoc[leveloffset=+3]
74+
75+
include::platform/ref-controller-multiple-connection-protocols.adoc[leveloffset=+3]
76+
8077
include::platform/ref-controller-credential-openShift.adoc[leveloffset=+2]
78+
8179
include::platform/proc-controller-credential-create-openshift-account.adoc[leveloffset=+3]
80+
8281
include::platform/ref-controller-credential-openStack.adoc[leveloffset=+2]
82+
8383
include::platform/ref-controller-credential-aap.adoc[leveloffset=+2]
84+
85+
include::platform/ref-controller-access-controller-creds-in-playbook.adoc[leveloffset=+3]
86+
8487
include::platform/ref-controller-credential-satellite.adoc[leveloffset=+2]
88+
8589
include::platform/ref-controller-credential-virtualization.adoc[leveloffset=+2]
90+
91+
include::platform/ref-controller-access-virt-creds-in-playbook.adoc[leveloffset=+3]
92+
8693
include::platform/ref-controller-credential-source-control.adoc[leveloffset=+2]
94+
8795
//The following Terraform module is for 2.5 only:
8896
include::platform/ref-controller-credential-terraform.adoc[leveloffset=+2]
97+
8998
include::platform/ref-controller-credential-thycotic-vault.adoc[leveloffset=+2]
99+
90100
include::platform/ref-controller-credential-thycotic-server.adoc[leveloffset=+2]
101+
91102
include::platform/ref-controller-credential-vault.adoc[leveloffset=+2]
103+
92104
include::platform/ref-controller-credential-vmware-vcenter.adoc[leveloffset=+2]
105+
106+
include::platform/ref-controller-access-vmware-creds-in-playbook.adoc[leveloffset=+3]
107+
93108
include::platform/ref-controller-use-credentials-in-playbooks.adoc[leveloffset=+1]
94109

95-
//endif::controller-UG[]
96110

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[id="con-controller-access-GCE-in-a-playbook"]
2+
3+
= Access Google Compute Engine credentials in an Ansible Playbook
4+
5+
You can get GCE credential parameters from a job runtime environment:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
gce:
11+
email: '{{ lookup("env", "GCE_EMAIL") }}'
12+
project: '{{ lookup("env", "GCE_PROJECT") }}'
13+
pem_file_path: '{{ lookup("env", "GCE_PEM_FILE_PATH") }}'
14+
----
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[id="con-controller-access-machine-credentials-playbook"]
2+
3+
= Access machine credentials in an ansible playbook
4+
5+
You can get username and password from Ansible facts:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
machine:
11+
username: '{{ ansible_user }}'
12+
password: '{{ ansible_password }}'
13+
----
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[id="con-controller-how-credentials-work"]
2+
3+
= How credentials work
4+
5+
{ControllerNameStart} uses SSH to connect to remote hosts.
6+
To pass the key from {ControllerName} to SSH, the key must be decrypted before it can be written to a named pipe.
7+
{ControllerNameStart} uses that pipe to send the key to SSH, so that the key is never written to disk.
8+
If passwords are used, {ControllerName} handles them by responding directly to the password prompt and decrypting the password before writing it to the prompt.
9+
10+
The *Credentials* page shows credentials that are currently available.
11+
The default view is collapsed (Compact), showing the credential name, and credential type.
12+
13+
From this screen you can edit image:leftpencil.png[Edit,15,15], duplicate image:copy.png[Copy,15,15] or delete {MoreActionsIcon} a credential.
14+
15+
[NOTE]
16+
====
17+
It is possible to create duplicate credentials with the same name and without an organization.
18+
However, it is not possible to create two duplicate credentials in the same organization.
19+
20+
.Example
21+
22+
. Create two machine credentials with the same name but without an organization.
23+
. Use the module `ansible.controller.export` to export the credentials.
24+
. Use the module `ansible.controller.import` in a different automation execution node.
25+
. Check the imported credentials.
26+
27+
When you export two duplicate credentials and then import them in a different node, only one credential is imported.
28+
====

downstream/modules/platform/proc-controller-add-users-job-templates.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
. Click the *User Access* tab.
1212
You can see users and teams associated with this credential and their roles.
1313
If no users exist, add them from the *Users* menu.
14-
For more information, see link:{BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/access_management_and_authentication/gw-managing-access#assembly-controller-users_gw-manage-rbac[Users].
14+
For more information, see link:{URLCentralAuth}/gw-managing-access#assembly-controller-users_gw-manage-rbac[Users].
1515
. Click btn:[Add roles].
1616
. Select the user(s) that you want to give access to the credential and click btn:[Next].
1717
. From the *Select roles to apply* page, select the roles you want to add to the User.
@@ -27,4 +27,4 @@ If the action is not successful, a warning displays.
2727
. Select the *Job templates* tab to select a job template to which you want to assign this credential.
2828
. Chose a job template or select *Create job template* from the *Create template* list to assign the credential to additional job templates.
2929
+
30-
For more information about creating new job templates, see the xref:controller-job-templates[Job templates] section.
30+
For more information about creating new job templates, see link:{URLControllerUserGuide}/controller-job-templates[Job templates].

downstream/modules/platform/proc-controller-create-credential.adoc

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,14 @@
33
[id="controller-create-credential"]
44

55
= Creating new credentials
6-
//ifdef::controller-GS[]
7-
//As part of the initial setup, a demonstration credential and a Galaxy credential have been created for your use. Use the Galaxy credential as a template.
8-
//It can be copied, but not edited.
9-
//You can add more credentials as necessary.
10-
//endif::controller-GS[]
116

12-
//ifdef::controller-UG[]
137
Credentials added to a team are made available to all members of the team.
148
You can also add credentials to individual users.
159

1610
As part of the initial setup, two credentials are available for your use: Demo Credential and Ansible Galaxy.
1711
Use the Ansible Galaxy credential as a template.
1812
You can copy this credential, but not edit it.
1913
Add more credentials as needed.
20-
//endif::controller-UG[]
2114

2215
.Procedure
2316
. From the navigation panel, select {MenuAECredentials}.
@@ -30,12 +23,9 @@ Add more credentials as needed.
3023
* Optional *Organization*: The name of the organization with which the credential is associated. The default is *Default*.
3124
* *Credential type*: enter or select the credential type you want to create.
3225

33-
. Enter the appropriate details depending on the type of credential selected, as described in xref:ref-controller-credential-types[Credential types].
26+
. Enter the appropriate details depending on the type of credential selected, as described in link:{URLControllerUserGuide}/controller-credentials#ref-controller-credential-types[Credential types].
3427
+
3528
image:credential-types-drop-down-menu.png[Credential types drop down list]
3629

37-
3830
. Click btn:[Create credential].
3931

40-
//You can also use this procedure from the *Credentials* tab when you select a credential type on the *Credential Types* page. Not sure how to document that, it should be a single route.
41-
//endif::controller-UG[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[id="ref-controller-access-azure-resources-in-playbook"]
2+
3+
= Access {Azure} resource manager credentials in an ansible playbook
4+
5+
You can get {Azure} credential parameters from a job runtime environment:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
azure:
11+
client_id: '{{ lookup("env", "AZURE_CLIENT_ID") }}'
12+
secret: '{{ lookup("env", "AZURE_SECRET") }}'
13+
tenant: '{{ lookup("env", "AZURE_TENANT") }}'
14+
subscription_id: '{{ lookup("env", "AZURE_SUBSCRIPTION_ID") }}'
15+
----
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[id="ref-controller-access-controller-creds-in-playbook"]
2+
3+
= Access {ControllerName} credentials in an Ansible Playbook
4+
5+
You can get the host, username, and password parameters from a job runtime environment:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
controller:
11+
host: '{{ lookup("env", "CONTROLLER_HOST") }}'
12+
username: '{{ lookup("env", "CONTROLLER_USERNAME") }}'
13+
password: '{{ lookup("env", "CONTROLLER_PASSWORD") }}'
14+
----
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[id="ref-controller-access-ec2-credentials-in-playbook"]
2+
3+
= Access Amazon EC2 credentials in an Ansible Playbook
4+
5+
You can get AWS credential parameters from a job runtime environment:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
aws:
11+
access_key: '{{ lookup("env", "AWS_ACCESS_KEY_ID") }}'
12+
secret_key: '{{ lookup("env", "AWS_SECRET_ACCESS_KEY") }}'
13+
security_token: '{{ lookup("env", "AWS_SECURITY_TOKEN") }}'
14+
----
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[id="ref-controller-access-network-creds-playbook"]
2+
3+
= Access network credentials in an ansible playbook
4+
5+
You can get the username and password parameters from a job runtime environment:
6+
7+
[literal, options="nowrap" subs="+attributes"]
8+
----
9+
vars:
10+
network:
11+
username: '{{ lookup("env", "ANSIBLE_NET_USERNAME") }}'
12+
password: '{{ lookup("env", "ANSIBLE_NET_PASSWORD") }}'
13+
----

0 commit comments

Comments
 (0)