Quick start: Installing a GitOps Runtime

Install the Helm-based GitOps Runtime

Install GitOps Runtime quick start

Follow this quick start to install the GitOps Runtime in Codefresh.
It outlines system requirements, prerequisites, and installation modes.

Runtime installation modes

Choose from two installation options based on your existing Argo CD setup:

  • Install with an existing Argo CD instance (default)
    If your cluster already runs Argo CD, the GitOps Runtime integrates with it by installing additional Codefresh components. This option integrates seamlessly without modifying your existing deployment.

  • Install with a new Argo CD instance If Argo CD is not installed, Codefresh can deploy and configure it along with the GitOps Runtime.

The key difference is whether Argo CD instance is either external to the Runtime or installed as part of it. For an architectural overview, see Runtime installation modes and architecture.

Quick start assumptions

This quick start assumes you are:

  • Installing the first GitOps Runtime in your Codefresh account.
  • Using tunnel-based access mode.
    GitOps Runtimes support both tunnel-based and ingress-based access modes.
    This quick start follows the default tunnel-based mode, which does not require an ingress controller. For details, see Runtime access modes and architecture.

  • Using GitHub as the Git provider.

Runtime system requirements

Before installation, make sure your environment meets the system requirements.

Runtime prerequisites

Complete the prerequisites to prepare your environment for the selected installation mode.

Installing with an existing Argo CD instance (default)

Follow the installation wizard to install the GitOps Runtime with an existing Argo CD instance.

Installing with a new Argo CD instance

Follow the installation wizard to install the GitOps Runtime with a new Argo CD instance.

What’s next?

After installation, configure the GitOps Runtime to complete the setup.

Quick start: Configuring a GitOps Runtime