diff --git a/README.md b/README.md index 3c77baa..1eea9de 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This terraform module will help you deploy the helm charts on local. - [Requirements](#requirements) -- [Usage remote chart](#usage-remote-chart) +- [Remote chart deployment](#remote-chart-deployment) -- [Usage local chart](#usage-local-chart) +- [Local chart deployment](#local-chart-deployment) - [Example Remote Chart Deployment](#example-remote-chart-deployment ) @@ -15,7 +15,7 @@ This terraform module will help you deploy the helm charts on local. - [Variables](#variables) ## Requirements -1. Make sure that you have `kubectl` installed and you have configured your `~/.kube/config` +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 @@ -24,37 +24,73 @@ This terraform module will help you deploy the helm charts on local. + provider registry.terraform.io/hashicorp/template v2.2.0 -## Usage remote chart - -First you will need to find the proper helm chart from the https://artifacthub.io/ -``` -mkdir ~/example-deployment -cd ~/example-deployment -``` - -Create `module.tf` to call the module on terraform registry, then customize it under the data section by stating your custom values as your chart needed. +## 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. ```hcl module "helm_deploy" { source = "fuchicorp/chart/helm" - remote_chart = "true" ## Set to true to remote chart false to local charts - chart_repo = "https://github.io/helm-charts" ## Here provide the repository url + 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" ## Helm chart version + release_version = "#example chart version" ## Version of Helm chart - ## Your custom values.yaml +## Your custom values.yaml remote_override_values = <