feat: image digest (#518)

codefresh-io · Nov 7, 2024 · cd679fc · cd679fc
1 parent e60a838
commit cd679fc
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 2 deletions.
diff --git a/charts/cf-runtime/Chart.yaml b/charts/cf-runtime/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 description: A Helm chart for Codefresh Runner
 name: cf-runtime
-version: 6.4.10
+version: 7.0.0
 keywords:
   - codefresh
   - runner
@@ -17,6 +17,8 @@ annotations:
   artifacthub.io/containsSecurityUpdates: "false"
   # Supported kinds: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`:
   artifacthub.io/changes: |
+    - kind: changed
+      description: "BREAKING: adding images digests"
     - kind: fixed
       description: "fix of variable replacement in arguments of typed steps (Engine 1.174.14)"
     - kind: fixed

diff --git a/charts/cf-runtime/README.md b/charts/cf-runtime/README.md
@@ -1,6 +1,6 @@
 ## Codefresh Runner
 
-![Version: 6.4.10](https://img.shields.io/badge/Version-6.4.10-informational?style=flat-square)
+![Version: 7.0.0](https://img.shields.io/badge/Version-7.0.0-informational?style=flat-square)
 
 Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/installation/codefresh-runner/) to Kubernetes.
 
@@ -16,6 +16,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [To 4.x](#to-4-x)
   - [To 5.x](#to-5-x)
   - [To 6.x](#to-6-x)
+  - [To 7.x](#to-7-x) 
 - [Architecture](#architecture)
 - [Configuration](#configuration)
   - [EBS backend volume configuration in AWS](#ebs-backend-volume-configuration)
@@ -247,6 +248,27 @@ runner:
     enabled: true
 ```
 
+### To 7.x
+
+⚠️⚠️⚠️ **BREAKING CHANGE** ⚠️⚠️⚠️
+
+7.0.0 release adds image digests to all images in default values, for example:
+
+```yaml
+runtime:
+  engine:
+    image:
+      registry: quay.io
+      repository: codefresh/engine
+      tag: 1.174.15
+      pullPolicy: IfNotPresent
+      digest: sha256:d547c2044c1488e911ff726462cc417adf2dda731cafd736493c4de4eb9e357b
+```
+
+Which means any overrides for tags won't be used and underlying Kubernetes runtime will pull the image by the digest.
+
+See [Pull an image by digest (immutable identifier)](https://docs.docker.com/reference/cli/docker/image/pull/#pull-an-image-by-digest-immutable-identifier)
+
 ## Architecture
 
 [Codefresh Runner architecture](https://codefresh.io/docs/docs/installation/codefresh-runner/#codefresh-runner-architecture)

diff --git a/charts/cf-runtime/README.md.gotmpl b/charts/cf-runtime/README.md.gotmpl
@@ -16,6 +16,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [To 4.x](#to-4-x)
   - [To 5.x](#to-5-x)
   - [To 6.x](#to-6-x)
+  - [To 7.x](#to-7-x)  
 - [Architecture](#architecture)
 - [Configuration](#configuration)
   - [EBS backend volume configuration in AWS](#ebs-backend-volume-configuration)
@@ -247,6 +248,29 @@ runner:
     enabled: true
 ```
 
+### To 7.x
+
+⚠️⚠️⚠️ **BREAKING CHANGE** ⚠️⚠️⚠️
+
+7.0.0 release adds image digests to all images in default values, for example:
+
+```yaml
+runtime:
+  engine:
+    image:
+      registry: quay.io
+      repository: codefresh/engine
+      tag: 1.174.15
+      pullPolicy: IfNotPresent
+      digest: sha256:d547c2044c1488e911ff726462cc417adf2dda731cafd736493c4de4eb9e357b
+```
+
+Which means any overrides for tags won't be used and underlying Kubernetes runtime will pull the image by the digest. 
+
+See [Pull an image by digest (immutable identifier)](https://docs.docker.com/reference/cli/docker/image/pull/#pull-an-image-by-digest-immutable-identifier)
+
+
+
 ## Architecture
 
 [Codefresh Runner architecture](https://codefresh.io/docs/docs/installation/codefresh-runner/#codefresh-runner-architecture)