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
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+28-20Lines changed: 28 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,21 @@ The [CLI-based installation for Hybrid GitOps]({{site.baseurl}}/docs/installatio
13
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
14
15
15
16
-
Install Hybrid Runtimes forGitOps in Codefresh accountsthrough Helm charts.
16
+
This article walks you through the process of installing HybridGitOpsRuntimesinyourCodefresh accountsusing Helm charts.Please note that you can have only one GitOps Runtime per cluster, but multiple GitOps Runtimes can be installed in the same account across different clusters. Each Runtime within your account must have a unique name.
17
17
18
-
You can install a single GitOps Runtime per cluster.
19
-
Multiple Runtimes per account on different clusters.
20
-
Every Runtime in your account must be unique
18
+
***First-time GitOps Runtime installation**
19
+
If this is your first time installing a GitOps Runtime in your Codefresh account, follow these steps:
21
20
21
+
*[Complete pre-requisites]((#prepare-for-gitops-runtime-installation)): Before starting the installation, complete pre-requisites, as described in Prepare for GitOps Runtime Installation.
22
+
*[System requirements](#minimum-system-requirements): Check the minimum system requirements to ensure smooth installation.
23
+
*[Step-by-step installation](#install-first-gitops-runtime-in-account): Follow our step-by-step guide to install the Hybrid GitOps Runtime from the Codefresh UI.
22
24
23
-
***First-time GitOps Runtime installation**
24
-
If you are installing the first GitOps Runtime in your Codefresh account, before starting the installation, complete the[pre-requisites](#prepare-for-gitops-runtime-installation) and make sure you meet the[system requirements](#minimum-system-requirements). Then install the Hybrid GitOps Runtime from the Codefresh UI following our[step-by-step guide](#install-first-gitops-runtime-in-account).
25
25
26
-
***Installing additional Runtimes in accounts**
27
-
If you have already installed a GitOps Runtime in your account, and want to install additional Runtimes in the same account on different clusters, you can follow the[quick install](#install-additional-gitops-runtimes-in-account, as already set up the Git provider and Shared Configuration Repository for your account.
26
+
27
+
28
+
***Installing additional GitOps Runtimes in accounts**
29
+
If you have already installed a GitOps Runtime in your account, and want to install additional Runtimes on different clusters on different clusters within the same account, continue with a simplified installation.
30
+
Since you have already set up the Git provider and Shared Configuration Repository for your account during the initial installation, go for the[shorter install](#install-additional-gitops-runtimes-in-account).
Do not change the Argo CD password by logging into theArgoCD UI with the`argocd-initial-admin-secret`.
66
+
Do not change the Argo CD password by logging into theArgo CD UI with the`argocd-initial-admin-secret`.
64
67
Changing the Argo CD password can result in system instability, and disrupt the proper functioning of the Codefresh platform.
65
68
66
69
@@ -380,15 +383,20 @@ You can now add [external clusters to the Runtime]({{site.baseurl}}/docs/install
380
383
381
384
382
385
##Install additional GitOps Runtimes in account
383
-
As long as the account is on different clusters, you can install additional GitOps Runtimes via Helm in the same account.
386
+
After installing the first RUntime Install one or more GitOps Runtimes on different clusters within the same account.
387
+
The Codefresh`values.yaml` located[here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}, contains all the arguments you can configure, including optional ones.
384
388
385
-
Copy the Helm install command from the UI to get the values that Codefresh automatically retrieves for you such as your account ID, and then run the command.
389
+
**Git provider and Shared Configuration Repository**
390
+
The Git provider and Shared Configuration Repository is configured once per account. As you have already completed this setup in your initial installation, additional installations do not require this.
386
391
387
-
>**NOTE**:
388
-
Every Runtime must have a unique name in the same account.
392
+
**Access mode**
393
+
You can define the tunnel/ingres/service-mesh-based access mode for the additional Rntimes. The command 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 Step ??
394
+
395
+
**Runtime name**
396
+
The new Runtime must have a unique name in the same account.
389
397
390
-
The Codefresh`values.yaml` located[here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}, contains all the arguments you can configure, including optional ones.
391
398
399
+
**How to**
392
400
393
401
1. In the Codefresh UI, go to[Install Hybrid GitOps Runtime](https://g.codefresh.io/2.0/account-settings/runtimes/info/list?drawer=install-codefresh-runtime){:target="\_blank"}.
394
402
1. Copy the command in_Step 4_ and define the values that are not automatically populated.
@@ -405,19 +413,19 @@ max-width="40%"
405
413
406
414
407
415
where:
408
-
*`<helm-release-name>` is the name of the Helm release, and you caneiterh retain the default`cf-gitops-runtime`, or define a custom release name.
416
+
*`<helm-release-name>` is the name of the Helm release, and you caneither retain the default`cf-gitops-runtime`, or define a custom release name.
409
417
*`<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.
410
-
*`<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.
418
+
*`<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 if other access modes are not explicitly defined.
411
419
*`<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.
412
-
*`<runtime-name>` is the name of theruntime, and must be unique in your account.
420
+
*`<runtime-name>` is the name of theRuntime, and must be unique in your account.
413
421
*`<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.
414
422
*`--wait` waits until all the pods are up and running for the deployment.
415
423
416
424
##Install GitOps Runtime via Terraform
417
425
418
426
You can also use Terraform to install a GitOps Runtime with the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs){:target="\_blank"}.
Feel free to user a different chart version and a unique name for the Runtime. You can getboth values for Codefresh token and account ID from the Codefresh UI as explained in the previous section.
454
+
Feel free to user a different chart version and a unique name for the Runtime. You can getthe values forboth theCodefresh API token and account ID from the Codefresh UI as explained in the previous section.
447
455
448
456
By default the Codefresh Runtime can deploy to the cluster it is installed on.
449
457
You can also[use Terraform to connect additional]({{site.baseurl}}/docs/installation/gitops/managed-cluster/#add-a-managed-cluster-with-terraform) external clusters to your runtime.
@@ -457,7 +465,7 @@ If you use private registries, you need to override specific image values for th
457
465
We have a utility to help override image values for GitOps Runtimes. The utility creates values files that match the structure of the subcharts, allowing you to easily replace image registries. During chart installation, you can provide these values files to override the images, as needed.
458
466
For more details, see[ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#using-with-private-registries---helper-utility){:target="\_blank"}.
459
467
460
-
##Custom repository certificates
468
+
###Custom repository certificates
461
469
462
470
Repository certificates are required to authenticate users to on-premises Git servers.