Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/argoproj-labs/terraform-provider-argocd
Terraform provider for ArgoCD
https://github.com/argoproj-labs/terraform-provider-argocd
argocd terraform terraform-provider
Last synced: 25 days ago
JSON representation
Terraform provider for ArgoCD
- Host: GitHub
- URL: https://github.com/argoproj-labs/terraform-provider-argocd
- Owner: argoproj-labs
- License: mpl-2.0
- Created: 2020-03-31T23:29:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T18:08:48.000Z (7 months ago)
- Last Synced: 2024-05-29T21:38:56.444Z (7 months ago)
- Topics: argocd, terraform, terraform-provider
- Language: Go
- Homepage:
- Size: 1.08 MB
- Stars: 371
- Watchers: 12
- Forks: 87
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-argo - terraform-provider-argocd
README
# Terraform Provider for ArgoCD
[](https://github.com/oboukili/terraform-provider-argocd/actions/workflows/tests.yml)
The [ArgoCD Terraform
Provider](https://registry.terraform.io/providers/oboukili/argocd/latest/docs)
provides lifecycle management of
[ArgoCD](https://argo-cd.readthedocs.io/en/stable/) resources.
**NB**: The provider is not concerned with the installation/configuration of
ArgoCD itself. To make use of the provider, you will need to have an existing
ArgoCD deployment and, the ArgoCD API server must be
[accessible](https://argo-cd.readthedocs.io/en/stable/getting_started/#3-access-the-argo-cd-api-server)
from where you are running Terraform.
---
## Documentation
Official documentation on how to use this provider can be found on the
[Terraform
Registry](https://registry.terraform.io/providers/oboukili/argocd/latest/docs).
## Compatibility promise
This provider is compatible with _at least_ the last 2 minor releases of ArgoCD
(e.g, ranging from 1.(n).m, to 1.(n-1).0, where `n` is the latest available
minor version).
Older releases are not supported and some resources may not work as expected.
## Motivations
### *I thought ArgoCD already allowed for 100% declarative configuration?*
While that is true through the use of ArgoCD Kubernetes Custom Resources, there
are some resources that simply cannot be managed using Kubernetes manifests,
such as project roles JWTs whose respective lifecycles are better handled by a
tool like Terraform. Even more so when you need to export these JWTs to another
external system using Terraform, like a CI platform.
### *Wouldn't using a Kubernetes provider to handle ArgoCD configuration be enough?*
Existing Kubernetes providers do not patch arrays of objects, losing project
role JWTs when doing small project changes just happen.
ArgoCD Kubernetes admission webhook controller is not as exhaustive as ArgoCD
API validation, this can be seen with RBAC policies, where no validation occur
when creating/patching a project.
Using Terraform to manage Kubernetes Custom Resource becomes increasingly
difficult the further you use HCL2 DSL to merge different data structures *and*
want to preserve type safety.
Whatever the Kubernetes CRD provider you are using, you will probably end up
using `locals` and the `yamlencode` function **which does not preserve the
values' type**. In these cases, not only the readability of your Terraform plan
will worsen, but you will also be losing some safeties that Terraform provides
in the process.
---
## Requirements
* [Terraform](https://www.terraform.io/downloads) (>= 1.0)
* [Go](https://go.dev/doc/install) (1.19)
* [GNU Make](https://www.gnu.org/software/make/)
* [golangci-lint](https://golangci-lint.run/usage/install/#local-installation) (optional)
## Contributing
Contributions are welcome!
### Building
1. `git clone` this repository and `cd` into its directory
2. `make build` will trigger the Golang build
The provided `GNUmakefile` defines additional commands generally useful during
development, like for running tests, generating documentation, code formatting
and linting. Taking a look at it's content is recommended.
### Testing
The acceptance tests run against a disposable ArgoCD installation within a
[Kind](https://github.com/kubernetes-sigs/kind) cluster. Other requirements are
having a Docker daemon running and
[Kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/)
installed.
```sh
make testacc_prepare_env
make testacc
make testacc_clean_env
```
### Generating documentation
This provider uses [terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs/)
to generate documentation and store it in the `docs/` directory.
Once a release is cut, the Terraform Registry will download the documentation from `docs/`
and associate it with the release version. Read more about how this works on the
[official page](https://www.terraform.io/registry/providers/docs).
Use `make generate` to ensure the documentation is regenerated with any changes.
### Using a development build
If [running tests and acceptance tests](#testing) isn't enough, it's possible to
set up a local terraform configuration to use a development builds of the
provider. This can be achieved by leveraging the Terraform CLI [configuration
file development
overrides](https://www.terraform.io/cli/config/config-file#development-overrides-for-provider-developers).
First, use `make install` to place a fresh development build of the provider in
your
[`${GOBIN}`](https://pkg.go.dev/cmd/go#hdr-Compile_and_install_packages_and_dependencies)
(defaults to `${GOPATH}/bin` or `${HOME}/go/bin` if `${GOPATH}` is not set).
Repeat this every time you make changes to the provider locally.
Then, setup your environment following [these
instructions](https://www.terraform.io/plugin/debugging#terraform-cli-development-overrides)
to make your local terraform use your local build.
### Troubleshooting during local development
* **"too many open files":** Running all acceptance tests in parallel (the
default) may open a lot of files and sockets, therefore ensure your local
workstation [open files/sockets limits are tuned
accordingly](https://k6.io/docs/misc/fine-tuning-os).
---
## Credits
* Thanks to [JetBrains](https://www.jetbrains.com/?from=terraform-provider-argocd) for providing a GoLand open source license to support the development of this provider.
* Thanks to [Keplr](https://www.welcometothejungle.com/fr/companies/keplr) for allowing me to contribute to this side-project of mine during paid work hours.
 