This component is responsible for creating and managing an ArgoCD desired state repository.

Usage

Stack Level: Regional

The following are example snippets of how to use this component:

# stacks/argocd/repo/default.yaml
components:
  terraform:
    argocd-repo:
      vars:
        enabled: true
        github_user: ci-acme
        github_user_email: [email protected]
        github_organization: ACME
        github_codeowner_teams:
          - "@ACME/cloud-admins"
          - "@ACME/cloud-posse"
        # the team must be present in the org where the repository lives
        # team_slug is the name of the team without the org
        # e.g. `@cloudposse/engineering` is just `engineering`
        permissions:
          - team_slug: admins
            permission: admin
          - team_slug: bots
            permission: admin
          - team_slug: engineering
            permission: push

# stacks/argocd/repo/non-prod.yaml
import:
  - catalog/argocd/repo/defaults

components:
  terraform:
    argocd-deploy-non-prod:
      component: argocd-repo
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        name: argocd-deploy-non-prod
        description: "ArgoCD desired state repository (Non-production) for ACME applications"
        environments:
          - tenant: mgmt
            environment: uw2
            stage: sandbox

# stacks/mgmt-gbl-corp.yaml
import:
---
- catalog/argocd/repo/non-prod

If the repository already exists, it will need to be imported (replace names of IAM profile var file accordingly):

$ export TF_VAR_github_token_override=[REDACTED]
$ atmos terraform varfile argocd-deploy-non-prod -s mgmt-gbl-corp
$ cd components/terraform/argocd-repo
$ terraform import -var "import_profile_name=eg-mgmt-gbl-corp-admin" -var-file="mgmt-gbl-corp-argocd-deploy-non-prod.terraform.tfvars.json" "github_repository.default[0]" argocd-deploy-non-prod
$ atmos terraform varfile argocd-deploy-non-prod -s mgmt-gbl-corp
$ cd components/terraform/argocd-repo
$ terraform import -var "import_profile_name=eg-mgmt-gbl-corp-admin" -var-file="mgmt-gbl-corp-argocd-deploy-non-prod.terraform.tfvars.json" "github_branch.default[0]" argocd-deploy-non-prod:main
$ cd components/terraform/argocd-repo
$ terraform import -var "import_profile_name=eg-mgmt-gbl-corp-admin" -var-file="mgmt-gbl-corp-argocd-deploy-non-prod.terraform.tfvars.json" "github_branch_default.default[0]" argocd-deploy-non-prod

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.0
github	>= 6.0
random	>= 2.3
tls	>= 3.0

Providers

Name	Version
aws	>= 4.0
github	>= 6.0
tls	>= 3.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
store_write	cloudposse/ssm-parameter-store/aws	0.11.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
github_branch_default.default	resource
github_branch_protection.default	resource
github_repository.default	resource
github_repository_deploy_key.default	resource
github_repository_file.application_set	resource
github_repository_file.codeowners_file	resource
github_repository_file.gitignore	resource
github_repository_file.pull_request_template	resource
github_repository_file.readme	resource
github_team_repository.default	resource
tls_private_key.default	resource
aws_ssm_parameter.github_api_key	data source
github_repository.default	data source
github_team.default	data source
github_user.automation_user	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
attributes	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.	list(string)	[]	no
context	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.	any	{ "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 }	no
create_repo	Whether or not to create the repository or use an existing one	bool	true	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
description	The description of the repository	string	null	no
descriptor_formats	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).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
environments	Environments to populate applicationset.yaml files and repository deploy keys (for ArgoCD) for. auto-sync determines whether or not the ArgoCD application will be automatically synced. ignore-differences determines whether or not the ArgoCD application will ignore the number of replicas in the deployment. Read more on ignore differences here: https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#respect-ignore-difference-configs Example: tenant: plat environment: use1 stage: sandbox auto-sync: true ignore-differences: - group: apps kind: Deployment json-pointers: - /spec/replicas	list(object({ tenant = optional(string, null) environment = string stage = string attributes = optional(list(string), []) auto-sync = bool ignore-differences = optional(list(object({ group = string, kind = string, json-pointers = list(string) })), []) }))	[]	no
github_base_url	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/	string	null	no
github_codeowner_teams	List of teams to use when populating the CODEOWNERS file. For example: ["@ACME/cloud-admins", "@ACME/cloud-developers"].	list(string)	n/a	yes
github_default_notifications_enabled	Enable default GitHub commit statuses notifications (required for CD sync mode)	string	true	no
github_notifications	ArgoCD notification annotations for subscribing to GitHub. The default value given uses the same notification template names as defined in the eks/argocd component. If want to add additional notifications, include any existing notifications from this list that you want to keep in addition.	list(string)	[ "notifications.argoproj.io/subscribe.on-deploy-started.app-repo-github-commit-status: """, "notifications.argoproj.io/subscribe.on-deploy-started.argocd-repo-github-commit-status: """, "notifications.argoproj.io/subscribe.on-deploy-succeded.app-repo-github-commit-status: """, "notifications.argoproj.io/subscribe.on-deploy-succeded.argocd-repo-github-commit-status: """, "notifications.argoproj.io/subscribe.on-deploy-failed.app-repo-github-commit-status: """, "notifications.argoproj.io/subscribe.on-deploy-failed.argocd-repo-github-commit-status: """ ]	no
github_organization	GitHub Organization	string	n/a	yes
github_token_override	Use the value of this variable as the GitHub token instead of reading it from SSM	string	null	no
github_user	Github user	string	n/a	yes
github_user_email	Github user email	string	n/a	yes
gitignore_entries	List of .gitignore entries to use when populating the .gitignore file. For example: [".idea/", ".vscode/"].	list(string)	n/a	yes
id_length_limit	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.	number	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
manifest_kubernetes_namespace	The namespace used for the ArgoCD application	string	"argocd"	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
permissions	A list of Repository Permission objects used to configure the team permissions of the repository team_slug should be the name of the team without the @{org} e.g. @cloudposse/team => team permission is just one of the available values listed below	list(object({ team_slug = string, permission = string }))	[]	no
push_restrictions_enabled	Enforce who can push to the main branch	bool	true	no
regex_replace_chars	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.	string	null	no
region	AWS Region	string	n/a	yes
required_pull_request_reviews	Enforce restrictions for pull request reviews	bool	true	no
restrict_pushes_blocks_creations	Setting this to false allows people, teams, or apps to create new branches matching this rule	bool	true	no
slack_notifications_channel	If given, the Slack channel to for deployment notifications.	string	""	no
ssm_github_api_key	SSM path to the GitHub API key	string	"/argocd/github/api_key"	no
ssm_github_deploy_key_format	Format string of the SSM parameter path to which the deploy keys will be written to (%s will be replaced with the environment name)	string	"/argocd/deploy_keys/%s"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
vulnerability_alerts_enabled	Enable security alerts for vulnerable dependencies	bool	false	no
web_commit_signoff_required	Require contributors to sign off on web-based commits	bool	false	no

Outputs

Name	Description
deploy_keys_ssm_path_format	SSM Parameter Store path format for the repository's deploy keys
deploy_keys_ssm_paths	SSM Parameter Store paths for the repository's deploy keys
repository	Repository name
repository_default_branch	Repository default branch
repository_description	Repository description
repository_git_clone_url	Repository git clone URL
repository_ssh_clone_url	Repository SSH clone URL
repository_url	Repository URL

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Related Projects

Check out these related projects.

• Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
• Atmos - Atmos is like docker-compose but for your infrastructure

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2024 Cloud Posse, LLC