Skip to content

Commit 532cf20

Browse files
AAP-44847 Update self-service installation doc per user feedback
1 parent 27a0a88 commit 532cf20

File tree

4 files changed

+15
-26
lines changed

4 files changed

+15
-26
lines changed

downstream/assemblies/devtools/assembly-self-service-generate-scm-tokens.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,21 @@ ifdef::context[]
1212
[id="self-service-generate-scm-tokens_{context}"]
1313
endif::[]
1414

15+
:context: self-service-generate-scm-tokens
16+
1517
= Generating GitHub and Gitlab personal access tokens
1618

17-
:context: self-service-generate-scm-tokens
19+
If you are planning to use private repositories, you must set up personal access tokens (PATs) in your SCM (Scource control management (SCM).
20+
21+
[NOTE]
22+
====
23+
You must add a source control credential in your {PlatformNameShort} instance.
24+
See
25+
link:{URLSelfServiceUsing}/self-service-using-scm-credentials-private-repos_aap-self-service-using#self-service-add-scm-credentials-aap_self-service-using-scm-credentials-private-repos[Adding Source Control Credentials for GitHub or Gitlab in Ansible Automation Platform].
26+
====
1827

1928
include::devtools/proc-self-service-create-gh-pat.adoc[leveloffset=+1]
29+
2030
include::devtools/proc-self-service-create-gl-pat.adoc[leveloffset=+1]
2131

2232
ifdef::parent-context-of-self-service-generate-scm-tokens[:context: {parent-context-of-self-service-generate-scm-tokens}]

downstream/modules/devtools/proc-self-service-download-tar.adoc

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,15 @@ link:{PlatformDownloadUrl}[Red Hat Ansible Automation Platform Product Software
1919
The format of the filename is `ansible-backstage-rhaap-bundle-x.y.z.tar.gz`.
2020
+
2121
Substitute the Ansible plug-ins release version, for example `1.0.0`, for `x.y.z`.
22-
. Extract the `ansible-backstage-rhaap-bundle-<version-number>.tar.gz` contents to `$DYNAMIC_PLUGIN_ROOT_DIR`.
22+
. Extract the {SelfServiceShort} plug-ins from `ansible-backstage-rhaap-bundle-<version-number>.tar.gz` to `$DYNAMIC_PLUGIN_ROOT_DIR`.
2323
+
2424
----
25-
$ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR
25+
$ tar -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR 'ansible-backstage-plugin-*-dynamic-*.tgz*' 'ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-*.tgz*' 'ansible-plugin-backstage-self-service-dynamic-*.tgz*'
2626
----
2727
+
2828
Substitute the Ansible plug-ins release version, for example `1.0.0`, for `x.y.z`.
2929

3030
.Verification
3131

32-
Run `ls` to verify that the extracted files are in the `$DYNAMIC_PLUGIN_ROOT_DIR` directory:
33-
34-
----
35-
$ ls $DYNAMIC_PLUGIN_ROOT_DIR
36-
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
37-
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
38-
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
39-
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz.integrity
40-
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
41-
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity
42-
43-
----
44-
45-
The files with the `.integrity` file type contain the plugin SHA value.
32+
Run `ls` to verify that the extracted files are in the `$DYNAMIC_PLUGIN_ROOT_DIR` directory.
4633

downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
. Click the *Helm* option in the OpenShift sidebar.
1515
. In the *Helm* page, click *Create* and select *Helm Release*.
1616
. Search for `AAP` in the Helm Charts filter,
17-
and select the `AAP Technical Preview: Self-service automation` chart.
17+
and select the `AAP Technology Preview: Self-service automation` chart.
1818
. In the modal dialog on the chart page, click *Create*.
1919
. Select the *YAML view* in the *Create Helm Release* page.
2020
. Locate the `clusterRouterBase` key in the YAML file and replace the placeholder value with the base URL of your OpenShift instance.

downstream/modules/devtools/proc-self-service-setup-registry-image.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,4 @@ image::self-service-plugin-registry.png[Developer perspective]
3636
(1) Plug-in registry
3737
. Click the *terminal* tab and log in to the container.
3838
. In the terminal, run `ls` to confirm that the `.tar` files are in the plugin registry.
39-
+
40-
----
41-
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
42-
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
43-
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
44-
----
45-
+
46-
The version numbers and file names can differ.
4739

0 commit comments

Comments
 (0)