You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
= 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.
8
+
= Running an Insights Operator gather operation from the OpenShift CLI
9
+
You can run an Insights Operator gather operation by using the {product-title} command line interface.
10
10
11
11
.Prerequisites
12
12
@@ -20,7 +20,7 @@ You can run an Insights Operator gather operation using the {product-title} comm
20
20
$ oc apply -f <your_datagather_definition>.yaml
21
21
----
22
22
+
23
-
Replace `<your_datagather_definition>.yaml` with a configuration file using the following parameters:
23
+
Replace `<your_datagather_definition>.yaml` with a configuration file that contains the following parameters:
24
24
+
25
25
[source,yaml]
26
26
----
@@ -35,11 +35,16 @@ spec:
35
35
----
36
36
+
37
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.
38
+
<1> Under *metadata*, replace `<your_data_gather>` with a unique name for the gather operation.
39
+
<2> Under *gatherers*, specify any individual gather operations that you intend to disable. In the example provided, `workloads` is the only data gather operation that is disabled and all of the other default operations are set to run.
40
+
When the `spec` parameter is empty, all of the default gather operations run.
40
41
--
41
42
42
-
.Verification
43
+
[IMPORTANT]
44
+
====
45
+
Do not add a prefix of `periodic-gathering-` to the name of your gather operation because this string is reserved for other administrative operations and might impact the intended gather operation.
46
+
====
43
47
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.
48
+
.Verification
45
49
50
+
* 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.
= 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.
9
+
= Running an Insights Operator gather operation from the web console
10
+
To collect data, you can run an Insights Operator gather operation by using the {product-title} web console.
11
11
12
12
.Prerequisites
13
13
14
14
* You are logged in to the {product-title} web console as a user with the `cluster-admin` role.
15
15
16
16
.Procedure
17
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.
18
+
. On the console, select *Administration* -> *CustomResourceDefinitions*.
19
+
. On the *CustomResourceDefinitions* page, in the *Search by name* field, find the *DataGather* resource definition, and then click it.
20
+
. On the console, select *Administration* -> *CustomResourceDefinitions*.
21
+
. On the *CustomResourceDefinitions* page, in the *Search by name* field, find the *DataGather* resource definition, and then click it.
20
22
. On the *CustomResourceDefinition details* page, click the *Instances* tab.
21
23
. Click *Create DataGather*.
22
-
. To create a new `DataGather` operation, edit the configuration file:
24
+
. To create a new `DataGather` operation, edit the following configuration file and then save your changes.
23
25
+
24
26
[source,yaml]
25
27
----
@@ -34,15 +36,22 @@ spec:
34
36
----
35
37
+
36
38
--
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
+
<1> Under *metadata*, replace `<your_data_gather>` with a unique name for the gather operation.
40
+
<2> Under *gatherers*, specify any individual gather operations that you intend to disable. In the example provided, `workloads` is the only data gather operation that is disabled and all of the other default operations are set to run.
41
+
When the `spec` parameter is empty, all of the default gather operations run.
39
42
--
40
-
+
41
-
. Click *Save*.
43
+
44
+
[IMPORTANT]
45
+
====
46
+
Do not add a prefix of `periodic-gathering-` to the name of your gather operation because this string is reserved for other administrative operations and might impact the intended gather operation.
47
+
====
42
48
43
49
.Verification
44
50
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.
51
+
. On the console, select to *Workloads* -> *Pods*.
52
+
. On the Pods page, go to the *Project* pull-down menu, and then select *Show default projects*.
53
+
. Select the `openshift-insights` project from the *Project* pull-down menu.
54
+
. On the console, select to *Workloads* -> *Pods*.
55
+
. On the Pods page, go to the *Project* pull-down menu, and then select *Show default projects*.
56
+
. Select the `openshift-insights` project from the *Project* pull-down menu.
57
+
. 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.
0 commit comments