Skip to content

Commit c34c24d

Browse files
docs: improve docs about Runtime spec sync (#639)
1 parent 54ddfb8 commit c34c24d

File tree

3 files changed

+19
-25
lines changed

3 files changed

+19
-25
lines changed

charts/cf-runtime/Chart.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
apiVersion: v2
22
description: A Helm chart for Codefresh Runner
33
name: cf-runtime
4-
version: 8.3.16
4+
version: 8.3.17
55
keywords:
66
- codefresh
77
- runner
@@ -18,9 +18,7 @@ annotations:
1818
# Supported kinds: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`:
1919
artifacthub.io/changes: |
2020
- kind: changed
21-
description: "Update \"engine\" to 1.180.8"
22-
- kind: fixed
23-
description: "Fix race condition causing build step failures if running in parallel and inline Dockerfile is used"
21+
description: "Improve documentation regarding runtime spec synchronization"
2422
dependencies:
2523
- name: cf-common
2624
repository: oci://quay.io/codefresh/charts

charts/cf-runtime/README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Codefresh Runner
22

3-
![Version: 8.3.16](https://img.shields.io/badge/Version-8.3.16-informational?style=flat-square)
3+
![Version: 8.3.17](https://img.shields.io/badge/Version-8.3.17-informational?style=flat-square)
44

55
Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/installation/codefresh-runner/) to Kubernetes.
66

@@ -249,16 +249,6 @@ global:
249249
runtimeName: "my-cluster-name/my-namespace" # optional
250250
```
251251

252-
> **Note!** Though it's still possible to update runtime-environment via [get](https://codefresh-io.github.io/cli/runtime-environments/get-runtime-environments/) and [patch](https://codefresh-io.github.io/cli/runtime-environments/apply-runtime-environments/) commands, it's recommended to enable sidecar container to pull runtime spec from Codefresh API to detect any drift in configuration.
253-
254-
```yaml
255-
runner:
256-
# -- Sidecar container
257-
# Reconciles runtime spec from Codefresh API for drift detection
258-
sidecar:
259-
enabled: true
260-
```
261-
262252
### To 7.x
263253

264254
⚠️⚠️⚠️ **BREAKING CHANGE** ⚠️⚠️⚠️
@@ -345,6 +335,14 @@ runtime:
345335

346336
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
347337

338+
### Runtime spec synchronization
339+
340+
> **Note!** Though it's still possible to update runtime-environment via [get](https://codefresh-io.github.io/cli/runtime-environments/get-runtime-environments/) and [patch](https://codefresh-io.github.io/cli/runtime-environments/apply-runtime-environments/) CLI commands, it's recommended to apply all changes via Helm chart values and upgrade the chart.
341+
342+
To avoid drift between the Helm chart values and the actual runtime-environment spec in Codefresh, on every chart upgrade the runtime-environment spec is updated to match the chart values.
343+
344+
In addition, CronJob that enabled by default runs every 5 minutes and overrides any changes made directly in Codefresh to ensure the runtime-environment spec matches the chart values. This job may be configured via `runtime.patch.cronjob` values.
345+
348346
### EBS backend volume configuration
349347

350348
`dind-volume-provisioner` should have permissions to create/attach/detach/delete/get EBS volumes

charts/cf-runtime/README.md.gotmpl

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -249,16 +249,6 @@ global:
249249
runtimeName: "my-cluster-name/my-namespace" # optional
250250
```
251251

252-
> **Note!** Though it's still possible to update runtime-environment via [get](https://codefresh-io.github.io/cli/runtime-environments/get-runtime-environments/) and [patch](https://codefresh-io.github.io/cli/runtime-environments/apply-runtime-environments/) commands, it's recommended to enable sidecar container to pull runtime spec from Codefresh API to detect any drift in configuration.
253-
254-
```yaml
255-
runner:
256-
# -- Sidecar container
257-
# Reconciles runtime spec from Codefresh API for drift detection
258-
sidecar:
259-
enabled: true
260-
```
261-
262252
### To 7.x
263253

264254
⚠️⚠️⚠️ **BREAKING CHANGE** ⚠️⚠️⚠️
@@ -345,6 +335,14 @@ runtime:
345335

346336
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
347337

338+
### Runtime spec synchronization
339+
340+
> **Note!** Though it's still possible to update runtime-environment via [get](https://codefresh-io.github.io/cli/runtime-environments/get-runtime-environments/) and [patch](https://codefresh-io.github.io/cli/runtime-environments/apply-runtime-environments/) CLI commands, it's recommended to apply all changes via Helm chart values and upgrade the chart.
341+
342+
To avoid drift between the Helm chart values and the actual runtime-environment spec in Codefresh, on every chart upgrade the runtime-environment spec is updated to match the chart values.
343+
344+
In addition, CronJob that enabled by default runs every 5 minutes and overrides any changes made directly in Codefresh to ensure the runtime-environment spec matches the chart values. This job may be configured via `runtime.patch.cronjob` values.
345+
348346
### EBS backend volume configuration
349347

350348
`dind-volume-provisioner` should have permissions to create/attach/detach/delete/get EBS volumes

0 commit comments

Comments
 (0)