You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Add migration from CLI to Helm gitops runtime (#843)
* Add migration from CLI to Helm gitops runtimeAdded first draft of article for migrating CLI runtime to Helm* Update migrationAdded separate step for updating values.yaml* Update migrate-cli-runtimes-helm.md* Update migrate-cli-runtimes-helm.mdImplemented feedback* Update note in helm installEdited note in Helm install with xref to migration* Add troubleshooting section for helm validationAdded section on values.yaml in step 3 and section on helm validation troubleshooting* Update migrate-cli-runtimes-helm.md* Update hybrid-gitops-helm-installation.mdRemoved Helm chart repository in step 1 and <helm-repo-chart-name> flag from install step* Update migrate-cli-runtimes-helm.md* Update migrate-cli-runtimes-helm.mdMinor edits* Update formattingMinor formatting fixes
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+9-13Lines changed: 9 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,10 @@ redirect_from:
7
7
toc:true
8
8
---
9
9
10
-
>**ATTENTION**:
11
-
We have transitioned to a Helm-based installation for Hybrid GitOps Runtimes for improved experience and performance, which is now the default Runtime for GitOps.
12
-
The[CLI-based installation for Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) is considered legacy.
13
-
We will deprecate this installation mode permanently in the coming months. Please stay tuned for further updates and instructions, including guidelines on the migration process.
14
-
10
+
>**ATTENTION**:
11
+
We have transitioned to a Helm-based installation for Hybrid GitOps Runtimes for improved experience and performance, which is now the default Runtime for GitOps. <br><br>
12
+
The CLI-based installation for Hybrid GitOps is considered legacy. We will deprecate this installation mode permanently in the coming months.<br>
13
+
You can migrate existing CLI-based GitOps Runtimes to Helm-based ones, as described in[Migrating GitOps Runtimes from CLI to Helm]({{site.baseurl}}/docs/installation/gitops/migrate-cli-runtimes-helm/).
15
14
16
15
17
16
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts. You can install a single GitOps Runtime on a cluster. To install additional Runtimes in the same account, each account must be on a different cluster. Every Runtime within your account must have a unique name.
*`<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 installation command.
379
378
*`<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.
380
379
*`<runtime-name>` is the name of the GitOps Runtime, and is either`codefresh` which is the default, or the custom name you define.
381
-
*`<helm-repo-name>` is the name of the repo in which to store the Helm chart, and must 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.
382
380
*`gitops-runtime` is the chart name defined by Codefresh, and cannot be changed.
383
381
* GitOps with Argo CD installation:
384
382
*`argo-cd.fullnameOverride=codefresh-argo-cd` is mandatory when_installing GitOps with Argo CD_ to avoid conflicts at the cluster-level for resources in both the Community Argo CD and GitOps Runtime's Argo CD.
1. Wait for a few minutes, and then click**Close**.
401
399
You are taken to the List View for GitOps Runtimes where:
402
-
* The Hybrid GitOps Runtime you added is prefixed with a green dot indicating that it is online
403
-
* The Type column for the Runtime displays**Helm**
400
+
* The Hybrid GitOps Runtime you added is prefixed with a green dot indicating that it is online.
401
+
* The Type column for the Runtime displays**Helm**.
404
402
* The Sync Status column displays**Complete Installation**, indicating that there are pending steps to complete the installation.
405
403
* Drilling down into the Runtime shows empty tabs for Runtime Components, Git Sources, and Managed Clusters.
406
404
The Runtime Components are populated only when the GitOps Runtime is configured as an Argo Application, described later on in the installation process.
@@ -427,7 +425,7 @@ Configure Git credentials to authorize access to and ensure proper functioning o
427
425
Git credentials include authorizing access to Git through OAuth2 or a Git Runtime token, and optionally configuring SSH access to the Git installation repo for the Runtime.
428
426
429
427
**Git authorization**
430
-
* OAuth2 authorization is possible if your admin has registered an OAuth Application for Codefresh. See[OAuth2 setup forCodefresh]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/).
428
+
* OAuth2 authorization is possible if your admin has registered an OAuth Application for Codefresh. See[OAuth2 setup forGitOps]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/).
431
429
* Git access token authentication requires you to generate an access token in your Git provider account for the GitOps Runtime, with the correct scopes. See[GitOps Runtime token scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes).
432
430
433
431
**SSH access to Git**
@@ -599,8 +597,6 @@ The Git provider and Shared Configuration Repository is configured once per acco
599
597
**Shared Configuration Repository and Git provider**
600
598
The Shared Configuration Repository and Git provider are configured once per account, and not required for additional installations.
601
599
602
-
**Helm chart repository**
603
-
The repository for the Helm chart is also configured per account, and is not required for additional installations in the same account.
604
600
605
601
**Access mode**
606
602
You can define the tunnel/ingress/service-mesh-based access mode for the additional GitOps Runtimes you install. The command in the How To below is valid for the tunnel-based access mode. For ingress-based or service-mesh-based access modes, add the required arguments and values, as described in the step-by-step section,[Step 3: Install Hybrid GitOps Runtime](#step-3-install-hybrid-gitops-runtime).