https://github.com/hyperspike/argocd-cluster-register

Register Cluster-API clusters with Argo-CD
https://github.com/hyperspike/argocd-cluster-register

argocd cluster-api gitops kubernetes

Last synced: 5 months ago
JSON representation

Register Cluster-API clusters with Argo-CD

• Host: GitHub
• URL: https://github.com/hyperspike/argocd-cluster-register
• Owner: hyperspike
• License: apache-2.0
• Created: 2022-04-07T20:10:57.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2026-01-14T10:49:18.000Z (5 months ago)
• Last Synced: 2026-01-14T14:35:08.533Z (5 months ago)
• Topics: argocd, cluster-api, gitops, kubernetes
• Language: Go
• Homepage:
• Size: 1.01 MB
• Stars: 31
• Watchers: 1
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ArgoCD-Cluster-Register

[![scan workflow](https://github.com/hyperspike/argocd-cluster-register/actions/workflows/scan.yaml/badge.svg)](https://github.com/hyperspike/argocd-cluster-register/actions/workflows/scan.yaml)

[![license](https://badgen.net/github/license/hyperspike/argocd-cluster-register)](https://github.com/hyperspike/argocd-cluster-register/blob/main/LICENSE)

[![release](https://badgen.net/github/release/hyperspike/argocd-cluster-register/stable)](https://github.com/hyperspike/argocd-cluster-register/releases/latest)

[![Go Report Card](https://goreportcard.com/badge/github.com/hyperspike/argocd-cluster-register)](https://goreportcard.com/report/github.com/hyperspike/argocd-cluster-register)

_ArgoCD-Cluster-Register_ An ArgoCD controller to listen for Cluster-API clusters and register them with an ArgoCD project

## How it works

the Cluster-Register controller listens to Kubernetes-API for the [Cluster-API](https://cluster-api.sigs.k8s.io/) Resource [Cluster](https://doc.crds.dev/github.com/kubernetes-sigs/cluster-api/cluster.x-k8s.io/Cluster/v1beta1@v1.2.0) and if a cluster is in a non-deleting state it will search for Cluster Connecting resources and add a deterministic Cluster secret into the ArgoCD namespace. Furthermore it will then add the Cluster to the appropriate ArgoCD [Projects](https://doc.crds.dev/github.com/argoproj/argo-cd/argoproj.io/AppProject/v1alpha1@v2.4.4).

Thus the Cluster-Register controller never contacts CAPI or ArgoCD directly. Providing two benefits, re-use of [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) and ease of programming as there is only the controller-runtime/kubebuilder to interacte with.

## Getting Started

Please note; ArgoCD-Cluster-Register is still work in progress, and the deployment config is undergoing some updates.

    LATEST=$(curl -s https://api.github.com/repos/hyperspike/argocd-cluster-register/releases/latest | jq -r .tag_name)

    curl -sL https://github.com/hyperspike/argocd-cluster-register/releases/download/$LATEST/install.yaml | kubectl create -f -

Verifying the container image

    LATEST=$(curl -s https://api.github.com/repos/hyperspike/argocd-cluster-register/releases/latest | jq -r .tag_name)

    cosign verify ghcr.io/hyperspike/argocd-cluster-register:$LATEST  --certificate-oidc-issuer https://token.actions.githubusercontent.com --certificate-identity https://github.com/hyperspike/argocd-cluster-register/.github/workflows/image.yaml@refs/tags/$LATEST

### Notes

ArgoCD-Cluster-Register doesn't provide label based filtering at this time, but this feature is planed.

Testing includes [Kubeadm](https://kubernetes.io/docs/reference/setup-tools/kubeadm/)/[CAPI-Docs](https://cluster-api.sigs.k8s.io/tasks/kubeadm-bootstrap.html) and [EKS](https://www.amazonaws.cn/en/eks/)/[CAPI-Docs](https://cluster-api-aws.sigs.k8s.io/topics/eks/enabling.html) Clusters, other [declarative](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#clusters) auth mechanisms have not been implemented.