cloutomate/argocd-vault-plugin repository overview

⁠AVP Sidecar

This project builds a custom container image for the ArgoCD Vault Plugin to be used as an ArgoCD Config Management Plugin. This plugin mechanism works by spinning up Sidecars and usually required additional configuration and setup.

This image simplifies the process, allowing a single Sidecar to be used for Helm Umbrella Charts, Kustomize Projects as well as plain YAML manifests.

⁠Setup

1. Create a Kubernetes Secret in the argocd namespace containing

   • AVP_TYE equal to the desired backend type⁠.
   • all required options for the chosen backend type (if any).

2. Sidecar Configuration

Add the Plugin Container as a Sidecar. The easiest option is to use the Helm Chart and define the Sidecar as follows:

repoServer:
  extraContainers:
  - name: avp
    image: cloutomate/argocd-vault-plugin:v1.0.0
    # Map AVP_TYPE and its configuration options from Secret
    envFrom:
    - secretRef:
        name: avp-env
    # Mount required, shared ArgoCD Volumes
    volumeMounts:
    - mountPath: /var/run/argocd
      name: var-files
    - mountPath: /home/argocd/cmp-server/plugins
      name: plugins
    - mountPath: /tmp
      name: tmp

Important:

Please note that the backend does not need to be functional, if no secret decryption was required. The backend is only verified upon first actual usage. Not setting a backend type or its required options leads to a permanent error, though.

⁠Options

• Set AVP_DEBUG Environment variable to 1 to enable verbose debug output.

⁠Reference

• ArgoCD Config Management Plugins⁠
• ArgoCD Vault Plugin⁠