Runtime prerequisites

Complete the prerequisites depending on your installation mode

Before installing GitOps Runtimes, ensure you meet the system requirements, and complete the necessary prerequisites, which vary by installation mode.

Prerequisites summary

This table lists the prerequisites for installing a GitOps Runtime, depending on the installation mode.

Remove Argo Project and SealedSecret components

For GitOps Runtime installation, the target cluster should not have:

• SealedSecret controller components
• For an existing Argo CD instance:
  • Argo Events
  • Argo Rollouts
  • Argo Workflows
• For a new Argo CD instance:
  • Argo CD
  • Argo Events
  • Argo Rollouts
  • Argo Workflows

Switch ownership of Argo Project CRDs

If you have Argo Project CRDs on your cluster, you must decide how to manage them when installing the GitOps Runtime.
The table below lists the options available depending on your installation mode.

Option: Adopt all Argo Project CRDs

Adopt all Argo Project CRDs to transfer their ownership to the GitOps Runtime.
The GitOps Runtime manages them as part of the GitOps Runtime Helm chart:

• The CRDs are automatically upgraded whenever the Runtime is upgraded.
• They remain compatible with the GitOps environment.

Script to adopt all Argo Project CRDs

• Run this script before installation:
  Copy

  curl https://raw.githubusercontent.com/codefresh-io/gitops-runtime-helm/main/scripts/adopt-crds.sh | bash -s <runtime-helm-release name> <runtime-namespace>
  

Option: Adopt only Argo Rollout CRDs

Adopting only Argo Rollouts CRDs ensures that there is only one active Argo Rollouts controller active on the cluster with the GitOps Runtime.

• Run this script before installation:
  Copy

  #!/bin/sh
  RELEASE=<runtime-helm-release-name>
  NAMESPACE=<runtime-namespace>
  kubectl label --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) app.kubernetes.io/managed-by=Helm
  kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-name=$RELEASE
  kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-namespace=$NAMESPACE
  

Option: Handle Argo Project CRDs outside of the Runtime chart

• Disable CRD installation under the relevant section for each of the Argo Projects in the Helm chart:
  --set <argo-project>.crds.install=false
  where:
  <argo-project> is the Argo Project component: argo-cd, argo-workflows, argo-rollouts and argo-events.

See Argo’s readme on Helm charts.

Configure connectivity with Argo CD services (Existing Argo only)

Installing the GitOps Runtime with an existing Argo CD instance requires connectivity between the Runtime and key Argo CD services. The following Argo CD services must be accessible from the GitOps Runtime: argocd-server argocd-repo-server argocd-redis

There are two options to configure service discovery:

• Auto-detection via labels
• Configuring service names and ports in the Runtime’s values.yaml file.

Configure auto-detect for Argo CD services

Assign the correct labels to the Argo CD services for the GitOps Runtime to auto-detect them.

• argocd-server: app.kubernetes.io/component=server,app.kubernetes.io/part-of=argocd
• argocd-repo-server: app.kubernetes.io/component=repo-server,app.kubernetes.io/part-of=argocd
• argocd-redis: app.kubernetes.io/component=redis,app.kubernetes.io/part-of=argocd

Manually configure service names and ports in values.yaml

If auto-detection is not feasible, configure the names and ports for each of the Argo CD services in the Runtime’s values.yaml file located here.

Here’s an example of the service configuration in values.yaml.

global:
  external-argo-cd:
    server:
      svc: argocd
      port: 80
    redis:
      svc: argocd-redis
      port: 6379
    repoServer:
      svc: argocd-repo-server
      port: 8081
...

Verify Argo CD root path configuration (Existing Argo only)

If your existing Argo CD instance runs behind a reverse proxy and uses a non-default root path, you must configure the path in the Runtime’s values.yaml in global.external-argo-cd.server.rootpath.

Here’s an example of the non-default root path configuration for Argo CD in values.yaml.

global:
  external-argo-cd:
    server:
      svc: argocd
      port: 80
      rootpath: '/argocd' # example value if ArgoCD is behind a reverse proxy such as https://example.com/argocd/
...

Align Argo CD chart’s minor versions (Community Argo only)

To avoid potentially incompatible changes or mismatches, ensure that the Runtime installation with an existing Argo CD instance uses the same upstream version of Argo CD used by Codefresh.

1. Get the Argo CD chart version used by Codefresh from the Dependencies either in ArtifactHub or from the GitOps Runtime’s Chart.yaml in Git:
   • ArtifactHub:

• Chart.yaml:

2. Go to https://github.com/codefresh-io/argo-helm/blob/argo-cd-<dependency-chart-version>/charts/argo-cd/Chart.yaml
   where:
   <dependency-chart-version> is the Codefresh Argo CD chart version you retrieved in step 1, for example, 5.38.1-1-cap-CR-18361.
3. Check the appVersion as in the example below.

4. If your minor appversion differs from that used by Codefresh, do one of the following:
   • Lower version: Upgrade to the required minor appversion.
   • Higher version: If not available in Codefresh forks, please contact Codefresh Support.

Set resource tracking to label for existing Argo CD instance (Community Argo only)

When installing a GitOps Runtime alongside an existing Argo CD instance, ensure that the existing Argo CD instance tracks resources using the label method. If both the existing Argo CD and the Runtime Argo CD use the same tracking methods, conflicts may occur when tracking applications with the same name or when tracking the same resource.

1. In the Argo CD namespace, check the argocd-cm ConfigMap.
2. Ensure that argocd-cm.application.resourceTrackingMethod is either:
   • Not defined, in which case it defaults to label, or
   • Explicitly set to label.

Related articles

GitOps Runtimes with ingress controllers/service meshes
Ingress configuration for Runtimes
Install GitOps Runtime with existing Argo CD
Install GitOps Runtime with new Argo CD
Install GitOps Runtime alongside Community Argo CD