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
* Update hybrid-gitops-helm-installation.mdAdded install command set for service mesh mode and blurb on access modes supported* Update hybrid-gitops-helm-installation.mdContent edits* Update hybrid-gitops-helm-installation.md* Update hybrid-gitops-helm-installation.md
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+42-9Lines changed: 42 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Changing the ArgoCD password can result in system instability, and disrupt the p
29
29
30
30
##Quick Helm install for Hybrid GitOps Runtime
31
31
32
-
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 andother values.
32
+
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, andthen run the command.
33
33
34
34
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.
35
35
@@ -303,8 +303,19 @@ Install the Hybrid GitOps Runtime through the Helm chart. The Codefresh `values.
303
303
If you define a custom name for the Hybrid GitOps Runtime, it must start with a lower-case character, and can include up to 62 lower-case characters and numbers.
304
304
305
305
**Namespace**
306
-
The Namespace must conform to the naming conventions for Kubernetes objects.
306
+
The Namespace must conform to the naming conventions for Kubernetes objects.
307
307
308
+
**Access modes**
309
+
You can define three different access modes:
310
+
* Tunnel-based, the default mode, automatically enabled when ingress-based access is not defined in the installation command.
311
+
* Ingress-based, uses an ingress controller, which, depending on the type of ingress controller, may need to be configured both before and after installation.
312
+
* Service-mesh-based, which may also need to be configured before and after installation. This mode requires explicitly disabling the tunnel- and ingress-based modes in the installation command.
313
+
314
+
See[Ingress controller configuration](/#ingress-controller-configuration) in this article.
315
+
316
+
<br>
317
+
318
+
**How to**
308
319
1. To generate your Codefresh API key, click**Generate**.
309
320
1. If needed, select**Customize runtime values**, and define the**Runtime Name** and**Namespace**.
310
321
The default names are`codefresh` for both.
@@ -320,6 +331,8 @@ The Namespace must conform to the naming conventions for Kubernetes objects.
320
331
Unless otherwise indicated, values are automatically populated by Codefresh.
321
332
If you're using a terminal, remember to copy the values from the UI beforehand.<br>
*`<runtime-name>` is the name of the GitOps Runtime, and is either`codefresh` which is the default, or the custom name you define.
361
389
*`<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.
362
390
*`gitops-runtime` is the chart name defined by Codefresh, and cannot be changed.
363
-
*`global.runtime.ingress.enabled=true` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
364
-
*`<ingress-host>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
365
-
*`<ingress-class>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller. For example,`nginx` for the NGINX ingress controller.
391
+
* Ingress-based Runtimes:
392
+
*`global.runtime.ingress.enabled=true` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
393
+
*`<ingress-host>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
394
+
*`<ingress-class>` is mandatory for_ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller. For example,`nginx` for the NGINX ingress controller.
395
+
* Service-mesh-based Runtimes:
396
+
*`global.runtime.ingressUrl=<ingress-url>` is the ingress URL that is the entry point to the cluster.
397
+
*`global.runtime.ingress.enabled=false` disables the ingress-based access mode.
398
+
*`tunnel-client.enabled=false` disables the tunnel-based access mode.
366
399
*`--wait` is optional, and when defined, waits until all the pods are up and running for the deployment.
367
400
368
401
{:start="5"}
369
402
1. Wait for a few minutes, and then click**Close**.
370
-
You are taken to the List View for GitOps Runtimes where you can see:
371
-
* The Hybrid GitOps Runtime you added prefixed with a green dot indicating that it is online
372
-
* Type columnshowing**Helm**
373
-
***Complete Installation** in the Sync Status column
403
+
You are taken to the List View for GitOps Runtimes where:
404
+
* The Hybrid GitOps Runtime you addedisprefixed with a green dot indicating that it is online
405
+
*TheType columnfor the Runtime displays**Helm**
406
+
*The Sync Status column displays**Complete Installation**, indicating that there are pending tasks to complete the installation.
374
407
1. Continue with[Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-hybrid-gitops-runtime).