Skip to content

Commit f2b7275

Browse files
NimRegevNimRegev
authored
Hybird helm updates (codefresh-io#733)
* 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
1 parent 6dd950b commit f2b7275

File tree

3 files changed

+34
-48
lines changed

3 files changed

+34
-48
lines changed

‎_docs/installation/gitops/hybrid-gitops-helm-installation.md

Lines changed: 33 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Hybrid GitOps Runtime installation"
2+
title: "Hybrid GitOps Helm Runtime installation"
33
description: "Provision Hybrid GitOps Runtimes through Helm"
44
group: installation
55
redirect_from:
@@ -9,13 +9,15 @@ toc: true
99

1010
Install the Hybrid Runtime for GitOps through a Helm chart.
1111

12-
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).
12+
If you already have a Codefresh acccount, go for the [quick install](#quick-helm-install-for-hybrid-gitops-runtime).
13+
14+
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).
1315

1416
>Hybrid GitOps installation with Helm is currently in Beta.
1517
1618
## Quick Helm install for Hybrid GitOps Runtime
1719

18-
Install the Hybrid GitOps Runtime via Helm with the default tunnel-based access mode.
20+
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.
1921

2022
The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}.
2123

@@ -27,57 +29,42 @@ Quick installation assumes that:
2729
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/)
2830
* Your cluster does not have [Argo project CRDs](#argo-project-crds).
2931

30-
**Copy automatically populated values from Codefresh UI**
31-
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.
32+
33+
**Automated validation**
34+
Codefresh automatically validates the `values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.
35+
36+
* Validation failures
37+
To get more details on the reasons for the failure, run:
38+
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
39+
where:
40+
* `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.
41+
42+
* To disable automated validation, add `--set installer.skipValidation=true` to the install command.
43+
44+
For more details, see [Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article.
45+
46+
### Copy & run Helm installation command
3247

3348
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"}.
34-
1. Copy the required values from Step 4 as shown in the example below.
49+
1. Copy the command in _Step 4_ and define the values that are not automatically populated.
3550

3651
{% include
3752
image.html
3853
lightbox="true"
3954
file="/images/runtime/hybrid-helm-quick-install-copy-values.png"
4055
url="/images/runtime/hybrid-helm-quick-install-copy-values.png"
41-
alt="Copy automatically populated values from UI"
42-
caption="Copy automatically populated values from UI"
56+
alt="Copy command with automatically populated values from UI"
57+
caption="Copy command with automatically populated values from UI"
4358
max-width="40%"
4459
%}
4560

46-
**Automated validation**
47-
Codefresh automatically validates the `values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.
48-
To get more details on the reasons for the failure, run:
49-
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
50-
where:
51-
* `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.
52-
53-
To disable automated validation, add `--set installer.skipValidation=true` to the install command.
54-
55-
For more details, see [Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article.
56-
57-
### Quick install command
58-
59-
>**IMPORTANT**:
60-
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.
61-
62-
63-
{% highlight yaml %}
64-
helm upgrade --install <helm-release-name> \
65-
--create-namespace \
66-
--namespace <namespace> \
67-
--set global.codefresh.accountId=<codefresh-account-id> \
68-
--set global.codefresh.userToken.token=<codefresh-api-key> \
69-
--set global.runtime.name=<runtime-name> \
70-
<helm-repo-name>/gitops-runtime \
71-
--devel \
72-
--wait
73-
{% endhighlight yaml %}
7461

7562
where:
7663
* `<helm-release-name>` is the name of the Helm release that you define.
77-
* `<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.
78-
* `<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.
79-
* `<codefresh-api-key>` is an existing or generated API key. If generated, copy it from the Codefresh UI.
80-
* `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name you define.
64+
* `<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.
65+
* `<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.
66+
* `<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.
67+
* `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name that you define.
8168
* `<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.
8269
* `--wait` waits until all the pods are up and running for the deployment.
8370

@@ -295,7 +282,6 @@ helm upgrade --install <helm-release-name> \
295282
<br>
296283

297284
**Ingress-based install chart command:**
298-
299285
{% highlight yaml %}
300286
helm upgrade --install <helm-release-name> \
301287
--create-namespace \
@@ -311,13 +297,13 @@ helm upgrade --install <helm-release-name> \
311297
{% endhighlight %}
312298
<br>
313299

314-
&nbsp;&nbsp;&nbsp;&nbsp;where:
315-
*
300+
&nbsp;&nbsp;&nbsp;&nbsp;where:
301+
*
316302
* `<helm-release-name>` is the name of the Helm release.
317-
* `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either `codefresh`, or the custom name you defined.
318-
* `<codefresh-account-id>` is mandatory only for _tunnel-based Hybrid GitOps Runtimes_.
319-
* `<codefresh-api-key>` is the generated API key.
320-
* `<runtime-name>` is the name of the runtime, either `codefresh`, or the custom name you defined.
303+
* `<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.
304+
* `<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.
305+
* `<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.
306+
* `<runtime-name>` is the name of the runtime, either `codefresh` which is the default, or a custom name that you define.
321307
* `<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.
322308
* `gitops-runtime` is the chart name defined by Codefresh.
323309
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.

‎_docs/installation/gitops/shared-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Shared Configuration Repository"
33
description: "Share configuration settings across GitOps Runtimes"
44
group: installation
55
redirect_from:
6-
- /reference/shared-configuration/
6+
- /docs/reference/shared-configuration/
77
toc: true
88
---
99

‎images/runtime/hybrid-helm-quick-install-copy-values.png

62.5 KB
Loading

0 commit comments

Comments
 (0)