8000 AAP-45308 Add sync frequency section to portal install doc by ariordan-redhat · Pull Request #3418 · ansible/aap-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

AAP-45308 Add sync frequency section to portal install doc #3418

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 7, 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 @@ -18,6 +18,7 @@ endif::[]

include::devtools/proc-self-service-add-deployment-url-oauth-app.adoc[leveloffset=+1]
include::devtools/p 10000 roc-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:]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:]
Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
+
----
Expand All @@ -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.

Original file line number Diff line number Diff line change
Expand Up @@ -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 <AAP-self-service-technical-preview_project_name>
$ oc new-project <self-service-technical-preview-project-name>
----
Example output:
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Set up a registry in your OpenShift cluster to host the plug-ins and make them a
----
$ oc project <AAP-self-service-technical-preview_project_name>
----
. 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
Expand All @@ -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-&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;&#0035;-&#0035;&#0035;&#0035;&#0035;` pod.
// Can't use multiple hashtags characters in Asciidoc: Asciidoctor interprets them as special characters.
+
image::self-service-plugin-registry.png[Developer perspective]
+
Expand Down
34 changes: 34 additions & 0 deletions downstream/modules/devtools/proc-self-service-sync-frequency.adoc
Original file line number Diff line number Diff line change
@@ -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.

0