forked from helm/charts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README.md to fluentd (helm#11182)
Signed-off-by: Maxime Guyot <[email protected]>
- Loading branch information
1 parent
14c70d8
commit 762526e
Showing
3 changed files
with
84 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ apiVersion: v1 | |
description: A Fluentd Elasticsearch Helm chart for Kubernetes. | ||
icon: https://raw.githubusercontent.com/fluent/fluentd-docs/master/public/logo/Fluentd_square.png | ||
name: fluentd | ||
version: 1.5.0 | ||
version: 1.5.1 | ||
appVersion: v2.3.1 | ||
home: https://www.fluentd.org/ | ||
sources: | ||
|
@@ -13,3 +13,5 @@ sources: | |
maintainers: | ||
- name: rendhalver | ||
email: [email protected] | ||
- name: miouge1 | ||
email: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
approvers: | ||
- rendhalver | ||
- miouge1 | ||
reviewers: | ||
- rendhalver | ||
- miouge1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# fluentd | ||
|
||
[Fluentd](https://www.fluentd.org/) collects events from various data sources and writes them to files, RDBMS, NoSQL, IaaS, SaaS, Hadoop and so on. Fluentd helps you unify your logging infrastructure (Learn more about the Unified Logging Layer). | ||
|
||
## TL;DR; | ||
|
||
```console | ||
$ helm install stable/fluentd | ||
``` | ||
|
||
## Introduction | ||
|
||
This chart bootstraps an fluentd deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. | ||
|
||
## Installing the Chart | ||
|
||
To install the chart with the release name `my-release`: | ||
|
||
```console | ||
$ helm install stable/fluentd --name my-release | ||
``` | ||
|
||
The command deploys fluentd on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. | ||
|
||
## 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. | ||
|
||
## Configuration | ||
|
||
The following table lists the configurable parameters of the fluentd chart and their default values. | ||
|
||
Parameter | Description | Default | ||
--- | --- | --- | ||
`affinity` | node/pod affinities | `{}` | ||
`configMaps` | Fluentd configuration | See [values.yaml](values.yaml) | ||
`output.host` | output host | `elasticsearch-client.default.svc.cluster.local` | ||
`output.port` | output port | `9200` | ||
`output.scheme` | output port | `http` | ||
`output.sslVersion` | output ssl version | `TLSv1` | ||
`output.buffer_chunk_limit` | output buffer chunk limit | `2M` | ||
`output.buffer_queue_limit` | output buffer queue limit | `8` | ||
`service.type` | type of service | `ClusterIP` | ||
`image.pullPolicy` | Image pull policy | `IfNotPresent` | ||
`image.repository` | Image repository | `gcr.io/google-containers/fluentd-elasticsearch` | ||
`image.tag` | Image tag | `v2.3.1` | ||
`imagePullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods) | ||
`ingress.enabled` | enable ingress | `false` | ||
`nodeSelector` | node labels for pod assignment | `{}` | ||
`replicaCount` | desired number of pods | `1` ??? | ||
`resources` | pod resource requests & limits | `{}` | ||
`priorityClassName` | priorityClassName | `nil` | ||
`service.port` | port for the service | `80` | ||
`service.type` | type of service | `ClusterIP` | ||
`tolerations` | List of node taints to tolerate | `[]` | ||
`persistence.enabled` | Enable buffer persistence | `false` | ||
`persistence.accessMode` | Access mode for buffer persistence | `ReadWriteOnce` | ||
`persistence.size` | Volume size for buffer persistence | `10Gi` | ||
|
||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, | ||
|
||
```console | ||
$ helm install stable/fluentd --name my-release \ | ||
--set=image.tag=v0.0.2,resources.limits.cpu=200m | ||
``` | ||
|
||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, | ||
|
||
```console | ||
$ helm install stable/fluentd --name my-release -f values.yaml | ||
``` | ||
|
||
> **Tip**: You can use the default [values.yaml](values.yaml) |