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
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+59-3Lines changed: 59 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ There are two options for Hybrid GitOps Runtime installation via Helm, each cate
41
41
42
42
#####First-time GitOps Runtime installation
43
43
If this is your first time installing a GitOps Runtime in your Codefresh account on a clean cluster, follow these steps:
44
-
*[Complete prerequisites](#preparing-for-hybrid-gitops-runtime-installation): Before starting the installation, completepre-requisites.
44
+
*[Complete prerequisites](#preparing-for-hybrid-gitops-runtime-installation): Before starting the installation, completeprerequisites.
45
45
*[System requirements](#minimum-system-requirements): Check the minimum system requirements to ensure smooth installation.
46
46
*[Step-by-step installation](#install-first-gitops-runtime-in-account): Follow our step-by-step guide to install the Hybrid GitOps Runtime from the Codefresh UI.
47
47
@@ -69,7 +69,6 @@ In the documentation, Hybrid GitOps Runtimes are also referred to as GitOps Runt
69
69
70
70
##Preparing for Hybrid GitOps Runtime installation
71
71
72
-
73
72
Complete the prerequisites to ensure a smooth installation of Hybrid GitOps Runtime on a clean cluster.
Before initiating the installation, Codefresh automatically validates the`values.yaml` file to verify that the supplied values are correct.
133
+
A validation error will automatically terminate the installation.
134
+
135
+
You can disable automated validation and manually run the validation if desired.
136
+
137
+
###Validated settings
138
+
The table below lists the settings validated in the`values` file.
139
+
140
+
{: .table .table-bordered .table-hover}
141
+
|**Setting**|**Validation**|
142
+
| --------------| --------------|
143
+
|**userToken**|If explicitly defined, or defined as a`secretKeyRef` which exists in the current k8s context and the defined namespace.|
144
+
|**Account permissions**|If the user has admin permissions for the account in which they are installing the runtime.|
145
+
|**Runtime name**|If defined, and is unique to the account.|
146
+
|**Access mode**|{::nomarkdown}<ul><li>For tunnel-based (the default), if <codeclass="highlighter-rouge">accountId</code> is defined, and matches the account of the <codeclass="highlighter-rouge">userToken</code> defined in the file.</li><li>For ingress-based, if the hosts array contains at least one entry that is a valid URL (successful HTTP GET).</li><li>If both tunnel-based and ingress-based access modes are disabled, if <codeclass="highlighter-rouge">runtime.ingressUrl</code> is defined.</li></ul>{:/}|
147
+
|**gitCredentials**|{::nomarkdown}<ul><li>When defined, if includes a Git password either explicitly, or as a <codeclass="highlighter-rouge">secretKeyRef</code>, similar to <codeclass="highlighter-rouge">userToken</code>.</li><li>The password or token has the required permissions in the Git provider.</li></ul>{:/}|
148
+
149
+
###Validation failures
150
+
If there is a validation failure, Codefresh terminates the installation with the error message:
151
+
`Job has reached the specified backoff limit`
152
+
153
+
To get more detailed and meaningful information on the reason for the validation failure, run:
*`<values_file>` is the name of the values.yaml used by the Helm installation.
181
+
*`<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either the default`codefresh`, or the custom name you intend to use for the installation. The Namespace must conform to the naming conventions for Kubernetes objects.
182
+
*`<version>` is the version of the runtime to install.
183
+
184
+
132
185
##Install first GitOps Runtime in account
133
186
If this is the first GitOps Runtime installation in your Codefresh account, install the Runtime from the Codefresh UI, following the step-by-step installation procedure.
134
187
188
+
The Codefresh`values.yaml` located[here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}, contains all the arguments you can configure, including optional ones. See ???
189
+
190
+
191
+
135
192
136
-
The Codefresh`values.yaml` located[here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}, contains all the arguments you can configure, including optional ones.
137
193
138
194
###Before you begin
139
195
* Make sure you meet the[minimum requirements](#minimum-system-requirements) for installation