Skip to content

Commit b099927

Browse files
adellapeadellape
authored
Merge pull request #63976 from xJustin/hccdoc-1094-insights-on-demand
2 parents f6ce790 + 52ddf19 commit b099927

File tree

4 files changed

+112
-0
lines changed

4 files changed

+112
-0
lines changed

‎modules/disabling-insights-operator-gather.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ You can disable the Insights Operator gather operations. Disabling the gather op
1212
:FeatureName: The `InsightsDataGather` custom resource
1313
include::snippets/technology-preview.adoc[]
1414

15+
[NOTE]
16+
====
17+
If you enable Technology Preview in your cluster, the Insights Operator runs gather operations in individual pods. This is part of the Technology Preview feature set for the Insights Operator and supports the new data gathering features.
18+
====
19+
1520
.Prerequisites
1621

1722
* You are logged in to the {product-title} web console as a user with `cluster-admin` role.

‎modules/running-insights-operator-gather-cli.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/remote_health_monitoring/using-insights-operator.adoc
4+
5+
6+
:_content-type: PROCEDURE
7+
[id="running-insights-operator-gather-openshift-cli_{context}"]
8+
= Running an Insights Operator gather operation using the OpenShift CLI
9+
You can run an Insights Operator gather operation using the {product-title} command line interface.
10+
11+
.Prerequisites
12+
13+
* You are logged in to {product-title} as a user with the `cluster-admin` role.
14+
15+
.Procedure
16+
* Enter the following command to run the gather operation:
17+
+
18+
[source,terminal]
19+
----
20+
$ oc apply -f <your_datagather_definition>.yaml
21+
----
22+
+
23+
Replace `<your_datagather_definition>.yaml` with a configuration file using the following parameters:
24+
+
25+
[source,yaml]
26+
----
27+
apiVersion: insights.openshift.io/v1alpha1
28+
kind: DataGather
29+
metadata:
30+
name: <your_data_gather> <1>
31+
spec:
32+
gatherers: <2>
33+
- name: workloads
34+
state: Disabled
35+
----
36+
+
37+
--
38+
<1> Replace the `<your_data_gather>` with a unique name for your gather operation.
39+
<2> Enter individual gather operations to disable under the `gatherers` parameter. This example disables the `workloads` data gather operation and will run the remainder of the default operations. To run the complete list of default gather operations, leave the `spec` parameter empty. You can find the complete list of gather operations in the Insights Operator documentation.
40+
--
41+
42+
.Verification
43+
44+
* Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the Insights Operator automatically uploads the data to Red Hat for processing.
45+

‎modules/running-insights-operator-gather-web-console.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * support/remote_health_monitoring/using-insights-operator.adoc
4+
5+
6+
:_content-type: PROCEDURE
7+
8+
[id="running-insights-operator-gather-web-console_{context}"]
9+
= Running an Insights Operator gather operation using the web console
10+
You can run an Insights Operator gather operation using the {product-title} web console.
11+
12+
.Prerequisites
13+
14+
* You are logged in to the {product-title} web console as a user with the `cluster-admin` role.
15+
16+
.Procedure
17+
18+
. Navigate to *Administration* -> *CustomResourceDefinitions*.
19+
. On the *CustomResourceDefinitions* page, use the *Search by name* field to find the *DataGather* resource definition and click it.
20+
. On the *CustomResourceDefinition details* page, click the *Instances* tab.
21+
. Click *Create DataGather*.
22+
. To create a new `DataGather` operation, edit the configuration file:
23+
+
24+
[source,yaml]
25+
----
26+
apiVersion: insights.openshift.io/v1alpha1
27+
kind: DataGather
28+
metadata:
29+
name: <your_data_gather> <1>
30+
spec:
31+
gatherers: <2>
32+
- name: workloads
33+
state: Disabled
34+
----
35+
+
36+
--
37+
<1> Replace the `<your_data_gather>` with a unique name for your gather operation.
38+
<2> Enter individual gather operations to disable under the `gatherers` parameter. This example disables the `workloads` data gather operation and will run the remainder of the default operations. To run the complete list of default gather operations, leave the `spec` parameter empty. You can find the complete list of gather operations in the Insights Operator documentation.
39+
--
40+
+
41+
. Click *Save*.
42+
43+
.Verification
44+
45+
. Navigate to *Workloads* -> *Pods*.
46+
. On the Pods page, select the *Project* pulldown menu, and then turn on Show default projects.
47+
. Select the `openshift-insights` project from the *Project* pulldown menu.
48+
. Check that your new gather operation is prefixed with your chosen name under the list of pods in the `openshift-insights` project. Upon completion, the Insights Operator automatically uploads the data to Red Hat for processing.

‎support/remote_health_monitoring/using-insights-operator.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,18 @@ include::modules/disabling-insights-operator-alerts.adoc[leveloffset=+1]
2323
include::modules/insights-operator-downloading-archive.adoc[leveloffset=+1]
2424
include::modules/insights-operator-gather-duration.adoc[leveloffset=+1]
2525
include::modules/disabling-insights-operator-gather.adoc[leveloffset=+1]
26+
[id="running-insights-operator-gather_using-insights-operator"]
27+
== Running an Insights Operator gather operation
28+
29+
You can run Insights Operator data gather operations on demand. The following procedures describe how to run the default list of gather operations using the OpenShift web console or CLI. You can customize the on demand gather function to exclude any gather operations you choose. Disabling gather operations from the default list degrades Insights Advisor's ability to offer effective recommendations for your cluster. If you have previously disabled Insights Operator gather operations in your cluster, this procedure will override those parameters.
30+
31+
:FeatureName: The `DataGather` custom resource
32+
include::snippets/technology-preview.adoc[]
33+
34+
[NOTE]
35+
====
36+
If you enable Technology Preview in your cluster, the Insights Operator runs gather operations in individual pods. This is part of the Technology Preview feature set for the Insights Operator and supports the new data gathering features.
37+
====
38+
include::modules/running-insights-operator-gather-web-console.adoc[leveloffset=+2]
39+
include::modules/running-insights-operator-gather-cli.adoc[leveloffset=+2]
2640
include::modules/insights-operator-configuring.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)