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
1. Download the Codefresh CLI and authenticate it with your Codefresh account. Follow [here](https://codefresh-io.github.io/cli/getting-started/) for more detailed instructions.
44
-
2. Run the following command to create mandatory values for Codefresh Runner:
45
+
- Specify the following mandatory values
45
46
46
-
```console
47
-
codefresh runner init --generate-helm-values-file
48
-
```
47
+
```yaml
48
+
# -- Global parameters
49
+
# @default -- See below
50
+
global:
51
+
# -- User token in plain text (required if `global.codefreshTokenSecretKeyRef` is omitted!)
52
+
# Ref: https://g.codefresh.io/user/settings (see API Keys)
53
+
codefreshToken: ""
54
+
# -- User token that references an existing secret containing API key (required if `global.codefreshToken` is omitted!)
55
+
codefreshTokenSecretKeyRef: {}
56
+
# E.g.
57
+
# codefreshTokenSecretKeyRef:
58
+
# name: my-codefresh-api-token
59
+
# key: codefresh-api-token
49
60
50
-
* This will not install anything on your cluster, except for running cluster acceptance tests, which may be skipped using the `--skip-cluster-test` option.
51
-
* This command will also generate a `generated_values.yaml` file in your current directory, which you will need to provide to the `helm upgrade` command later.
52
-
3. Run the following to complete the installation:
61
+
# -- Account ID (required!)
62
+
# Can be obtained here https://g.codefresh.io/2.0/account-settings/account-information
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
97
+
98
+
```console
99
+
helm show values cf-runtime/cf-runtime
100
+
```
68
101
69
102
## Upgrade Chart
70
103
@@ -83,7 +116,7 @@ Affected values:
83
116
### To 3.x
84
117
85
118
⚠️⚠️⚠️
86
-
### Please, READ this before the upgrade!
119
+
### READ this before the upgrade!
87
120
88
121
This major release adds [runtime-environment](https://codefresh.io/docs/docs/installation/codefresh-runner/#runtime-environment-specification) spec into chart templates.
89
122
That means it is possible to set parametes for `dind` and `engine` pods via [values.yaml](./values.yaml).
@@ -138,6 +171,69 @@ runtime:
138
171
Affected values:
139
172
- `.runtime.dind.pvcs` converted from **list** to **dict**
140
173
174
+
### To 6.x
175
+
176
+
⚠️⚠️⚠️
177
+
### READ this before the upgrade!
178
+
179
+
This major release deprecates previously required `codefresh runner init --generate-helm-values-file`.
180
+
181
+
Affected values:
182
+
- **Replaced** `.monitor.clusterId` with `.global.context` as **mandatory** value!
#### Migrate the Helm chart from version 5.x to 6.x
190
+
191
+
Given this is the legacy `generated_values.yaml` values:
192
+
193
+
> legacy `generated_values.yaml`
194
+
```yaml
195
+
{
196
+
"appProxy": {
197
+
"enabled": false,
198
+
},
199
+
"monitor": {
200
+
"enabled": false,
201
+
"clusterId": "my-cluster-name",
202
+
"token": "1234567890"
203
+
},
204
+
"global": {
205
+
"namespace": "namespace",
206
+
"codefreshHost": "https://g.codefresh.io",
207
+
"agentToken": "0987654321",
208
+
"agentId": "agent-id-here",
209
+
"agentName": "my-cluster-name_my-namespace",
210
+
"accountId": "my-account-id",
211
+
"runtimeName": "my-cluster-name/my-namespace",
212
+
"codefreshToken": "1234567890",
213
+
"keys": {
214
+
"key": "-----BEGIN RSA PRIVATE KEY-----...",
215
+
"csr": "-----BEGIN CERTIFICATE REQUEST-----...",
216
+
"ca": "-----BEGIN CERTIFICATE-----...",
217
+
"serverCert": "-----BEGIN CERTIFICATE-----..."
218
+
}
219
+
}
220
+
}
221
+
```
222
+
223
+
Update `values.yaml` for new chart version:
224
+
225
+
> For existing installation for backward compatibility `.Values.global.agentToken/agentTokenSecretKeyRef` **must be provided!** For installation from scratch this value is no longer required.
226
+
227
+
> updated `values.yaml`
228
+
```yaml
229
+
global:
230
+
codefreshToken: "1234567890"
231
+
accountId: "my-account-id"
232
+
context: "my-cluster-name"
233
+
agentToken: "0987654321" # MANDATORY when migrating from < 6.x chart version !
0 commit comments