8000 2.5 Update names and configmap for ansible-plugins 1.5 (#3449) by ariordan-redhat · Pull Request #3458 · ansible/aap-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

2.5 Update names and configmap for ansible-plugins 1.5 (#3449) #3458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ include::devtools/proc-rhdh-add-devtools-container.adoc[leveloffset=+2]
include::devtools/proc-rhdh-add-custom-configmap.adoc[leveloffset=+1]
include::devtools/proc-rhdh-configure-devtools-server.adoc[leveloffset=+1]
include::devtools/proc-rhdh-configure-aap-details.adoc[leveloffset=+1]
include::devtools/proc-rhdh-configure-showcase-location.adoc[leveloffset=+1]
include::devtools/proc-rhdh-add-plugin-software-templates.adoc[leveloffset=+1]
include::devtools/proc-rhdh-configure-rbac.adoc[leveloffset=+1]

Expand Down
14 changes: 7 additions & 7 deletions downstream/modules/devtools/proc-rhdh-add-plugin-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ global:
...
plugins:
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap plugin>
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap-dynamic plugin>
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
pluginConfig:
dynamicPlugins:
frontend:
Expand All @@ -28,17 +28,17 @@ global:
text: Ansible
path: /ansible
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-scaffolder-backend-module-backstage-rhaap plugin>
integrity: <SHA512 Integrity key for ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic plugin>
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap-backend plugin>
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap-backend-dynamic plugin>
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
Expand Down Expand Up @@ -66,7 +66,7 @@ To verify that the plug-ins have been installed, open the `install-dynamic-plugi
The following example from the log indicates a successful installation for one of the plug-ins:
+
-----
=> Successfully installed dynamic plugin http://plugin-registry-1:8080/ansible-plugin-backstage-rhaap-1.1.0.tgz
=> Successfully installed dynamic plugin http://plugin-registry-1:8080/ansible-plugin-backstage-rhaap-dynamic-1.1.0.tgz
-----
+
The following image shows the container log in the *Pod details* page.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
:_mod-docs-content-type: PROCEDURE

[id="rhdh-configure-showcase-location_{context}"]
= Configuring `showCaseLocation`

You must configure `showCaseLocation` in your custom config map.

// Prevents the following error:
// cause: Error: Missing required config value at 'ansible.rhaap.showCaseLocation.type' in 'env'

.Procedure

. Edit your custom {RHDH} config map, `app-config-rhdh`, that you created in
xref:rhdh-add-custom-configmap_rhdh-ocp-required-installation[Adding a custom ConfigMap].
. Add the following code to your {RHDH} `app-config-rhdh.yaml` file.
+
----
kind: ConfigMap< 10000 /td>
apiVersion: v1
metadata:
name: app-config-rhdh
...
data:
app-config-rhdh.yaml: |-
ansible:
rhaap:
...
showCaseLocation:
type: file
target: '/tmp/aap-showcases/'
...

----

Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ image::rhdh-plugin-registry.png[Developer perspective]
+
(2) Plug-in registry
. Click the terminal tab and login to the container.
. In the terminal, run `ls` to confirm that the .tar files are in the plugin registry.
. In the terminal, run `ls` to confirm that the `.tar` files are in the plugin registry.
+
----
ansible-plugin-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
----
+
The version numbers and file names can differ.
Expand Down
12 changes: 6 additions & 6 deletions downstream/modules/devtools/proc-rhdh-download-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ Run `ls` to verify that the extracted files are in the `$DYNAMIC_PLUGIN_ROOT_DIR

----
$ ls $DYNAMIC_PLUGIN_ROOT_DIR
ansible-plugin-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz.integrity
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity

----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The example ConfigMap used in the following procedure is called `rhaap-dynamic-p
. Select the `rhaap-dynamic-plugins-config` ConfigMap from the list.
. Select the *YAML* tab to edit the `rhaap-dynamic-plugins-config` ConfigMap.
. In the `data.dynamic-plugins.yaml.plugins` block, add the three dynamic plug-ins from the plug-in registry.
** For the `integrity` hash values, use the `.integrity` files in your `$DYNAMIC_PLUGIN_ROOT_DIR` directory that correspond to each plug-in, for example use `ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity` for the `ansible-plugin-backstage-rhaap-x.y.z.tgz` plug-in.
** For the `integrity` hash values, use the `.integrity` files in your `$DYNAMIC_PLUGIN_ROOT_DIR` directory that correspond to each plug-in, for example use `ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity` for the `ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz` plug-in.
** Replace `x.y.z` with the correct version of the plug-ins.
+
----
Expand All @@ -30,8 +30,8 @@ data:
...
plugins:
- disabled: false
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
pluginConfig:
dynamicPlugins:
frontend:
Expand All @@ -47,16 +47,16 @@ data:
path: /ansible
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz.integrity
pluginConfig:
dynamicPlugins:
backend:
ansible.plugin-backstage-rhaap-backend: null
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity
pluginConfig:
dynamicPlugins:
backend:
Expand Down
6 changes: 3 additions & 3 deletions downstream/modules/devtools/proc-rhdh-uninstall-ocp-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ global:
plugins:
- disabled: false
integrity: <SHA512 value>
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
pluginConfig:
dynamicPlugins:
frontend:
Expand All @@ -33,15 +33,15 @@ global:
- disabled: false
integrity: <SHA512 value>
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
- disabled: false
integrity: <SHA512 value>
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ data:
...
plugins: # Remove the Ansible plug-ins entries below the ‘plugins’ YAML key
- disabled: false
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
integrity: <SHA512 value>
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
integrity: <SHA512 value>
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
integrity: <SHA512 value>
...

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,26 @@ You do not need to reload the deployment manually .
+
----
- disabled: false
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
integrity: <SHA512 value>
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
integrity: <SHA512 value>
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
integrity: <SHA512 value>
----
.. Click btn:[Save].
. To completely remove all the Ansible plugins remove the entire list entries that contain
+
----
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
----
. Open the custom {RHDH}ConfigMap, `app-config-rhdh`.
.. Remove the `locations:` block to delete the templates from the {RHDHShort} instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ global:
plugins:
- disabled: false
integrity: <SHA512 value>
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
pluginConfig:
dynamicPlugins:
frontend:
Expand All @@ -33,15 +33,15 @@ global:
- disabled: false
integrity: <SHA512 value>
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
- disabled: false
integrity: <SHA512 value>
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
This example uses a ConfigMap file called `rhaap-dynamic-plugins-config`.
. Update `x.y.z` with the version numbers for the updated {AAPRHDHShort}.
. Update the integrity values for each plug-in with the `.integrity` value from the corresponding extracted {AAPRHDHShort} `.tar` file.
// For example, use the `.integrity` value from `ansible-plugin-backstage-rhaap-x.y.z.tgz` for the `ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity` key.
// For example, use the `.integrity` value from `ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz` for the `ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity` key.
+
----
kind: ConfigMap
Expand All @@ -22,18 +22,18 @@ data:
...
plugins: # Update the Ansible plug-in entries below with the updated plugin versions
- disabled: false
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz.integrity
...
- disabled: false
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity
...

----
Expand Down
12 changes: 6 additions & 6 deletions downstream/modules/devtools/proc-self-service-download-tar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ Run `ls` to verify that the extracted files are in the `$DYNAMIC_PLUGIN_ROOT_DIR

----
$ ls $DYNAMIC_PLUGIN_ROOT_DIR
ansible-plugin-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz.integrity
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity

----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ image::self-service-plugin-registry.png[Developer perspective]
. In the terminal, run `ls` to confirm that the `.tar` files are in the plugin registry.
+
----
ansible-plugin-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
----
+
The version numbers and file names can differ.
Expand Down
F907
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ data:
baseUrl: '<https://MyControllerUrl>'
token: '<AAP Personal Access Token>'
checkSSL: <true or false>
showCaseLocation:
type: file
target: '/tmp/aap-showcases/'
# Optional integrations
devSpaces:
baseUrl: '<https://MyDevSpacesURL>'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ global:
plugins:
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap plugin>
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
pluginConfig:
dynamicPlugins:
frontend:
Expand All @@ -28,15 +28,15 @@ global:
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-scaffolder-backend-module-backstage-rhaap plugin>
package: >-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
- disabled: false
integrity: <SHA512 Integrity key for ansible-plugin-backstage-rhaap-backend plugin>
package: >-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
pluginConfig:
dynamicPlugins:
backend:
Expand Down
0