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

Commita08e8bf

Browse files
authored
Gitops helm validation updates (#729)
* Fix numbering in platform certs proc* Update hybrid-gitops-helm-installation.mdFixed broken links* Add updates for validation stepUpdated content for validation step with debug and disable options* Update validation and install stepsImplemented review comments for validation step;added yaml formatting for install commands and fixed note on populated values
1 parentd06f1da commita08e8bf

File tree

1 file changed

+58
-26
lines changed

1 file changed

+58
-26
lines changed

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

Lines changed: 58 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,15 @@ 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 --set --devel --wait`
30+
`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`
3131

32+
>**NOTE**:
33+
Unless otherwise indicated, values are automatically populated by Codefresh.
34+
If you're using a terminal, remember to copy the values from the UI beforehand.<br>
35+
3236
where:
3337
*`<helm-release-name>` is the name of the Helm release.
3438
*`<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either`codefresh`, or the custom name you defined.
35-
*`<codefresh-account-id>` is your Codefresh account ID.
3639
*`<codefresh-api-key>` is the generated API key.
3740
*`<runtime-name>` is the name of the runtime, either`codefresh`, or the custom name you defined.
3841
*`gitops-runtime` is the chart name defined by Codefresh.
@@ -107,7 +110,9 @@ The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gi
107110
Codefresh automatically validates the`values.yaml` file before initiating the installation to verify that the supplied values are correct.
108111
You also have the option to manually run the validation if desired.
109112

110-
<!--- **Validation failure**
113+
114+
**Validation failure**
115+
111116
If there is a validation failure, Codefresh will terminate the Helm installation and display the error message:`Job has reached the specified backoff limit`.
112117

113118
To get more detailed and meaningful information on the reason for the validation failure, run:
@@ -135,7 +140,8 @@ installer:
135140
{% endraw %}
136141
{% endhighlight %}
137142

138-
**Validated settings**-->
143+
144+
**Validated settings**
139145

140146
The table below lists the settings validated in the`values` file.
141147

@@ -157,11 +163,7 @@ The table below lists the settings validated in the `values` file.
157163
where:
158164
*`<values_file>` is the name of the values.yaml used by the Helm installation.
159165
*`<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.
160-
*`<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.-->
166+
*`<version>` is the version of the runtime to install. To target the latest pre-release version, use`--devel` instead of`--version <version>`.
165167
1. Continue with[Step 2: Select Hybrid Runtime install option](#step-2-select-hybrid-runtime-install-option).
166168

167169
###Step 2: Select Hybrid Runtime install option
@@ -216,27 +218,57 @@ The Namespace must conform to the naming conventions for Kubernetes objects.
216218
`<helm-repo-name>` is the name of the repository to which to add the Hybrid GitOps Runtime Helm chart. For example,`cf-gitops-runtime`.
217219
1. Copy and run the command to install the runtime Helm chart:
218220
The commands differ depending on the access mode. An ingress-based Hybrid GitOps Runtime requires additional flags.<br>
221+
222+
>**NOTE**:
223+
Unless otherwise indicated, values are automatically populated by Codefresh.
224+
If you're using a terminal, remember to copy the values from the UI beforehand.<br>
225+
226+
**Tunnel-based install chart command:**<br>
227+
{% highlight yaml %}
228+
helm upgrade --install <helm-release-name>\
229+
--create-namespace\
230+
--namespace <namespace>\
231+
--set global.codefresh.accountId=<codefresh-account-id>\
232+
--set global.codefresh.userToken.token=<codefresh-api-key>\
233+
--set global.runtime.name=<runtime-name>\
234+
<helm-repo-name>/gitops-runtime\
235+
--devel\
236+
--wait
237+
{% endhighlight %}
238+
239+
<br>
219240

220-
**Tunnel-based install chart command:**<br>
221-
`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`
241+
**Ingress-based install chart command:**
222242

243+
{% highlight yaml %}
244+
helm upgrade --install <helm-release-name>\
245+
--create-namespace\
246+
--namespace <namespace>\
247+
--set global.codefresh.userToken.token=<codefresh-api-key>\
248+
--set global.runtime.name=<runtime-name>\
249+
--set global.runtime.ingress.enabled=true\
250+
--set "global.runtime.ingress.hosts[0]"=<ingress-host>\
251+
--set global.runtime.ingress.className=<ingress-class>\
252+
<helm-repo-name>/gitops-runtime\
253+
--devel\
254+
--wait
255+
{% endhighlight %}
256+
<br>
223257

224-
**Ingress-based install chart command:**
225-
`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 global.runtime.ingress.enabled=true --set "global.runtime.ingress.hosts[0]"=<ingress-host> --set global.runtime.ingress.className=<ingress-class> --devel --wait`
226-
227-
>Unless otherwise indicated, values are automatically populated by Codefresh.
258+
&nbsp;&nbsp;&nbsp;&nbsp;where:
259+
*
260+
* `<helm-release-name>` is the name of the Helm release.
261+
* `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either `codefresh`, or the custom name you defined.
262+
* `<codefresh-account-id>` is mandatory only for _tunnel-based Hybrid GitOps Runtimes_.
263+
* `<codefresh-api-key>` is the generated API key.
264+
* `<runtime-name>` is the name of the runtime, either `codefresh`, or the custom name you defined.
265+
* `gitops-runtime` is the chart name defined by Codefresh.
266+
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
267+
* `<ingress-host>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
268+
* `<ingress-class>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller. For example, `nginx` for the NGINX ingress controller.
269+
* `--wait` waits until all the pods are up and running for the deployment.
228270

229-
where:
230-
* `<helm-release-name>` is the name of the Helm release.
231-
* `<namespace>` is the namespace in which to install the Hybrid GitOps runtime, either `codefresh`, or the custom name you defined.
232-
* `<codefresh-account-id>` is your Codefresh account ID.
233-
* `<codefresh-api-key>` is the generated API key.
234-
* `<runtime-name>` is the name of the runtime, either `codefresh`, or the custom name you defined.
235-
* `gitops-runtime` is the chart name defined by Codefresh.
236-
* `global.runtime.ingress.enabled=true` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and indicates that the runtime is ingress-based.
237-
* `<ingress-host>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the IP address or host name of the ingress controller component.
238-
* `<ingress-class>` is mandatory for _ingress-based Hybrid GitOps Runtimes_, and is the ingress class of the ingress controller. For example, `nginx` for the NGINX ingress controller.
239-
* `--wait` waits until all the pods are up and running for the deployment.
271+
{:start="5"}
240272
1. Wait for a few minutes, and then click**Close**.
241273
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.
242274
1. Continue with[Step 5: Configure Git credentials for runtime](#step-5-configure-git-credentials-for-hybrid-gitops-runtime).

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp