https://github.com/small-hack/appset-secret-plugin
An Argo CD ApplicationSet Generator Plugin to retrieve values from Kubernete Secrets
https://github.com/small-hack/appset-secret-plugin
applicationset argo-cd argocd argocd-applicationsets argocd-generators argocd-plugin
Last synced: 12 months ago
JSON representation
An Argo CD ApplicationSet Generator Plugin to retrieve values from Kubernete Secrets
- Host: GitHub
- URL: https://github.com/small-hack/appset-secret-plugin
- Owner: small-hack
- License: agpl-3.0
- Created: 2023-08-04T12:30:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T00:38:59.000Z (over 1 year ago)
- Last Synced: 2024-07-30T05:20:27.227Z (over 1 year ago)
- Topics: applicationset, argo-cd, argocd, argocd-applicationsets, argocd-generators, argocd-plugin
- Language: Python
- Homepage: https://small-hack.github.io/appset-secret-plugin
- Size: 133 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ApplicationSet Secret Plugin Generator
[](https://cloud.docker.com/u/jessebot/repository/docker/jessebot/argocd-appset-secret-plugin)
[appset-secret-plugin](https://github.com/small-hack/appset-secret-plugin) is an Argo CD [ApplicationSet Plugin Generator](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Plugin/) (_only available in Argo CD `v2.8.0` or newer_) to fetch variables from an existing [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) that is mounted as file in our plugin generator deployment.
## Usage
First, [install Argo CD](https://argo-cd.readthedocs.io/en/stable/getting_started/#1-install-argo-cd) on your cluster.
### Install with helm
For helm, see the [`README`](./charts/appset-secret-plugin/README.md) for full details of the allowed values in [`values.yaml`](./charts/appset-secret-plugin/values.yaml), but this is the gist for testing:
```console
helm repo add appset-secret-plugin https://small-hack.github.io/appset-secret-plugin
helm install my-release-name appset-secret-plugin/appset-secret-plugin
```
You'll likely want to pass in a value for an existing Kubernetes Secret containing your secret keys you want to be available to the Plugin Generator. To do that, let's say the name of your Kubernetes Secret is `my-secret-name`, you can try this:
```console
helm install my-release-name appset-secret-plugin/appset-secret-plugin \
--set secretVars.existingSecret=my-secret-name
```
### Install with Kustomize
See the [README](./kustomize/README.md) in the kustomize directory.
# Testing
You can create a Kubernetes Secret for your queriable variables, like this:
```yaml
apiVersion: v1
kind: Secret
metadata:
name: argocd-secret-vars
namespace: argocd
labels:
app.kubernetes.io/part-of: argocd
type: stringData
data:
secret_vars.yaml: |
app_name: "beepboop"
```
Here's an example ApplicationSet, using the secret plugin generator, to apply:
```yaml
apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
name: my-application-set
spec:
goTemplate: true
goTemplateOptions: ["missingkey=error"]
generators:
- plugin:
configMapRef:
name: secret-var-plugin-generator
input:
parameters:
secret_vars: ["app_name"]
template:
metadata:
name: "from-appset-{{.app_name}}"
spec:
project: default
source:
repoURL: https://github.com/argoproj/argocd-example-apps.git
path: guestbook
destination:
server: https://kubernetes.default.svc
namespace: default
```
You can apply the example ApplicationSet and Secret with:
```bash
kubectl apply -f example/appset_and_secret.yaml
```
### Status
This is beta project still, but I'm working on getting to stable. Please open a GitHub Issue with your method of installation, your distro of k8s and the version of your k8s tooling (kustomize, helm, etc), if you're having any trouble. Also, always happy to look at PRs :)