From f20320feafee91a571fba8781e4ea5b5a97a062d Mon Sep 17 00:00:00 2001 From: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com> Date: Wed, 14 May 2025 09:46:40 +0100 Subject: [PATCH] 2.5 Self-service: Rename; add proc to disable telemetry (#3445) --- ...sembly-self-service-telemetry-capture.adoc | 15 ++---- downstream/attributes/attributes.adoc | 14 +++--- .../con-self-service-telemetry-data.adoc | 14 ++++++ ...-service-add-deployment-url-oauth-app.adoc | 4 +- .../proc-self-service-install-verify.adoc | 2 +- .../proc-self-service-ocp-project-setup.adoc | 4 +- ...roc-self-service-setup-registry-image.adoc | 2 +- .../proc-self-service-sync-frequency.adoc | 2 +- .../proc-self-service-telemetry-disable.adoc | 48 +++++++++++++++++++ .../proc-self-service-view-configmap.adoc | 4 +- ...roc-self-service-view-deployment-logs.adoc | 2 +- .../titles/self-service-install/docinfo.xml | 6 +-- .../titles/self-service-install/master.adoc | 2 +- 13 files changed, 86 insertions(+), 33 deletions(-) create mode 100644 downstream/modules/devtools/con-self-service-telemetry-data.adoc create mode 100644 downstream/modules/devtools/proc-self-service-telemetry-disable.adoc diff --git a/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc b/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc index 51519d245..24451c290 100644 --- a/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc +++ b/downstream/assemblies/devtools/assembly-self-service-telemetry-capture.adoc @@ -16,20 +16,11 @@ endif::[] :context: self-service-telemetry -The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with self-service technical preview. This feature is enabled by default. +The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with {SelfService}. This feature is enabled by default. -Red Hat collects and analyses the following data: +include::devtools/con-self-service-telemetry-data.adoc[leveloffset=+1] -* Events of page visits and clicks on links or buttons. -* System-related information, for example, locale, timezone, user agent including browser and OS details. -* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters. -* Anonymized IP addresses, recorded as 0.0.0.0. -* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the RHDH application. -* Feedback and sentiment provided in the feedback form. - -// With Red Hat Developer Hub, you can disable or customize the telemetry data collection feature. -// For more information, refer to the Telemetry data collection guide in the Red Hat Developer Hub documentation. -// include::devtools/zzz[leveloffset=+1] +include::devtools/proc-self-service-telemetry-disable.adoc[leveloffset=+1] ifdef::parent-context-of-self-service-telemetry[:context: {parent-context-of-self-service-telemetry}] ifndef::parent-context-of-self-service-telemetry[:!context:] diff --git a/downstream/attributes/attributes.adoc b/downstream/attributes/attributes.adoc index e5a09e9e5..cb07c50ba 100644 --- a/downstream/attributes/attributes.adoc +++ b/downstream/attributes/attributes.adoc @@ -126,9 +126,9 @@ :RHDH: Red Hat Developer Hub :RHDHVers: 1.4 :RHDHShort: RHDH -:SelfService: Ansible Automation Platform self-service technical preview -:SelfServiceShort: self-service technical preview -:SelfServiceShortStart: Self-service technical preview +:SelfService: Ansible Automation Platform self-service technology preview +:SelfServiceShort: self-service technology preview +:SelfServiceShortStart: Self-service technology preview :Builder: Ansible Builder :Navigator: automation content navigator :NavigatorStart: Automation content navigator @@ -312,13 +312,13 @@ :LinkTroubleshootingAAP: {URLTroubleshootingAAP}[{TitleTroubleshootingAAP}] // // titles/self-service-install -:TitleSelfServiceInstall: Installing Ansible Automation Platform self-service technical preview -:URLSelfServiceInstall: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/installing_ansible_automation_platform_self-service_technical_preview +:TitleSelfServiceInstall: Installing Ansible Automation Platform self-service technology preview +:URLSelfServiceInstall: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/installing_ansible_automation_platform_self-service_technology_preview :LinkSelfServiceInstall: {URLSelfServiceInstall}[{TitleSelfServiceInstall}] // // titles/self-service-using -:TitleSelfServiceUsing: Using Ansible Automation Platform self-service technical preview -:URLSelfServiceUsing: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/using_ansible_automation_platform_self-service_technical_preview +:TitleSelfServiceUsing: Using Ansible Automation Platform self-service technology preview +:URLSelfServiceUsing: {BaseURL}/red_hat_ansible_automation_platform/{PlatformVers}/html/using_ansible_automation_platform_self-service_technology_preview :LinkSelfServiceUsing: {URLSelfServiceUsing}[{TitleSelfServiceUsing}] // // titles/aap-plugin-rhdh-install diff --git a/downstream/modules/devtools/con-self-service-telemetry-data.adoc b/downstream/modules/devtools/con-self-service-telemetry-data.adoc new file mode 100644 index 000000000..f75c9bfd1 --- /dev/null +++ b/downstream/modules/devtools/con-self-service-telemetry-data.adoc @@ -0,0 +1,14 @@ +:_mod-docs-content-type: CONCEPT + +[id="self-service-telemetry-data_{context}"] += Telemetry data collected by Red Hat + +Red Hat collects and analyses the following data: + +* Events of page visits and clicks on links or buttons. +* System-related information, for example, locale, timezone, user agent including browser and OS details. +* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters. +* Anonymized IP addresses, recorded as `0.0.0.0`. +* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the RHDH application. +// * Feedback and sentiment provided in the feedback form. + diff --git a/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc b/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc index 196175da0..672e33553 100644 --- a/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc +++ b/downstream/modules/devtools/proc-self-service-add-deployment-url-oauth-app.adoc @@ -14,8 +14,8 @@ You must update this value using the URL from the deployed application so that y .. Copy the URL. .. To determine the `Redirect URI` value, append `/api/auth/rhaap/handler/frame` to the end of the deployment URL. + -For example, if the URL for the deployment is `\https://my-aap-self-service-technical-preview-backstage-myproject.mycluster.com`, -then the `Redirect URI` value is `\https://my-aap-self-service-technical-preview-backstage-myproject.mycluster.com/api/auth/rhaap/handler/frame`. +For example, if the URL for the deployment is `\https://my-aap-self-service-tech-preview-backstage-myproject.mycluster.com`, +then the `Redirect URI` value is `\https://my-aap-self-service-tech-preview-backstage-myproject.mycluster.com/api/auth/rhaap/handler/frame`. . Update the `Redirect URIs` field in the OAuth application in {PlatformNameShort}: .. In a browser, open your instance of {PlatformNameShort}. .. Navigate to {MenuAMAdminOauthApps}. diff --git a/downstream/modules/devtools/proc-self-service-install-verify.adoc b/downstream/modules/devtools/proc-self-service-install-verify.adoc index 99413d296..1e6092562 100644 --- a/downstream/modules/devtools/proc-self-service-install-verify.adoc +++ b/downstream/modules/devtools/proc-self-service-install-verify.adoc @@ -9,7 +9,7 @@ navigate to the *Topology* view for the namespace where you deployed the Helm ch + The deployment appears: the label on the icon is `D`. The name of the deployment is `-backstage`, -for example ``. +for example ``. + While it is deploying, the icon is light blue. The color changes to dark blue when deployment is complete. 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 a8c5fbc75..21679cef2 100644 --- a/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc +++ b/downstream/modules/devtools/proc-self-service-ocp-project-setup.adoc @@ -30,7 +30,7 @@ Using project "default". . Create a new project. Use a unique project name. + ---- -$ oc new-project +$ oc new-project ---- + Lowercase alphanumeric characters (`a-z`, `0-9`) and the hyphen character (`-`) are permitted for project names. @@ -47,6 +47,6 @@ Now using project "my-project" on server "https://openshift.example.com:6443". . Open your new project: + ---- -$ oc project +$ oc project ---- 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 a7dfe3dac..8b2d0f880 100644 --- a/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc +++ b/downstream/modules/devtools/proc-self-service-setup-registry-image.adoc @@ -11,7 +11,7 @@ Set up a registry in your OpenShift cluster to host the plug-ins and make them a . Open your OpenShift project for {SelfServiceShort}. + ---- -$ oc project +$ oc project ---- . Run the following commands to create a plugin registry build in in your OpenShift project. + diff --git a/downstream/modules/devtools/proc-self-service-sync-frequency.adoc b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc index 92cc0eec0..a6d01ddf9 100644 --- a/downstream/modules/devtools/proc-self-service-sync-frequency.adoc +++ b/downstream/modules/devtools/proc-self-service-sync-frequency.adoc @@ -30,5 +30,5 @@ 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. +// To run a synchronization outside of the scheduled frequency, restart your {SelfServiceShort} instance. diff --git a/downstream/modules/devtools/proc-self-service-telemetry-disable.adoc b/downstream/modules/devtools/proc-self-service-telemetry-disable.adoc new file mode 100644 index 000000000..792accd33 --- /dev/null +++ b/downstream/modules/devtools/proc-self-service-telemetry-disable.adoc @@ -0,0 +1,48 @@ +:_newdoc-version: 2.18.3 +:_template-generated: 2025-05-05 +:_mod-docs-content-type: PROCEDURE + +[id="self-service-telemetry-disable_{context}"] += Disabling telemetry data collection + +You can disable and enable the telemetry data collection feature for {SelfServiceShort} in the ConfigMap for your {OCPShort} project. + +. Log in to the {OCPShort} console and open the project for {SelfServiceShort} in the *Developer* perspective. +. Open the ConfigMap: +.. Select the *Topology* view. +.. Select menu:Workloads[Config Maps]. +.. Select the `-backstage-app-config` ConfigMap, for example `my-aap-self-service-tech-preview-backstage-app-config`. +.. Click the ConfigMap to open its *Details* page. +.. Select the *YAML* tab. +. Update the ConfigMap: +** To disable telemetry data collection, +set `disabled` to `true` for `package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment` in the `global.dynamic.plugins` section. ++ +---- +global: + ... + dynamic: + ... + plugins: + ... + package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment + - disabled: true + +---- +** To enable telemetry data collection, +set `disabled` to `false` for `package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment` in the `global.dynamic.plugins` section. ++ +---- +global: + ... + dynamic: + ... + plugins: + ... + package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment + - disabled: false + +---- +. Click btn:[Save] to apply the changes to the ConfigMap. +. Restart the pod so that your deployment uses the latest configuration. + diff --git a/downstream/modules/devtools/proc-self-service-view-configmap.adoc b/downstream/modules/devtools/proc-self-service-view-configmap.adoc index d5d161e7f..88acc2491 100644 --- a/downstream/modules/devtools/proc-self-service-view-configmap.adoc +++ b/downstream/modules/devtools/proc-self-service-view-configmap.adoc @@ -6,9 +6,9 @@ . In a browser, open the project for your {SelfServiceShort} in your OpenShift instance. . In the *Developer* view, select *ConfigMaps* in the navigation pane. -. Select the `-backstage-app-config` ConfigMap, for example `my-aap-self-service-technical-preview-backstage-app-config`. +. Select the `-backstage-app-config` ConfigMap, for example `my-aap-self-service-tech-preview-backstage-app-config`. . Verify that the ConfigMap conforms with the values you updated in the Helm chart. . Return to the list of ConfigMaps and select the `-dynamic-plugins` ConfigMap, -for example `my-aap-self-service-technical-preview-dynamic-plugins`. +for example `my-aap-self-service-tech-preview-dynamic-plugins`. . Verify that the ConfigMap conforms with the expected plugin values. diff --git a/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc b/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc index e023fb93e..0b82b79dd 100644 --- a/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc +++ b/downstream/modules/devtools/proc-self-service-view-deployment-logs.adoc @@ -10,7 +10,7 @@ navigate to the *Topology* view for the namespace where you deployed the Helm ch . The deployment appears: the label on the icon is `D`. + The name of the deployment is `-backstage`, -for example ``. +for example ``. . Click the icon representing the deployment. . The *Details* pane for the deployment opens. . Select the *Resources* tab. diff --git a/downstream/titles/self-service-install/docinfo.xml b/downstream/titles/self-service-install/docinfo.xml index 5b8a745e9..6eae8aa3e 100644 --- a/downstream/titles/self-service-install/docinfo.xml +++ b/downstream/titles/self-service-install/docinfo.xml @@ -1,9 +1,9 @@ -Installing Ansible Automation Platform self-service technical preview +Installing Ansible Automation Platform self-service technology preview Red Hat Ansible Automation Platform 2.5 -Install and configure Ansible Automation Platform self-service technical preview +Install and configure Ansible Automation Platform self-service technology preview - This guide describes how to install and configure Ansible Automation Platform self-service technical preview so that users can run automation. + This guide describes how to install and configure Ansible Automation Platform self-service technology preview so that users can run automation. Red Hat Customer Content Services diff --git a/downstream/titles/self-service-install/master.adoc b/downstream/titles/self-service-install/master.adoc index 03918dc41..4e0de6ce5 100644 --- a/downstream/titles/self-service-install/master.adoc +++ b/downstream/titles/self-service-install/master.adoc @@ -7,7 +7,7 @@ include::attributes/attributes.adoc[] // Book Title -= Installing Ansible Automation Platform self-service technical preview += Installing Ansible Automation Platform self-service technology preview Thank you for your interest in {PlatformName}. {PlatformNameShort} is a commercial offering that helps teams manage complex multi-tier deployments by adding control, knowledge, and delegation to Ansible-powered environments.