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
+41-23Lines changed: 41 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ 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
-
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using 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.
16
+
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts.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
18
***First-time GitOps Runtime installation**
19
19
If this is your first time installing a GitOps Runtime in your Codefresh account, follow these steps:
@@ -23,34 +23,34 @@ This article walks you through the process of installing Hybrid GitOps Runtimes
23
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.
24
24
25
25
26
-
27
-
28
26
***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 clusterson different clusterswithin the same account, continue with a simplified installation.
30
-
Since you have already set up theGit provider and Shared Configuration Repository foryour account duringtheinitial installation, go for the[shorter install](#install-additional-gitops-runtimes-in-account).
27
+
If you have already installed a GitOps Runtime in your account, and want to install additional Runtimes on different clusters within the same account, continue with a[simplified installation](#install-additional-gitops-runtimes-in-account) from the Codefresh UI, or use[Terraform](/install-gitops-runtime-via-terraform).
28
+
Git provider and Shared Configuration Repository forexample are not required fortheadditional Runtimes, as they are already set up for youraccount.
31
29
32
30
33
31
34
32
##Prepare for GitOps Runtime installation
35
33
36
34
37
35
###Argo project components & CRDs
38
-
Hybrid GitOps installation requires a cluster without Argo project components and CRDs.
36
+
Hybrid GitOps installation requires a cluster without Argo project components (Argo Rollouts, Argo CD, Argo Events, and Argo Workflows), and CRDs.
37
+
38
+
If you already have Argo project CRDs on your cluster, you can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps Runtime Helm release. Allowing the Runtime to manage the CRDs also ensures that the CRDs are automatically upgraded whenever the Runtime is upgraded.
39
+
39
40
40
-
* Argo project components include Argo Rollouts, Argo CD, Argo Events, and Argo Workflows.
41
+
####Handle Argo project CRDs outside of the chart
42
+
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
43
+
`--set <argo-project>.crds.install=false`<br>
44
+
where:<br>
45
+
`<argo-project>` is the argo project component:`argo-cd`,`argo-workflows`,`argo-rollouts` and`argo-events`.
46
+
47
+
See[Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"}.
41
48
42
-
* You can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps Runtime Helm release.
43
-
If you already have Argo project CRDs on your cluster, do one of the following:
44
-
* Handle Argo projects CRDs outside of the chart (see[Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"})
45
-
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
46
-
`--set <argo-project>.crds.install=false`<br>
47
-
where:<br>
48
-
`<argo-project>` is the argo project component:`argo-cd`,`argo-workflows`,`argo-rollouts` and`argo-events`.
49
+
####Adopt the Argo project CRDs (recommended)
49
50
50
-
* Adopt the CRDs<br>
51
-
Adopting the CRDs allows them to be managed by the`gitops-runtime helm release`. Doing so ensures when you upgrade the Hybrid GitOps Runtime, the CRDs are also automatically upgraded.
51
+
Adopting the CRDs, switches ownership to the Hybrid GitOps Runtime, allowing them to be managed by the GitOps Runtime chart.
52
52
53
-
Run this script_before_ installation:
53
+
Run this script_before_ installation:
54
54
55
55
```
56
56
#!/bin/sh
@@ -70,7 +70,7 @@ Changing the Argo CD password can result in system instability, and disrupt the
70
70
71
71
72
72
##Install first GitOps Runtime in account
73
-
If this is the firstHelm Runtimeinstall in your Codefresh account, install the Runtime from the Codefresh UI, following the step-by-step Hybrid GitOps Runtime installation procedure.
73
+
If this is the firstGitOps Runtimeinstallation in your Codefresh account, install the Runtime from the Codefresh UI, following the step-by-step installation procedure.
74
74
75
75
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.
76
76
@@ -383,14 +383,15 @@ You can now add [external clusters to the Runtime]({{site.baseurl}}/docs/install
383
383
384
384
385
385
##Install additional GitOps Runtimes in account
386
-
After installing the first RUntimeInstallone or more GitOps Runtimes on different clusters within the same account.
386
+
Installadditional Hybrid GitOps Runtimes on different clusters within the same account.
387
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.
388
388
389
+
389
390
**Git provider and Shared Configuration Repository**
390
-
The Git provider and Shared Configuration Repository isconfigured once per account. As you havealreadycompleted this setup in your initial installation, additional installations do not require this.
391
+
The Git provider and Shared Configuration Repository,configured once per account, isalreadyavailable this setup in your initial installation, additional installations do not require this.
391
392
392
393
**Access mode**
393
-
You can define the tunnel/ingres/service-mesh-based access mode for the additionalRntimes. 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
+
You can define the tunnel/ingress/service-mesh-based access mode for the additionalGitOps Runtimes. The commandin the How Tobelow 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 inthe step-by-step section,[Step4: Install Hybrid GitOps Runtime](/#step-4-install-hybrid-gitops-runtime).
394
395
395
396
**Runtime name**
396
397
The new Runtime must have a unique name in the same account.
@@ -421,10 +422,21 @@ where:
421
422
*`<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.
422
423
*`--wait` waits until all the pods are up and running for the deployment.
423
424
425
+
426
+
**Post-installation configuration**
427
+
428
+
Depending on your configuration, if you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See[Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
429
+
430
+
You can now add[Git Sources]({{site.baseurl}}/installation/gitops/git-sources/),[external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/),[create and deploy GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).
431
+
432
+
433
+
434
+
424
435
##Install GitOps Runtime via Terraform
425
436
426
437
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 get the values for both the Codefresh API token and account ID from the Codefresh UI as explained in the previous section.
466
+
Feel free to user a different chart version and a unique name for the Runtime. You can get the values for both the Codefresh API token and account ID from the Codefresh UI as explained in the previous section.
467
+
468
+
The example 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 4: Install Hybrid GitOps Runtime](/#step-4-install-hybrid-gitops-runtime).
469
+
470
+
Depending on your configuration, if you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See[Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
455
471
456
-
By default the Codefresh Runtime can deploy to the cluster it is installed on.
472
+
By default, the Codefresh Runtime can deploy to the cluster it is installed on.
457
473
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.
458
474
459
475
@@ -1202,5 +1218,7 @@ providers:
1202
1218
1203
1219
## Related articles
1204
1220
[Managing and monitoring GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/)
1221
+
[Add Git Sources to GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
1222
+
[Add external clusters to GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)