README.adoc

Requirements

The following requirements are needed by this module:

• argocd (>= 6)

• htpasswd (>= 1)

• null (>= 3)

• random (>= 3)

• utils (>= 1)

Providers

The following providers are used by this module:

• null (>= 3)

• random (>= 3)

• htpasswd (>= 1)

• argocd (>= 6)

• utils (>= 1)

Resources

The following resources are used by this module:

• argocd_application.this (resource)

• argocd_project.this (resource)

• htpasswd_password.loki_password_hash (resource)

• null_resource.dependencies (resource)

• null_resource.this (resource)

• random_password.loki_password (resource)

• utils_deep_merge_yaml.values (data source)

Optional Inputs

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

argocd_project

Description: Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.

Type: string

Default: null

argocd_labels

Description: Labels to attach to the Argo CD Application resource.

Type: map(string)

Default: {}

destination_cluster

Description: Destination cluster where the application should be deployed.

Type: string

Default: "in-cluster"

target_revision

Description: Override of target revision of the application chart.

Type: string

Default: "v10.0.0"

enable_service_monitor

Description: Enable Prometheus ServiceMonitor in the Helm chart.

Type: bool

Default: true

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: {}

resources

Description: Resource limits and requests for Loki’s components. Follow the style on official documentation to understand the format of the values.

Important

These are not production values. You should always adjust them to your needs.

Type:

object({

    ingester = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    distributor = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    querier = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    query_frontend = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    query_scheduler = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    compactor = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "512Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "1Gi")
      }), {})
    }), {})

    index_gateway = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "1Gi")
      }), {})
    }), {})

    memcached_chunks = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    memcached_frontend = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    memcached_index_queries = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    memcached_index_writes = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})

    promtail = optional(object({
      requests = optional(object({
        cpu    = optional(string, "100m")
        memory = optional(string, "256Mi")
      }), {})
      limits = optional(object({
        cpu    = optional(string)
        memory = optional(string, "512Mi")
      }), {})
    }), {})
  })

Default: {}

ingress

Description: Loki frontend ingress configuration.

Type:

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

Default: null

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	>= 6
htpasswd	>= 1
null	>= 3
random	>= 3
utils	>= 1

Providers

Name	Version
null	>= 3
random	>= 3
htpasswd	>= 1
argocd	>= 6
utils	>= 1

Resources

Name	Type
argocd_application.this	resource
argocd_project.this	resource
htpasswd_password.loki_password_hash	resource
null_resource.dependencies	resource
null_resource.this	resource
random_password.loki_password	resource
utils_deep_merge_yaml.values	data source

Inputs

Name	Description	Type	Default	Required
argocd_project	Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.	string	null	no
argocd_labels	Labels to attach to the Argo CD Application resource.	map(string)	{}	no
destination_cluster	Destination cluster where the application should be deployed.	string	"in-cluster"	no
target_revision	Override of target revision of the application chart.	string	"v10.0.0"	no
enable_service_monitor	Enable Prometheus ServiceMonitor in the Helm chart.	bool	true	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
resources	Resource limits and requests for Loki’s components. Follow the style on official documentation to understand the format of the values. Important These are not production values. You should always adjust them to your needs.	object({ ingester = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) distributor = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) querier = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) query_frontend = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) query_scheduler = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) compactor = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "512Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "1Gi") }), {}) }), {}) index_gateway = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "1Gi") }), {}) }), {}) memcached_chunks = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) memcached_frontend = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) memcached_index_queries = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) memcached_index_writes = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) promtail = optional(object({ requests = optional(object({ cpu = optional(string, "100m") memory = optional(string, "256Mi") }), {}) limits = optional(object({ cpu = optional(string) memory = optional(string, "512Mi") }), {}) }), {}) })	{}	no
ingress	Loki frontend ingress configuration.	object({ hosts = list(string) cluster_issuer = string allowed_ips = optional(list(string), []) })	null	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.