mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
50 lines
3.9 KiB
Plaintext
50 lines
3.9 KiB
Plaintext
// Module included in the following assemblies:
|
|
|
|
// * networking/network_observability/installing-operators.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="network-observability-operator-installation_{context}"]
|
|
= Installing the Network Observability Operator
|
|
|
|
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`.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
The actual memory consumption of the Operator depends on your cluster size and the number of resources deployed. Memory consumption might need to be adjusted accordingly. For more information refer to "Network Observability controller manager pod runs out of memory" in the "Important Flow Collector configuration considerations" section.
|
|
====
|
|
|
|
.Prerequisites
|
|
|
|
* If you choose to use Loki, install the link:https://catalog.redhat.com/software/containers/openshift-logging/loki-rhel8-operator/622b46bcae289285d6fcda39[{loki-op} version 5.7+].
|
|
* You must have `cluster-admin` privileges.
|
|
* One of the following supported architectures is required: `amd64`, `ppc64le`, `arm64`, or `s390x`.
|
|
* Any CPU supported by Red Hat Enterprise Linux (RHEL) 9.
|
|
* Must be configured with OVN-Kubernetes as the main network plugin, and optionally using secondary interfaces with Multus and SR-IOV.
|
|
|
|
[NOTE]
|
|
====
|
|
Additionally, this installation example uses the `netobserv` namespace, which is used across all components. You can optionally use a different namespace.
|
|
====
|
|
|
|
.Procedure
|
|
|
|
. In the {product-title} web console, click *Ecosystem* -> *Software Catalog*.
|
|
. Choose *Network Observability Operator* from the list of available Operators in the software catalog, and click *Install*.
|
|
. Select the checkbox `Enable Operator recommended cluster monitoring on this Namespace`.
|
|
. Navigate to *Ecosystem* -> *Installed Operators*. Under Provided APIs for Network Observability, select the *Flow Collector* link.
|
|
. Navigate to the *Flow Collector* tab, and click *Create FlowCollector*. Make the following selections in the form view:
|
|
.. *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", `spec.agent.ebpf`.
|
|
.. If you are not using Loki, click *Loki client settings* and change *Enable* to *False*. The setting is *True* by default.
|
|
.. If you are using Loki, set the following specifications:
|
|
... *spec.loki.mode*: Set this to the `LokiStack` mode, which automatically sets URLs, TLS, cluster roles and a cluster role binding, as well as the `authToken` value. Alternatively, the `Manual` mode allows more control over configuration of these settings.
|
|
... *spec.loki.lokistack.name*: Set this to the name of your `LokiStack` resource. In this documentation, `loki` is used.
|
|
.. Optional: If you are in a large-scale environment, consider configuring the `FlowCollector` with Kafka for forwarding data in a more resilient, scalable way. See "Configuring the Flow Collector resource with Kafka storage" in the "Important Flow Collector configuration considerations" section.
|
|
.. Optional: Configure other optional settings before the next step of creating the `FlowCollector`. For example, if you choose not to use Loki, then you can configure exporting flows to Kafka or IPFIX. See "Export enriched network flow data to Kafka and IPFIX" and more in the "Important Flow Collector configuration considerations" section.
|
|
. Click *Create*.
|
|
|
|
.Verification
|
|
|
|
To confirm this was successful, when you navigate to *Observe* you should see *Network Traffic* listed in the options.
|
|
|
|
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.
|