Skip to content


Running the ApplicationSet controller as an image within Kubernetes

The following assumes you have:

  1. Installed a recent version of kustomize (3.x+).
  2. Created a container repository for your development image.
  3. Ran docker login from the CLI, and provided your registry credentials.
  4. Deployed ArgoCD into the argocd namespace.

To build and push a container with your current code, and deploy Kubernetes manifests for the controller Deployment:

# Build and push the image to container registry
IMAGE="(username)/argocd-applicationset:v0.0.1" make image-push

# Deploy the ApplicationSet controller manifests
IMAGE="(username)/argocd-applicationset:v0.0.1" make deploy

The ApplicationSet controller should now be running in the argocd namespace.

Running the ApplicationSet Controller as a standalone process from the CLI

When iteratively developing a Kubernetes controller, it is often easier to run the controller process from your local CLI, rather than requiring a container rebuild and push for new code changes.

  1. First, setup a local Argo CD development environment:

  2. Ensure that port 8081 is exposed in the Argo CD test server container:

    • In the Makefile file at the root of the Argo CD repo:
      • Add the following to this location in the Makefile
      • Replace: -p 4000:4000 \
      • With: -p 4000:4000 -p 8081:8081 \
      • This exposes port 8081 (the repo-server listen port), which is required for ApplicationSet Git generator functionality.
  3. Start Argo CD and wait for startup completion:

    • Ensure your active namespace is set to argocd (for example, kubectl config view --minify | grep namespace:).
    • Run make start under the Argo CD dev environment.
    • Wait for the Argo CD processes to start within the container.
    • These processes should remaining running, alongside the local ApplicationSet controller, during the following steps.
    • Verify that:
      • You have exposed port 8081 in the Makefile (as described in prerequisites). docker ps should show port 8081 as mapped to an accessible IP.
  4. Apply the ApplicationSet CRDs into the argocd namespace, and build the controller:

    • kubectl apply -f manifests/crds/argoproj.io_applicationsets.yaml
    • make build
  5. Run the Application Set Controller from the CLI:

    ./dist/argocd-applicationset --metrics-addr=":18081" --probe-addr=":18082" --argocd-repo-server=localhost:8081 --debug  --namespace=argocd

On success, you should see the following (amongst other text):

INFO    controller-runtime.controller   Starting Controller {"controller": "applicationset"}
INFO    controller-runtime.controller   Starting workers    {"controller": "applicationset", "worker count": 1}

Building docs locally

pip3 install -r docs/requirements.txt
make build-docs-local
make serve-docs-local