Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb55c47e

Browse files
authored
Gitops runtime validation content (#1032)
* Add validation sectionAdded values.yaml automated and manual validation info* Update hybrid-gitops-helm-installation.md* Update app-context-menu-in-product.png* Update hybrid-gitops-helm-installation.md
1 parentab8c119 commitb55c47e

File tree

2 files changed

+59
-3
lines changed

2 files changed

+59
-3
lines changed

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

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ There are two options for Hybrid GitOps Runtime installation via Helm, each cate
4141

4242
#####First-time GitOps Runtime installation
4343
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.
4545
*[System requirements](#minimum-system-requirements): Check the minimum system requirements to ensure smooth installation.
4646
*[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.
4747

@@ -69,7 +69,6 @@ In the documentation, Hybrid GitOps Runtimes are also referred to as GitOps Runt
6969

7070
##Preparing for Hybrid GitOps Runtime installation
7171

72-
7372
Complete the prerequisites to ensure a smooth installation of Hybrid GitOps Runtime on a clean cluster.
7473

7574

@@ -129,11 +128,68 @@ kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{p
129128
kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-namespace=$NAMESPACE
130129
```
131130

131+
##Validating`values.yaml`
132+
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:
154+
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
155+
where:
156+
*`{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.
157+
158+
###Disable automated validation
159+
You may want to disable automated validation for specific scenarios, such as to address false-negatives.
160+
Do so by either adding the flag to the Helm install command or adding the relevant section to the values file.
161+
162+
163+
#####In install command
164+
`--set installer.skipValidation=true`
165+
166+
#####In values file
167+
{% highlight yaml %}
168+
{% raw %}
169+
...
170+
installer: skipValidation: true
171+
...
172+
{% endraw %}
173+
{% endhighlight %}
174+
175+
176+
###Manually validate values.yaml
177+
To manually validate the values file, run:
178+
`cf helm validate --values <values_file> --namespace <namespace> --version <version>`
179+
where:
180+
*`<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+
132185
##Install first GitOps Runtime in account
133186
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.
134187

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+
135192

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.
137193

138194
###Before you begin
139195
* Make sure you meet the[minimum requirements](#minimum-system-requirements) for installation
-32 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp