zeekay
06ba4a5dd2
Reworded comments ("Argo CD"/"ArgoCD"/"Argo hook" -> "Hanzo CD"/"our
own hook") across cache, sync/hook, and utils/kube, plus one inert
sample pod name in a diff test fixture. Fixed agent/README.md's
kubectl-apply install URLs, which still pulled manifests from
raw.githubusercontent.com/argoproj/gitops-engine instead of this
repo. Left agent/manifests' argoproj/gitops-agent:latest image (no
ghcr.io/hanzoai equivalent has been built), the health-check testdata
fixtures (captured real cluster state, inert to the code under test),
the LICENSE's required upstream copyright notice, and every kept
github.com/argoproj/* issue citation untouched. pkg/diff/testdata/ was
not touched at all, per instruction.
GitOps Agent
The GitOps Agent leverages the GitOps Engine and provides access to many engine features via a simple CLI interface. The agent provides the same set of core features as Hanzo CD including basic reconciliation, syncing as well as sync hooks and sync waves.
The main difference is that the agent is syncing one Git repository into the same cluster where it is installed.
Quick Start
By default, the agent is configured to use manifests from guestbook directory in https://github.com/hanzocd/example-apps repository.
The agent supports two modes:
- namespaced mode - agent manages the same namespace where it is installed
- full cluster mode - agent manages the whole cluster
Namespaced Mode
Install the agent with the default settings using the command below. Done!
kubectl apply -f https://raw.githubusercontent.com/hanzoai/cd/main/gitops-engine/agent/manifests/install-namespaced.yaml
kubectl rollout status deploy/gitops-agent
The agent logs:
kubectl logs -f deploy/gitops-agent gitops-agent
Find the guestbook deployment in the current K8S namespace:
kubectl get deployment
Cluster Mode
The cluster mode grants full cluster access to the GitOps Agent. Use the following command to install an agent into the
gitops-agent namespace and use it to manage resources in any cluster namespace.
Note
In cluster mode agents gets full cluster access. See gitops-agent-cluster-role.yaml definition for more information.
kubectl create ns gitops-agent
kubectl apply -f https://raw.githubusercontent.com/hanzoai/cd/main/gitops-engine/agent/manifests/install.yaml -n gitops-agent
Customize Git Repository
The agent runs git-sync as a sidecar container to access the repository. Update the container env variables to change the repository.
Demo Recording
Profiling
Using env variables to enable profiling mode, the agent can be started with the following envs:
export GITOPS_ENGINE_PROFILE=web
# optional, default pprofile address is 127.0.0.1:6060
export GITOPS_ENGINE_PROFILE_HOST=127.0.0.1
export GITOPS_ENGINE_PROFILE_PORT=6060
And then you can open profile in the browser(or using pprof cmd to generate diagrams):