terraform-container-fluentbit

Terraform module to generate well-formed JSON documents that are passed to the aws_ecs_task_definition Terraform resource as container definitions.

Usage

IMPORTANT: The main branch is used in source just as an example. In your code, do not pin to main because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

This module is meant to be used as output only, meaning it will be used to create outputs which are consumed as a parameter by Terraform resources or other modules.

For complete examples, see

complete

For a complete example with automated tests, see examples/complete with bats and Terratest for the example test.

module "fluentbit_container" {
  # this can and should be pinned to a release tag using ?ref=tags/x.y.z
  source = "git::https://github.com/AdRoll/terraform-container-fluentbit.git?ref=main"
}

module "task" {
  source = "git::https://github.com/cloudposse/terraform-aws-ecs-alb-service-task.git?ref=tags/0.31.0"

  name = local.container_name

  container_definition_json = jsonencode([
    module.fluentbit_container.json_map,
  ])

  # ...
}

To build the README.md, use either

direnv to load the environment variable and run

make init
make readme

make init
README_TEMPLATE_FILE=docs/README.md.gotmpl make readme

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen

Requirements

Name	Version
terraform	~> 0.12.0
local	~> 1.2

Providers

Name	Version
aws	n/a

Inputs

Name	Description	Type	Default	Required
command	The command that is passed to the container	`list(string)`	`null`	no
container_cpu	The number of cpu units to reserve for the container. This is optional for tasks using Fargate launch type and the total amount of container_cpu of all containers in a task will need to be lower than the task-level cpu value	`number`	`64`	no
container_definition	Container definition overrides which allows for extra keys or overriding existing keys.	`map`	`{}`	no
container_depends_on	The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. The condition can be one of START, COMPLETE, SUCCESS or HEALTHY	list(object({ containerName = string condition = string }))	`null`	no
container_image	The image used to start the container. Images in the Docker Hub registry available by default	`string`	`""`	no
container_memory	The amount of memory (in MiB) to allow the container to use. This is a hard limit, if the container attempts to exceed the container_memory, the container is killed. This field is optional for Fargate launch type and the total amount of container_memory of all containers in a task will need to be lower than the task memory value	`number`	`64`	no
container_memory_reservation	The amount of memory (in MiB) to reserve for the container. If container needs to exceed this threshold, it can do so up to the set container_memory hard limit	`number`	`null`	no
container_name	The name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed)	`string`	`"log_router"`	no
dns_search_domains	Container DNS search domains. A list of DNS search domains that are presented to the container	`list(string)`	`null`	no
dns_servers	Container DNS servers. This is a list of strings specifying the IP addresses of the DNS servers	`list(string)`	`null`	no
docker_labels	The configuration options to send to the `docker_labels`	`map(string)`	`null`	no
entrypoint	The entry point that is passed to the container	`list(string)`	`null`	no
environment_files	One or more files containing the environment variables to pass to the container. This maps to the --env-file option to docker run. The file must be hosted in Amazon S3. This option is only available to tasks using the EC2 launch type. This is a list of maps	list(object({ value = string type = string }))	`null`	no
essential	Determines whether all other containers in a task are stopped, if this container fails or stops for any reason. Due to how Terraform type casts booleans in json it is required to double quote this value	`bool`	`true`	no
extra_hosts	A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This is a list of maps	list(object({ ipAddress = string hostname = string }))	`null`	no
firelens_configuration	The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FirelensConfiguration.html	object({ type = string options = map(string) })	{ "options": { "config-file-type": "file", "config-file-value": "/fluent-bit/configs/parse-json.conf", "enable-ecs-log-metadata": true }, "type": "fluentbit" }	no
healthcheck	A map containing command (string), timeout, interval (duration in seconds), retries (1-10, number of times to retry before marking container unhealthy), and startPeriod (0-300, optional grace period to wait, in seconds, before failed healthchecks count toward retries)	object({ command = list(string) retries = number timeout = number interval = number startPeriod = number })	{ "command": [ "CMD-SHELL", "[[ $(pgrep fluent-bit	wc -l) = 1 ]]
links	List of container names this container can communicate with without port mappings	`list(string)`	`null`	no
linux_parameters	Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LinuxParameters.html	object({ capabilities = object({ add = list(string) drop = list(string) }) devices = list(object({ containerPath = string hostPath = string permissions = list(string) })) initProcessEnabled = bool maxSwap = number sharedMemorySize = number swappiness = number tmpfs = list(object({ containerPath = string mountOptions = list(string) size = number })) })	`null`	no
log_configuration	Log configuration options to send to a custom log driver for the container. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html	`any`	`null`	no
logging_group_name	If logging to cloudwatch, this will be the cloudwatch log group name	`string`	`""`	no
map_environment	The environment variables to pass to the container. This is a map of string: {key: value}, environment override map_environment	`map(string)`	`{}`	no
mount_points	Container mount points. This is a list of maps, where each map should contain a `containerPath` and `sourceVolume`. The `readOnly` key is optional.	`list`	`[]`	no
port_mappings	The port mappings to configure for the container. This is a list of maps. Each map should contain "containerPort", "hostPort", and "protocol", where "protocol" is one of "tcp" or "udp". If using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort	list(object({ containerPort = number hostPort = number protocol = string }))	`[]`	no
privileged	When this variable is `true`, the container is given elevated privileges on the host container instance (similar to the root user). This parameter is not supported for Windows containers or tasks using the Fargate launch type.	`bool`	`null`	no
readonly_root_filesystem	Determines whether a container is given read-only access to its root filesystem. Due to how Terraform type casts booleans in json it is required to double quote this value	`bool`	`false`	no
repository_credentials	Container repository credentials; required when using a private repo. This map currently supports a single key; "credentialsParameter", which should be the ARN of a Secrets Manager's secret holding the credentials	`map(string)`	`null`	no
secrets	The secrets to pass to the container. This is a list of maps	list(object({ name = string valueFrom = string }))	`null`	no
start_timeout	Time duration (in seconds) to wait before giving up on resolving dependencies for a container	`number`	`null`	no
stop_timeout	Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own	`number`	`null`	no
system_controls	A list of namespaced kernel parameters to set in the container, mapping to the --sysctl option to docker run. This is a list of maps: { namespace = "", value = ""}	`list(map(string))`	`null`	no
ulimits	Container ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit"	list(object({ name = string hardLimit = number softLimit = number }))	`null`	no
user	The user to run as inside the container. Can be any of these formats: user, user:group, uid, uid:gid, user:gid, uid:group. The default (null) will use the container's configured `USER` directive or root if not set.	`string`	`null`	no
volumes_from	A list of VolumesFrom maps which contain "sourceContainer" (name of the container that has the volumes to mount) and "readOnly" (whether the container can write to the volume)	list(object({ sourceContainer = string readOnly = bool }))	`[]`	no
working_directory	The working directory to run commands inside the container	`string`	`null`	no

Outputs

Name	Description
json	String type of container definition
json_map	Map type of container definition

Related Projects

Check out these related projects.

terraform-aws-ecs-container-definition - Terraform module to generate well-formed JSON documents (container definitions) that are passed to the aws_ecs_task_definition Terraform resource

classicvalues / terraform-container-fluentbit Goto Github PK