Skip to content

Commit bd9f0fc

Browse files
authored
Merge pull request #57748 from JoeAldinger/OSDOCS-5595
OSDOCS-5595:updates install and uninstall for NW observability Operator
2 parents 2ed7b09 + d85d286 commit bd9f0fc

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

modules/network-observability-operator-install.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,38 @@
55
:_content-type: PROCEDURE
66
[id="network-observability-operator-installation_{context}"]
77
= Installing the Network Observability Operator
8-
You can install the Network Observability Operator using the {product-title} web console Operator Hub. When you install the Operator, it provides the `FlowCollector` custom resource definition (CRD). You can set specifications in the web console when you create the `FlowCollector`.
8+
You can install the Network Observability Operator using the {product-title} web console Operator Hub. When you install the Operator, it provides the `FlowCollector` custom resource definition (CRD). You can set specifications in the web console when you create the `FlowCollector`.
99

1010
.Prerequisites
1111

12-
* Installed Loki. It is recommended to install Loki using the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[Loki Operator version 5.6].
12+
* Installed Loki. It is recommended to install Loki using the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[Loki Operator version 5.6].
1313
1414
.Procedure
1515

1616
.. In the {product-title} web console, click *Operators* -> *OperatorHub*.
17-
//In the Operator Hub on the test console Julian provided perms for, its NetObserv Operator, with a capital O.
17+
//In the Operator Hub on the test console Julian provided perms for, its NetObserv Operator, with a capital O.
1818
.. Choose *Network Observability Operator* from the list of available Operators in the *OperatorHub*, and click *Install*.
19+
.. Select the checkbox `Enable Operator recommended cluster monitoring on this Namespace`.
1920
.. Navigate to *Operators* -> *Installed Operators*. Under Provided APIs for Network Observability, select the *Flow Collector* link.
2021
. Navigate to the *Flow Collector* tab, and click *Create FlowCollector*. Make the following selections in the form view:
2122
+
22-
* *spec.agent.ebpf.Sampling* : Specify a sampling size for flows. Lower sampling sizes will have higher impact on resource utilization. For more information, see the `FlowCollector` API reference, under spec.agent.ebpf.
23+
* *spec.agent.ebpf.Sampling* : Specify a sampling size for flows. Lower sampling sizes will have higher impact on resource utilization. For more information, see the `FlowCollector` API reference, under spec.agent.ebpf.
2324
* *spec.deploymentModel*: If you are using Kafka, verify Kafka is selected.
2425
* *loki.url*: Since authentication is specified separately, this URL needs to be updated to `https://loki-gateway-http.netobserv.svc:8080/api/logs/v1/network`. The first part of the URL, "loki", should match the name of your LokiStack.
2526
* *loki.tenantID*: Set this to `network`.
2627
* *loki.statusUrl*: Set this to `https://loki-query-frontend-http.netobserv.svc:3100/`.
2728
* *loki.authToken*: Select the `FORWARD` value.
2829
* *tls.enable*: Verify that the box is checked so it is enabled.
29-
. Click *Create*.
30+
. Click *Create*.
3031

3132
.Verification
3233

33-
To confirm this was successful, when you navigate to *Observe* you should see *Network Traffic* listed in the options.
34+
To confirm this was successful, when you navigate to *Observe* you should see *Network Traffic* listed in the options.
3435

35-
In the absence of *Application Traffic* within the {product-title} cluster, default filters might show that there are "No results", which results in no visual flow. Beside the filter selections, select *Clear all filters* to see the flow.
36+
In the absence of *Application Traffic* within the {product-title} cluster, default filters might show that there are "No results", which results in no visual flow. Beside the filter selections, select *Clear all filters* to see the flow.
3637

3738
[IMPORTANT]
3839
====
39-
If you installed Loki using the Loki Operator, it is advised not to use `querierUrl`, as it can break the console access to Loki. If you installed Loki using another type of Loki installation, this does not apply.
40+
If you installed Loki using the Loki Operator, it is advised not to use `querierUrl`, as it can break the console access to Loki. If you installed Loki using another type of Loki installation, this does not apply.
4041
====
4142

modules/network-observability-operator-uninstall.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ You can uninstall the Network Observability Operator using the {product-title} w
1010
.Procedure
1111

1212
. Remove the `FlowCollector` custom resource.
13-
.. Click *Flow Collector*, which is next to the *Network Observability Operator* in the *Provided APIs* column.
13+
.. Click *Flow Collector*, which is next to the *Network Observability Operator* in the *Provided APIs* column.
1414
.. Click the options menu {kebab} for the *cluster* and select *Delete FlowCollector*.
1515
. Uninstall the Network Observability Operator.
16-
.. Navigate back to the *Operators* -> *Installed Operators* area.
16+
.. Navigate back to the *Operators* -> *Installed Operators* area.
1717
.. Click the options menu {kebab} next to the *Network Observability Operator* and select *Uninstall Operator*.
18+
.. *Home* -> *Projects* and select `openshift-netobserv-operator`
19+
.. Navigate to *Actions* and select *Delete Project*
1820
. Remove the `FlowCollector` custom resource definition (CRD).
19-
.. Navigate to *Administration* -> *CustomResourceDefinitions*.
20-
.. Look for *FlowCollector* and click the options menu {kebab}.
21+
.. Navigate to *Administration* -> *CustomResourceDefinitions*.
22+
.. Look for *FlowCollector* and click the options menu {kebab}.
2123
.. Select *Delete CustomResourceDefinition*.
2224
+
2325
[IMPORTANT]
2426
====
25-
The Loki Operator and Kafka remain if they were installed and must be removed separately. Additionally, you might have remaining data stored in an object store, and a persistent volume that must be removed.
27+
The Loki Operator and Kafka remain if they were installed and must be removed separately. Additionally, you might have remaining data stored in an object store, and a persistent volume that must be removed.
2628
====

0 commit comments

Comments
 (0)