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

Commitd06f1da

Browse files
authored
Gitops helm validation updates (#728)
* Fix numbering in platform certs proc* Update hybrid-gitops-helm-installation.mdFixed broken links
1 parent485c09c commitd06f1da

File tree

1 file changed

+69
-27
lines changed

1 file changed

+69
-27
lines changed

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

Lines changed: 69 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +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). 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).
1313

1414
>Hybrid GitOps installation with Helm is currently in Beta.
1515
1616
##Quick Helm install for Hybrid GitOps Runtime
1717

1818
Install the Hybrid GitOps Runtime via Helm with the default tunnel-based access mode.
1919

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

2222
>**NOTE**:
2323
Quick Helm install assumes:
@@ -27,7 +27,7 @@ The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gi
2727

2828

2929
* Run:
30-
`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`
30+
`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 --set --devel --wait`
3131

3232
where:
3333
*`<helm-release-name>` is the name of the Helm release.
@@ -38,6 +38,16 @@ The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gi
3838
*`gitops-runtime` is the chart name defined by Codefresh.
3939
*`--wait` waits until all the pods are up and running for the deployment.
4040

41+
**Automated validation**
42+
Codefresh automatically validates the`values` file before initiating the installation. If there is a validation failure, Codefresh terminates the installation.
43+
To get more details on the reasons for the failure, run:
44+
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
45+
where:
46+
*`{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.
47+
48+
To disable automated validation, add`--set installer.skipValidation=true` to the install command.
49+
50+
For more details, see[Step 1: (Optional) Validate Helm values file](#step-1-optional-validate-helm-values-file) in this article.
4151

4252
##Argo project CRDs
4353
Hybrid GitOps installation requires a cluster without Argo project CRDs.
@@ -75,49 +85,83 @@ Install the Hybrid GitOps Runtime via Helm from the Codefresh UI.
7585
The Codefresh`values.yaml` is located[here](https://github.com/codefresh-io/gitops-runtime-helm/tree/main/charts/gitops-runtime){:target="\_blank"}.
7686

7787
###Before you begin
78-
* Make sure you meet the[minimum requirements]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#minimum-system-requirements) for installation
88+
* Make sure you meet the[minimum requirements](#minimum-system-requirements) for installation
7989
* Git provider requirements:
8090
*[Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes). You need to supply as part of the Helm install command.
8191
*[Personal Access Token (PAT)]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) with the required scopes for Git-based actions.
8292
* Server URLs for on-premises Git providers
8393
* Verify there are no Argo project CRDs in the target namespace or that you have adopted the CRDs (see[Argo project CRDs](#argo-project-crds))
8494
* For ingress-based runtimes only, verify that these ingress controllers are configured correctly:
85-
*[Ambassador ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#ambassador-ingress-configuration)
86-
*[AWS ALB ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#alb-aws-ingress-configuration)
87-
*[Istio ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#istio-ingress-configuration)
88-
*[NGINX Enterprise ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#nginx-enterprise-ingress-configuration)
89-
*[NGINX Community ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#nginx-community-version-ingress-configuration)
90-
*[Traefik ingress configuration]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#traefik-ingress-configuration)
95+
*[Ambassador ingress configuration](#ambassador-ingress-configuration)
96+
*[AWS ALB ingress configuration](#aws-alb-ingress-configuration)
97+
*[Istio ingress configuration](#istio-ingress-configuration)
98+
*[NGINX Enterprise ingress configuration](#nginx-enterprise-ingress-configuration)
99+
*[NGINX Community ingress configuration](#nginx-community-version-ingress-configuration)
100+
*[Traefik ingress configuration](#traefik-ingress-configuration)
91101
<br><br>
92102

93103

94104

95105

96106
###Step 1: (Optional) Validate Helm values file
97-
Codefresh automatically validates the`values.yaml` file before starting the installation to verify that the settings are correct.
98-
If you prefer, you can also manually validate the file.
107+
Codefresh automatically validates the`values.yaml` file before initiating the installation to verify that the supplied values are correct.
108+
You also have the option to manually run the validation if desired.
109+
110+
<!--- **Validation failure**
111+
If there is a validation failure, Codefresh will terminate the Helm installation and display the error message: `Job has reached the specified backoff limit`.
112+
113+
To get more detailed and meaningful information on the reason for the validation failure, run:
114+
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
115+
where:
116+
* `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.
117+
118+
**Disable automated validation**
119+
You may want to disable automated validation for specific scenarios, such as to address false-negatives.
120+
You can do so by either adding the flag to the Helm install command or adding the relevant section to the `values` file.
121+
122+
* In install command:
123+
`--set installer.skipValidation=true`
99124
100-
The table below lists the settings that are validated in the`values` file.
125+
* In `values` file:
126+
127+
{% highlight yaml %}
128+
{% raw %}
129+
...
130+
131+
installer:
132+
skipValidation: true
133+
134+
...
135+
{% endraw %}
136+
{% endhighlight %}
137+
138+
**Validated settings**-->
139+
140+
The table below lists the settings validated in the`values` file.
101141

102142
{: .table .table-bordered .table-hover}
103143
| Setting| Validation|
104144
| --------------| --------------|
105145
|**`userToken`**| If explicitly defined, or defined as a`secretKeyRef` which exists in the current k8s context and the defined namespace.|
106146
|**Account permissions**| If the user has admin permissions for the account in which they are installing the runtime.|
107147
|**Runtime name**| If defined, and is unique to the account.|
108-
|**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 <codeclass="highlighter-rouge">hosts</code> array contains at least one entry that is a valid URL (successful HTTP GET).</li></ul>{:/}|
148+
|**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 <codeclass="highlighter-rouge">hosts</code> 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>{:/}|
109149
|**`gitCredentials`**| {::nomarkdown}<ul><li>When defined, 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>{:/}|
110150

111151

112152

113-
**How to**
153+
**How to: Manually validate values file**
114154

115-
1.Run:
116-
`cfconfig validate --values <values_file> --namespace <namespace> --version <version>`
155+
1.To manually validate the`values` file, run:
156+
`cfhelm validate --values <values_file> --namespace <namespace> --version <version>`
117157
where:
118158
*`<values_file>` is the name of the values.yaml used by the Helm installation.
119159
*`<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.
120160
*`<version>` is the version of the runtime to install.
161+
<!---1. If there is a validation failure, to see more details on the reasons for the failure, run:
162+
`kubectl logs jobs/validate-values -n ${NAMESPACE}`
163+
where:
164+
* `{NAMESPACE}` must be replaced with the namespace of the Hybrid GitOps Runtime.-->
121165
1. Continue with[Step 2: Select Hybrid Runtime install option](#step-2-select-hybrid-runtime-install-option).
122166

123167
###Step 2: Select Hybrid Runtime install option
@@ -127,11 +171,11 @@ The table below lists the settings that are validated in the `values` file.
127171
* If you have already provisioned a Hybrid GitOps Runtime, to provision additional runtimes:
128172
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and from Runtimes in the sidebar, select[**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
129173
1. Click**+ Add Runtimes**, and then select**Hybrid Runtimes**.
130-
1. Continue with[Step 3: Set up GitOps Gitaccount](#step-3-set-up-gitops-git-account).
174+
1. Continue with[Step 3: Set up GitOps Gitprovider](#step-3-set-up-gitops-git-provider).
131175

132176
###Step 3: Set up GitOps Git provider
133177
Select the Git provider, define the provider's API URL, and the Shared Configuration Repository for your account.
134-
The[Shared Configuration Repository]({{site.baseurl}}docs/reference/shared-configuration/) is a Git repository with configuration manifests shared between all the Hybrid GitOps Runtimes within the same account.
178+
The[Shared Configuration Repository]({{site.baseurl}}/docs/reference/shared-configuration/) is a Git repository with configuration manifests shared between all the Hybrid GitOps Runtimes within the same account.
135179

136180
>**NOTE**:
137181
This is a one-time action, required once per account.
@@ -147,9 +191,9 @@ The [Shared Configuration Repository]({{site.baseurl}}docs/reference/shared-conf
147191
1. Define the URL of the**Shared Configuration Repository**.
148192
>NOTE:
149193
>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.
150-
>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).
194+
>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).
151195
1. Click**Next**.
152-
1. Continue with[Step 4: Install Hybrid Runtime](#step-4-install-hybrid-runtime).
196+
1. Continue with[Step 4: Install Hybrid Runtime](#step-4-install-hybrid-gitops-runtime).
153197

154198
###Step 4: Install Hybrid GitOps Runtime
155199

@@ -161,8 +205,6 @@ If you define a custom name for the Hybrid GitOps Runtime, it must start with a
161205

162206
**Namespace**
163207
The Namespace must conform to the naming conventions for Kubernetes objects.
164-
>NOTE:
165-
>If you have already validated your`values.yaml` file in[Step 1: Validate Helm values file](#step-1-validate-helm-values-file), verify that the Namespace is identical to the one defined in the`cf config validate` command.
166208

167209
1. To generate your Codefresh API key, click**Generate**.
168210
1. If needed, select**Customize runtime values**, and define the**Runtime Name** and**Namespace**.
@@ -197,7 +239,7 @@ The Namespace must conform to the naming conventions for Kubernetes objects.
197239
* `--wait` waits until all the pods are up and running for the deployment.
198240
1. Wait for a few minutes, and then click**Close**.
199241
You are taken to the List View for GitOps Runtimes where you can see the Hybrid GitOps Runtime you added prefixed with a red dot.
200-
1. Continue with[Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-runtime).
242+
1. Continue with[Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-hybrid-gitops-runtime).
201243

202244

203245

@@ -280,9 +322,9 @@ Create a [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/#cre
280322
Required only for ALB AWS, Istio, or NGINX Enterprise ingress-controllers.<br>
281323

282324
* Complete configuring these ingress controllers:
283-
*[ALB AWS: Alias DNS record in route53 to load balancer]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#create-an-alias-to-load-balancer-in-route53)
284-
*[Istio: Configure cluster routing service]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#cluster-routing-service)
285-
*[NGINX Enterprise ingress controller: Patch certificate secret]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#patch-certificate-secret)
325+
*[ALB AWS: Alias DNS record in route53 to load balancer](#create-an-alias-to-load-balancer-in-route53)
326+
*[Istio: Configure cluster routing service](#cluster-routing-service)
327+
*[NGINX Enterprise ingress controller: Patch certificate secret](#patch-certificate-secret)
286328

287329
That's it! You have successfully completed installing a Hybrid GitOps Runtime with Helm. See the Runtime in the[Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#gitops-runtime-views) page.
288330

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp