This repo is archived. Development of this module continues in lablabs/terraform-aws-eks-argocd
We help companies build, run, deploy and scale software and infrastructure by embracing the right technologies and principles. Check out our website at https://lablabs.io/
A terraform module to deploy the ArgoCD on Kubernetes cluster.
This module deploys ArgoCD in two different ways:
- A helm release that is further managed by Helm
- A helm release along with ArgoCD Application CRD which allows Argo to self-manage itself.
Deploy helm chart by helm (default method, set enabled = true)
Deploy helm chart as argo application by kubernetes manifest (set enabled = true and argo_enabled = true)
When deploying with ArgoCD application, Kubernetes terraform provider requires access to Kubernetes cluster API during plan time. This introduces potential issue when you want to deploy the cluster with this addon at the same time, during the same Terraform run.
To overcome this issue, the module deploys the ArgoCD application object using the Helm provider, which does not require API access during plan. If you want to deploy the application using this workaround, you can set the argo_helm_enabled variable to true.
Create helm release resource and deploy it as argo application (set enabled = true, argo_enabled = true and argo_helm_enabled = true)
This module provides an option to deploy in self managed mode. If self_managed is set, the module will make an initial deployment of ArgoCD with Helm and then proceed to deploy ArgoCD Application object, so you're able to manage ArgoCD from ArgoCD. The helm release has a lifecycle ignore_changes rules set on it's resource, so no further changes are made to the release. It is only used for the initial ArgoCD deployment and only the newly deployed, self-managed object is used.
Important notice
Changing the self_managed variable after ArgoCD was already deployed will result in it's re-creation.
Check out other terraform kubernetes addons.
See Basic example for further information.
| Name | Version |
|---|---|
| terraform | >= 1.0 |
| helm | >= 2.6.0 |
| kubernetes | >= 2.11.0 |
| utils | >= 0.17.0 |
No modules.
| Name | Type |
|---|---|
| helm_release.argo_application | resource |
| helm_release.self_managed | resource |
| helm_release.this | resource |
| kubernetes_manifest.this | resource |
| utils_deep_merge_yaml.argo_helm_values | data source |
| utils_deep_merge_yaml.values | data source |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| argo_apiversion | ArgoCD Appliction apiVersion | string |
"argoproj.io/v1alpha1" |
no |
| argo_destination_server | Destination server for ArgoCD Application | string |
"https://kubernetes.default.svc" |
no |
| argo_enabled | If set to true, the module will be deployed as ArgoCD application, otherwise it will be deployed as a Helm release | bool |
false |
no |
| argo_helm_enabled | If set to true, the ArgoCD Application manifest will be deployed using Kubernetes provider as a Helm release. Otherwise it'll be deployed as a Kubernetes manifest. See Readme for more info | bool |
false |
no |
| argo_helm_values | Value overrides to use when deploying argo application object with helm | string |
"" |
no |
| argo_info | ArgoCD info manifest parameter | list |
[ |
no |
| argo_kubernetes_manifest_computed_fields | List of paths of fields to be handled as "computed". The user-configured value for the field will be overridden by any different value returned by the API after apply. | list(string) |
[ |
no |
| argo_kubernetes_manifest_field_manager_force_conflicts | Forcibly override any field manager conflicts when applying the kubernetes manifest resource | bool |
false |
no |
| argo_kubernetes_manifest_field_manager_name | The name of the field manager to use when applying the kubernetes manifest resource. Defaults to Terraform | string |
"Terraform" |
no |
| argo_kubernetes_manifest_wait_fields | A map of fields and a corresponding regular expression with a pattern to wait for. The provider will wait until the field matches the regular expression. Use * for any value. | map(string) |
{} |
no |
| argo_metadata | ArgoCD Application metadata configuration. Override or create additional metadata parameters | map |
{} |
no |
| argo_namespace | Namespace to deploy ArgoCD application CRD to | string |
"argo" |
no |
| argo_project | ArgoCD Application project | string |
"default" |
no |
| argo_skip_crds | If set, no CRDs will be installed when deploying argo application | bool |
false |
no |
| argo_spec | ArgoCD Application spec configuration. Override or create additional spec parameters | map |
{} |
no |
| argo_sync_policy | ArgoCD syncPolicy manifest parameter | map |
{} |
no |
| enabled | Variable indicating whether deployment is enabled | bool |
true |
no |
| helm_atomic | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | bool |
false |
no |
| helm_chart_name | Helm chart name to be installed | string |
"argo-cd" |
no |
| helm_chart_version | Version of the Helm chart | string |
"4.10.8" |
no |
| helm_cleanup_on_fail | Allow deletion of new resources created in this helm upgrade when upgrade fails | bool |
false |
no |
| helm_create_namespace | Create the namespace if it does not yet exist | bool |
true |
no |
| helm_dependency_update | Runs helm dependency update before installing the chart | bool |
false |
no |
| helm_description | Set helm release description attribute (visible in the history) | string |
"" |
no |
| helm_devel | Use helm chart development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored | bool |
false |
no |
| helm_disable_openapi_validation | If set, the installation process will not validate rendered helm templates against the Kubernetes OpenAPI Schema | bool |
false |
no |
| helm_disable_webhooks | Prevent helm chart hooks from running | bool |
false |
no |
| helm_force_update | Force helm resource update through delete/recreate if needed | bool |
false |
no |
| helm_keyring | Location of public keys used for verification. Used only if helm_package_verify is true | string |
"~/.gnupg/pubring.gpg" |
no |
| helm_lint | Run the helm chart linter during the plan | bool |
false |
no |
| helm_package_verify | Verify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chart | bool |
false |
no |
| helm_postrender | Value block with a path to a binary file to run after helm renders the manifest which can alter the manifest contents | map(any) |
{} |
no |
| helm_recreate_pods | Perform pods restart during helm upgrade/rollback | bool |
false |
no |
| helm_release_max_history | Maximum number of release versions stored per release | number |
0 |
no |
| helm_release_name | Helm release name | string |
"argocd" |
no |
| helm_render_subchart_notes | If set, render helm subchart notes along with the parent | bool |
true |
no |
| helm_replace | Re-use the given name of helm release, only if that name is a deleted release which remains in the history. This is unsafe in production | bool |
false |
no |
| helm_repo_ca_file | Helm repositories cert file | string |
"" |
no |
| helm_repo_cert_file | Helm repositories cert file | string |
"" |
no |
| helm_repo_key_file | Helm repositories cert key file | string |
"" |
no |
| helm_repo_password | Password for HTTP basic authentication against the helm repository | string |
"" |
no |
| helm_repo_url | Helm repository | string |
"https://argoproj.github.io/argo-helm" |
no |
| helm_repo_username | Username for HTTP basic authentication against the helm repository | string |
"" |
no |
| helm_reset_values | When upgrading, reset the values to the ones built into the helm chart | bool |
false |
no |
| helm_reuse_values | When upgrading, reuse the last helm release's values and merge in any overrides. If 'helm_reset_values' is specified, this is ignored | bool |
false |
no |
| helm_set_sensitive | Value block with custom sensitive values to be merged with the values yaml that won't be exposed in the plan's diff | map(any) |
{} |
no |
| helm_skip_crds | If set, no CRDs will be installed before helm release | bool |
false |
no |
| helm_timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks) | number |
300 |
no |
| helm_wait | Will wait until all helm release resources are in a ready state before marking the release as successful. It will wait for as long as timeout | bool |
false |
no |
| helm_wait_for_jobs | If wait is enabled, will wait until all helm Jobs have been completed before marking the release as successful. It will wait for as long as timeout | bool |
false |
no |
| namespace | The K8s namespace in which the ingress-nginx has been created | string |
"argo" |
no |
| self_managed | If set to true, the module will create ArgoCD Application manifest in the cluster and abandon the Helm release | bool |
true |
no |
| settings | Additional settings which will be passed to the Helm chart values, see https://artifacthub.io/packages/helm/argo/argo-cd | map(any) |
{} |
no |
| values | Additional yaml encoded values which will be passed to the Helm chart. | string |
"" |
no |
| Name | Description |
|---|---|
| helm_release_application_metadata | Argo application helm release attributes |
| helm_release_metadata | Helm release attributes |
| helm_release_self_managed_metadata | Helm release attributes |
| kubernetes_application_attributes | Argo kubernetes manifest attributes |
Feel free to create an issue in this repository if you have questions, suggestions or feature requests.
We want to provide high quality code and modules. For this reason we are using several pre-commit hooks and GitHub Actions workflow. A pull-request to the master branch will trigger these validations and lints automatically. Please check your code before you will create pull-requests. See pre-commit documentation and GitHub Actions documentation for further details.
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.