Skip to content

Commit 367e7d4

Browse files
doc updates alongwith minor helm chart changes
1 parent 65bea2a commit 367e7d4

File tree

6 files changed

+39
-108
lines changed

6 files changed

+39
-108
lines changed

CHANGELOG.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
11
# Change Log
22

3-
# 2025-06-09
4-
3+
# 2025-06-17
54
### Added
6-
- Introduced a new DaemonSet that uses eBPF (Extended Berkeley Packet Filter) to capture TCP connection logs, enabling visualization of application-level communication within the Kubernetes cluster.
5+
- Introduced a new DaemonSet that uses eBPF (Extended Berkeley Packet Filter) to capture TCP connection logs and builds application/network topology representing workload to workload relationships within the Kubernetes cluster.
6+
- New helm variable to control the resource limits at individual logan workloads.
7+
- Enables OKE infra discovery and service logs collection (default)
78
- OCI Console integration supporting new features:
8-
- **Network View:** Dynamically discover and visualize workload-to-workload communication within the cluster.
9-
- **Infrastructure View:** Visualize OKE infrastructure components such as Subnets, Load Balancers, Nodes, and their interactions.
10-
- **Kubernetes Spec Change Detection (View Insights):** Monitor changes/diffs of 50+ key properties across primary Kubernetes workload types:
11-
- DaemonSet
12-
- Deployment
13-
- ReplicaSet
14-
- StatefulSet
15-
- CronJob & Job
16-
- Exclusion: Managed workloads (ex - A Job created via a CronJob) are not tracked
17-
18-
**Note:** Additional enhancements and features are available in the OCI Console beyond those listed here. Please refer to the OCI Log Analytics Release Notes for more details.
9+
- Topology : New Views (Infra and Network) along with Platform.
10+
- View Insights for Workloads including capabilities to view the detailed spec of a workload, monitor the changes to the spec of a workload, create in-line labels for issues etc.
1911

2012
### Changed
2113
- `kubernetesClusterID` (in the Helm chart) is now a mandatory field. *(This is not backward compatible.)*
22-
- Updated resource limits for Log Analytics pods and workloads.
2314

2415
## 2025-03-19
2516
### Added

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ It does extensive enrichment of logs, metrics and object information to enable c
3636

3737
## Get Started :rocket:
3838

39-
:stop_sign: Upgrading to a major version (like 2.x to 3.x)? See [upgrade](#upgrading-to-a-major-version) section below for details. :warning:
39+
:stop_sign: Upgrading to a major version (like 3.x to 4.x)? See [upgrade](#upgrading-to-a-major-version) section below for details. :warning:
4040

4141
### Pre-requisites
4242

@@ -366,6 +366,27 @@ Refer [here](#3c-import-dashboards).
366366
367367
### Upgrading to a major version
368368
369+
#### v3.6.0 → v4.0.0
370+
371+
For changes in this release, refer to [CHANGELOG.md](CHANGELOG.md)
372+
373+
1. Update IAM Policies:
374+
* This version requires additional policy statements for infrastructure discovery.
375+
* See the pre-requisites section in the [README](../README.md#0-pre-requisites) for details.
376+
377+
2. Upgrade the Helm chart:
378+
379+
```sh
380+
# fetch latest (4.x) helm repo for oci
381+
helm repo update oci-onm
382+
383+
# fetch the current release configuration
384+
helm get values <release-name> -n <namespace> > override_values.yaml
385+
386+
# Upgrade the helm chart
387+
helm upgrade <release-name> oci/oci-onm -f override_values.yaml
388+
```
389+
369390
#### 2.x to 3.x
370391
371392
One of the major changes introduced in 3.0.0 is refactoring of helm chart where major features of the solution got split into separate sub-charts. 2.x has only support for logs and objects collection using Fluentd and OCI Logging Analytics and this is now moved into a separate chart oci-onm-logan and included as a sub-chart to the main chart oci-onm. This is a breaking change w.r.t the values.yaml and any customisations that you might have done on top of it. There is no breaking change w.r.t functionality offered in 2.x. For full list of changes in 3.x, refer to [changelog](CHANGELOG.md).

charts/logan/templates/tcpconnect-daemonset.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ spec:
4444
- --
4545
args:
4646
- /usr/bin/tcpconnect -e
47-
- -i {{ .Values.fluentd.kubernetesSystem.logs.tcpconnect.interval }}
47+
- -i 30
4848
env:
4949
- name: K8S_NODE_NAME
5050
valueFrom:

charts/logan/values.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ privileged: false
8484

8585
# -- Enables the collection of TCP connect logs.
8686
# Default: true
87-
# Warning: Disabling this will prevent automatic discovery of workload-to-workload communication within the cluster.
87+
# Note: Disabling this will prevent automatic discovery of workload-to-workload communication within the cluster.
8888
enableTCPConnectLogs: true
8989

9090
# -- Enables collection of AWS EKS Control Plane logs through CloudWatch or S3 Fluentd plugin
@@ -114,13 +114,13 @@ resources:
114114

115115
# Requests and limits for Memory and CPU [Overrides]
116116
resourceOverrides:
117-
# Responsible for TCP connection events collection.
117+
# Responsible for TCP connect logs collection aiding discovery of workload to workload relationships.
118118
tcpconnectDaemonset:
119119
# -- Resource requests
120120
requests:
121121
cpu: 10m
122122
memory: 50Mi
123-
# Responsible for log collection.
123+
# Responsible for various logs collection.
124124
fluentdDaemonset:
125125
# -- Limits
126126
limits:
@@ -402,8 +402,6 @@ fluentd:
402402
path: /var/log/containers/*-logan-tcpconnect*.log
403403
# Logging Analytics log source to use for parsing and processing the logs: TCP CONNECT Logs
404404
ociLALogSourceName: "Kubernetes TCP Connect Logs"
405-
# Network logs Polling frequency in seconds
406-
interval: 30
407405

408406
# Config specific to Kubernetes Audit Logs Collection
409407
kube-audit:
@@ -727,7 +725,7 @@ k8sDiscovery:
727725
infra:
728726
# Enable Logs collection for OKE's OCI infra components - LB, OKE Cluster control plane, Subnet logs etc
729727
# Not supported for Non OKE clusters
730-
enable_service_log: false
728+
enable_service_log: true
731729
# Discovers OKE Node Pools in all compartments of tenant
732730
# when false, Node Pools present in OKE's compartment are discovered
733731
probe_all_compartments: false

docs/FAQ.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Refer [here](../README.md#installation-instructions).
1818
| :----: | :----: | :----: | :----: | :----: |
1919
| Namespace | All | oci-onm | Namespace in which all the resources would be installed. | There is a provision to choose pre-created namespace or to create a different namespace and then use it. |
2020
| DaemonSet | Logs | oci-onm-logan | Responsible for log collection. | |
21-
| DaemonSet | Logs | oci-onm-logan-tcpconnect | Responsible for TCP connection events collection. | The pods in this DaemonSet run in privileged mode, but with only the CAP_BPF capability enabled. This allows them to execute the required BPF programs while maintaining a minimal security footprint. |
21+
| DaemonSet | Logs | oci-onm-logan-tcpconnect | Responsible for TCP connect logs collection aiding discovery of workload to workload relationships. | The pods in this DaemonSet run in privileged mode, but with only the CAP_BPF capability enabled which enables the pods to run the required eBPF program. |
2222
| CronJob | Discovery, Kubernetes Objects State | oci-onm-discovery | Responsible for Kubernetes discovery and objects state collection. | |
2323
| StatefulSet | Metrics | oci-onm-mgmt-agent | Responsible for metrics collection. | |
2424
| ConfigMap | Logs | oci-onm-logs | Contains Fluentd configuration aiding the log collection. | |
@@ -625,11 +625,13 @@ Allow service loganalytics to {VCN_READ,SUBNET_READ,VNIC_READ} in tenancy
625625

626626
### Why does the TcpConnect DaemonSet use privileged mode? Can it be disabled?
627627

628-
The tcpconnect DaemonSet runs an eBPF program to collect TCP connection events, which are essential for dynamically mapping communication between workloads in the cluster. These relationships are visualized in the network topology view.
628+
TcpConnect DaemonSet is responsible for TCP connect logs collection aiding discovery of workload to workload relationships.
629629

630-
To enable the eBPF program, the DaemonSet requires privileged mode with the CAP_BPF capability.
630+
To be able to run the required eBPF program, the pods needs to run in privileged mode but restricting to CAP_BPF capability only.
631631

632-
You can disable this feature by setting the following property to false:
632+
If you need to disable this feature, set the following property to false:
633+
634+
> Note: Disabling this will prevent automatic discovery of workload-to-workload communication within the cluster, resulting in an empty network topology view in the OCI Console.
633635
634636
```yaml
635637
...
@@ -642,8 +644,6 @@ oci-onm-logan:
642644
..
643645
```
644646

645-
**Warning:** Warning: Disabling this will prevent automatic discovery of workload-to-workload communication within the cluster, resulting in an empty network topology view in the OCI Console.
646-
647647
### Control plane log collection for AWS EKS (Amazon Elastic Kubernetes Service)
648648

649649
AWS EKS control plane logs are available in CloudWatch.

docs/helm-chart-upgrade-guide.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

0 commit comments

Comments
 (0)