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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -29,7 +29,7 @@ Changing the ArgoCD password can result in system instability, and disrupt the p
## Quick Helm install for Hybrid GitOps Runtime
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.
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.
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.
Expand DownExpand Up
@@ -303,8 +303,19 @@ Install the Hybrid GitOps Runtime through the Helm chart. The Codefresh `values.
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.
**Namespace**
The Namespace must conform to the naming conventions for Kubernetes objects.
The Namespace must conform to the naming conventions for Kubernetes objects.
**Access modes**
You can define three different access modes:
* Tunnel-based, the default mode, automatically enabled when ingress-based access is not defined in the installation command.
* Ingress-based, uses an ingress controller, which, depending on the type of ingress controller, may need to be configured both before and after installation.
* 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.
See [Ingress controller configuration](/#ingress-controller-configuration) in this article.
<br>
**How to**
1. To generate your Codefresh API key, click **Generate**.
1. If needed, select **Customize runtime values**, and define the **Runtime Name** and **Namespace**.
The default names are `codefresh` for both.
Expand All
@@ -320,6 +331,8 @@ The Namespace must conform to the naming conventions for Kubernetes objects.
Unless otherwise indicated, values are automatically populated by Codefresh.
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.
* `<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.
* `gitops-runtime` is the chart name defined by Codefresh, and cannot be changed.
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
* `<ingress-host>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
* `<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.
* Ingress-based Runtimes:
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
* `<ingress-host>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
* `<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.
* Service-mesh-based Runtimes:
* `global.runtime.ingressUrl=<ingress-url>` is the ingress URL that is the entry point to the cluster.
* `global.runtime.ingress.enabled=false` disables the ingress-based access mode.
* `tunnel-client.enabled=false` disables the tunnel-based access mode.
* `--wait` is optional, and when defined, waits until all the pods are up and running for the deployment.
{:start="5"}
1. Wait for a few minutes, and then click **Close**.
You are taken to the List View for GitOps Runtimes where you can see:
* The Hybrid GitOps Runtime you added prefixed with a green dot indicating that it is online
* Type columnshowing **Helm**
* **Complete Installation** in the Sync Status column
You are taken to the List View for GitOps Runtimes where:
* The Hybrid GitOps Runtime you addedisprefixed with a green dot indicating that it is online
*TheType columnfor the Runtime displays **Helm**
*The Sync Status column displays**Complete Installation**, indicating that there are pending tasks to complete the installation.
1. Continue with [Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-hybrid-gitops-runtime).
Expand Down
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.