codefresh-io
diff --git a/‎_docs/installation/gitops/hybrid-gitops-helm-installation.md
Lines changed: 81 additions & 24 deletions b/‎_docs/installation/gitops/hybrid-gitops-helm-installation.md
Lines changed: 81 additions & 24 deletions
diff --git a/‎images/runtime/hybrid-helm-quick-install-copy-values.png
84.8 KB b/‎images/runtime/hybrid-helm-quick-install-copy-values.png
84.8 KB
@@ -19,27 +19,29 @@ Install the Hybrid GitOps Runtime via Helm with the default tunnel-based access
 
 The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}.
 
-> **NOTE**:  
-  Quick Helm install assumes:  
-  * 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.
-  * Your cluster does not have [Argo project CRDs](#argo-project-crds).
-
-
-
-* Run:  
-  `helm upgrade --install <helm-release-name> --create-namespace --namespace <namespace> --set global.codefresh.userToken.token=<codefresh-api-key> --set global.runtime.name=<runtime-name> <helm-repo-name>/gitops-runtime --set --devel --wait`  
-  
-  >**NOTE**:  
-  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>
-
-  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-api-key>` is the generated API key.
-  * `<runtime-name>` is the name of the runtime, either `codefresh`, or the custom name you defined. 
-  * `gitops-runtime` is the chart name defined by Codefresh.
-  * `--wait` waits until all the pods are up and running for the deployment.  
+### Before running quick install
+
+**Notes & assumptions**  
+Quick installation assumes that:
+* 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.  
+  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.
+
+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.
+
+{% 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"
+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.  
@@ -52,6 +54,35 @@ To disable automated validation, add `--set installer.skipValidation=true` to th
 
 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. 
+  * `<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.  
+
+
+
 ## Argo project CRDs
 Hybrid GitOps installation requires a cluster without Argo project CRDs.    
 You can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps Runtime Helm release. 
@@ -82,6 +113,31 @@ If you use private registries, you need to override specific image values for th
 We have a utility to help override image values for GitOps Runtimes. The utility creates values files that match the structure of the subcharts, allowing you to easily replace image registries. During chart installation, you can provide these values files to override the images, as needed.
 For more details, see [ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#using-with-private-registries---helper-utility){:target="\_blank"}.
 
+## Custom repository certificates
+
+Repository certificates are required to authenticate users to on-premises Git servers.  
+
+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"}.
+
+{% highlight yaml %} 
+global:
+  codefresh:
+    tls:
+      caCerts:
+        # optional - use an existing secret that contains the cert
+        # secretKeyRef:
+        #   name: my-certificate-secret
+        #   key: ca-bundle.crt
+        # or create "codefresh-tls-certs" secret
+        secret:
+          create: true
+          content: |
+            -----BEGIN CERTIFICATE-----
+            ...
+            -----END CERTIFICATE-----
+{% endhighlight yaml %}
+
+
 ## Step-by-step Hybrid GitOps Runtime installation walkthrough
 Install the Hybrid GitOps Runtime via Helm from the Codefresh UI.
 
@@ -191,9 +247,9 @@ The [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/
   * Bitbucket Cloud: `https://api.bitbucket.org/2.0`
   * Bitbucket Server: `<server-url>/rest/api/1.0`
 1. Define the URL of the **Shared Configuration Repository**.
-   >NOTE:   
-     >Because the Shared Configuration repo is defined at the account-level, the Git provider you select for the first Runtime in your account is used for all the other Runtimes in the same account. 
-     >To change the Shared repo or Git credentials after installation, see [Update Git credentials for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes).
+   >**NOTE**:   
+     >Because the Shared Configuration Repo is defined at the account-level, the Git provider you select for the first Runtime in your account is used for all the other Runtimes in the same account. 
+     >To change the Shared Configuration Repo or Git credentials after installation, see [Update Git credentials for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes).
 1. Click **Next**.
 1. Continue with [Step 4: Install Hybrid Runtime](#step-4-install-hybrid-gitops-runtime).
 
@@ -262,6 +318,7 @@ helm upgrade --install <helm-release-name> \
       * `<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. 
+      * `<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.
       * `<ingress-host>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.