For the complete documentation index, see llms.txt. This page is also available as Markdown.

Install a Harness GitOps Agent

This topic describes how to install a worker process that runs in your environment and performs GitOps tasks.

This topic describes how to install a Harness GitOps Agent, a worker process that runs in your environment and performs GitOps tasks.

You need to set up an Agent before you can set up a Cluster, Repository, or Application, as the Agent is selected in all three of these.

Typically, you install the Agent in the target cluster, but you can install it any cluster and it can connect to remote clusters using the credentials you provide.

Requirements

The Harness GitOps Agent has the following requirements:

  • vCPUs, Memory, Disk Size: the Harness GitOps Agent only needs 1vCPUs, 2GB memory, 20GB disk, but you'll also be running Kubernetes and your deployed services. Consider the total CPU and memory needs for the Agent and the applications and services in your cluster.

  • Networking: outbound HTTPS for the Harness connection to app.harness.io, github.com, and hub.docker.com. Allow TCP port 22 for SSH.

  • A Kubernetes service account with the permissions need to create your desired state. The Harness GitOps Agent requires either cluster-admin or admin permissions in the target namespace:

    • Create Deployment, Service, StatefulSet, Network Policy, Service Account, Role, ClusterRole, RoleBinding, ClusterRoleBinding, ConfigMap, Secret.

    • Permission to apply CustomResourceDefinition. For more information, see User-Facing Roles from Kubernetes.

  • Namespace: The target namespace in the cluster must be created already. Harness will not create the namespace.

Using existing Argo CD projects

Typically, when you set up a Harness GitOps Agent you install a new Harness GitOps Agent in your target cluster along with other services (Repo server, Redis cache, Application controller, ApplicationSet controller).

In some cases, you might already have an Argo CD Project running in your target cluster. In this case, you can select this Project when you set up the Harness GitOps Agent.

You can use an existing Argo CD Project when you already have services deployed to different environments from that Argo CD instance.

If you don't use an existing Argo CD Project, you will create GitOps Applications, Repos, Clusters, etc in Harness. You may have to delete some of the already existing entities in Argo CD cluster, for example, repositories or cluster you already have with the same URL.

In both cases, you will install the Harness GitOps Agent process.

If you use an existing Argo CD instance, then Harness will use the following existing processes in the cluster:

  • Repo server

  • Redis cache

  • Application controller

  • ApplicationSet controller

If you do not use an existing Argo CD instance, then Harness will install the following:

  • GitOps agent

  • Repo server

  • Redis cache

  • Application controller

  • ApplicationSet controller

Go to Harness GitOps Basics to learn more about GitOps concepts.

Configure custom Argo CD component names (BYOA)

When you install the Harness GitOps Agent as an overlay on an existing Argo CD instance (Bring Your Own Argo CD), the agent health check looks for Argo CD components using the default Helm chart names (for example, argocd-redis, argocd-repo-server). If your existing Argo CD uses different service names, which is common with HA Redis (Sentinel/HAProxy) setups or custom Helm release names, the health check cannot find the expected workloads and the agent shows a DEGRADED status even though it is functionally healthy.

To resolve this, pass the correct service names for your existing Argo CD components when you install the agent with Helm. The flags differ depending on whether your Argo CD is a standard or HA install.

Non-HA setup

For a standard (non-HA) Argo CD install, use redisSvc and repoServerSvc:

For example, with a Helm release named argocd:

HA setup

For an HA Argo CD install (Redis HA with HAProxy/Sentinel), use redisHaProxySvc instead of redisSvc:

For example, with a Helm release named argocd:

You can find the correct service names by listing services in your Argo CD namespace:

Create a GitOps Agent

Create a Harness GitOps Agent

Ensure your Harness Project has the Continuous Delivery module enabled.

In your Harness Project, click GitOps.

The Harness GitOps Overview, Applications, and Settings appear. If this is the first time GitOps has been set up in the Project, the Applications will be empty.

All entities other than Applications are in Settings.

Select Settings. The Harness GitOps settings appear.

Select GitOps Agents.

Select New GitOps Agent. The Agent wizard appears.

For the example in this topic, a regular Harness GitOps agent is created without an existing Argo CD instance (non-BYOA setup). For creating a BYOA setup (with an existing Argo CD installation), please refer to Bring Your Own Argo CD into Harness GitOps

In Agent Installations, you can choose to install a Harness GitOps Agent with or without an existing Argo CD instance.

Select No, and then click Start.

In Name, enter the name for the new Agent.

In GitOps Operator, select Argo. Argo CD is the only supported GitOps reconciler. Flux is not supported.

In Namespace, enter the namespace where you want to install the Harness GitOps Agent.

If Namespaced is selected, the Harness GitOps agent is installed without cluster-scoped permissions, and it can access only those resources that are in its own namespace. You can select Skip Crds to not install Argo CD CRDs to avoid a collision if already installed.

Note that if you remove CRDs from cluster, you will loose your instances of Argo CD objects like applications, projects and application sets.

Select Next. The Helm Chart and YAML deployment options appear.

The Helm Chart option lets you download a override.yaml file for the Harness GitOps Agent. Download this file and pass it as values to the Helm chart.

The YAML option lets you download the manifest YAML for the Harness GitOps Agent. You can download this YAML file and run it in your Harness GitOps Agent cluster.

Install the Agent

Select Download Values Yaml or Download YAML. You are prompted to save the YAML file.

Open a terminal and navigate to the folder where you downloaded manifest or override YAML file.

In the same terminal, log into the Kubernetes cluster where you want to install the Agent.

For example, here's a typical GKE login:

In case of Helm Chart, run the following command to install the helm-chart file you downloaded (in this example, the namespace entered in the Namespace setting is argocd):

You can use --set argo-cd.crds.install=false to skip CRDs installation to avoid collision if CRDs were already installed with previous installation of GitOps Agent or Argo CD.

In case of YAML, run the following command to apply the YAML file you downloaded (in this example, the namespace entered in the Namespace setting is argocd):

In the following output example you can see all of the Harness GitOps objects created in Kubernetes.

This example output is for installing a new Harness GitOps Agent without using an existing Argo CD instance using the YAML.

Back in Harness, select Continue.

Harness indicates that the Harness GitOps Agents is registered.

Select Continue.

When you are finished, the Agents list shows the new Agent as Healthy and Connected.

In your cloud platform Kubernetes cluster you can see the agent workload:

Now that you have the Harness GitOps Agent installed, running, and registered, you can configure the remaining components.

Argo CD and Harness project mapping

Once you have installed the Agent, when you create Application, Cluster, or Repository in Harness project, Harness will create its own Argo CD project in the cluster and name it with a random string.

Once you use this Agent to add another entity, such as a Cluster or Repository, Harness will then map this new Argo CD project to a Harness Project identifier (Id). You will see this mapping in Harness:

If you used an existing Argo CD Project, you will see the existing Argo CD Project mapped to your Harness Project Id:

See Entity Identifier Reference.

Mapping existing Argo CD projects to Harness projects for BYOA

When you install a Harness GitOps Agent in an existing Argo CD namespace, Harness can import your existing Argo CD entities into Harness GitOps. We call this Bring Your Own Argo CD (BYOA).

In addition, when you install the Harness GitOps Agent in your existing Argo CD cluster, you can map Argo CD projects to Harness Projects. Harness will import all the Argo CD project entities (applications, clusters, repos, etc) and create them in Harness automatically.

Also, whenever new entities are created in mapped Argo CD projects, they are added to Harness automatically.

For steps on setting up the mapping and import, go to Map existing Argo projects.

Default In-Cluster

When you create a GitOps agent, a default in-cluster is automatically created. This in-cluster is special kind of cluster which does not have project set so it is always created on scope same as GitOps agent.

  • You can remove in-cluster from Harness but that does not actually delete in-cluster as it is a special cluster object. If deleted, it can be recreated.

  • For a Namespaced agent, in-cluster is not being created as the cluster access is restricted to the agent's namespace only. If you still want to deploy to the same cluster where the agent is installed, you can add a cluster as usual using a publicly available endpoint for that cluster. Additionally, you can specify namespace/namespaces when creating that cluster to restrict access only to the specified namespaces.

Advanced Options

The Harness GitOps Agent can be configured with advanced options during creation. This section goes through those options.

Proxy support

The Harness GitOps Agent can work on environments where traffic is routed through a proxy.

To do so, add your proxy settings to your GitOps agent when creating your agent.

  1. Expand the Advanced dropdown menu in the Overview page.

  2. Find the Proxy Settings as seen below and fill in the relevant fields for your proxy.

Manually configure proxy support (DEPRECATED)

To enable proxy support for the Harness GitOps Agent in environments where traffic is routed through a proxy, configuration is required for two key components: the `agent itself and the argocd-repo-server. Follow these steps to set up proxy support for both components.

  1. Agent: Add a property/config HTTPS_PROXY, and add proxy details, such as URL, port, and auth details as its value in the ConfigMap gitops-agent. For example, HTTPS_PROXY: "http://squid.proxy-test:3128".

  2. Agent: Add an environment variable NO_PROXY in the Harness GitOps Agent deployment with the following value.

  3. Argo CD Repo Server: Add the following environment variables and relevant proxy details, such as URL, port, and auth details in the argocd-repo-server deployment as well the second initcontainer under the argocd-repo-server deployment , namely the sops-helm-secrets-tool since it downloads resources from the internet using wget.

An example of how the repo-server yaml would look like:

Proxy setup for testing

Use the following YAML example to install proxy in any other environment.

Helm Secrets Path Traversal

This feature allows Helm to traverse file paths containing dots (e.g. /../). This is disabled by default due to security risks, so please enable this with caution.

To do so, check the Enable Helm Secrets Path Traversal check box under the Advanced settings dropdown when creating your agent, as pictured below.

GitOps Auto Updater Job

The GitOps Auto Updater Job is designed to automate the process of keeping the GitOps agent up to date. This job checks the GitOps service at regular intervals (default is every four hours) to determine if a new version of the GitOps agent is available.

You can customize the schedule for these checks and updates, as well as specify a private or custom registry for pulling the updated agent images.

Scheduling the Updater Job

Locate the ConfigMap: The ConfigMap is typically named gitops-agent-upgrader and can be found in the namespace where your GitOps agent is deployed.

By default, the upgrader checks for updates every four hours. You can change this frequency by modifying the schedule field in the CronJob manifest of the GitOps agent YAML file:

If you are using an overrides YAML file, add cron: "0 */4 * * *" in the Agent upgrader overrides section and run the Helm upgrade command again to apply the changes.

After making changes to the values.yaml file, run a Helm upgrade to apply the configuration:

Disable Auto Upgrader

To disable the auto-upgrader, you can set suspend: true in the CronJob configuration under the kind: CronJob section:

Alternatively, you can run the following command to suspend the auto-upgrade on the installed image:

You can also remove the entire CronJob section if necessary.

If you are using an overrides YAML file, set enabled: false in the Agent upgrader overrides section and run the Helm upgrade command again to apply the changes.

Configuring GitOps Auto Upgrader for a Private Repository

Ensure that your GitOps Auto Updater is configured to use your private registry. This involves updating the gitops-agent-upgrader ConfigMap.

Modify the ConfigMap: Add the UPGRADER_REGISTRY_MIRROR entry to specify your private repository. Here’s an example of what the ConfigMap YAML would look like:

If you are using an overrides YAML file, you will need to update the values.yaml file to include the registry mirror for the upgrader:

After making changes to the values.yaml file, run a Helm upgrade to apply the configuration:

Make sure that the agent image is hosted in your private repository with the appropriate format as mentioned in your config file, such as privateregistryhost.xyz/harness/gitops-agent:tag:

STIG-compliant agent images (SAAS - On Demand)

Harness provides STIG-compliant (Security Technical Implementation Guide) hardened gitops agent images for SAAS customers with compliance requirements.

These images are stored in a private registry and are available on-demand for organizations in regulated environments such as government agencies, financial institutions, and enterprises with stringent security policies.

How to access:

  1. Login to you Harness account, submit a Zendesk support ticket requesting STIG-compliant gitops agent images.

    Click to view full size image
  2. The Harness Customer Success team will review your request and provide a Docker Hub token for the private registry.

  3. Create a Kubernetes imagePullSecret with the provided credentials:

This will generate a secret yaml file like (harness-stig-registry-secret.yml):

4. Apply the secret manifest

  1. Update your gitops agent manifest to reference the STIG image and pull secret:

  2. GitOps agent support STIG images starting with version v0.113.0 upwards.

  3. Other STIG images

COMPONENT
IMAGE
VERSION

HAPROXY

docker.io/harnesssecure/haproxy:3.2.14-alpine3.23

3.2.14-alpine3.23

ArgoCD

docker.io/harnesssecure/argocd:v3.3.0

v3.3.0

Redis

docker.io/harness/redis:7.4.8-jammy

7.4.8-jammy

ShellCheck

docker.io/harnesssecure/shellcheck:v0.11.0

v0.11.0

GitOps Agent FAQs

Here are some answers to commonly asked GitOps Agent questions.

What version of GitOps Agent supports what version of Repo server and Redis cache?

GitOps Agent version
Packaged Argo CD version
Supported Argo CD versions
Redis version
Haproxy version

0.122.0-0.125.0

v3.4.2

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8, 3.2.5, 3.3.0, 3.3.9, 3.3.10, 3.4.2

redis:7.4.1-alpine

2.9.4-alpine

0.120.0-0.121.0

v3.3.10

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8, 3.2.5, 3.3.0, 3.3.9, 3.3.10

redis:7.4.1-alpine

2.9.4-alpine

0.118.0-0.119.0

v3.3.9

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8, 3.2.5, 3.3.0, 3.3.9

redis:7.4.1-alpine

2.9.4-alpine

0.110.0-0.117.0

v3.3.0

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8, 3.2.5, 3.3.0

redis:7.4.1-alpine

2.9.4-alpine

0.108.0

v3.2.5

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8, 3.2.5

redis:7.4.1-alpine

2.9.4-alpine

0.106.0

v3.1.8

2.8.2, 2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21, 3.1.8

redis:7.4.1-alpine

2.9.4-alpine

0.104.0 - 0.105.0

v2.14.21

2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16, 2.14.21

redis:7.4.1-alpine

2.9.4-alpine

0.102.0 - 0.103.0

v2.14.16

2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13, 2.14.16

redis:7.4.1-alpine

2.9.4-alpine

0.97.0 - 0.101.0

v2.14.13

2.10.14, 2.13.2, 2.13.5, 2.14.9, 2.14.13

redis:7.4.1-alpine

2.9.4-alpine

0.94.0 - 0.96.0

v2.14.9

2.10.10, 2.10.14, 2.13.2, 2.13.5, 2.14.9

redis:7.4.1-alpine

2.9.4-alpine

0.86.2 - 0.93.0

v2.13.5

2.9.4, 2.10.10, 2.10.14, 2.13.2, 2.13.5

redis:7.4.1-alpine

2.9.4-alpine

0.84.2 - 0.85.0

v2.13.2

2.9.0, 2.9.3, 2.9.4, 2.10.10, 2.10.14, 2.13.2

redis:7.4.1-alpine

2.9.4-alpine

0.83.0

v2.10.14

v2.8.2, 2.9.0, 2.9.3, 2.9.4, 2.10.10, 2.10.14

redis:7.2.4-alpine

2.6.14-alpine

0.82.0

RELEASE BURNED

RELEASE BURNED

RELEASE BURNED

N/A

0.78.0 - 0.81.0

v2.10.14

v2.8.2, 2.9.0, 2.9.3, 2.9.4, 2.10.10, 2.10.14

redis:7.2.4-alpine

N/A

0.77.0

v2.10.10

v2.8.2, 2.9.0, 2.9.3, 2.9.4, 2.10.10

redis:7.2.4-alpine

N/A

0.67.0 - 0.76.0

v2.9.4

v2.7.2, v.2.7.8, v2.8.2, 2.9.0, 2.9.3, 2.9.4

redis:7.0.11-alpine

N/A

0.66.0

v2.9.3

v2.7.2, v.2.7.8, v2.8.2, 2.9.0, 2.9.3

redis:7.0.11-alpine

N/A

0.64.0 - 0.65.0

v2.9.0

v2.7.2, v.2.7.8, v2.8.2, 2.9.0,

redis:7.0.11-alpine

N/A

0.60.0 - 0.63.0

v2.8.2

v2.3.5, v2.7.2, v.2.7.8, v2.8.2

redis:7.0.11-alpine

N/A

The supported Argo CD versions listed above are what Harness has verified. However, any patch version should work for each minor version listed. For example, the GitOps agent version 0.78.0 should support the Argo CD version of 2.10.0, but this is not verified by Harness.

How long is a GitOps Agent version supported?

Harness supports GitOps Agent versions that support Argo CD versions n to n-2 minor version (e.g 2.5.4, 2.4.4, 2.3.4).

The GitOps Agent comes with an upgrader service that performs upgrades and automatically detects when an upgrade is needed.

If you disable automatic upgrades, we recommend you manually update often since Harness is actively rolling out bug fixes and feature enhancements.

The Argo CD components upgrade must be done manually.

How can I uninstall a GitOps Agent?

If you need to uninstall a GitOps Agent, you can use kubectl delete with the same manifest you used to install it. For example, kubectl delete -f gitops-agent.yml -n argocd.

What happens if CRDs are removed when uninstalling a GitOps agent?

When you uninstall the GitOps agent, deleting its CRDs will also delete all GitOps-managed apps in the cluster. To avoid accidental data loss, ensure CRDs are preserved:

This tells Helm not to delete CRDs when you run: helm uninstall <releaseName>

If you installed the agent with an older or custom chart that doesn’t include crds.keep: true, Helm’s default behavior will delete CRDs (and all dependent apps) on uninstall. Either override that setting at uninstall time or update your chart to include it.

High Availability GitOps Agent

The Harness GitOps agent is a worker process based on Argo CD that is responsible for executing Harness GitOps tasks. It has the following components:

  • agent

  • redis

  • argocd-application-controller

  • argocd-repo-server

  • argocd-applicationset-controller

It has two install types:

  • Normal

  • High Availability (HA)

Normal Agent

The Normal install type installs exactly 1 replica of all components.

High Availability (HA)

Both Argo CD and Harness have an HA install type. The Harness HA type installs different variations of the components with more than 1 replicas.

  • agent has 2 replicas. In HA mode, the agent will utilize a Horizontal Pod Autoscaler for CPU and memory, with a minimum of 1 replica and a maximum of 5 replicas.

  • redis has 3 replicas/sentinels (haproxy).

  • argocd-application-controller has 1 replica (Argo CD uses 2).

  • argocd-repo-server server has 2 replicas.

  • argocd-applicationset-controller has 1 replica.

Argo CD use case

Handling UI load

Since Argo CD has only 1 instance per UI, adding multiple replicas helps to manage load from the UI.

Adding multiple replicas helps scale the operations required by the UI, so more users can log in concurrently. For more information, go to argocd-server.

Handling the application reconciliation and syncs

Argo CD performs application reconciliation and syncs using the argocd-application-controller and argocd-repo-server.

The argocd-application-controller has 2 queues that are used for processing of application reconciliation and application syncs. By default, argocd-application-controller has 20 processors for the application reconciliation queue and 10 processors for the application syncs.

For reference, the Argo CD community recommends using 50 and 20 processors respectively for 1000 applications.

For more information, go to:

The argocd-application-controller also watches (at a fixed frequency of 10 seconds, by default) the clusters using the Kubernetes client on the current state and maintains a cache for faster retrieval.

If the controller manages a lot of clusters and is facing memory issues, the clusters are sharded (ARGOCD_CONTROLLER_SHARDING_ALGORITHM) across multiple replicas of argocd-application-controller.

For more information, go to High Availability from Argo CD.

Handling Monorepos

The argocd-repo-server maintains one repository clone locally and uses it for application manifest generation. If the manifest generation must change a file in the local repository clone, then only one concurrent manifest generation per server instance is allowed. This limitation might significantly slowdown Argo CD if you have a monorepo with multiple applications (50+).

For more information, go to High Availability from Argo CD.

Harness use cases

With Harness GitOps, multiple agents can run within a single Harness project. Harness is not limited to a single agent instance—you can deploy multiple agents across different scopes or clusters, enabling you to manage more applications and environments than a standard Argo CD setup.

When to use Harness GitOps HA Agent?:

  • If you have high UI activity (50+ active sessions) for the applications on the agent.

  • When you have a monorepo.

  • If you want to add more than 100 applications per agent.

Considerations

Harness Agent reconciliation

The GitOps agent has 2 types of reconciliation on top of the Argo CD's reconciliation. This ensures that the data the GitOps service has is in sync with what is present in the destination cluster.

  1. On CRUD events, reconciliation runs every 10 seconds.

  2. The bulk reconciliation (to check if anything was removed/added in the cluster directly) runs every 100 seconds.

Known problem (Fixed)

As of GitOps Agent 0.89 this has been fixed. If you are encountering this issue, please upgrade your GitOps Service to version 1.28 or higher, and agent to 0.89 or higher.

In older agent versions, when agents run with multiple replicas, each replica is unaware of the others. As a result, reconciliation runs on all replicas independently.

Consequently, if there is a HA agent running 5 pods, all of the pods would send the reconcile call (5 times in 1 cycle). This resulted in computing overhead.

The highAvailability flag

The highAvailability flag controls how the agent performs health checks for Redis components:

  • highAvailability: true: Checks for High Availability (HA) Redis with HAProxy (redis-ha-haproxy)

  • highAvailability: false: Checks for standard Redis service (argocd-redis)

When to use:

Scenario
highAvailability flag

External Redis

false

BYOA with standard Redis

false

BYOA with High Availability (HA) Redis

true

If set incorrectly, the agent shows DEGRADED status even though it functions normally. Go to Troubleshooting to fix this issue.


References

Last updated

Was this helpful?