Skip to content

Commit d4e20f4

Browse files
committed
OCPBUGS-60988: Added update secret step to insights-operator-new-pull-secret
1 parent 419fa45 commit d4e20f4

7 files changed

+57
-45
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -821,8 +821,8 @@ Topics:
821821
File: about-remote-health-monitoring
822822
- Name: Showing data collected by remote health monitoring
823823
File: showing-data-collected-by-remote-health-monitoring
824-
- Name: Opting out of remote health reporting
825-
File: opting-out-of-remote-health-reporting
824+
- Name: Remote health reporting
825+
File: remote-health-reporting
826826
- Name: Enabling remote health reporting
827827
File: enabling-remote-health-reporting
828828
- Name: Using Insights to identify issues with your cluster
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: CONCEPT
2+
[id="enabling-remote-health-reporting"]
3+
= Enabling remote health reporting
4+
5+
If you or your organization have disabled remote health reporting, you can enable this feature again. You can see that remote health reporting is disabled from the message "Insights not available" in the *Status* tile on the {product-title} web console *Overview* page.
6+
7+
To enable remote health reporting, you must change the global cluster pull secret with a new authorization token.
8+
9+
[NOTE]
10+
====
11+
Enabling remote health reporting enables both Insights Operator and Telemetry.
12+
====
13+

modules/insights-operator-new-pull-secret-disabled.adoc

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="insights-operator-new-pull-secret_{context}"]
7-
= Modifying the global cluster pull secret to disable remote health reporting
7+
= Changing the global cluster pull secret to disable remote health reporting
88

9-
You can modify your existing global cluster pull secret to disable remote health reporting. This disables both Telemetry and the Insights Operator.
9+
You can change your existing global cluster pull secret to disable remote health reporting. This configuration disables both Telemetry and the Insights Operator.
1010

1111
.Prerequisites
1212

@@ -19,16 +19,14 @@ endif::openshift-rosa,openshift-dedicated[]
1919

2020
.Procedure
2121

22-
. Download the global cluster pull secret to your local file system.
22+
. Download the global cluster pull secret to your local file system:
2323
+
2424
[source,terminal]
2525
----
2626
$ oc extract secret/pull-secret -n openshift-config --to=.
2727
----
2828

29-
. In a text editor, edit the `.dockerconfigjson` file that was downloaded.
30-
31-
. Remove the `cloud.openshift.com` JSON entry, for example:
29+
. In a text editor, edit the `.dockerconfigjson` file that you downloaded by removing the `cloud.openshift.com` JSON entry:
3230
+
3331
[source,json]
3432
----
@@ -37,4 +35,13 @@ $ oc extract secret/pull-secret -n openshift-config --to=.
3735

3836
. Save the file.
3937

40-
You can now update your cluster to use this modified pull secret.
38+
. Update the secret in your cluster by running the following command:
39+
+
40+
[source,terminal]
41+
----
42+
$ oc set data secret/pull-secret -n openshift-config \
43+
--from-file=.dockerconfigjson=pull-secret
44+
----
45+
+
46+
You might need to wait several minutes for the secret to update in your cluster.
47+

modules/insights-operator-new-pull-secret-enable.adoc

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="insights-operator-new-pull-secret-enable_{context}"]
7-
= Modifying your global cluster pull secret to enable remote health reporting
7+
= Changing your global cluster pull secret to enable remote health reporting
88

9-
You can modify your existing global cluster pull secret to enable remote health reporting. If you have previously disabled remote health monitoring, you must first download a new pull secret with your `console.openshift.com` access token from {cluster-manager-first}.
9+
You can change your existing global cluster pull secret to enable remote health reporting. If you have disabled remote health monitoring, you must first download a new pull secret with your `console.openshift.com` access token from {cluster-manager-first}.
1010

1111
.Prerequisites
1212

@@ -16,6 +16,7 @@ You can modify your existing global cluster pull secret to enable remote health
1616
.Procedure
1717

1818
. Navigate to link:https://console.redhat.com/openshift/downloads[https://console.redhat.com/openshift/downloads].
19+
1920
. From *Tokens* -> *Pull Secret*, click *Download*.
2021
+
2122
The file `pull-secret.txt` containing your `cloud.openshift.com` access token in JSON format downloads:
@@ -40,26 +41,32 @@ $ oc get secret/pull-secret -n openshift-config \
4041
--template='{{index .data ".dockerconfigjson" | base64decode}}' \
4142
> pull-secret
4243
----
44+
4345
. Make a backup copy of your pull secret.
4446
+
4547
[source,terminal]
4648
----
4749
$ cp pull-secret pull-secret-backup
4850
----
51+
4952
. Open the `pull-secret` file in a text editor.
53+
5054
. Append the `cloud.openshift.com` JSON entry from `pull-secret.txt` into `auths`.
55+
5156
. Save the file.
52-
. Update the secret in your cluster.
57+
58+
. Update the secret in your cluster by running the following command:
5359
+
5460
[source,terminal]
5561
----
5662
$ oc set data secret/pull-secret -n openshift-config \
5763
--from-file=.dockerconfigjson=pull-secret
5864
----
59-
60-
It may take several minutes for the secret to update and your cluster to begin reporting.
65+
+
66+
You might need to wait several minutes for the secret to update and your cluster to begin reporting.
6167
6268
.Verification
6369
6470
. Navigate to the {product-title} Web Console Overview page.
71+
6572
. *Insights* in the *Status* tile reports the number of issues found.

modules/telemetry-consequences-of-disabling-telemetry.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc
44

5+
:_mod-docs-content-type: CONCEPT
56
[id="telemetry-consequences-of-disabling-telemetry_{context}"]
67
= Consequences of disabling remote health reporting
78

support/remote_health_monitoring/enabling-remote-health-reporting.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="opting-out-remote-health-reporting"]
3-
= Opting out of remote health reporting
2+
[id="remote-health-reporting"]
3+
= Remote health reporting
44
include::_attributes/common-attributes.adoc[]
55
ifdef::openshift-dedicated[]
66
include::_attributes/attributes-openshift-dedicated.adoc[]
@@ -10,29 +10,33 @@ endif::[]
1010
toc::[]
1111

1212
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
13-
You may choose to opt out of reporting health and usage data for your cluster.
14-
endif::[]
15-
16-
// moved OSD note on not able to opt out to about telemetery
17-
18-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
13+
You can opt in or opt out of reporting health and usage data for your cluster.
1914

20-
To opt out of remote health reporting, you must:
15+
// Enabling remote health reporting
16+
include::modules/enabling-remote-health-reporting.adoc[leveloffset=+1]
2117

22-
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#insights-operator-new-pull-secret_opting-out-remote-health-reporting[Modify the global cluster pull secret] to disable remote health reporting.
23-
. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#images-update-global-pull-secret_opting-out-remote-health-reporting[Update the cluster] to use this modified pull secret.
18+
// Changing your global cluster pull secret to enable remote health reporting
19+
include::modules/insights-operator-new-pull-secret-enable.adoc[leveloffset=+1]
2420

21+
// Consequences of disabling remote health reporting
2522
include::modules/telemetry-consequences-of-disabling-telemetry.adoc[leveloffset=+1]
2623

24+
// Changing the global cluster pull secret to disable remote health reporting
2725
include::modules/insights-operator-new-pull-secret-disabled.adoc[leveloffset=+1]
2826

27+
[role="_additional-resources"]
28+
.Additional resources
29+
* xref:../../support/remote-health-monitoring-with-connected-clusters.adoc#images-update-global-pull-secret_opting-out-remote-health-reporting[Changing your global cluster pull secret to enable remote health reporting]
30+
31+
// Registering your disconnected cluster
2932
include::modules/insights-operator-register-disconnected-cluster.adoc[leveloffset=+1]
3033

3134
[role="_additional-resources"]
3235
.Additional resources
3336
* xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#telemetry-consequences-of-disabling-telemetry_opting-out-remote-health-reporting[Consequences of disabling remote health reporting]
3437
* link:https://access.redhat.com/documentation/en-us/subscription_central/2023/html/getting_started_with_the_subscriptions_service/con-how-does-subscriptionwatch-show-data_assembly-viewing-understanding-subscriptionwatch-data-ctxt[How does the subscriptions service show my subscription data?](Getting Started with the Subscription Service)
3538
39+
// Updating the global cluster pull secret
3640
include::modules/images-update-global-pull-secret.adoc[leveloffset=+1]
3741

3842
endif::[]

0 commit comments

Comments
 (0)