Skip to content

Commit 298ce7f

Browse files
committed
OBSDOCS-1886: Docs for Network Policies
1 parent 23ba919 commit 298ce7f

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/otel/otel-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="troubleshoot-network-policies_{context}"]
7+
= Disabling network policies
8+
9+
The {OTELOperator} creates network policies to control the traffic for the Operator and operands to improve security.
10+
By default, the network policies are enabled and configured to allow traffic to all the required components. No additional configuration is needed.
11+
12+
If you are experiencing traffic issues for the OpenTelemetry Collector or its Target Allocator component, the problem might be caused by the default network policy configuration. You can disable network policies for the OpenTelemetry Collector to troubleshoot the issue.
13+
14+
.Prerequisites
15+
16+
* You have access to the cluster as a cluster administrator with the `cluster-admin` role.
17+
18+
.Procedure
19+
20+
* Disable the network policy for the OpenTelemetry Collector by configuring the `OpenTelemetryCollector` custom resource (CR):
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: opentelemetry.io/v1beta1
25+
kind: OpenTelemetryCollector
26+
metadata:
27+
name: otel
28+
namespace: observability
29+
spec:
30+
networkPolicy:
31+
enabled: false # <1>
32+
# ...
33+
----
34+
<1> Specify whether to enable network policies by setting `networkPolicy.enabled` to `true` (default) or `false`. Setting it to `false` disables the creation of network policies.
35+

observability/otel/otel-troubleshooting.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1]
2020
2121
include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1]
2222

23+
include::modules/otel-troubleshoot-network-policies.adoc[leveloffset=+1]
24+
2325
include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1]
2426

2527
[role="_additional-resources"]

0 commit comments

Comments
 (0)