Skip to content

Commit

Permalink
Merge branch 'master' into read-pod-status-from-events
Browse files Browse the repository at this point in the history
  • Loading branch information
turytsia authored Jan 2, 2025
2 parents 5847f28 + 9af3503 commit a6b2bea
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/actions/deploy-kubernetes/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ runs:
- name: Install Helm
uses: azure/setup-helm@v3
with:
version: '3.8.2'
version: '3.9.0'

- name: Print cluster info
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/buildAndDeploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
uses: ./.github/actions/deploy-skaffold

- name: Create k8s Kind Cluster
uses: helm/kind-action@v1.10.0
uses: helm/kind-action@v1.12.0
with:
version: v0.24.0
kubectl_version: v1.31.0
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/buildAndTestHelm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Set up Helm
uses: azure/setup-helm@v3
with:
version: v3.8.2
version: v3.9.0

- name: Add dependency chart repos
run: |
Expand Down Expand Up @@ -73,7 +73,7 @@ jobs:
uses: ./.github/actions/deploy-skaffold

- name: Create k8s Kind Cluster
uses: helm/kind-action@v1.10.0
uses: helm/kind-action@v1.12.0
with:
version: v0.24.0
kubectl_version: ${{ matrix.kubernetes_version }}
Expand Down
18 changes: 9 additions & 9 deletions deploy/helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@
## Table of contents

- [Installation](#installation)
- [Requirements](#requirements)
- [Configuration](#configuration)
- [Limitations](#limitations)
- [Auto Instrumentation (experimental feature)](#auto-instrumentation-experimental-feature)

## Installation

Walk through `Add a Kubernetes cluster` in [SolarWinds Observability](https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=gh-k8s-collector)

## Requirements

- Each Kubernetes version is supported for 15 months after its initial release. For example, version 1.27 released on April 11, 2023 is supported until July 11, 2024. For release dates for individual Kubernetes versions, see [Patch Releases](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches) in Kubernetes documentation.
- Local Kubernetes deployments (e.q. Minikube, Docker Desktop) are not supported (although most of the functionality may be working).
- Note: since Kubernetes v1.24 Docker container runtime will not be reporting pod level network metrics (`kubenet` and other network plumbing was removed from upstream as part of the dockershim removal/deprecation)
- Supported architectures: Linux x86-64 (`amd64`), Linux ARM (`arm64`), Windows x86-64 (`amd64`).
- Helm 3.9.0 or newer.

## Configuration

The [Helm chart](Chart.yaml) that you are about to deploy to your cluster has various configuration options. The full list, including the default settings, is available in [values.yaml](values.yaml).
Expand Down Expand Up @@ -115,7 +123,6 @@ otel:
- attributes["k8s.object.kind"] == "ConfigMap" and resource.attributes["k8s.namespace.name"] != "kube-system"
```


## Receive 3rd party metrics

SWO K8s Collector has an OTEL service endpoint which is able to forward metrics and logs into SolarWinds Observability. All incoming data is properly associated with current cluster. Additionally, metrics are decorated with prefix `k8s.`.
Expand Down Expand Up @@ -150,13 +157,6 @@ config:
service_address: <chart-name>-metrics-collector.<namespace>.svc.cluster.local:4317
```

## Limitations

- Each Kubernetes version is supported for 15 months after its initial release. For example, version 1.27 released on April 11, 2023 is supported until July 11, 2024. For release dates for individual Kubernetes versions, see [Patch Releases](https://kubernetes.io/releases/patch-releases/#detailed-release-history-for-active-branches) in Kubernetes documentation.
- Local Kubernetes deployments (e.q. Minikube, Docker Desktop) are not supported (although most of the functionality may be working).
- Note: since Kubernetes v1.24 Docker container runtime will not be reporting pod level network metrics (`kubenet` and other network plumbing was removed from upstream as part of the dockershim removal/deprecation)
- Supported architectures: Linux x86-64 (`amd64`), Linux ARM (`arm64`), Windows x86-64 (`amd64`).

## Auto Instrumentation (experimental feature)

This chart allows you to deploy the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator), which can be used to auto-instrument applications with [SWO APM](https://documentation.solarwinds.com/en/success_center/observability/content/intro/services.htm).
Expand Down
8 changes: 8 additions & 0 deletions deploy/helm/templates/asserts.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,12 @@

{{- if mustRegexMatch "^[\\s]+$" .Values.cluster.uid -}}
{{ fail "If specified, the custom cluster UID should be a valid string." }}
{{- end -}}

{{- if empty .Capabilities.HelmVersion.Version -}}
{{ fail "This version of Helm is not supported. Please use 3.9.0 or newer." }}
{{- end -}}

{{- if eq ((semver "3.9.0").Compare (semver .Capabilities.HelmVersion.Version)) 1 -}}
{{ fail "This version of Helm is not supported. Please use 3.9.0 or newer." }}
{{- end -}}

0 comments on commit a6b2bea

Please sign in to comment.