devops-stack-module-template

A DevOps Stack module to deploy something.

The something chart used by this module is shipped in this repository as well, in order to avoid any unwanted behaviors caused by unsupported versions.

Current Chart Version	Original Repository	Default Values
1.2.3	Chart	values.yaml (here you can also use artifacthub.io)

Usage

Here you will show examples of how to call this module on your code. Note that the depends_on needs to be adapted to your use case.

You can start by giving a simple example and then show some others with increasing complexity and/or for specific use cases.

module "template" {
  source = "git::https://github.com/camptocamp/devops-stack-module-template.git?ref=<RELEASE>"

  cluster_name            = local.cluster_name
  argocd_namespace        = local.argocd_namespace

  dependency_ids = {
    argocd = module.argocd_bootstrap.id
  }
}

Something Explained Better

If there is some part of the module’s configuration that needs more specific explanations, such as a very particular output on which every other module depends on, maybe consider creating a subsection to improve readability.

Note	The AsciiDoc syntax provides a way to write admonitions such as this one, so use it if you think it is useful. The official documentation for Antora Docs provides more examples.

Technical Reference

This section will contain the more technical details of the module. It is mainly generated automatically by Terraform Docs (everything that is between the comments BEGIN_TF_DOCS / END_TF_DOCS). However, it is recommended to, at the bare minimum, add a dependencies section to explain the reason on why this module could depend on another one from the DevOps Stack.

You can safely delete the content between the comments BEGIN_TF_DOCS / END_TF_DOCS and BEGIN_TF_TABLES / END_TF_TABLES when creating your on module.

Dependencies

module.argocd_bootstrap

This module must be one of the first ones to be deployed and consequently it needs to be deployed after the module argocd_bootstrap.

Requirements

The following requirements are needed by this module:

• argocd (>= 6)

• null (>= 3)

• utils (>= 1)

Providers

The following providers are used by this module:

• utils (>= 1)

• argocd (>= 6)

• null (>= 3)

Resources

The following resources are used by this module:

• argocd_application.this (resource)

• argocd_project.this (resource)

• null_resource.dependencies (resource)

• null_resource.this (resource)

• utils_deep_merge_yaml.values (data source)

Required Inputs

The following input variables are required:

cluster_name

Description: Name given to the cluster. Value used for naming some the resources created by the module.

Type: string

base_domain

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

Type: string

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: "v1.0.0"

cluster_issuer

Description: SSL certificate issuer to use. Usually you would configure this value as letsencrypt-staging or letsencrypt-prod on your root *.tf files.

Type: string

Default: "selfsigned-issuer"

helm_values

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

Type: any

Default: []

deep_merge_append_list

Description: A boolean flag to enable/disable appending lists instead of overwriting them.

Type: bool

Default: false

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

Outputs

The following outputs are exported:

id

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

Reference in table format

Show tables

= Requirements

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

= Providers

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

= Resources

Name	Type
argocd_application.this	resource
argocd_project.this	resource
null_resource.dependencies	resource
null_resource.this	resource
utils_deep_merge_yaml.values	data source

= Inputs

Name	Description	Type	Default	Required
cluster_name	Name given to the cluster. Value used for naming some the resources created by the module.	string	n/a	yes
base_domain	Base domain of the cluster. Value used for the ingress' URL of the application.	string	n/a	yes
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	"v1.0.0"	no
cluster_issuer	SSL certificate issuer to use. Usually you would configure this value as letsencrypt-staging or letsencrypt-prod on your root *.tf files.	string	"selfsigned-issuer"	no
helm_values	Helm chart value overrides. They should be passed as a list of HCL structures.	any	[]	no
deep_merge_append_list	A boolean flag to enable/disable appending lists instead of overwriting them.	bool	false	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

= Outputs

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