Requirements

The following requirements are needed by this module:

Modules

The following Modules are called:

loki-stack

Source: ../

Version:

Required Inputs

The following input variables are required:

logs_storage

Description: AWS S3 bucket configuration values for the bucket where the logs will be stored.

Type:

object({
    bucket_id    = string
    region       = string
    iam_role_arn = string
  })

Optional Inputs

The following input variables are optional (have default values):

cluster_name

Description: Name given to the cluster. Value used for the ingress' URL of the application.

Type: string

Default: null

base_domain

Description: Base domain of the cluster. Value used for the ingress' URL of the application.

Type: string

Default: null

argocd_namespace

Description: Namespace used by Argo CD where the Application and AppProject resources should be created.

Type: string

Default: "argocd"

target_revision

Description: Override of target revision of the application chart.

Type: string

Default: "v2.0.2"

namespace

Description: Namespace where the applications’s Kubernetes resources should be created. Namespace will be created in case it doesn’t exist.

Type: string

Default: "loki-stack"

helm_values

Description: Helm chart value overrides. They should be passed as a list of HCL structures.

Type: any

Default: []

app_autosync

Description: Automated sync options for the Argo CD Application resource.

Type:

object({
    allow_empty = optional(bool)
    prune       = optional(bool)
    self_heal   = optional(bool)
  })

Default:

{
  "allow_empty": false,
  "prune": true,
  "self_heal": true
}

dependency_ids

Description: IDs of the other modules on which this module depends on.

Type: map(string)

Default: {}

distributed_mode

Description: Boolean to activate Loki in distributed mode.

Type: bool

Default: false

ingress

Description: Loki frontend ingress configuration.

Type:

object({
    hosts          = list(string)
    cluster_issuer = string
    allowed_ips    = optional(list(string), [])
  })

Default: null

enable_filebeat

Description: n/a

Type: bool

Default: false

ingester_config

Description: Configuration of ingester to have more replicas

Type:

object({
    replicas       = number
    maxUnavailable = number
  })

Default:

{
  "maxUnavailable": null,
  "replicas": 1
}

Outputs

The following outputs are exported:

id

Description: ID to pass other modules in order to refer to this module as a dependency. It takes the ID that comes from the main module and passes it along to the code that called this variant in the first place.

loki_credentials

Description: n/a = Requirements

Name Version

>= 4

>= 1

>= 3

>= 3

>= 1

Modules

Name Source Version

Inputs

Name Description Type Default Required

AWS S3 bucket configuration values for the bucket where the logs will be stored.

object({
    bucket_id    = string
    region       = string
    iam_role_arn = string
  })

n/a

yes

Name given to the cluster. Value used for the ingress' URL of the application.

string

null

no

Base domain of the cluster. Value used for the ingress' URL of the application.

string

null

no

Namespace used by Argo CD where the Application and AppProject resources should be created.

string

"argocd"

no

Override of target revision of the application chart.

string

"v2.0.2"

no

Namespace where the applications’s Kubernetes resources should be created. Namespace will be created in case it doesn’t exist.

string

"loki-stack"

no

Helm chart value overrides. They should be passed as a list of HCL structures.

any

[]

no

Automated sync options for the Argo CD Application resource.

object({
    allow_empty = optional(bool)
    prune       = optional(bool)
    self_heal   = optional(bool)
  })
{
  "allow_empty": false,
  "prune": true,
  "self_heal": true
}

no

IDs of the other modules on which this module depends on.

map(string)

{}

no

Boolean to activate Loki in distributed mode.

bool

false

no

Loki frontend ingress configuration.

object({
    hosts          = list(string)
    cluster_issuer = string
    allowed_ips    = optional(list(string), [])
  })

null

no

n/a

bool

false

no

Configuration of ingester to have more replicas

object({
    replicas       = number
    maxUnavailable = number
  })
{
  "maxUnavailable": null,
  "replicas": 1
}

no

Outputs

Name Description

id

ID to pass other modules in order to refer to this module as a dependency. It takes the ID that comes from the main module and passes it along to the code that called this variant in the first place.

n/a