Skip to content

Commit d1a55b4

Browse files
ariordan-redhatariordan-redhat
committed
AAP-55501 Update Portal upgrade process
1 parent 18431e9 commit d1a55b4

File tree

5 files changed

+76
-65
lines changed

5 files changed

+76
-65
lines changed

‎downstream/assemblies/devtools/assembly-self-service-upgrading.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ endif::[]
1616

1717
:context: self-service-upgrading
1818

19+
[role="_abstract"]
20+
To ensure that your {SelfServiceShort} deployment has the latest features and fixes,
21+
you must upgrade the plug-in registry and Helm chart to the latest versions.
22+
1923
include::devtools/proc-self-service-download-tar.adoc[leveloffset=+1]
2024

2125
include::devtools/proc-self-service-update-registry.adoc[leveloffset=+1]

‎downstream/attributes/attributes.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,13 @@
347347
:LinkTroubleshootingAAP: link:{URLTroubleshootingAAP}[{TitleTroubleshootingAAP}]
348348
//
349349
// titles/self-service-install
350-
:TitleSelfServiceInstall: Installing Ansible Automation Platform self-service technology preview
351-
:URLSelfServiceInstall: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/installing_ansible_automation_platform_self-service_technology_preview
350+
:TitleSelfServiceInstall: Installing self-service automation portal
351+
:URLSelfServiceInstall: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/installing_self-service_automation_portal
352352
:LinkSelfServiceInstall: link:{URLSelfServiceInstall}[{TitleSelfServiceInstall}]
353353
//
354354
// titles/self-service-using
355-
:TitleSelfServiceUsing: Using Ansible Automation Platform self-service technology preview
356-
:URLSelfServiceUsing: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/using_ansible_automation_platform_self-service_technology_preview
355+
:TitleSelfServiceUsing: Using self-service automation portal
356+
:URLSelfServiceUsing: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/using_self-service_automation_portal
357357
:LinkSelfServiceUsing: link:{URLSelfServiceUsing}[{TitleSelfServiceUsing}]
358358
//
359359
// titles/aap-plugin-rhdh-install

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,20 @@
33
[id="rhdh-download-tar_{context}"]
44
= Downloading the plug-in TAR files
55

6-
The `.tar.gz` files for {SelfServiceShort} are available from the Red Hat Customer Portal.
6+
[role="_abstract"]
7+
Download the latest `.tar.gz` plug-in files for {SelfServiceShort} from the Red Hat Customer Portal.
78

89
. Create a directory on your local machine to store the files.
910
+
1011
----
11-
$ mkdir /path/to/<automation-portal-plugins-local-dir-changeme>
12+
$ mkdir /path/to/<automation-portal-plugins>
1213
----
1314
. Set an environment variable (`$DYNAMIC_PLUGIN_ROOT_DIR`) to represent the directory path.
1415
+
1516
----
16-
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<automation-portal-plugins-local-dir-changeme>
17+
$ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<automation-portal-plugins>
1718
----
18-
. In a browser, navigate to the
19+
. Download the setup bundle. In a browser, navigate to the
1920
link:{PlatformDownloadUrl}[Red Hat Ansible Automation Platform Product Software downloads page].
2021
and select the *Product Software* tab.
2122
. Click *Download now* next to *Ansible self-service automation portal Setup Bundle* to download the latest version of the plug-ins.

‎downstream/modules/devtools/proc-self-service-update-helm.adoc‎

Lines changed: 42 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,57 @@
33
[id="rhdh-update-helm_{context}"]
44
= Updating the {SelfServiceShort} version numbers for a Helm installation
55

6+
[role="_abstract"]
67
After you have updated your plug-in registry for your {SelfServiceShort} project on your {OCPShort} instance,
78
you must update the Helm chart with the new versions of your plug-ins files.
89

10+
You can update the Helm chart from the command line using `helm` commands, or from the OpenShift web console.
11+
12+
[NOTE]
13+
====
14+
For upgrades in air-gapped or disconnected environments, the standard procedure cannot be used directly.
15+
You must first mirror the necessary container images to your local registry and prepare the Helm chart for offline use.
16+
17+
For detailed instructions on this process, see the
18+
link:{URLSelfServiceInstall}/self-service-disconnected-install_aap-self-service-install[Installing the self-service automation portal in an air-gapped environment] section of _{LinkSelfServiceInstall}_.
19+
====
20+
21+
922
.Procedure
1023

11-
. In a browser, log in to your {OCPShort} console.
12-
. Select your OpenShift project for {SelfServiceShort}.
13-
. Select *Helm* and select your Helm chart for {SelfServiceShort} from the list.
14-
. Select menu:Actions[Upgrade].
15-
. In the *Upgrade Helm Release* pane, select *YAML view*.
16-
. Modify the YAML code to update the versions of the `.tgz` and `.integrity` files to match the versions in the plug-in registry:
24+
* *Update the Helm chart from the command line:*
25+
.. In a terminal, log in to your OpenShift instance.
26+
.. Run the following command to ensure your Helm repository is up to date:
1727
+
1828
----
19-
...
20-
global:
21-
...
22-
plugins:
23-
- disabled: false
24-
integrity: <SHA512 value>
25-
package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
26-
pluginConfig:
27-
dynamicPlugins:
28-
frontend:
29-
ansible.plugin-backstage-rhaap:
30-
appIcons:
31-
- importName: AnsibleLogo
32-
name: AnsibleLogo
33-
dynamicRoutes:
34-
- importName: AnsiblePage
35-
menuItem:
36-
icon: AnsibleLogo
37-
text: Ansible
38-
path: /ansible
39-
- disabled: false
40-
integrity: <SHA512 value>
41-
package: >-
42-
http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
43-
pluginConfig:
44-
dynamicPlugins:
45-
backend:
46-
ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
47-
- disabled: false
48-
integrity: <SHA512 value>
49-
package: >-
50-
http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-dynamic-x.y.z.tgz
51-
pluginConfig:
52-
dynamicPlugins:
53-
backend:
54-
ansible.plugin-backstage-rhaap-backend: null
55-
29+
$ helm repo update
30+
----
31+
.. Find the latest version of the Helm chart:
32+
+
5633
----
57-
. Click btn:[Upgrade] to restart the pods.
34+
$ helm search repo openshift-helm-charts/redhat-rhaap-portal
35+
----
36+
.. Upgrade the Helm release:
37+
+
38+
----
39+
$ helm upgrade <release_name> openshift-helm-charts/redhat-rhaap-portal --version <chart_version>
40+
----
41+
+
42+
Replace `<release_name>` with the name of your Helm release and `<chart_version>`
43+
with the new Helm chart version number you identified in the previous step.
44+
* *Update the Helm chart using the OpenShift web console:*
45+
.. In a browser, log in to your {OCPShort} web console.
46+
.. Switch to the *Developer* perspective.
47+
.. From the navigation menu, Select *Helm*.
48+
.. Find your existing {SelfServiceShort} deployment in the list of *Helm releases* and click its name.
49+
.. Select menu:Actions[Upgrade].
50+
.. In the *Upgrade* pane, select the version that you want to upgrade to from the *Chart Version* dropdown list.
51+
.. Review the YAML configuration to ensure your custom values are preserved.
52+
.. Click btn:[Upgrade] to begin the upgrade.
5853

5954
.Verification
6055

61-
. In the {OCPShort} web console, select *Topology*.
62-
. Check that the {SelfServiceShort} instance is available.
63-
56+
After the upgrade completes, verify that the updated {SelfServiceShort} instance is running:
57+
. In the {OCPShort} web console, navigate to the *Topology* view for your project.
58+
. Check that the {SelfServiceShort} instance is available and that all associated pods are in a *Running* state.
6459

‎downstream/modules/devtools/proc-self-service-update-registry.adoc‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[id="rhdh-update-registry_{context}"]
44
= Updating the plug-in registry
55

6+
To update the plug-in registry, you must upload your plug-in files to OpenShift,
7+
and start a new build of the registry.
68

79
.Prerequisites
810
* You have downloaded the plug-in TAR files for {SelfService}.
@@ -17,15 +19,24 @@ to represent the path to the local directory where you have stored the TAR files
1719
----
1820
$ oc project <YOUR_SELF_SERVICE_AUTOMATION_PORTAL_PROJECT>
1921
----
20-
. Run the following commands to update your plug-in registry build in in your OpenShift project.
22+
. Find the name of your current plug-in registry build configuration:
2123
+
22-
The command assumes that `$DYNAMIC_PLUGIN_ROOT_DIR` represents the directory for your TAR files.
23-
Replace this in the command if you have chosen a different environment variable name.
24+
----
25+
$ oc get buildconfig
26+
----
27+
. From the output, identify the correct build configuration name, for example `aap-self-service-plugins`.
28+
. Run the following command to start a new build in in your OpenShift project.
2429
+
2530
----
26-
$ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
31+
$ oc start-build <build_config_name> --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
2732
----
2833
+
34+
--
35+
** The command assumes that `$DYNAMIC_PLUGIN_ROOT_DIR` represents the directory for your TAR files.
36+
Replace this in the command if you have chosen a different environment variable name.
37+
** Replace `<build_config_name>` with the build configuration name you identified.
38+
--
39+
+
2940
When the build starts, the following message is displayed:
3041
+
3142
----
@@ -38,12 +49,12 @@ When the build starts, the following message is displayed:
3849
. Open the *Topology* view in the *Developer* perspective for your project in the OpenShift web console.
3950
. Select the plugin registry icon to open the *plugin-registry* details pane.
4051
. In the *Pods* section of the *plugin-registry* details pane, select *View logs* for the
41-
`plugin-registry-&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;-&#0035;&#0035;&#0035;&#0035;` pod.
42-
// Can't use multiple hashtags characters in Asciidoc: Asciidoctor interprets them as special characters.
43-
+
44-
image::self-service-plugin-registry.png[Developer perspective]
45-
+
46-
(1) Plug-in registry
52+
new build pod.
53+
The format for the pod name is `<build_config_name>-<build_number>-build`.
54+
// +
55+
// image::self-service-plugin-registry.png[Developer perspective]
56+
// +
57+
// (1) Plug-in registry
4758
. Click the *terminal* tab and log in to the container.
4859
. In the terminal, run `ls` to view the TAR files in the plugin registry.
4960
. Verify that the new TAR files have been uploaded.

0 commit comments

Comments
 (0)