argocd

This component is responsible for provisioning Argo CD.

Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.

⚠️⚠️⚠️ ArgoCD CRDs must be installed separately from this component/helm release. ⚠️⚠️⚠️

kubectl apply -k "https://github.com/argoproj/argo-cd/manifests/crds?ref=<appVersion>"

# Eg. version v2.4.9
kubectl apply -k "https://github.com/argoproj/argo-cd/manifests/crds?ref=v2.4.9"

Usage

Preparing AppProject repos:

First, make sure you have a GitHub repo ready to go. We have a component for this called the argocd-repo component. It will create a GitHub repo and adds some secrets and code owners. Most importantly, it configures an applicationset.yaml that includes all the details for helm to create ArgoCD CRDs. These CRDs let ArgoCD know how to fulfill changes to its repo.

components:
  terraform:
    argocd-repo-defaults:
      metadata:
        type: abstract
      vars:
        enabled: true
        github_user: acme_admin
        github_user_email: [email protected]
        github_organization: ACME
        github_codeowner_teams:
          - "@ACME/acme-admins"
          - "@ACME/CloudPosse"
          - "@ACME/developers"
        gitignore_entries:
          - "**/.DS_Store"
          - ".DS_Store"
          - "**/.vscode"
          - "./vscode"
          - ".idea/"
          - ".vscode/"
        permissions:
          - team_slug: acme-admins
            permission: admin
          - team_slug: CloudPosse
            permission: admin
          - team_slug: developers
            permission: push

Injecting infrastructure details into applications

Second, your application repos could use values to best configure their helm releases. We have an eks/platform component for exposing various infra outputs. It takes remote state lookups and stores them into SSM. We demonstrate how to pull the platform SSM parameters later. Here's an example eks/platform config:

components:
  terraform:
    eks/platform:
      metadata:
        type: abstract
        component: eks/platform
      backend:
        s3:
          workspace_key_prefix: platform
      deps:
        - catalog/eks/cluster
        - catalog/eks/alb-controller-ingress-group
        - catalog/acm
      vars:
        enabled: true
        name: "platform"
        eks_component_name: eks/cluster
        ssm_platform_path: /platform/%s/%s
        references:
          default_alb_ingress_group:
            component: eks/alb-controller-ingress-group
            output: .group_name
          default_ingress_domain:
            component: dns-delegated
            environment: gbl
            output: "[.zones[].name][-1]"

    eks/platform/acm:
      metadata:
        component: eks/platform
        inherits:
          - eks/platform
      vars:
        eks_component_name: eks/cluster
        references:
          default_ingress_domain:
            component: acm
            environment: use2
            output: .domain_name

    eks/platform/dev:
      metadata:
        component: eks/platform
        inherits:
          - eks/platform
      vars:
        platform_environment: dev

    acm/qa2:
      settings:
        spacelift:
          workspace_enabled: true
      metadata:
        component: acm
      vars:
        enabled: true
        name: acm-qa2
        tags:
          Team: sre
          Service: acm
        process_domain_validation_options: true
        validation_method: DNS
        dns_private_zone_enabled: false
        certificate_authority_enabled: false

In the previous sample we create platform settings for a dev platform and a qa2 platform. Understand that these are arbitrary titles that are used to separate the SSM parameters so that if, say, a particular hostname is needed, we can safely select the right hostname using a moniker such as qa2. These otherwise are meaningless and do not need to align with any particular stage or tenant.

ArgoCD on SAML / AWS Identity Center (formerly aws-sso)

Here's an example snippet for how to use this component:

components:
  terraform:
    eks/argocd:
      settings:
        spacelift:
          workspace_enabled: true
          depends_on:
            - argocd-applicationset
            - tenant-gbl-corp-argocd-depoy-non-prod
      vars:
        enabled: true
        alb_group_name: argocd
        alb_name: argocd
        alb_logs_prefix: argocd
        certificate_issuer: selfsigning-issuer
        github_organization: MyOrg
        oidc_enabled: false
        saml_enabled: true
        ssm_store_account: corp
        ssm_store_account_region: us-west-2
        argocd_repo_name: argocd-deploy-non-prod
        argocd_rbac_policies:
          - "p, role:org-admin, applications, *, */*, allow"
          - "p, role:org-admin, clusters, get, *, allow"
          - "p, role:org-admin, repositories, get, *, allow"
          - "p, role:org-admin, repositories, create, *, allow"
          - "p, role:org-admin, repositories, update, *, allow"
          - "p, role:org-admin, repositories, delete, *, allow"
        # Note: the IDs for AWS Identity Center groups will change if you alter/replace them:
        argocd_rbac_groups:
          - group: deadbeef-dead-beef-dead-beefdeadbeef
            role: admin
          - group: badca7sb-add0-65ba-dca7-sbadd065badc
            role: reader
        chart_values:
          global:
            logging:
              format: json
              level: warn

    sso-saml/aws-sso:
      settings:
        spacelift:
          workspace_enabled: true
      metadata:
        component: sso-saml-provider
      vars:
        enabled: true
        ssm_path_prefix: "/sso/saml/aws-sso"
        usernameAttr: email
        emailAttr: email
        groupsAttr: groups

Note, if you set up sso-saml-provider, you will need to restart DEX on your EKS cluster manually:

kubectl delete pod <dex-pod-name> -n argocd

The configuration above will work for AWS Identity Center if you have the following attributes in a Custom SAML 2.0 application:

attribute name	value	type
Subject	${user:subject}	persistent
email	${user:email}	unspecified
groups	${user:groups}	unspecified

You will also need to assign AWS Identity Center groups to your Custom SAML 2.0 application. Make a note of each group and replace the IDs in the argocd_rbac_groups var accordingly.

Google Workspace OIDC

To use Google OIDC:

oidc_enabled: true
saml_enabled: false
oidc_providers:
  google:
    uses_dex: true
    type: google
    id: google
    name: Google
    serviceAccountAccess:
      enabled: true
      key: googleAuth.json
      value: /sso/oidc/google/serviceaccount
      admin_email: [email protected]
    config:
      # This filters emails when signing in with Google to only this domain. helpful for picking the right one.
      hostedDomains:
        - acme.com
      clientID: /sso/saml/google/clientid
      clientSecret: /sso/saml/google/clientsecret

Working with ArgoCD and GitHub

Here's a simple GitHub action that will trigger a deployment in ArgoCD:

# NOTE: Example will show dev, and qa2
name: argocd-deploy
on:
  push:
    branches:
      - main
jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-[email protected]
        with:
          aws-region: us-east-2
          role-to-assume: arn:aws:iam::123456789012:role/github-action-worker
      - name: Build
        shell: bash
        run: docker build -t some.docker.repo/acme/app . & docker push some.docker.repo/acmo/app
      - name: Checkout Argo Configuration
        uses: actions/checkout@v3
        with:
          repository: acme/argocd-deploy-non-prod
          ref: main
          path: argocd-deploy-non-prod
      - name: Deploy to dev
        shell: bash
        run: |
          echo Rendering helmfile:
          helmfile \
            --namespace acme-app \
            --environment dev \
            --file deploy/app/release.yaml \
            --state-values-file <(aws ssm get-parameter --name /platform/dev),<(docker image inspect some.docker.repo/acme/app) \
            template > argocd-deploy-non-prod/plat/use2-dev/apps/my-preview-acme-app/manifests/resources.yaml
          echo Updating sha for app:
          yq e '' -i argocd-deploy-non-prod/plat/use2-dev/apps/my-preview-acme-app/config.yaml
          echo Committing new helmfile
          pushd argocd-deploy-non-prod
          git add --all
          git commit --message 'Updating acme-app'
          git push
          popd

In the above example, we make a few assumptions:

You've already made the app in ArgoCD by creating a YAML file in your non-prod ArgoCD repo at the path plat/use2-dev/apps/my-preview-acme-app/config.yaml with contents:

app_repository: acme/app
app_commit: deadbeefdeadbeef
app_hostname: https://some.app.endpoint/landing_page
name: my-feature-branch.acme-app
namespace: my-feature-branch
manifests: plat/use2-dev/apps/my-preview-acme-app/manifests

you have set up ecr with permissions for github to push docker images to it
you already have your ApplicationSet and AppProject crd's in plat/use2-dev/argocd/applicationset.yaml, which should be generated by our argocd-repo component.
your app has a helmfile template in deploy/app/release.yaml
that helmfile template can accept both the eks/platform config which is pulled from ssm at the path configured in eks/platform/defaults
the helmfile template can update container resources using the output of docker image inspect

Notifications

Here's a configuration for letting argocd send notifications back to GitHub:

Create GitHub PAT with scope repo:status
Save the PAT to SSM /argocd/notifications/notifiers/common/github-token
Use this atmos stack configuration

components:
  terraform:
    eks/argocd/notifications:
      metadata:
        component: eks/argocd
      vars:
        github_default_notifications_enabled: true

Webhook

Here's a configuration Github notify ArgoCD on commit:

Create GitHub PAT with scope admin:repo_hook
Save the PAT to SSM /argocd/github/api_key
Use this atmos stack configuration

components:
  terraform:
    eks/argocd/notifications:
      metadata:
        component: eks/argocd
      vars:
        github_webhook_enabled: true

Creating Webhooks with `github-webhook`

If you are creating webhooks for ArgoCD deployment repos in multiple GitHub Organizations, you cannot use the same Terraform GitHub provider. Instead, we can use Atmos to deploy multiple component. To do this, disable the webhook creation in this component and deploy the webhook with the github-webhook component as such:

components:
  terraform:
    eks/argocd:
      metadata:
        component: eks/argocd
        inherits:
          - eks/argocd/defaults
      vars:
        github_webhook_enabled: true # create webhook value; required for argo-cd chart
        create_github_webhook: false # created with github-webhook
        argocd_repositories:
          "argocd-deploy-non-prod/org1": # this is the name of the `argocd-repo` component for "org1"
            environment: ue2
            stage: auto
            tenant: core
          "argocd-deploy-non-prod/org2":
            environment: ue2
            stage: auto
            tenant: core

    webhook/org1/argocd:
      metadata:
        component: github-webhook
      vars:
        github_organization: org1
        github_repository: argocd-deploy-non-prod
        webhook_url: "https://argocd.ue2.dev.plat.acme.org/api/webhook"
        ssm_github_webhook: "/argocd/github/webhook"

    webhook/org2/argocd:
      metadata:
        component: github-webhook
      vars:
        github_organization: org2
        github_repository: argocd-deploy-non-prod
        webhook_url: "https://argocd.ue2.dev.plat.acme.org/api/webhook"
        ssm_github_webhook: "/argocd/github/webhook"

Slack Notifications

ArgoCD supports Slack notifications on application deployments.

In order to enable Slack notifications, first create a Slack Application following the ArgoCD documentation.
Create an OAuth token for the new Slack App
Save the OAuth token to AWS SSM Parameter Store in the same account and region as Github tokens. For example, core-use2-auto
Add the app to the chosen Slack channel. If not added, notifications will not work
For this component, enable Slack integrations for each Application with var.slack_notifications_enabled and var.slack_notifications:

slack_notifications_enabled: true
slack_notifications:
  channel: argocd-updates

In the argocd-repo component, set var.slack_notifications_channel to the name of the Slack notification channel to add the relevant ApplicationSet annotations

Troubleshooting

For ArgoCD v1.9 and later, the initial admin password is available from a Kubernetes secret named argocd-initial-admin-secret. To get the initial password, execute the following command:

kubectl get secret -n argocd argocd-initial-admin-secret -o jsonpath='{.data.password}' | base64 --decode

Then open the ArgoCD admin UI and use the username admin and the password obtained in the previous step to log in to the ArgoCD admin.

Error "server.secretkey is missing"

If you provision a new version of the eks/argocd component, and some Helm Chart values get updated, you might encounter the error "server.secretkey is missing" in the ArgoCD admin UI. To fix the error, execute the following commands:

# Download `kubeconfig` and set EKS cluster
set-eks-cluster cluster-name

# Restart the `argocd-server` Pods
kubectl rollout restart deploy/argocd-server -n argocd

# Get the new admin password from the Kubernetes secret
kubectl get secret -n argocd argocd-initial-admin-secret -o jsonpath='{.data.password}' | base64 --decode

Reference: https://stackoverflow.com/questions/75046330/argo-cd-error-server-secretkey-is-missing

Variables

Required Variables

github_organization (string) required: GitHub Organization
region (string) required: AWS Region.
ssm_store_account (string) required: Account storing SSM parameters
ssm_store_account_region (string) required: AWS region storing SSM parameters

Optional Variables

admin_enabled (bool) optional

Toggles Admin user creation the deployed chart

Default value: false

alb_group_name (string) optional

A name used in annotations to reuse an ALB (e.g. argocd) or to generate a new one

Default value: null

alb_logs_bucket (string) optional

The name of the bucket for ALB access logs. The bucket must have policy allowing the ELB logging principal

Default value: ""

alb_logs_prefix (string) optional

alb_logs_bucket s3 bucket prefix

Default value: ""

alb_name (string) optional

The name of the ALB (e.g. argocd) provisioned by alb-controller. Works together with var.alb_group_name

Default value: null

anonymous_enabled (bool) optional

Toggles anonymous user access using default RBAC setting (Defaults to read-only)

Default value: false

argocd_apps_chart (string) optional

Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended.

Default value: "argocd-apps"

argocd_apps_chart_description (string) optional

Set release description attribute (visible in the history).

Default value: "A Helm chart for managing additional Argo CD Applications and Projects"

argocd_apps_chart_repository (string) optional

Repository URL where to locate the requested chart.

Default value: "https://argoproj.github.io/argo-helm"

argocd_apps_chart_values (any) optional

Additional values to yamlencode as helm_release values for the argocd_apps chart

Default value: { }

argocd_apps_chart_version (string) optional

Specify the exact chart version to install. If this is not specified, the latest version is installed.

Default value: "0.0.3"

argocd_apps_enabled (bool) optional

Enable argocd apps

Default value: true

argocd_create_namespaces (bool) optional

ArgoCD create namespaces policy

Default value: false

argocd_rbac_default_policy (string) optional

Default ArgoCD RBAC default role.

See https://argo-cd.readthedocs.io/en/stable/operator-manual/rbac/#basic-built-in-roles for more information.

Default value: "role:readonly"

argocd_rbac_groups optional

List of ArgoCD Group Role Assignment strings to be added to the argocd-rbac configmap policy.csv item.
e.g.
[
{
group: idp-group-name,
role: argocd-role-name
},
]
becomes: g, idp-group-name, role:argocd-role-name
See https://argo-cd.readthedocs.io/en/stable/operator-manual/rbac/ for more information.

Type:

list(object({
group = string,
role  = string
}))

Default value: [ ]

argocd_rbac_policies (list(string)) optional

List of ArgoCD RBAC Permission strings to be added to the argocd-rbac configmap policy.csv item.

See https://argo-cd.readthedocs.io/en/stable/operator-manual/rbac/ for more information.

Default value: [ ]

argocd_repositories optional

Map of objects defining an argocd_repo to configure. The key is the name of the ArgoCD repository.

Type:

map(object({
environment = string # The environment where the `argocd_repo` component is deployed.
stage       = string # The stage where the `argocd_repo` component is deployed.
tenant      = string # The tenant where the `argocd_repo` component is deployed.
}))

Default value: { }

atomic (bool) optional

If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used.

Default value: true

certificate_issuer (string) optional

Certificate manager cluster issuer

Default value: "letsencrypt-staging"

chart (string) optional

Default value: "argo-cd"

chart_description (string) optional

Set release description attribute (visible in the history).

Default value: null

chart_repository (string) optional

Repository URL where to locate the requested chart.

Default value: "https://argoproj.github.io/argo-helm"

chart_values (any) optional

Additional values to yamlencode as helm_release values.

Default value: { }

chart_version (string) optional

Specify the exact chart version to install. If this is not specified, the latest version is installed.

Default value: "5.55.0"

cleanup_on_fail (bool) optional

Allow deletion of new resources created in this upgrade when upgrade fails.

Default value: true

create_github_webhook (bool) optional

Enable GitHub webhook creation

Use this to create the GitHub Webhook for the given ArgoCD repo using the value created when var.github_webhook_enabled is true.

Default value: true

create_namespace (bool) optional

Create the namespace if it does not yet exist. Defaults to false.

Default value: false

eks_component_name (string) optional

The name of the eks component

Default value: "eks/cluster"

forecastle_enabled (bool) optional

Toggles Forecastle integration in the deployed chart

Default value: false

github_base_url (string) optional

This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the GITHUB_BASE_URL environment variable. The value must end with a slash, for example: https://terraformtesting-ghe.westus.cloudapp.azure.com/

Default value: null

github_default_notifications_enabled (bool) optional

Enable default GitHub commit statuses notifications (required for CD sync mode)

Default value: true

github_token_override (string) optional

Use the value of this variable as the GitHub token instead of reading it from SSM

Default value: null

github_webhook_enabled (bool) optional

Enable GitHub webhook integration

Use this to create a secret value and pass it to the argo-cd chart

Default value: true

helm_manifest_experiment_enabled (bool) optional

Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan

Default value: false

host (string) optional

Host name to use for ingress and ALB

Default value: ""

kube_data_auth_enabled (bool) optional

If true, use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled.

Default value: false

kube_exec_auth_aws_profile (string) optional

The AWS config profile for aws eks get-token to use

Default value: ""

kube_exec_auth_aws_profile_enabled (bool) optional

If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token

Default value: false

kube_exec_auth_enabled (bool) optional

If true, use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled, overrides kube_data_auth_enabled.

Default value: true

kube_exec_auth_role_arn (string) optional

The role ARN for aws eks get-token to use

Default value: ""

kube_exec_auth_role_arn_enabled (bool) optional

If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token

Default value: true

kubeconfig_context (string) optional

Context to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.

Default value: ""

kubeconfig_context_format (string) optional

A format string to use for creating the kubectl context name when
kubeconfig_file_enabled is true and kubeconfig_context is not supplied.
Must include a single %s which will be replaced with the cluster name.

Default value: ""

kubeconfig_exec_auth_api_version (string) optional

The Kubernetes API version of the credentials returned by the exec auth plugin

Default value: "client.authentication.k8s.io/v1beta1"

kubeconfig_file (string) optional

The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true

Default value: ""

kubeconfig_file_enabled (bool) optional

If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster

Default value: false

kubernetes_namespace (string) optional

The namespace to install the release into.

Default value: "argocd"

notifications_notifiers optional

Notification Triggers to configure.

See: https://argocd-notifications.readthedocs.io/en/stable/triggers/
See: Example value in argocd-notifications Helm Chart

Type:

object({
ssm_path_prefix = optional(string, "/argocd/notifications/notifiers")
# service.webhook.<webhook-name>:
webhook = optional(map(
  object({
    url = string
    headers = optional(list(
      object({
        name  = string
        value = string
      })
    ), [])
    insecureSkipVerify = optional(bool, false)
  })
))
})

Default value: { }

notifications_templates optional

Notification Templates to configure.

See: https://argocd-notifications.readthedocs.io/en/stable/templates/
See: Example value in argocd-notifications Helm Chart

Type:

map(object({
message = string
alertmanager = optional(object({
  labels       = map(string)
  annotations  = map(string)
  generatorURL = string
}))
webhook = optional(map(
  object({
    method = optional(string)
    path   = optional(string)
    body   = optional(string)
  })
))
}))

Default value: { }

notifications_triggers optional

Notification Triggers to configure.

See: https://argocd-notifications.readthedocs.io/en/stable/triggers/
See: Example value in argocd-notifications Helm Chart

Type:

map(list(
object({
  oncePer = optional(string)
  send    = list(string)
  when    = string
})
))

Default value: { }

oidc_enabled (bool) optional

Toggles OIDC integration in the deployed chart

Default value: false

oidc_issuer (string) optional

OIDC issuer URL

Default value: ""

oidc_name (string) optional

Name of the OIDC resource

Default value: ""

oidc_rbac_scopes (string) optional

OIDC RBAC scopes to request

Default value: "[argocd_realm_access]"

oidc_requested_scopes (string) optional

Set of OIDC scopes to request

Default value: "[\"openid\", \"profile\", \"email\", \"groups\"]"

rbac_enabled (bool) optional

Enable Service Account for pods.

Default value: true

resources optional

The cpu and memory of the deployment's limits and requests.

Type:

object({
limits = object({
  cpu    = string
  memory = string
})
requests = object({
  cpu    = string
  memory = string
})
})

Default value: null

saml_enabled (bool) optional

Toggles SAML integration in the deployed chart

Default value: false

saml_rbac_scopes (string) optional

SAML RBAC scopes to request

Default value: "[email,groups]"

saml_sso_providers optional

SAML SSO providers components

Type:

map(object({
component   = string
environment = optional(string, null)
}))

Default value: { }

service_type (string) optional

Service type for exposing the ArgoCD service. The available type values and their behaviors are:
ClusterIP: Exposes the Service on a cluster-internal IP. Choosing this value makes the Service only reachable from within the cluster.
NodePort: Exposes the Service on each Node's IP at a static port (the NodePort).
LoadBalancer: Exposes the Service externally using a cloud provider's load balancer.

Default value: "NodePort"

slack_notifications optional

ArgoCD Slack notification configuration. Requires Slack Bot created with token stored at the given SSM Parameter path.

See: https://argocd-notifications.readthedocs.io/en/stable/services/slack/

Type:

object({
token_ssm_path = optional(string, "/argocd/notifications/notifiers/slack/token")
api_url        = optional(string, null)
username       = optional(string, "ArgoCD")
icon           = optional(string, null)
})

Default value: { }

slack_notifications_enabled (bool) optional

Whether or not to enable Slack notifications. See `var.slack_notifications.

Default value: false

ssm_github_api_key (string) optional

SSM path to the GitHub API key

Default value: "/argocd/github/api_key"

ssm_oidc_client_id (string) optional

The SSM Parameter Store path for the ID of the IdP client

Default value: "/argocd/oidc/client_id"

ssm_oidc_client_secret (string) optional

The SSM Parameter Store path for the secret of the IdP client

Default value: "/argocd/oidc/client_secret"

ssm_store_account_tenant (string) optional

Tenant of the account storing SSM parameters.

If the tenant label is not used, leave this as null.

Default value: null

timeout (number) optional

Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds

Default value: 300

wait (bool) optional

Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout. Defaults to true.

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

github_webhook_value: The value of the GitHub webhook secret used for ArgoCD

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0
github, version: >= 4.0
helm, version: >= 2.6.0
kubernetes, version: >= 2.9.0, != 2.21.0
random, version: >= 3.5

Providers

aws, version: >= 4.0
aws, version: >= 4.0
github, version: >= 4.0
kubernetes, version: >= 2.9.0, != 2.21.0
random, version: >= 3.5

Modules

Name	Version	Source	Description
`argocd`	0.10.1	`cloudposse/helm-release/aws`	n/a
`argocd_apps`	0.10.1	`cloudposse/helm-release/aws`	n/a
`argocd_repo`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`dns_gbl_delegated`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`eks`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../../account-map/modules/iam-roles`	n/a
`iam_roles_config_secrets`	latest	`../../account-map/modules/iam-roles`	n/a
`notifications_notifiers`	1.0.2	`cloudposse/config/yaml//modules/deepmerge`	n/a
`notifications_templates`	1.0.2	`cloudposse/config/yaml//modules/deepmerge`	n/a
`saml_sso_providers`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

github_repository_webhook.default (resource)
random_password.webhook (resource)

Data Sources

The following data sources are used by this module:

aws_eks_cluster_auth.eks (data source)
aws_ssm_parameter.github_api_key (data source)
aws_ssm_parameter.github_deploy_key (data source)
aws_ssm_parameter.oidc_client_id (data source)
aws_ssm_parameter.oidc_client_secret (data source)
aws_ssm_parameter.slack_notifications (data source)
aws_ssm_parameters_by_path.argocd_notifications (data source)
kubernetes_resources.crd (data source)

References

Changelog

Components PR #905

The notifications.tf file has been renamed to notifications.tf. Delete notifications.tf after vendoring these changes.

Components PR #851

This is a bug fix and feature enhancement update. There are few actions necessary to upgrade.

Upgrade actions

Update atmos stack yaml config
1. Add github_default_notifications_enabled: true
2. Add github_webhook_enabled: true
3. Remove notifications_triggers
4. Remove notifications_templates
5. Remove notifications_notifiers

 components:
   terraform:
     argocd:
       settings:
         spacelift:
           workspace_enabled: true
       metadata:
         component: eks/argocd
       vars:
+        github_default_notifications_enabled: true
+        github_webhook_enabled: true
-        notifications_triggers:
-          trigger_on-deployed:
-            - when: app.status.operationState.phase in ['Succeeded'] and app.status.health.status == 'Healthy'
-              oncePer: app.status.sync.revision
-              send: [app-deployed]
-        notifications_templates:
-          template_app-deployed:
-            message: |
-              Application {{.app.metadata.name}} is now running new version of deployments manifests.
-            github:
-              status:
-                state: success
-                label: "continuous-delivery/{{.app.metadata.name}}"
-                targetURL: "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true"
-        notifications_notifiers:
-          service_github:
-            appID: xxxxxxx
-            installationID: xxxxxxx

Move secrets from /argocd/notifications/notifiers/service_webhook_github-commit-status/github-token to argocd/notifications/notifiers/common/github-token

chamber read -q argocd/notifications/notifiers/service_webhook_github-commit-status github-token | chamber write argocd/notifications/notifiers/common github-token
chamber delete argocd/notifications/notifiers/service_webhook_github-commit-status github-token

Create GitHub PAT with scope admin:repo_hook
Save the PAT to SSM /argocd/github/api_key

chamber write argocd/github api_key ${PAT}

Apply changes with atmos

Features

Git Webhook Configuration - makes GitHub trigger ArgoCD sync on each commit into argocd repo
Replace GitHub notification service with predefined Webhook notification service
Added predefined GitHub commit status notifications for CD sync mode:
- on-deploy-started
  - app-repo-github-commit-status
  - argocd-repo-github-commit-status
- on-deploy-succeded
  - app-repo-github-commit-status
  - argocd-repo-github-commit-status
- on-deploy-failed
  - app-repo-github-commit-status
  - argocd-repo-github-commit-status
Support SSM secrets (/argocd/notifications/notifiers/common/*) common for all notification services. (Can be referenced with $common_{secret-name} )

Bug Fixes

ArgoCD notifications pods recreated on deployment that change notifications related configs and secrets
Remove metadata output that expose helm values configs (used in debug purpose)
Remove legacy unnecessary helm values used in old ArgoCD versions (ex. workflow auth configs) and dropped notifications services

Breaking changes

Removed service_github from notifications_notifiers variable structure
Renamed service_webhook to webhook in notifications_notifiers variable structure

variable "notifications_notifiers" {
  type = object({
    ssm_path_prefix = optional(string, "/argocd/notifications/notifiers")
-    service_github = optional(object({
-      appID          = number
-      installationID = number
-      privateKey     = optional(string)
-    }))
    # service.webhook.<webhook-name>:
-    service_webhook = optional(map(
+    webhook = optional(map(
      object({
        url = string
        headers = optional(list(
      })
    ))
  })

Removed github from notifications_templates variable structure

variable "notifications_templates" {
  type = map(object({
    message = string
    alertmanager = optional(object({
      labels       = map(string)
      annotations  = map(string)
      generatorURL = string
    }))
-    github = optional(object({
-      status = object({
-        state     = string
-        label     = string
-        targetURL = string
-      })
-    }))
    webhook = optional(map(
      object({
        method = optional(string)
        path   = optional(string)
        body   = optional(string)
      })
    ))
 }))

Usage​

Preparing AppProject repos:​

Injecting infrastructure details into applications​

ArgoCD on SAML / AWS Identity Center (formerly aws-sso)​

Google Workspace OIDC​

Working with ArgoCD and GitHub​

Notifications​

Webhook​

Creating Webhooks with github-webhook​

Slack Notifications​

Troubleshooting​

Login to ArgoCD admin UI​

Error "server.secretkey is missing"​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Changelog​

Components PR #905​

Components PR #851​

Upgrade actions​

Features​

Bug Fixes​

Breaking changes​

Usage

Preparing AppProject repos:

Injecting infrastructure details into applications

ArgoCD on SAML / AWS Identity Center (formerly aws-sso)

Google Workspace OIDC

Working with ArgoCD and GitHub

Notifications

Webhook

Creating Webhooks with `github-webhook`

Slack Notifications

Troubleshooting

Login to ArgoCD admin UI

Error "server.secretkey is missing"

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References

Changelog

Components PR #905

Components PR #851

Upgrade actions

Features

Bug Fixes

Breaking changes