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
Copy file name to clipboardExpand all lines: FAQ.md
+3-19Lines changed: 3 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,32 +38,16 @@ Some features depend on the Linux kernel version in use. It should be at least 4
38
38
39
39
For OpenShift users, a visualization tool is integrated in the OpenShift console. Just open the console in your browser, and you will see new menu items (such as Network Traffic under Observe) once NetObserv is installed and configured.
40
40
41
-
Without OpenShift, you can still access the data (Loki logs, Prometheus metrics) in different ways:
41
+
Non-OpenShift users can deploy the standalone console, as explained in the Getting Started section from the readme.
42
+
43
+
Alternatively, you can still access the data (Loki logs, Prometheus metrics) in different ways:
42
44
43
45
- Querying Loki (or Prometheus) directly
44
46
- Using the Prometheus console
45
47
- Using and configuring Grafana
46
48
47
49
All these options depend on how you installed these components.
48
50
49
-
You may also want to try the Test Console, which is used by the development team. It is similar to the OpenShift console plugin and can work without OpenShift.
50
-
After cloning this repo, run:
51
-
52
-
```bash
53
-
USER=netobserv make use-test-console
54
-
# If you deployed netobserv in non-default namespaces, use NAMESPACE and/or OPERATOR_NS envs. If you want to point to a specific version, use VERSION.
55
-
# Example:
56
-
USER=netobserv NAMESPACE=other-namespace OPERATOR_NS=operator-namespace VERSION=vX.Y.Z make use-test-console
57
-
```
58
-
59
-
Or without cloning, run the following steps:
60
-
61
-
- Configure the operator to use a console-plugin standalone build: `kubectl set env deployment/netobserv-controller-manager -c "manager" RELATED_IMAGE_CONSOLE_PLUGIN="quay.io/netobserv/network-observability-standalone-frontend:main"`
62
-
- Configure the operator to deploy it: in `FlowCollector` yaml, set `spec.consolePlugin.advanced.env.TEST_CONSOLE` to `true`.
63
-
- Then port-forward port 9001: `kubectl port-forward svc/netobserv-plugin 9001:9001` and open http://localhost:9001/ .
64
-
65
-
Remember that it is only an internal dev tool, not a fully finished one. Do not expect the perfect user experience! By the way, contributions are welcome.
66
-
67
51
### How can I make sure everything is correctly deployed?
Copy file name to clipboardExpand all lines: README.md
+2-5Lines changed: 2 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,9 +75,7 @@ spec:
75
75
networkPolicy:
76
76
enable: false
77
77
consolePlugin:
78
-
advanced:
79
-
env:
80
-
TEST_CONSOLE: "true"
78
+
standalone: true
81
79
loki:
82
80
mode: Monolithic
83
81
monolithic:
@@ -93,8 +91,7 @@ EOF
93
91
```
94
92
95
93
A few remarks:
96
-
- While the [web console](https://github.com/netobserv/network-observability-console-plugin) is primarily designed as a plugin for the OpenShift Console, it is still possible to deploy it as a standalone, which the dev team sometimes use for testing. This is why it is mentioned as "TEST_CONSOLE" here.
97
-
- If you're in OpenShift, you should omit "TEST_CONSOLE: true" to use the Console plugin instead, which offers a better / more integrated experience.
94
+
-`spec.consolePlugin.standalone` can be set to true to deploy the [web console](https://github.com/netobserv/network-observability-console-plugin) as a standalone, as opposed to an OpenShift Console plugin. If you're in OpenShift, it's not recommended to set this mode, so you get a more integrated experience with the Console.
98
95
- You can change the Prometheus and Loki URLs depending on your installation. This example works if you use the "standalone" installation described above, with `install.loki=true` and `install.prom-stack=true`. Check more configuration options for [Prometheus](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecprometheus-1) and [Loki](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecloki-1).
99
96
- You can enable networkPolicy, which makes the operator lock down the namespaces that it manages; however, this is highly dependent on your cluster topology, and may cause malfunctions, such as preventing NetObserv pods from communicating with the Kube API server.
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/config/samples/flows_v1beta2_flowcollector.yaml).
723
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
724
724
725
725
To edit configuration in cluster, run:
726
726
@@ -736,7 +736,7 @@ spec:
736
736
737
737
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
738
738
739
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/QuickFilters.md).
739
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/QuickFilters.md).
740
740
741
741
- Kafka (`spec.deploymentModel: Kafka` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
742
742
@@ -772,7 +772,7 @@ spec:
772
772
This documentation includes:
773
773
774
774
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
775
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/Metrics.md).
775
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/Metrics.md).
776
776
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
777
777
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
778
778
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
Copy file name to clipboardExpand all lines: config/descriptions/ocp.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ In that case, you can still get the Prometheus metrics or export raw flows to a
38
38
39
39
## Configuration
40
40
41
-
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/config/samples/flows_v1beta2_flowcollector.yaml).
41
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
42
42
43
43
To edit configuration in cluster, run:
44
44
@@ -54,7 +54,7 @@ A couple of settings deserve special attention:
54
54
55
55
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
56
56
57
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/QuickFilters.md).
57
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/QuickFilters.md).
58
58
59
59
- Kafka (`spec.deploymentModel: Kafka` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
60
60
@@ -90,7 +90,7 @@ Please refer to the documentation on GitHub for more information.
90
90
This documentation includes:
91
91
92
92
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
93
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/Metrics.md).
93
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/Metrics.md).
94
94
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
95
95
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
96
96
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
Copy file name to clipboardExpand all lines: config/descriptions/upstream.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ In that case, you can still get the Prometheus metrics or export raw flows to a
42
42
43
43
## Configuration
44
44
45
-
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/config/samples/flows_v1beta2_flowcollector.yaml).
45
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
46
46
47
47
To edit configuration in cluster, run:
48
48
@@ -58,7 +58,7 @@ A couple of settings deserve special attention:
58
58
59
59
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
60
60
61
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/QuickFilters.md).
61
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/QuickFilters.md).
62
62
63
63
- Kafka (`spec.deploymentModel: Kafka` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
64
64
@@ -94,7 +94,7 @@ Please refer to the documentation on GitHub for more information.
94
94
This documentation includes:
95
95
96
96
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
97
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.0-community/docs/Metrics.md).
97
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.10.1-community/docs/Metrics.md).
98
98
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
99
99
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
100
100
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
0 commit comments