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-61Lines changed: 41 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,22 @@ toc: true
9
9
10
10
>**ATTENTION**:
11
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 now considered legacy.
13
-
We will deprecate this installation mode permanently in the coming months. Please stay tuned for further updates and instructions, including the migration process.
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
14
15
15
16
16
Install Hybrid Runtimes for GitOps in Codefresh accounts through Helm charts.
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
21
+
18
22
19
23
***First-time GitOps Runtime installation**
20
-
If you are installing the first GitOps Runtime in a Codefresh account, make sure you the complete the [pre-requisites](#prepare-for-gitops-runtime-installation) and meet [system requirements](#minimum-system-requirements), before starting the installation. Then follow our [step-by-step guide](#install-first-gitops-runtime-in-account) to complete the installation through the Codefresh UI.
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).
21
25
22
-
***Installing additional Runtimes in account**
23
-
If you have already installed a GitOps Runtime in your account, as you have already set up the Git provider and Shared Configuration Repository for your accounts, you can go to our [quick install](#install-additional-gitops-runtimes-in-account) section.
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.
24
28
25
29
26
30
@@ -62,16 +66,10 @@ Changing the Argo CD password can result in system instability, and disrupt the
62
66
63
67
64
68
65
-
66
-
67
-
68
-
69
-
70
-
71
69
## Install first GitOps Runtime in account
72
-
To install the first GitOps Runtime in your Codefresh account, If this is the first Helm Runtime install in your Codefresh account, install the Runtime from the Codefresh UI, following our step-by-step Hybrid GitOps Runtime installation procedure
70
+
If this is the first Helm Runtime install in your Codefresh account, install the Runtime from the Codefresh UI, following the step-by-step Hybrid GitOps Runtime installation procedure.
73
71
74
-
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.
72
+
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.
75
73
76
74
### Before you begin
77
75
* Make sure you meet the [minimum requirements](#minimum-system-requirements) for installation
@@ -382,37 +380,42 @@ You can now add [external clusters to the Runtime]({{site.baseurl}}/docs/install
382
380
383
381
384
382
## Install additional GitOps Runtimes in account
385
-
Install additional GitOps Runtimes via Helm in the same account
386
-
387
-
Install the Hybrid GitOps Runtime via Helm with the default tunnel-based access mode. You will 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.
383
+
As long as the account is on different clusters, you can install additional GitOps Runtimes via Helm in the same account.
388
384
389
-
The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}. It contains all the arguments that can be configured, including optional ones.
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.
390
386
391
-
### Before running quick install
387
+
>**NOTE**:
388
+
Every Runtime must have a unique name in the same account.
392
389
393
-
**Notes & assumptions**
394
-
Quick installation assumes that:
395
-
* 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.
396
-
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/).
397
-
* Your cluster does not have [Argo project components & CRDs](#argo-project-components--crds).
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.
398
391
399
392
400
-
**Automated validation**
401
-
Codefresh automatically validates the `values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.
393
+
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
+
1. Copy the command in _Step 4_ and define the values that are not automatically populated.
402
395
403
-
* Validation failures
404
-
To get more details on the reasons for the failure, run:
alt="Copy command with automatically populated values from UI"
402
+
caption="Copy command with automatically populated values from UI"
403
+
max-width="40%"
404
+
%}
408
405
409
-
* To disable automated validation, add `--set installer.skipValidation=true` to the install command.
410
406
411
-
For more details, see [Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article.
407
+
where:
408
+
*`<helm-release-name>` is the name of the Helm release, and you can eiterh retain the default `cf-gitops-runtime`, or define a custom release name.
409
+
*`<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.
411
+
*`<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 the runtime, and must be unique in your account.
413
+
*`<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
+
*`--wait` waits until all the pods are up and running for the deployment.
412
415
413
416
## Install GitOps Runtime via Terraform
414
417
415
-
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"}.
418
+
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 your own runtime name. You can get both values for Codefresh token and account ID from the Codefresh UI as explained in the previous section.
446
+
Feel free to user a different chart version and a unique name for the Runtime. You can get both values for Codefresh token and account ID from the Codefresh UI as explained in the previous section.
444
447
445
-
By default the Codefresh runtime can deploy to the cluster it is installed on.
448
+
By default the Codefresh Runtime can deploy to the cluster it is installed on.
446
449
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.
447
450
448
-
### Copy & run Helm installation command
449
-
450
-
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"}.
451
-
1. Copy the command in _Step 4_ and define the values that are not automatically populated.
alt="Copy command with automatically populated values from UI"
459
-
caption="Copy command with automatically populated values from UI"
460
-
max-width="40%"
461
-
%}
462
-
463
-
464
-
where:
465
-
*`<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.
466
-
*`<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.
467
-
*`<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.
468
-
*`<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.
469
-
*`<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name that you define.
470
-
*`<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.
471
-
*`--wait` waits until all the pods are up and running for the deployment.
472
452
473
-
## Post-installation GitOps Runtime configuration
453
+
## Optional GitOps Runtime configuration
474
454
475
455
### Image overrides for private registries
476
456
If you use private registries, you need to override specific image values for the different subcharts and container images.
@@ -481,7 +461,7 @@ For more details, see [ArtifactHub](https://artifacthub.io/packages/helm/codefre
481
461
482
462
Repository certificates are required to authenticate users to on-premises Git servers.
483
463
484
-
If your Git servers are on-premises, add the repository certificates to your Codefresh `values` file, in `.values.argo-cd`. These values are used by the argo-cd Codefresh deploys. For details on adding repository certificates, see this [section](https://github.com/codefresh-io/argo-helm/blob/argo-cd-5.29.2-cap-CR-18430/charts/argo-cd/values.yaml#LL336C7-L336C7){:target="\_blank"}.
464
+
If your Git servers are on-premises, add the repository certificates to your Codefresh `values` file, in `.values.argo-cd`. These values are used by the Argo CD that Codefresh deploys. For details on adding repository certificates, see this [section](https://github.com/codefresh-io/argo-helm/blob/argo-cd-5.29.2-cap-CR-18430/charts/argo-cd/values.yaml#LL336C7-L336C7){:target="\_blank"}.
|Git access tokens | {::nomarkdown}Git runtime token:<ul><li>Valid expiration date</li><li>Scopes:<ul><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#github-and-github-enterprise-runtime-token-scopes">GitHub and GitHub Enterprise</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#gitlab-cloud-and-gitlab-server-runtime-token-scopes">GitLab Cloud and GitLab Server</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#bitbucket-cloud-and-bitbucket-server-runtime-token-scopes">Bitbucket Cloud and Server</a> </li></ul></ul>{:/}|
514
-
||Git personal token:{::nomarkdown}<ul><li>Valid expiration date</li><li>Scopes: <ul><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#github-and-github-enterprise-personal-user-token-scopes">GitHub and GitHub Enterprise</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#gitlab-cloud-and-gitlab-server-personal-user-token-scopes">GitLab Cloud and GitLab Server</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#bitbucket-cloud-and-server-personal-user-token-scopes">Bitbucket Cloud and Server</a> </li></ul>{:/}|
494
+
||Git user token:{::nomarkdown}<ul><li>Valid expiration date</li><li>Scopes: <ul><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#github-and-github-enterprise-personal-user-token-scopes">GitHub and GitHub Enterprise</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#gitlab-cloud-and-gitlab-server-personal-user-token-scopes">GitLab Cloud and GitLab Server</a></li><li><ahref="https://codefresh.io/docs/docs/reference/git-tokens/#bitbucket-cloud-and-server-personal-user-token-scopes">Bitbucket Cloud and Server</a> </li></ul>{:/}|
0 commit comments