mirror of
https://github.com/bitnami/charts.git
synced 2026-03-15 14:57:16 +08:00
116 lines
12 KiB
Markdown
116 lines
12 KiB
Markdown
# Kubernetes Event Exporter
|
|
|
|
[Kubernetes Event Exporter](https://github.com/opsgenie/kubernetes-event-exporter) allows exporting the often missed Kubernetes events to various outputs so that they can be used for observability or alerting purposes.
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
$ helm repo add bitnami https://charts.bitnami.com/bitnami
|
|
$ helm install my-release bitnami/kubernetes-event-exporter
|
|
```
|
|
|
|
## Introduction
|
|
|
|
This chart bootstraps a [Kubernetes Event Exporter](https://github.com/opsgenie/kubernetes-event-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
|
|
|
|
## Prerequisites
|
|
|
|
- Kubernetes 1.12+
|
|
- Helm 3.1.0
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `my-release`:
|
|
|
|
```console
|
|
$ helm repo add bitnami https://charts.bitnami.com/bitnami
|
|
$ helm install my-release bitnami/kubernetes-event-exporter
|
|
```
|
|
|
|
These commands deploy Kubernetes Event Exporter on the Kubernetes cluster in the default configuration. The [Parameters](##parameters) section lists the parameters that can be configured during installation.
|
|
|
|
> **Tip**: List all releases using `helm list` or `helm ls --all-namespaces`
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall/delete the `my-release` deployment:
|
|
|
|
```console
|
|
$ helm delete my-release
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
|
|
## Parameters
|
|
|
|
The following table lists the configurable parameters of the Kubernetes Event Exporter chart and their default values.
|
|
|
|
### Global parameters
|
|
|
|
| Parameter | Description | Default |
|
|
|---------------------------|-------------------------------------------------|---------------------------------------------------------|
|
|
| `global.imageRegistry` | Global Docker image registry | `nil` |
|
|
| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` (does not add image pull secrets to deployed pods) |
|
|
|
|
### Common parameters
|
|
|
|
| Parameter | Description | Default |
|
|
|---------------------------------------------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------|
|
|
| `nameOverride` | String to partially override kubernetes-event-exporter.fullname template | `nil` |
|
|
| `fullnameOverride` | String to fully override kubernetes-event-exporter.fullname template | `nil` |
|
|
| `affinity` | Affinity for pod assignment | `{}` (evaluated as a template) |
|
|
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` (evaluated as a template) |
|
|
| `commonLabels` | Labels to add to all deployed objects | `{}` (evaluated as a template) |
|
|
| `containerSecurityContext.enabled` | Enable container security context | `true` |
|
|
| `containerSecurityContext.capabilities.drop` | Drop capabilities for the securityContext | `["ALL"]` |
|
|
| `containerSecurityContext.capabilities.add` | Add capabilities for the securityContext | `[]` |
|
|
| `containerSecurityContext.readOnlyRootFilesystem` | Allows the pod to mount the RootFS as ReadOnly only | `true` |
|
|
| `containerSecurityContext.runAsNonRoot` | If the pod should run as a non root container. | `true` |
|
|
| `containerSecurityContext.runAsUser` | Define the uid with which the pod will run | `1001` |
|
|
| `hostAliases` | Add deployment host aliases | `[]` |
|
|
| `extraEnvVars` | Array containing extra env vars to be added to all containers | `[]` (evaluated as a template) |
|
|
| `extraEnvVarsConfigMap` | ConfigMap containing extra env vars to be added to all containers | `""` (evaluated as a template) |
|
|
| `extraEnvVarsSecret` | Secret containing extra env vars to be added to all containers | `""` (evaluated as a template) |
|
|
| `extraVolumeMounts` | Array to add extra mounts (normally used with extraVolumes) | `[]` |
|
|
| `extraVolumes` | Array to add extra volumes | `[]` |
|
|
| `image.pullPolicy` | Container image pull policy | `IfNotPresent` |
|
|
| `image.pullSecrets` | Specify docker-registry secret names as an array | `nil` (does not add image pull secrets to deployed pods) |
|
|
| `image.registry` | Container image registry | `docker.io` |
|
|
| `image.repository` | Container image name | `bitnami/kubernetes-event-exporter` |
|
|
| `image.tag` | Container image tag | `0.9.0-debian-10-r0` |
|
|
| `initContainers` | Attach additional init containers to pods | `[]` (evaluated as a template) |
|
|
| `nodeAffinityPreset.key` | Node label key to match. Ignored if `affinity` is set. | `""` |
|
|
| `nodeAffinityPreset.type` | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
|
|
| `nodeAffinityPreset.values` | Node label values to match. Ignored if `affinity` is set. | `[]` |
|
|
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
|
| `podAffinityPreset` | Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""` |
|
|
| `podAnnotations` | Pod annotations | `{}` |
|
|
| `podAntiAffinityPreset` | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `"soft"` |
|
|
| `podSecurityContext.enabled` | Enable security context | `true` |
|
|
| `podSecurityContext.fsGroup` | Group ID for the container | `1001` |
|
|
| `priorityClassName` | priorityClassName of the pods | `""` |
|
|
| `rbac.create` | Create the RBAC roles for API accessibility | `true` |
|
|
| `resources.limits` | Specify resource limits which the container is not allowed to succeed. | `{}` |
|
|
| `resources.requests` | Specify resource requests which the container needs to spawn. | `{}` |
|
|
| `serviceAccount.create` | Create a serviceAccount for the pod | `true` |
|
|
| `serviceAccount.name` | Use the serviceAccount with the specified name | `""` |
|
|
| `tolerations` | Tolerations for pod assignment | `[]` |
|
|
| `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template). | `nil` |
|
|
|
|
### Kubernetes Event Exporter parameters
|
|
|
|
| Parameter | Description | Default |
|
|
|-----------------------|------------------------------------------------------------------------------|-----------------------------------------------------------|
|
|
| `config.logFormat` | How the logs are formatted. Allowed values: `pretty` or `json` | `pretty` |
|
|
| `config.logLevel` | Verbosity of the logs (options: `fatal`, `error`, `warn`, `info` or `debug`) | `debug` |
|
|
| `config.receivers` | Array containing event receivers | `[ {"name": "dump", "file": { "path": "/dev/stdout" }} ]` |
|
|
| `config.route.routes` | Array containing event route configuration | `[ {"match": [ {"receiver": "dumps"} ]} ]` |
|
|
|
|
## Configuration and installation details
|
|
|
|
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
|
|
|
|
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
|
|
|
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|