We have transitioned to a Helm-based installation for Hybrid GitOps Runtimes for improved experience and performance.

The[CLI-based installation for Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) is now considered legacy.We will deprecate this installation mode permanently on August 1, 2023.

To migrate your Hybrid GitOps Runtimes from CLI to Helm, please contact us,andwe'll migrate them for you.

The[CLI-based installation for Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) is now considered legacy.

We will deprecate this installation mode permanently in the coming months. Please stay tuned for further updatesandinstructions, including the migration process.

If you already have a Codefresh acccount, go for the[quick Helm install](#quick-helm-install-for-hybrid-gitops-runtime).

**Notes & assumptions**

Quick installation assumes that:

* You have set up a Git provider and the Shared Configuration Repository for your account. If these are not defined, you can define them_after_ installation from the Codefresh UI, when prompted to do so.

See[Update Git credentials for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes) and[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/)

See[Update Git credentials for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes) and[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).

* Your cluster does not have[Argo project components & CRDs](#argo-project-components--crds).

%}

where:

*`<helm-release-name>` is the name of the Helm release that you define.

where:

*`<helm-release-name>` is the name of the Helm release, and is either the default`cf-gitops-runtime`, or any custom release name that you define.

*`<namespace>` is the namespace in which to install the Hybrid GitOps runtime, and is either`codefresh` which is the default, or any custom name that you define.

*`<codefresh-account-id>` is mandatory only for_tunnel-based Hybrid GitOps Runtimes_ which is also the default access mode. Automatically populated by Codefresh in the command.

*`<codefresh-account-id>` is mandatory only for_tunnel-based Hybrid GitOps Runtimes_ which is also the default access mode. Automatically populated by Codefresh in the command.

*`<codefresh-token>` is the API key, either an existing one or the new API key you generated. When generated, it is automatically populated in the command.

*`<runtime-name>` is the name of the runtime, either`codefresh` which is the default, or a custom name that you define.

*`<helm-repo-name>` is the name of the repo in which to add the Helm chart, and is either`cf-gitops-runtime` which is the default, or any custom name you define.

*`<helm-repo-chart-name>` is the name of the repo in which to add the Helm chart, and is either`cf-gitops-runtime` which is the default, or any custom name you define.

*`--wait` waits until all the pods are up and running for the deployment.

You can also use Terraform to install a Codefresh runtime with the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs).

You can also use Terraform to install a Codefresh runtime with the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs){:target="\_blank"}.

Here is an example

* Make sure you meet the[minimum requirements](#minimum-system-requirements) for installation

* Git provider requirements:

*[Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes). Youneed to supply as part of the Helm install command.

*[Personal Access Token (PAT)]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) with the required scopes for Git-based actions.

*[Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes) which youneed to supply as part of the Helm install command

*[Personal Access Token (PAT)]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) with the required scopes for Git-based actions

* Server URLs for on-premises Git providers

* Verify there are no Argo project components and CRDs in the target namespace or that you have adopted the CRDs (see[Argo project components & CRDs](#argo-project-components--crds))

* For ingress-based runtimes only, verify that these ingress controllers are configured correctly:

* Bitbucket Server:`<server-url>/rest/api/1.0`

1. Define the URL of the**Shared Configuration Repository**.

1. Click**Next**.

1. Continue with[Step 4: Install Hybrid Runtime](#step-4-install-hybrid-gitops-runtime).

1. To generate your Codefresh API key, click**Generate**.

1. If needed, select**Customize runtime values**, and define the**Runtime Name** and**Namespace**.

The default names are`codefresh` for both.

1. Copy and run the command to the add the repositoryfor the Helm chart:

1. Copy and run the command to the add the repositoryin which to store the Helm chart:

`helm repo add <helm-repo-name> https://chartmuseum.codefresh.io/gitops-runtime` <br>

`helm repo update`<br>

where: <br>

`<helm-repo-name>` is the name of the repository to which to add the Hybrid GitOps Runtime Helm chart. For example,`cf-gitops-runtime`.

`<helm-repo-name>` is the name of the repository to which to add the Hybrid GitOps Runtime Helm chart, and is by default`cf-gitops-runtime`.

1. Copy and run the command to install the runtime Helm chart:

The commands differ depending on the access mode. An ingress-based Hybrid GitOps Runtime requires additional flags.<br>

&nbsp;&nbsp;&nbsp;&nbsp;where:

*`<helm-release-name>` is the name of the Helm release.

*`<helm-release-name>` is the name of the Helm release, and is either`cf-gitops-runtime` which is the default, or the release name you define.

*`<namespace>` is the namespace in which to install the Hybrid GitOps runtime, and is either`codefresh` which is the default, or the custom name you define.

*`<codefresh-account-id>` is mandatory only for_tunnel-based Hybrid GitOps Runtimes_ which is the default access mode. Automatically populated by Codefresh in the installation command.

*`<codefresh-api-key>` is the API key, either an existing one or a new API key you generated. When generated, it is automatically populated in the command.

*`<runtime-name>` is the name of theruntime,either`codefresh` which is the default, ora custom name that you define.

*`<helm-repo-name>` is the name of the repo in which toadd the Helm chart, andis either`cf-gitops-runtime` which is the default, or any custom name you define.

*`gitops-runtime` is the chart name defined by Codefresh.

*`<runtime-name>` is the name of theGitOps Runtime, and iseither`codefresh` which is the default, orthe custom name you define.

*`<helm-repo-name>` is the name of the repo in which tostore the Helm chart, andmust be identical to the`<hem-repo-name>` you defined in_step 3_, either`cf-gitops-runtime` which is the default, or any custom name you define.

*`gitops-runtime` is the chart name defined by Codefresh, and cannot be changed.

*`global.runtime.ingress.enabled=true` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.

*`<ingress-host>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.

*`<ingress-class>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller.For example,`nginx` for the NGINX ingress controller.

*`--wait` waits until all the pods are up and running for the deployment.

*`<ingress-class>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller. For example,`nginx` for the NGINX ingress controller.

*`--wait`is optional, and when defined,waits until all the pods are up and running for the deployment.

{:start="5"}

1. Wait for a few minutes, and then click**Close**.

You are taken to the List View for GitOps Runtimes where you can see the Hybrid GitOps Runtime you added prefixed with a red dot.

1. Wait for a few minutes, and then click**Close**.

You are taken to the List View for GitOps Runtimes where you can see:

* The Hybrid GitOps Runtime you added prefixed with a green dot indicating that it is online

* Type column showing**Helm**

***Complete Installation** in the Sync Status column

1. Continue with[Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-hybrid-gitops-runtime).

Configure the Hybrid GitOps Runtime as an Argo Application as the final step in the installation process.

By doing so, you can view the Runtime components, easily monitor health and sync statuses, and ensure that GitOps is the single source of truth for the Runtime.

By doing so, you can view the Runtime components, monitor health and sync statuses, and ensure that GitOps is the single source of truth for the Runtime.

You cannot configure the Runtime as an Argo Application if you have not configured Git credentials for the Runtime, as described in the previous step.

1. Click**Configure as Argo Application**. Codefresh takes care of the configuration for you.

1. Continue with[Step 7: (Optional) Create a Git Source](#step-7-optional-create-a-git-source).

Create a[Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/#create-a-git-source) for the Runtime.

You can now add[external clusters to the Runtime]({{site.baseurl}}/docs/installation/gitops/managed-cluster/), and[create and deploy GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).

We have transitioned to a[Helm-based installation for Hybrid GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/), for improved experience and performance.

The CLI-based installation for Hybrid GitOps is now considered legacy.We will deprecate this installation mode permanently on August 1, 2023.

To migrate your Hybrid GitOps Runtimes from CLI to Helm, please contact us,andwe'll migrate them for you.

We have transitioned to a[Helm-based installation for Hybrid GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/) for improved experience and performance.

The CLI-based installation for Hybrid GitOps is now considered legacy.

We will deprecate this installation mode permanently in the coming months. Please stay tuned for further updatesandinstructions, including the migration process.

Provision one or more Hybrid GitOps Runtimes in your Codefresh account.