From c8ae7ceda8fc67bf888ee5a507ba23eadaa9b552 Mon Sep 17 00:00:00 2001 From: Aine Riordan Date: Wed, 7 May 2025 12:58:47 +0100 Subject: [PATCH] AAP-45308 Add sync frequency section to portal install doc --- ...bly-self-service-accessing-deployment.adoc | 1 + ...mbly-self-service-create-ocp-registry.adoc | 1 + ...bly-self-service-deregister-templates.adoc | 2 +- ...-self-service-create-ocp-auth-secrets.adoc | 2 +- ...elf-service-install-helm-from-catalog.adoc | 9 ++--- .../proc-self-service-ocp-project-setup.adoc | 7 ++-- ...roc-self-service-setup-registry-image.adoc | 7 ++-- .../proc-self-service-sync-frequency.adoc | 34 +++++++++++++++++++ 8 files changed, 53 insertions(+), 10 deletions(-) create mode 100644 downstream/modules/devtools/proc-self-service-sync-frequency.adoc diff --git a/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc b/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc index d0ffc1c95..3eb3b5f8d 100644 --- a/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-accessing-deployment.adoc @@ -18,6 +18,7 @@ endif::[] include::devtools/proc-self-service-add-deployment-url-oauth-app.adoc[leveloffset=+1] include::devtools/proc-self-service-sign-in.adoc[leveloffset=+1] +include::devtools/proc-self-service-sync-frequency.adoc[leveloffset=+1] ifdef::parent-context-of-self-service-accessing-deployment[:context: {parent-context-of-self-service-accessing-deployment}] ifndef::parent-context-of-self-service-accessing-deployment[:!context:] diff --git a/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc b/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc index 3db0a2ce6..904a10d03 100644 --- a/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-create-ocp-registry.adoc @@ -17,6 +17,7 @@ endif::[] :context: self-service-create-ocp-registry include::devtools/proc-self-service-download-tar.adoc[leveloffset=+1] +include::devtools/proc-self-service-setup-registry-image.adoc[leveloffset=+1] ifdef::parent-context-of-self-service-create-ocp-registry[:context: {parent-context-of-self-service-create-ocp-registry}] ifndef::parent-context-of-self-service-create-ocp-registry[:!context:] diff --git a/downstream/assemblies/devtools/assembly-self-service-deregister-templates.adoc b/downstream/assemblies/devtools/assembly-self-service-deregister-templates.adoc index 96f4f3676..9ff29c3a7 100644 --- a/downstream/assemblies/devtools/assembly-self-service-deregister-templates.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-deregister-templates.adoc @@ -1,7 +1,7 @@ ifdef::context[:parent-context: {context}] [id="self-service-deregister-templates{context}"] -= Working with RBAC += Deregistering templates :context: self-service-deregister-templates diff --git a/downstream/modules/devtools/proc-self-service-create-ocp-auth-secrets.adoc b/downstream/modules/devtools/proc-self-service-create-ocp-auth-secrets.adoc index e7db84176..da1800c94 100644 --- a/downstream/modules/devtools/proc-self-service-create-ocp-auth-secrets.adoc +++ b/downstream/modules/devtools/proc-self-service-create-ocp-auth-secrets.adoc @@ -4,7 +4,7 @@ = Creating {PlatformNameShort} authentication secrets . Log in to your {OCPShort} instance. -. Open your OpenShift project for {SelfServiceShort}. +. Open your OpenShift project for {SelfServiceShort} in the *Administrator* view. . Click *Secrets* in the side pane. . Click *Create* to open the form for creating a new secret. . Select the *Key/Value* option. diff --git a/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc b/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc index ccfbd1012..2a480ec11 100644 --- a/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc +++ b/downstream/modules/devtools/proc-self-service-install-helm-from-catalog.adoc @@ -9,16 +9,17 @@ . You have set up secrets for {PlatformNameShort} authentication and SCM authentication. .Procedure -. In a browser, navigate to your OpenShift project for {SelfServiceShort}. +. In a browser, navigate to your OpenShift project for {SelfServiceShort} that you created earlier. +. Select the *Developer* view. . Click the *Helm* option in the OpenShift sidebar. . In the *Helm* page, click *Create* and select *Helm Release*. . Search for `AAP` in the Helm Charts filter, and select the `AAP Technical Preview: Self-service automation` chart. . In the modal dialog on the chart page, click *Create*. . Select the *YAML view* in the *Create Helm Release* page. -. Locate the `clusterRouteBase` key in the YAML file and replace the placeholder value with the base URL of your OpenShift instance. +. Locate the `clusterRouterBase` key in the YAML file and replace the placeholder value with the base URL of your OpenShift instance. + -The base URL is the URL portion of your OpenShift URL that follows `\https://console.openshift.console`, +The base URL is the URL portion of your OpenShift URL that follows `\https://console-openshift-console`, for example `apps.example.com`: + ---- @@ -29,6 +30,6 @@ for example `apps.example.com`: . The Helm chart is set up for the Default {PlatformNameShort} organization. + To update the Helm chart to use a different organization, -update the value for the `catalog.providers.rhaap.development.orgs` key from `default` to your {PlatformNameShort} organization name. +update the value for the `catalog.providers.rhaap.orgs` key from `Default` to your {PlatformNameShort} organization name. . Click *Create* to launch the deployment. diff --git a/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc b/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc index 16a6fa8d2..21ac712cf 100644 --- a/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc +++ b/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc @@ -27,10 +27,13 @@ You have access to 22 projects, the list has been suppressed. You can list all p Using project "default". ---- -. Create a new project: +. Create a new project. ++ +Lowercase alphanumeric characters (`a-z`, `0-9`) and the hyphen character (`-`) are permitted for project names. +The underscore (`_`) character is not permitted. + ---- -$ oc new-project +$ oc new-project ---- Example output: + diff --git a/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc b/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc index b7bd61c8c..a74b3fdd1 100644 --- a/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc +++ b/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc @@ -13,7 +13,7 @@ Set up a registry in your OpenShift cluster to host the plug-ins and make them a ---- $ oc project ---- -. Run the following commands to create a plug-in registry build in in your OpenShift project. +. Run the following commands to create a plugin registry build in in your OpenShift project. + ---- $ oc new-build httpd --name=plugin-registry --binary @@ -26,7 +26,10 @@ $ oc new-app --image-stream=plugin-registry Verify that the plugin-registry was deployed successfully: . Open the *Topology* view in the *Developer* perspective for your project in the OpenShift web console. -. Click the plug-in registry to view the details pane. +. Select the plugin registry icon to open the *plugin-registry* details pane. +. In the *Pods* section of the *plugin-registry* details pane, click *View logs* for the +`plugin-registry-#########-####` pod. +// Can't use multiple hashtags characters in Asciidoc: Asciidoctor interprets them as special characters. + image::self-service-plugin-registry.png[Developer perspective] + diff --git a/downstream/modules/devtools/proc-self-service-sync-frequency.adoc b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc new file mode 100644 index 000000000..92cc0eec0 --- /dev/null +++ b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc @@ -0,0 +1,34 @@ +:_mod-docs-content-type: PROCEDURE + +[id="self-service-sync-frequency_{context}"] += Adjusting synchronization frequency between {PlatformNameShort} and {SelfServiceShort} + +The Helm chart defines how frequently users, +teams and organization configuration information is synchronized from {PlatformNameShort} to {SelfServiceShort}. + +The frequency is set by the `catalog.providers.rhaap.schedule.frequency` key. +By default, the synchronization occurs hourly. + +* To adjust the synchronization frequency, edit the value for the `catalog.providers.rhaap.schedule.frequency` key in the Helm chart. ++ +---- + catalog: + ... + providers: + rhaap: + '{{- include "catalog.providers.env" . }}': + schedule: + frequency: {minutes: 60} + timeout: {seconds: 30} + +---- + +[NOTE] +==== +Increasing the synchronization frequency generates extra traffic. + +Bear this in mind when deciding the frequency, particularly if you have a large number of users. +==== + +// To run a synchronization outside of the scheduled frequency, restart your self-service technical preview instance. +