Terraform module helm-deploy

This terraform module will help you deploy the helm charts on local.

• Requirements

• Remote chart deployment

• Local chart deployment

• Example Remote Chart Deployment

• Example Local Chart Deployment

• Variables

Requirements

1. Make sure you have kubectl installed and ~/.kube/config file configured
2. Make sure that terraform also installed and follows requirements

• Terraform v0.13.7
  • provider registry.terraform.io/hashicorp/helm v2.5.1
  • provider registry.terraform.io/hashicorp/local v2.2.3
  • provider registry.terraform.io/hashicorp/template v2.2.0

Remote chart deployment

Create module.tf to call the module from terraform registry, then modify it under the data section by stating your custom values as your chart needed.

module "helm_deploy" {
  source                 = "fuchicorp/chart/helm"
  remote_chart           = true                             ## Set to true for remote chart
  chart_repo             = "https://github.io/helm-charts"    ## Provide repository url
  enabled                = true                             ## Enable to deploy the chart
  deployment_name        = "example-deployment-name"          ## Release name in the namespace
  deployment_environment = "dev"                              ## Kubernetes Namespace
  deployment_path        = "example-remote-name"              ## Name of the remote chart
  release_version        = "#example chart version"           ## Version of Helm chart

## Your custom values.yaml
  remote_override_values = <<EOF
## Put here your custom values like to override the values.yaml
  replicas: 2
  EOF
  }

When you finish all the custom configurations you can start the deployment

terraform init && terraform apply

Local chart deployment

Create module.tf file to call the module from terraform registry then modify it as needed.

module "helm_deploy_local" {
  source                 = "fuchicorp/chart/helm"
  deployment_name        = "my-example-chart"                   ## Release name in the namespace
  deployment_environment = "dev"                                ## Kubernetes Namespace
  deployment_path        = "charts/my-example-chart"            ## Remote chart location
  remote_chart           = false                              ## Set to false for local chart
  enabled                = true                               ## Enable to deploy the chart
  template_custom_vars   = {
    deployment_endpoint  = "my-example-chart.domain.com"
    deployment_image     = "nginx"
    deployment_image_tag = "latest"
  }
}

Create variables in values.yaml file

image:
  repository: ${deployment_image}                                   ## nginx
  pullPolicy: IfNotPresent
  # Overrides the image's tag (default tag is the chart appVersion)
  tag: ${deployment_image_tag}                                      ## latest

ingress:
  enabled: true
  annotations: {}
    # kubernetes.io/ingress.class: nginx
    # kubernetes.io/tls-acme: true
  hosts:
    - host: ${deployment_endpoint}                                  ## my-example-chart.domain.com
      paths: []
  tls:
  - secretName: chart-example-tls
    hosts:
    - ${deployment_endpoint}                                        ## my-example-chart.domain.com

Now its time to initialize the terraform and deploy it

terraform init && terraform apply

Example Remote Chart Deployment

In the case of remote chart deployment, you can follow the above instruction to deploy grafana

module "helm_deploy_remote" {
  source                 = "fuchicorp/chart/helm"
  deployment_name        = "grafana"
  deployment_environment = "dev"
  deployment_path        = "grafana/grafana"
  chart_repo             = "https://grafana.github.io/helm-charts"
  enabled                = true
  remote_chart           = true
  release_version        = "6.22.0"
  remote_override_values = <<EOF

## Grafana
replicas: ${var.grafana_replicas}

## Ingress for the grafana
ingress:
  enabled: true
  annotations: {}
    # kubernetes.io/ingress.class: nginx
    # kubernetes.io/tls-acme: true
  hosts:
    - host: ${var.grafana_endpoint}                         ## grafana.domain.com
      paths:
      - '/'
  tls:
  - secretName: chart-example-tls
    hosts:
    - ${var.grafana_endpoint}                               ## grafana.domain.com
EOF
}

Now, create variables.tf and use them to deploy the Grafana server in your Kubernetes Cluster

variable "grafana_endpoint" {
  default = "grafana.domain.com"
}

variable "grafana_replicas" {
  default = 1
}

Example Local Chart Deployment

In this example, you will learn how to use this module to deploy your local charts without packaging them. First, you will need to create your own local helm chart, to quickly do that, run:

mkdir -p ~/terraform/charts
cd ~/terraform/

After creating a base folder now create local chart

helm create charts/my-example-chart

Create module.tf file to call the module from terraform registry then modify it as needed.

module "helm_deploy_local" {
  source                 = "fuchicorp/chart/helm"
  deployment_name        = "my-example-chart"                     ## Release name in the namespace
  deployment_environment = "dev"                                  ## Kubernetes Namespace
  deployment_path        = "charts/my-example-chart"              ## Remote chart location
  remote_chart           = false                                ## Set to false for local chart
  enabled                = true                                 ## Enable to deploy the chart
  template_custom_vars   = {
    deployment_endpoint  = "my-example-chart.domain.com"
    deployment_image     = "nginx"
    deployment_image_tag = "latest"
  }
}

Once you have the default local helm chart you can create variables inside values.yaml file

image:
  repository: ${deployment_image}                                     ## nginx
  pullPolicy: IfNotPresent
  # Overrides the image's tag (default tag is the chart appVersion)
  tag: ${deployment_image_tag}                                        ## latest

ingress:
  enabled: true
  annotations: {}
    # kubernetes.io/ingress.class: nginx
    # kubernetes.io/tls-acme: true
  hosts:
    - host: ${deployment_endpoint}                                    ## my-example-chart.domain.com
      paths: []
  tls:
  - secretName: chart-example-tls
    hosts:
    - ${deployment_endpoint}                                          ## my-example-chart.domain.com

Now its time to initialize the terraform and deploy it

terraform init && terraform apply

Variables

For more info, please see the variables file.

Variable	Description	Default	Type
deployment_endpoint	Ingress endpoint example.fuchicorp.com	(Optional)	domain/string
deployment_name	The name of the deployment for helm release	(Required)	string
deployment_environment	Name of the namespace	(Required)	string
deployment_path	path for helm chart on local	(Required)	string
release_version	Specify the exact chart version to install.	(Optional)	string
remote_override_values	Specify the name of the file to override default values.yaml file	(Optional)	string
chart_repo	Url of the repository for the helm charts	(Optional)	string
remote_chart	Specify whether to deploy remote_chart to true or false default value is false	(Optional)	bool
enabled	Specify if you want to deploy the enabled to true or false default value is true	(Optional)	bool
template_custom_vars	Template custom veriables you can modify variables by parsting the template_custom_vars	(Optional)	map
timeout	If you would like to increase the timeout	(Optional)	number
recreate_pods	On update performs pods restart for the resource if applicable.	(Optional)	bool
values	Name of the values.yaml file	(Optional)	string

Contribute

Request a feature at: https://github.com/fuchicorp/terraform-helm-chart/issues Fork and create PR

Owner

This terraform module developed by the FuchiCorp LLC DevOps team. Thanks for using our chart, Enjoy using it!