Quick start: Installing a Hybrid GitOps Runtime

Install the Helm-based Hybrid GitOps Runtime

If you’ve reviewed and verified that you meet the requirements for a GitOps Runtime, let’s go ahead and install the Runtime.

Before you begin

Verify you have completed the prerequisites

Install the GitOps Runtime

1. In the Welcome page, select + Install Runtime.
2. From Runtimes in the sidebar, select GitOps Runtimes.
3. Click Hybrid Runtimes, and then click Add.
4. Install the Hybrid GitOps Runtime:
   1. Click Generate to create a new API key.
   2. Retain the default values for the GitOps Runtime name and namespace, codefresh.
   3. Copy the command in Step 3 and run it to install the Helm chart for the Hybrid GitOps Runtime:
      where:
      • cf-gitops-runtime is the default name of the Helm release, which you can change if needed.
      • codefresh is the default namespace in which to install the Hybrid GitOps runtime.
      • <codefresh-account-id> is mandatory for tunnel-based Hybrid GitOps Runtimes, and is automatically populated by Codefresh in the command.
      • <codefresh-token> is the API key you generated, and is also automatically populated in the command.
      • codefresh is the default name of the Runtime.
      • oci://quay.io/codefresh/gitops-runtime is the name of the Helm chart, predefined by Codefresh, and cannot be changed.

5. Wait for a few minutes, and then click Close.
   You are taken to the List View for GitOps Runtimes, where the Sync Status column displays Complete Installation.
6. In the Sync Status column, click Complete Installation.
   Codefresh displays the steps to complete installing the GitOps Runtime.

7. Click Add to integrate the Runtime token for your Git provider account:
   1. If not GitHub, select the Git provider.
   2. Define the provider’s API URL.
   3. Define the URL of the Shared Configuration Repository.
8. Click Add to add the user token for your Git provider account, and then paste the token in the field.
9. Complete the installation by clicking Configure as Argo Application.
   There is no need for any further action from you, as Codefresh takes care of the configuration. By configuring the Hybrid GitOps Runtime as an Argo Application, you can ensure that GitOps is the single source of truth for the Runtime, view and monitor Runtime components.

What’s next

Let’s create a Git Source to which we’ll link the applications we’ll create later in the quick start series.
Explore Git Sources and why we need them in Managing Git Sources in GitOps Runtimes.

Quick start: Creating a Git Source