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
+47-17Lines changed: 47 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,37 @@ Install the Hybrid Runtime for GitOps through a Helm chart.
13
13
Ingress-based access modes require an ingress controller to be configured before the installation, and additional flags such as the ingress host and class to be supplied as part of the install command.
14
14
15
15
* Shared configuration repository
16
-
The Alpha version assumes that you already have a shared configuration repository for your account.
16
+
The Alpha version assumes that you already have a[shared configuration repository]({{site.baseurl}}/docs/reference/shared-configuration/) for your account.
17
17
If this is not the case, contact support to help you set one up.
18
18
19
+
* Argo project CRDs
20
+
The installation requires a cluster without Argo project CRDs.
21
+
You can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps runtime Helm release.
22
+
For details, see[Argo project CRDs](#argo-project-crds).
23
+
24
+
25
+
##Argo project CRDs
26
+
If you already have Argo project CRDs on your cluster, do one of the following:
27
+
* 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"})
28
+
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
29
+
`--set <argo-project>.crds.install=false`<br>
30
+
where:<br>
31
+
`<argo-project>` is the argo project component:`argo-cd`,`argo-workflows`,`argo-rollouts` and`argo-events`.
32
+
33
+
* Adopt the CRDs<br>
34
+
Adopting the CRDs allows them to be managed by the`gitops-runtime helm release`. Doing so ensures that a runtime upgrade also automatically upgrades the CRDs.
@@ -25,7 +53,8 @@ Install the Hybrid Runtime for GitOps through a Helm chart.
25
53
*[Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes). You will need it after installation to update runtime credentials
26
54
*[Personal Access Token (PAT)]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) for Git-based actions
27
55
* Server URLs for on-premises Git providers
28
-
* (Optional, for ingress-based runtimes only) configuration for ingress controllers:
56
+
* Verify there are no Argo project CRDs in the target namespace or that you have adopted the CRDs (see[Argo project CRDs](#argo-project-crds))
57
+
* For ingress-based runtimes only, verify that these ingress controllers are configured correctly:
>Unless otherwise indicated, values are automatically populated by Codefresh.
101
+
71
102
where:
72
103
* `<helm-release-name>` is the name of the Helm release.
73
104
* `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either `codefresh`, or the custom name you defined.
@@ -78,10 +109,11 @@ The ingress class is the ingress class of the ingress controller, for example, `
78
109
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based runtimes_, and indicates that the runtime is ingress-based.
79
110
* `<ingress-host>` is mandatory for _ingress-based runtimes_, and is the IP address or host name of the ingress controller component.
80
111
* `<ingress-class>` is mandatory for _ingress-based runtimes_, and is the ingress class of the ingress controller. For example, `nginx` for the NGINX ingress controller.
112
+
* `--wait` waits until all the pods are up and running for the deployment.
81
113
82
-
1. Verify that the deployment is up and running after a couple of minutes.
83
-
1. Define your Git provider:
114
+
1. Define your Git provider and register the Git integration:
*`<runtime-name>` is the name of the runtime, either`codefresh`, or the custom name you defined.
87
119
*`<api-url>` is the URL of the Git provider, and can be one of the following:
@@ -109,21 +141,19 @@ The ingress class is the ingress class of the ingress controller, for example, `
109
141
max-width="80%"
110
142
%}
111
143
112
-
{:start="11"}
144
+
{:start="10"}
113
145
1. Paste the token you created and click**Update Credentials**.
114
146
1. Now add your personal access token, or if your admin has set up OAuth2, authorize access.
115
147
* Click your avatar, select[**Git Personal Access Token**](https://g.codefresh.io/2.0/git-personal-access-token){:target="\_blank"}.
116
148
* Proceed as needed. For details, see[Authorize Git access in Codefresh]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/#authorize-git-access-in-codefresh).
117
149
1. If you don't have the shared configuration repository for GitOps runtimes, contact support.
118
150
>For the Alpha, we assume that you already have a shared configuration repository for your account.
119
151
1. Optional.[Create a Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/#create-a-git-source) for the runtime.
120
-
1. Optional. Required for ingress-based only. If relevant, complete the configuration for these ingress controllers:
152
+
1. Required only for ALB AWS, Istio, or NGINX Enterprise ingress-controllers.<br>
153
+
Complete the configuration for these ingress controllers:
121
154
*[ALB AWS: Alias DNS record in route53 to load balancer]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#create-an-alias-to-load-balancer-in-route53)