generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
238 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
[id='customizing-telemetry-destination_{context}'] | ||
= Customizing telemetry destination | ||
|
||
|
||
The `analytics-provider-segment` plugin sends the collected telemetry data to Red Hat by default. However, you can configure a new destination that receives telemetry data based on your needs. For configuration, you need a unique segment key that points to the destination. | ||
|
||
|
||
.Prerequisites | ||
* You have an administrator role in the {product-short}. | ||
* You have installed the `janus-idp | ||
-backstage-plugin-analytics-provider-segment` plugin in {product-short}. For more information, see link:{LinkAdminGuide}#rhdh-installing-dynamic-plugins[Dynamic plugin installation]. | ||
|
||
.Procedure | ||
|
||
. Configure a new telemetry destination by using one of the following options: | ||
+ | ||
.Using Helm Chart | ||
|
||
* Add the following YAML code in your Helm configuration file: | ||
+ | ||
[source,yaml] | ||
---- | ||
gupstream: | ||
backstage: | ||
extraEnvVars: | ||
- name: SEGMENT_WRITE_KEY | ||
value: <segment_key> | ||
---- | ||
+ | ||
where:: | ||
`<segment_key>` denotes a unique identifier for destination configuration. | ||
|
||
+ | ||
.Using Operator | ||
|
||
* Add the following YAML code in your {product-very-short} ConfigMap file: | ||
+ | ||
[source,yaml] | ||
---- | ||
extraEnvs: | ||
envs: | ||
- name: SEGMENT_WRITE_KEY | ||
value: <segment_key> | ||
---- | ||
+ | ||
where:: | ||
`<segment_key>` denotes a unique identifier for destination configuration. | ||
|
||
. Save the configuration changes. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[id='disabling-telemetry-in-CI-environment_{context}'] | ||
= Disabling Telemetry in a CI environment | ||
|
||
You can disable telemetry data collection while running {product-very-short} in a Continuous Integration (CI) environment. | ||
|
||
|
||
.Prerequisites | ||
* You have an administrator role in the {product-short}. | ||
* You have installed the `janus-idp | ||
-backstage-plugin-analytics-provider-segment` plugin in {product-short}. For more information, see link:{LinkAdminGuide}#rhdh-installing-dynamic-plugins[Dynamic plugin installation]. | ||
|
||
.Procedure | ||
|
||
. Set the value of the `SEGMENT_TEST_MODE` environment variable to `true` in your CI configuration. | ||
. Save the configuration changes. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
[id='disabling-telemetry-in-local-environment_{context}'] | ||
= Disabling Telemetry in a local environment | ||
|
||
By default, the `analytics-provider-segment` plugin is disabled when you run the {product-short} application locally without using the `dynamic-plugins.default.yaml` file. However, if you run the application using the `dynamic-plugins.default.yaml` file, you can disable telemetry data collection based on your needs. | ||
|
||
.Prerequisites | ||
* You have an administrator role in the {product-short}. | ||
* You have installed the `janus-idp | ||
-backstage-plugin-analytics-provider-segment` plugin in {product-short}. For more information, see link:{LinkAdminGuide}#rhdh-installing-dynamic-plugins[Dynamic plugin installation]. | ||
|
||
.Procedure | ||
|
||
. Add the following YAML code in your `dynamic-plugins.default.yaml` configuration file: | ||
+ | ||
[source,yaml] | ||
---- | ||
dynamicPlugins: | ||
plugins: | ||
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' | ||
disabled: true | ||
---- | ||
|
||
. Save the configuration changes. | ||
|
||
. Delete the `dynamic-plugins-root/janus-idp-backstage-plugin-analytics-provider-segment` plugin directory. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
[id='disabling-telemetry-data-collection_{context}'] | ||
= Disabling Telemetry data collection in {product-very-short} | ||
|
||
To disable telemetry data collection, you must configure the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator. | ||
|
||
[NOTE] | ||
==== | ||
If the `analytics-provider-segment` plugin is already present in your Helm configuration file or ConfigMap file, set the value of the `plugins.disabled` parameter to `true` to quickly stop telemetry data collection. | ||
==== | ||
|
||
.Prerequisites | ||
* You have an administrator role in the {product-short}. | ||
* You have installed the `janus-idp | ||
-backstage-plugin-analytics-provider-segment` plugin in {product-short}. For more information, see link:{LinkAdminGuide}#rhdh-installing-dynamic-plugins[Dynamic plugin installation]. | ||
|
||
.Procedure | ||
|
||
. Configure the `analytics-provider-segment` plugin by using one of the following options: | ||
+ | ||
.Using Helm Chart | ||
|
||
* Add the following YAML code in your Helm configuration file: | ||
+ | ||
[source,yaml] | ||
---- | ||
global: | ||
dynamic: | ||
plugins: | ||
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' | ||
disabled: true | ||
---- | ||
|
||
+ | ||
.Using Operator | ||
|
||
.. Perform one of the following steps: | ||
+ | ||
* If you have created the `dynamic-plugins-rhdh` ConfigMap file, add the `analytics-provider-segment` plugin to the list of plugins and set its `plugins.disabled` parameter to `true`. | ||
+ | ||
* If you have not created the ConfigMap file, create it with the following YAML code: | ||
+ | ||
[source,yaml] | ||
---- | ||
kind: ConfigMap | ||
apiVersion: v1 | ||
metadata: | ||
name: dynamic-plugins-rhdh | ||
data: | ||
dynamic-plugins.yaml: | | ||
includes: | ||
- dynamic-plugins.default.yaml | ||
plugins: | ||
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' | ||
disabled: true | ||
---- | ||
|
||
.. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: | ||
+ | ||
[source,yaml] | ||
---- | ||
spec: | ||
application: | ||
dynamicPluginsConfigMapName: dynamic-plugins-rhdh | ||
---- | ||
|
||
. Save the configuration changes. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
[id='enabling-telemetry-data-collection_{context}'] | ||
= Enabling Telemetry data collection in {product-very-short} | ||
|
||
To enable telemetry data collection, you must configure the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator. | ||
|
||
[NOTE] | ||
==== | ||
If the `analytics-provider-segment` plugin is already present in your Helm configuration file or ConfigMap file, set the value of the `plugins.disabled` parameter to `false` to quickly start telemetry data collection. | ||
==== | ||
|
||
.Prerequisites | ||
* You have an administrator role in the {product-short}. | ||
* You have installed the `janus-idp | ||
-backstage-plugin-analytics-provider-segment` plugin in {product-short}. For more information, see link:{LinkAdminGuide}#rhdh-installing-dynamic-plugins[Dynamic plugin installation]. | ||
|
||
.Procedure | ||
|
||
. Configure the `analytics-provider-segment` plugin by using one of the following options: | ||
+ | ||
.Using Helm Chart | ||
|
||
* Add the following YAML code in your Helm configuration file: | ||
+ | ||
[source,yaml] | ||
---- | ||
global: | ||
dynamic: | ||
plugins: | ||
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' | ||
disabled: false | ||
---- | ||
|
||
+ | ||
.Using Operator | ||
|
||
.. Perform one of the following steps: | ||
+ | ||
* If you have created the `dynamic-plugins-rhdh` ConfigMap file, add the `analytics-provider-segment` plugin to the list of plugins and set its `plugins.disabled` parameter to `false`. | ||
+ | ||
* If you have not created the ConfigMap file, create it with the following YAML code: | ||
+ | ||
[source,yaml] | ||
---- | ||
kind: ConfigMap | ||
apiVersion: v1 | ||
metadata: | ||
name: dynamic-plugins-rhdh | ||
data: | ||
dynamic-plugins.yaml: | | ||
includes: | ||
- dynamic-plugins.default.yaml | ||
plugins: | ||
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' | ||
disabled: false | ||
---- | ||
|
||
.. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: | ||
+ | ||
[source,yaml] | ||
---- | ||
spec: | ||
application: | ||
dynamicPluginsConfigMapName: dynamic-plugins-rhdh | ||
---- | ||
|
||
. Save the configuration changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters