Skip to content

Commit

Permalink
update params table (#2468)
Browse files Browse the repository at this point in the history 
* update params table

* Update fluentd-helm.md (#2469)

---------

Co-authored-by: tamirmich <tamir.michaeli@logz.io>
  • Loading branch information
@mirii1994 @tamir-michaeli
mirii1994 and tamir-michaeli committed Sep 26, 2023
1 parent a960cfe commit 25a084b
Showing 1 changed file with 52 additions and 3 deletions.
55 changes: 52 additions & 3 deletions _source/logzio_collections/_log-sources/fluentd-helm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ helm install -n monitoring \
| Parameter | Description | Default |
|---|---|---|
| `image` | The logzio-fluentd docker image. | `logzio/logzio-fluentd` |
| `imageTag` | The logzio-fluentd docker image tag. | `1.0.1` |
| `imageTag` | The logzio-fluentd docker image tag. | `1.4.0` |
| `nameOverride` | Overrides the Chart name for resources. | `""` |
| `fullnameOverride` | Overrides the full name of the resources. | `""` |
| `apiVersions.daemonset` | Daemonset API version. | `apps/v1` |
Expand All @@ -128,12 +128,15 @@ helm install -n monitoring \
| `apiVersions.configmap` | Configmap API version. | `v1` |
| `apiVersions.secret` | Secret API version. | `v1` |
| `namespace` | Chart's namespace. | `monitoring` |
| `fargateLogRouter.enabled` | Boolen to decide if to configure fargate log router | `false` |
| `env_id` | Add to your logs field `env_id` with identification of the environment you're shipping logs from. | `""` |
| `isRBAC` | Specifies whether the Chart should be compatible to a RBAC cluster. If you're running on a non-RBAC cluster, set to `false`. | `true` |
| `serviceAccount.name` | Name of the service account. | `""` |
| `daemonset.tolerations` | Set [tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for all DaemonSet pods. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `daemonset.nodeSelector` | Set [nodeSelector](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for all DaemonSet pods. | `{}` |
| `daemonset.affinity` | Set [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) rules for the scheduler to determine where all DaemonSet pods can be placed. | |
| `daemonset.fluentdSystemdConf` | Controls whether Fluentd system messages will be enabled. | `disable` |
| `daemonset.fluentdPrometheusConf` | Controls the launch of a prometheus plugin that monitors Fluentd. | `disable` |
| `daemonset.fluentdPrometheusConf` | Controls the launch of a prometheus plugin that monitors Fluentd. | `false` |
| `daemonset.includeNamespace` | Use if you wish to send logs from specific k8s namespaces, space delimited. Should be in the following format: `kubernetes.var.log.containers.**_<<NAMESPACE-TO-INCLUDE>>_** kubernetes.var.log.containers.**_<<ANOTHER-NAMESPACE>>_**`. | `""` |
| `daemonset.kubernetesVerifySsl` | Enables to validate SSL certificates. | `true` |
| `daemonset.auditLogFormat` | Match Fluentd's format for kube-apiserver audit logs. Set to `audit-json` if your audit logs are in json format. | `audit` |
Expand All @@ -149,15 +152,47 @@ helm install -n monitoring \
| `daemonset.logzioRetryForever` | If true, plugin will retry flushing forever | `true` |
| `daemonset.logzioFlushThreadCount` | Number of threads to flush the buffer. | `2` |
| `daemonset.logzioLogLevel` | The log level for this container. | `info` |
| `daemonset.excludeFluentdPath` | Path to fluentd logs file, to exclude them from the logs that Fluent tails. | `/var/log/containers/*fluentd*.log` |
| `daemonset.extraExclude` | A comma-seperated list (no spaces), of more paths to exclude from the Fluentd source that tails containers logs. For example - /path/one.log,/path/two.log | `""` |
| `daemonset.containersPath` | Path for containers logs. | `"/var/log/containers/*.log"` |
| `daemonset.logType` | Set log type for the logs. | `"k8s"` |
| `daemonset.extraEnv` | If needed, more env vars can be added with this field. | `[]` |
| `daemonset.resources` | Allows you to set the resources for Fluentd Daemonset. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `daemonset.extraVolumeMounts` | If needed, more volume mounts can be added with this field. | `[]` |
| `daemonset.terminationGracePeriodSeconds` | Termination period (in seconds) to wait before killing Fluentd pod process on pod shutdown. | `30` |
| `daemonset.extraVolumes` | If needed, more volumes can be added with this field. | `[]` |
| `daemonset.init.extraVolumeMounts` | If needed, more volume mounts to the init container can be added with this field. | `[]` |
| `daemonset.init.containerImage` | Init container image for the fluentd daemonset. | `busybox` |
| `daemonset.priorityClassName` | Set [priorityClassName](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/) for all DaemonSet pods. | `""` |
| `windowsDaemonset.kubernetesVerifySsl` | Enables to validate SSL certificates (windows). | `true` |
| `windowsDaemonset.auditLogFormat` | Match Fluentd's format for kube-apiserver audit logs. Set to `audit-json` if your audit logs are in json format. (windows) | `audit` |
| `windowsDaemonset.containerdRuntime` | **Deprecated from chart version 0.1.0.** Determines whether to use a configuration for a Containerd runtime. Set to `false` if your cluster doesn't use Containerd as CRI. (windows) | `true` |
| `windowsDaemonset.cri` | Container runtime interface of the cluster. Used to determine which configuration to use when concatenating partial logs (windows). Valid options are: `docker`, `containerd`. | `containerd` |
| `windowsDaemonset.logzioBufferType` | Specifies which plugin to use as the backend. | `file` |
| `windowsDaemonset.logzioBufferPath` | Path of the buffer. (windows) | `/var/log/fluentd-buffers/stackdriver.buffer` |
| `windowsDaemonset.logzioOverflowAction` | Controls the behavior when the queue becomes full. (windows) | `block` |
| `windowsDaemonset.logzioChunkLimitSize` | Maximum size of a chunk allowed. (windows) | `2M` |
| `windowsDaemonset.logzioQueueLimitLength` | Maximum length of the output queue. (windows) | `6` |
| `windowsDaemonset.logzioFlushInterval` | Interval, in seconds, to wait before invoking the next buffer flush. (windows) | `5s` |
| `windowsDaemonset.logzioRetryMaxInterval` | Maximum interval, in seconds, to wait between retries. (windows) | `30` |
| `windowsDaemonset.logzioRetryForever` | If true, plugin will retry flushing forever (windows) | `true` |
| `windowsDaemonset.logzioFlushThreadCount` | Number of threads to flush the buffer. (windows) | `2` |
| `windowsDaemonset.logzioLogLevel` | The log level for this container. (windows) | `info` |
| `windowsDaemonset.excludeFluentdPath` | Path to fluentd logs file, to exclude them from the logs that Fluent tails. | `/var/log/containers/*fluentd*.log` |
| `windowsDaemonset.extraExclude` | A comma-seperated list (no spaces), of more paths to exclude from the Fluentd source that tails containers logs. For example - /path/one.log,/path/two.log | `""` |
| `windowsDaemonset.containersPath` | Path for containers logs. | `"/var/log/containers/*.log"` |
| `windowsDaemonset.extraEnv` | If needed, more env vars can be added with this field. (windows) | `[]` |
| `windowsDaemonset.resources` | Allows you to set the resources for Fluentd Daemonset. (windows) | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `windowsDaemonset.extraVolumeMounts` | If needed, more volume mounts can be added with this field. (windows) | `[]` |
| `daemonset.terminationGracePeriodSeconds` | Termination period (in seconds) to wait before killing Fluentd pod process on pod shutdown. | `30` |
| `windowsDaemonset.extraVolumes` | If needed, more volumes can be added with this field. (windows) | `[]` |
| `windowsDaemonset.priorityClassName` | Set [priorityClassName](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/) for all DaemonSet pods. (windows) | `""` |
| `clusterRole.rules` | Configurable [cluster role rules](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole) that Fluentd uses to access Kubernetes resources. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `secrets.logzioShippingToken` | Secret with your [logzio shipping token](https://app.logz.io/#/dashboard/settings/general). | `""` |
| `secrets.logzioListener` | Secret with your logzio listener host. `listener.logz.io`. | `" "` |
| `secrets.customEndpoint` | Secret with your custom endpoint, for example:`http://endpoint:8080`. Overrides `secrets.logzioListener` | `""` |
| `secrets.enabled` | When `true`, the logzio secret will be created and managed by this Chart. If you're managing the logzio secret by yourself, set to `false`. | `true` |
| `secretName` | Name of the secret in case it's placed from an external source. | `logzio-logs-secret` |
| `configMapIncludes` | Initial includes for `fluent.conf`. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `configmap.extraConfig` | If needed, more Fluentd configuration can be added with this field. | `{}` |
| `configmap.fluent` | Configuration for `fluent.conf`. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
Expand All @@ -169,7 +204,11 @@ helm install -n monitoring \
| `configmap.partialContainerd` | Configuration for `partial-containerd.conf`. Used to concatenate partial logs that split due to large size, for containerd cri. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `configmap.audit` | Configuration for `audit.conf`. | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `configmap.auditJson` | Configuration for `audit-json.conf`. This is the configuration that's being used when `daemonset.auditLogFormat` is set to `audit-json` | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `logLevelFilter` | Add log level filter. Regex of the log level(s) you want to ship. For example, if you want to ship warning and error logs, use `WARNING|ERROR`. Possible levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `TRACE`. | `""` |
| `configmap.envId` | Config snippet for adding `env_id` field to logs | See [values.yaml](https://github.com/logzio/logzio-helm/blob/master/charts/fluentd/values.yaml). |
| `configmap.customSources` | Add sources to the Fluentd configuration | `""` |
| `configmap.customFilters` | Add filters to the Fluentd configuration | `""` |
| `configmap.customFilterAfter` | Add filters to the Fluentd configuration, after default filters | `""` |
| `logLevelFilter` | Add log level filter. Regex of the log level(s) you want to ship. For example, if you want to ship warning and error logs, use `WARNING\|ERROR`. Possible levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `TRACE`. | `""` |

**Note:** If you're adding your own configuration file via `configmap.extraConfig`:
- Add a `--set-file` flag to your `helm install` command, as seen in the [example above](https://github.com/logzio/logzio-helm/tree/master/charts/fluentd#configuration).
Expand Down Expand Up @@ -207,6 +246,16 @@ Will result with the following log (json):
}
```

## Fluentd images for windows server
By default the fluentd image for windows-server supports windows server 2019.
If needed, the fluentd image can be changed to support windows server 2022 with the following commands:

```yaml
--set windowsImage=logzio/fluentd-windows-2022 \
--set windowsImageTag=0.0.1
```


#### Uninstalling the Chart

The command removes all the k8s components associated with the chart and deletes the release.
Expand Down

0 comments on commit 25a084b

Please sign in to comment.