8000 2.5 Self-service: Rename; add proc to disable telemetry (#3445) by ariordan-redhat · Pull Request #3465 · ansible/aap-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

2.5 Self-service: Rename; add proc to disable telemetry (#3445) #3465

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 14, 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 @@ -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:]
Expand Down
14 changes: 7 additions & 7 deletions downstream/attributes/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions downstream/modules/devtools/con-self-service-telemetry-data.adoc
Original file line number Diff line number Diff line change
@@ -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.

Original file line number Diff line number Diff line change
Expand Up @@ -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}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<installation-name>-backstage`,
for example `<my-aap-self-service-technical-preview-backstage>`.
for example `<my-aap-self-service-tech-preview-backstage>`.
+
While it is deploying, the icon is light blue.
The color changes to dark blue when deployment is complete.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Using project "default".
. Create a new project. Use a unique project name.
+
----
$ oc new-project <self-service-technical-preview-project-name>
$ oc new-project <self-service-tech-preview-project-name>
----
+
Lowercase alphanumeric characters (`a-z`, `0-9`) and the hyphen character (`-`) are permitted for project names.
Expand All @@ -47,6 +47,6 @@ Now using project "my-project" on server "https://openshift.example.com:6443".
. Open your new project:
+
----
$ oc project <self-service-technical-preview-project-name>
$ oc project <self-service-tech-preview-project-name>
----

Original file line number Diff line number Diff line change
Expand Up @@ -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 <AAP-self-service-technical-preview_project_name>
$ oc project <AAP-self-service-tech-preview-project-name>
----
. Run the following commands to create a plugin registry build in in your OpenShift project.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Original file line number Diff line number Diff line change
@@ -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 `<installation-name>-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.

Original file line number Diff line number Diff line change
Expand Up @@ -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 `<installation-name>-backstage-app-config` ConfigMap, for example `my-aap-self-service-technical-preview-backstage-app-config`.
. Select the `<installation-name>-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 `<installation-name>-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.

Original file line number Diff line number Diff line change
Expand Up @@ -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 `<installation-name>-backstage`,
for example `<my-aap-self-service-technical-preview-backstage>`.
for example `<my-aap-self-service-tech-preview-backstage>`.
. Click the icon representing the deployment.
. The *Details* pane for the deployment opens.
. Select the *Resources* tab.
Expand Down
6 changes: 3 additions & 3 deletions downstream/titles/self-service-install/docinfo.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<title>Installing Ansible Automation Platform self-service technical preview</title>
<title>Installing Ansible Automation Platform self-service technology preview</title>
<productname>Red Hat Ansible Automation Platform</productname>
<productnumber>2.5</productnumber>
<subtitle>Install and configure Ansible Automation Platform self-service technical preview</subtitle>
<subtitle>Install and configure Ansible Automation Platform self-service technology preview</subtitle>
<abstract>
<para>This guide describes how to install and configure Ansible Automation Platform self-service technical preview so that users can run automation.</para>
<para>This guide describes how to install and configure Ansible Automation Platform self-service technology preview so that users can run automation.</para>
</abstract>
<authorgroup>
<orgname>Red Hat Customer Content Services </orgname>
Expand Down
2 changes: 1 addition & 1 deletion downstream/titles/self-service-install/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
0