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):

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.3.0"

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

retention

Description: Logs retention period.To deactivate retention, pass 0s.

Type: string

Default: "30d"

Outputs

The following outputs are exported:

id

Description: ID to pass other modules in order to refer to this module as a dependency.

loki_credentials

Description: Credentials to access the Loki ingress, if activated. = Requirements

Name Version

argocd

>= 4

htpasswd

>= 1

null

>= 3

random

>= 3

utils

>= 1

Modules

Name Source Version

loki-stack

Inputs

Name Description Type Default Required

logs_storage

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

argocd_namespace

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

string

"argocd"

no

target_revision

Override of target revision of the application chart.

string

"v2.3.0"

no

namespace

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_values

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

any

[]

no

app_autosync

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

dependency_ids

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

map(string)

{}

no

distributed_mode

Boolean to activate Loki in distributed mode.

bool

false

no

ingress

Loki frontend ingress configuration.

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

null

no

enable_filebeat

n/a

bool

false

no

retention

Logs retention period.To deactivate retention, pass 0s.

string

"30d"

no

Outputs

Name Description

id

ID to pass other modules in order to refer to this module as a dependency.

loki_credentials

Credentials to access the Loki ingress, if activated.