Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sparkfabrik/terraform-helm-fluentbit

This module installs FluentBit on Amazon EKS and create the necessary resources to send logs to CloudWatch.
https://github.com/sparkfabrik/terraform-helm-fluentbit

aws aws-eks cloudwatch eks helm helm-chart infrastructure-as-code kubernetes terraform-module

Last synced: about 9 hours ago
JSON representation

This module installs FluentBit on Amazon EKS and create the necessary resources to send logs to CloudWatch.

Host: GitHub
URL: https://github.com/sparkfabrik/terraform-helm-fluentbit
Owner: sparkfabrik
License: gpl-3.0
Created: 2024-05-09T10:17:55.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-09-20T15:28:04.000Z (4 days ago)
Last Synced: 2024-09-23T04:03:00.453Z (2 days ago)
Topics: aws, aws-eks, cloudwatch, eks, helm, helm-chart, infrastructure-as-code, kubernetes, terraform-module
Language: HCL
Homepage:
Size: 35.2 KB
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # FluentBit installation on Amazon EKS

This module installs FluentBit on Amazon EKS and create the necessary resources to send logs to CloudWatch.

It also opinionatedly configures FluentBit to send logs to CloudWatch and to exclude some log files from the application log group and include some log files in the platform log group. You can customize this behavior by using the dedicated variables.

## Providers

| Name | Version |

|------|---------|

|  [helm](#provider\_helm) | >= 2.0 |

|  [kubernetes](#provider\_kubernetes) | >= 2.23 |

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.0 |

|  [helm](#requirement\_helm) | >= 2.0 |

|  [kubernetes](#requirement\_kubernetes) | >= 2.23 |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_exclude\_from\_application\_log\_group](#input\_additional\_exclude\_from\_application\_log\_group) | List of additional log files to exclude from the application log group. The element of this list will be prefixed with `/var/log/containers/` and suffixed with `*.log`. | `list(string)` | `[]` | no |

|  [additional\_filters](#input\_additional\_filters) | Filter block(s) to add to the FluentBit configuration. The filter block(s) must be in the format of a string. | `string` | `""` | no |

|  [additional\_include\_in\_platform\_log\_group](#input\_additional\_include\_in\_platform\_log\_group) | List of additional log files to include in the platform log group. The element of this list will be prefixed with `/var/log/containers/` and suffixed with `*.log`. | `list(string)` | `[]` | no |

|  [application\_log\_retention\_days](#input\_application\_log\_retention\_days) | The retention period for the application log group. Remember to check the valid values for the retention period in the AWS CloudWatch documentation. | `number` | `30` | no |

|  [aws\_fluentbit\_role\_name](#input\_aws\_fluentbit\_role\_name) | The name of the IAM role for FluentBit. | `string` | `"fluentbit"` | no |

|  [aws\_region](#input\_aws\_region) | The AWS region used to send logs to CloudWatch. | `string` | n/a | yes |

|  [cluster\_name](#input\_cluster\_name) | The name of the EKS cluster. | `string` | n/a | yes |

|  [cluster\_oidc\_issuer\_host](#input\_cluster\_oidc\_issuer\_host) | The OIDC issuer host for the EKS cluster. | `string` | n/a | yes |

|  [default\_additional\_include\_in\_platform\_log\_group](#input\_default\_additional\_include\_in\_platform\_log\_group) | List of log files to include in the platform log group. This list is intended for the log files of the system AWS EKS applications, use the variable `additional_include_in_platform_log_group` to include custom log files. The element of this list will be prefixed with `/var/log/containers/` and suffixed with `*.log`. | `list(string)` | 
[
  "ebs-csi-controller",
  "ebs-csi-node",
  "efs-csi-controller",
  "efs-csi-node"
] | no |

|  [default\_exclude\_from\_application\_log\_group](#input\_default\_exclude\_from\_application\_log\_group) | List of log files to exclude from the application log group. This list is intended for the log files of the system AWS EKS applications, use the variable `additional_exclude_from_application_log_group` to exclude custom log files. The element of this list will be prefixed with `/var/log/containers/` and suffixed with `*.log`. | `list(string)` | [
  "aws-load-balancer-controller",
  "aws-node",
  "cluster-autoscaler-aws-cluster-autoscaler",
  "coredns",
  "ebs-csi-controller",
  "ebs-csi-node",
  "efs-csi-controller",
  "efs-csi-node",
  "kube-proxy",
  "metric-server-metrics-server"
] | no |

|  [fluentbit\_flush\_seconds](#input\_fluentbit\_flush\_seconds) | The interval in seconds to flush the logs to CloudWatch. | `number` | `15` | no |

|  [fluentbit\_http\_server\_enabled](#input\_fluentbit\_http\_server\_enabled) | Enable the HTTP server for fluentbit. | `bool` | `false` | no |

|  [fluentbit\_http\_server\_port](#input\_fluentbit\_http\_server\_port) | Port for the HTTP server. | `number` | `2020` | no |

|  [fluentbit\_log\_retention\_days](#input\_fluentbit\_log\_retention\_days) | The retention period for the FluentBit log group. Remember to check the valid values for the retention period in the AWS CloudWatch documentation. | `number` | `3` | no |

|  [fluentbit\_read\_from\_head](#input\_fluentbit\_read\_from\_head) | Start reading from the beginning of the log stream. Keep also the entries already stored. | `string` | `"Off"` | no |

|  [fluentbit\_read\_from\_tail](#input\_fluentbit\_read\_from\_tail) | Start reading new entries. Skip entries already stored. | `string` | `"On"` | no |

|  [fluentbit\_send\_fluentbit\_logs\_to\_cloudwatch](#input\_fluentbit\_send\_fluentbit\_logs\_to\_cloudwatch) | Send FluentBit logs to CloudWatch. | `bool` | `true` | no |

|  [helm\_additional\_values](#input\_helm\_additional\_values) | Additional values to be passed to the Helm chart. | `list(string)` | `[]` | no |

|  [helm\_chart\_version](#input\_helm\_chart\_version) | The version of the aws-for-fluent-bit Helm chart. | `string` | `"0.1.32"` | no |

|  [helm\_release\_name](#input\_helm\_release\_name) | The name of the Helm release. | `string` | `"fluentbit"` | no |

|  [k8s\_additional\_labels](#input\_k8s\_additional\_labels) | Additional labels to apply to the kubernetes resources. | `map(string)` | `{}` | no |

|  [k8s\_default\_labels](#input\_k8s\_default\_labels) | Labels to apply to the kubernetes resources. These are opinionated labels, you can add more labels using the variable `additional_k8s_labels`. If you want to remove a label, you can override it with an empty map(string). | `map(string)` | {
  "managed-by": "terraform",
  "scope": "fluentbit"
} | no |

|  [k8s\_fluentbit\_service\_account\_name](#input\_k8s\_fluentbit\_service\_account\_name) | The name of the Kubernetes service account for FluentBit. | `string` | `"fluentbit"` | no |

|  [namespace](#input\_namespace) | The namespace in which the Fluent Bit resources will be created. | `string` | `"amazon-cloudwatch"` | no |

|  [platform\_log\_retention\_days](#input\_platform\_log\_retention\_days) | The retention period for the platform log group. Remember to check the valid values for the retention period in the AWS CloudWatch documentation. | `number` | `14` | no |

|  [role\_policy\_arns](#input\_role\_policy\_arns) | The ARNs of the policies to attach to the IAM role. | `list(string)` | [
  "arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess",
  "arn:aws:iam::aws:policy/CloudWatchAgentServerPolicy"
]
 | no |

## Outputs

| Name | Description |

|------|-------------|

|  [final\_exclude\_from\_application\_log\_group](#output\_final\_exclude\_from\_application\_log\_group) | The final list of log files to exclude from the application log group. |

|  [final\_include\_in\_platform\_log\_group](#output\_final\_include\_in\_platform\_log\_group) | The final list of log files to include in the platform log group. |

|  [final\_k8s\_common\_labels](#output\_final\_k8s\_common\_labels) | The final list of common labels to apply to the Kubernetes resources. |

## Resources

| Name | Type |

|------|------|

| [helm_release.this](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |

| [kubernetes_namespace_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace_v1) | resource |

| [kubernetes_secret_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret_v1) | resource |

| [kubernetes_service_account_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/service_account_v1) | resource |

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [iam\_assumable\_role\_with\_oidc\_for\_fluent\_bit](#module\_iam\_assumable\_role\_with\_oidc\_for\_fluent\_bit) | terraform-aws-modules/iam/aws//modules/iam-assumable-role-with-oidc | ~> 5.0 |