Hybird helm updates (#733)

NimRegev · web-flow · commit f2b7275e0167 · 2023-06-18T15:17:25.000+03:00
* Update hybrid helm installation

Added section on repo certs for on-prem git servers, and more info with UI link for copying auto-populated values

* Update hybrid-gitops-helm-installation.md

* Update hybrid-gitops-helm-installation.md

* Update hybrid-gitops-helm-installation.md

* Update hybrid-gitops-helm-installation.md

* Updated screenshot for quick install copy command

* Update hybrid-gitops-helm-installation.md

* Update helm install

Edited Helm install argument descriptions; fixed redirect path for shared config repo topic
diff --git a/_docs/installation/gitops/hybrid-gitops-helm-installation.md b/_docs/installation/gitops/hybrid-gitops-helm-installation.md
@@ -1,5 +1,5 @@
 ---
-title: "Hybrid GitOps Runtime installation"
+title: "Hybrid GitOps Helm Runtime installation"
 description: "Provision Hybrid GitOps Runtimes through Helm"
 group: installation
 redirect_from:
@@ -9,13 +9,15 @@ toc: true
 
 Install the Hybrid Runtime for GitOps through a Helm chart.
 
-If you already have a Codefresh acccount, go for the [quick install](#quick-helm-install-for-hybrid-gitops-runtime). For step-by-step installation from the Codefresh UI, see [Step-by-step Hybrid GitOps Runtime installation walkthrough](#step-by-step-hybrid-gitops-runtime-installation-walkthrough). 
+If you already have a Codefresh acccount, go for the [quick install](#quick-helm-install-for-hybrid-gitops-runtime).  
+
+For step-by-step installation from the Codefresh UI, see [Step-by-step Hybrid GitOps Runtime installation walkthrough](#step-by-step-hybrid-gitops-runtime-installation-walkthrough). 
 
 >Hybrid GitOps installation with Helm is currently in Beta.
 
 ## Quick Helm install for Hybrid GitOps Runtime
 
-Install the Hybrid GitOps Runtime via Helm with the default tunnel-based access mode. 
+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 other values.
 
 The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}.
 
@@ -27,57 +29,42 @@ Quick installation assumes that:
   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-repo/)
 * Your cluster does not have [Argo project CRDs](#argo-project-crds).
 
-**Copy automatically populated values from Codefresh UI**  
-For quick installation from a terminal, required values such as Helm release and chart names, as well as the Codefresh account ID for default tunnel-based installation, are automatically generated by Codefresh within the UI. Copy the automatically populated values you need from the UI.
+
+**Automated validation**  
+Codefresh automatically validates the `values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.  
+
+* Validation failures  
+  To get more details on the reasons for the failure, run:  
+    `kubectl logs jobs/validate-values -n ${NAMESPACE}`  
+    where:  
+      * `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime. 
+
+* To disable automated validation, add `--set installer.skipValidation=true` to the install command.
+
+For more details, see [Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article. 
+
+### Copy & run Helm installation command
 
 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"}.
-1. Copy the required values from Step 4 as shown in the example below.
+1. Copy the command in _Step 4_ and define the values that are not automatically populated.
 
 {% include
 image.html
 lightbox="true"
 file="/images/runtime/hybrid-helm-quick-install-copy-values.png"
 url="/images/runtime/hybrid-helm-quick-install-copy-values.png"
-alt="Copy automatically populated values from UI"
-caption="Copy automatically populated values from UI"
+alt="Copy command with automatically populated values from UI"
+caption="Copy command with automatically populated values from UI"
 max-width="40%"
 %}
 
-**Automated validation**  
-Codefresh automatically validates the `values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.  
-To get more details on the reasons for the failure, run:  
-  `kubectl logs jobs/validate-values -n ${NAMESPACE}`  
-  where:  
-  * `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime. 
-
-To disable automated validation, add `--set installer.skipValidation=true` to the install command.
-
-For more details, see [Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article. 
-
-### Quick install command
-
->**IMPORTANT**:  
-Before running the installation command in the terminal, make sure to copy the automatically populated values from the UI. See **Copy automatically populated values from Codefresh UI** in the previous section.
-
- 
-{% highlight yaml %} 
-helm upgrade --install <helm-release-name> \
-  --create-namespace \
-  --namespace <namespace> \
-  --set global.codefresh.accountId=<codefresh-account-id> \
-  --set global.codefresh.userToken.token=<codefresh-api-key> \
-  --set global.runtime.name=<runtime-name> \
-  <helm-repo-name>/gitops-runtime \
-  --devel \
-  --wait  
-{% endhighlight yaml %}
 
 where:  
   * `<helm-release-name>` is the name of the Helm release that you define.  
-  * `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, and is either `codefresh` which is the default, or any custom name you define.
-  *  `<codefresh-account-id>` is mandatory only for _tunnel-based Hybrid GitOps Runtimes_ which is also the default access mode. Automatically generated by Codefresh. Copy it from the Codefresh UI.
-  * `<codefresh-api-key>` is an existing or generated API key. If generated, copy it from the Codefresh UI.
-  * `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name you define. 
+  * `<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.
+  *  `<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. 
+  * `<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.
+  * `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name that you define. 
   * `<helm-repo-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. 
   * `--wait` waits until all the pods are up and running for the deployment.  
 
@@ -295,7 +282,6 @@ helm upgrade --install <helm-release-name> \
 <br>
 
   **Ingress-based install chart command:**  
-
 {% highlight yaml %}
 helm upgrade --install <helm-release-name> \
   --create-namespace \
@@ -311,13 +297,13 @@ helm upgrade --install <helm-release-name> \
 {% endhighlight %}
 <br>
 
-&nbsp;&nbsp;&nbsp;&nbsp;where: 
-  * 
+&nbsp;&nbsp;&nbsp;&nbsp;where:  
+  *    
       * `<helm-release-name>` is the name of the Helm release.  
-      * `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either `codefresh`, or the custom name you defined.  
-      * `<codefresh-account-id>` is mandatory only for _tunnel-based Hybrid GitOps Runtimes_.
-      * `<codefresh-api-key>` is the generated API key.
-      * `<runtime-name>` is the name of the runtime, either `codefresh`, or the custom name you defined. 
+      * `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, and is either `codefresh` which is the default, or the custom name you define.  
+      * `<codefresh-account-id>` is mandatory only for _tunnel-based Hybrid GitOps Runtimes_ which is the default access mode. Automatically populated by Codefresh in the installation command.
+      * `<codefresh-api-key>` is the API key, either an existing one or a new API key you generated. When generated, it is automatically populated in the command.
+      * `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name that you define. 
       * `<helm-repo-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. 
       * `gitops-runtime` is the chart name defined by Codefresh.
       * `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
diff --git a/_docs/installation/gitops/shared-configuration.md b/_docs/installation/gitops/shared-configuration.md
@@ -3,7 +3,7 @@ title: "Shared Configuration Repository"
 description: "Share configuration settings across GitOps Runtimes"
 group: installation
 redirect_from:
-  - /reference/shared-configuration/
+  - /docs/reference/shared-configuration/
 toc: true
 ---
 
diff --git a/images/runtime/hybrid-helm-quick-install-copy-values.png b/images/runtime/hybrid-helm-quick-install-copy-values.png
