Skip to content

Commit

Permalink
add breaking change notice to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yaroslav-codefresh committed Sep 26, 2024
1 parent f3dd609 commit aa00a8e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion charts/gitops-runtime/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ annotations:
artifacthub.io/alternativeName: "codefresh-gitops-runtime"
artifacthub.io/changes: |-
- kind: changed
description: 'feat: update to upstream argo-cd 2.12.3 and helm 7.4.7 (#281)'
description: 'feat: update to upstream argo-cd 2.12.3 and helm 7.4.7 (#281). Contains a BREAKING CHANGE in the chart -- see the README.md'
- kind: changed
description: 'update gitops-operator to `0.2.12` - fix: action script fails to extract commit_sha from response (#285)'
- kind: changed
Expand Down
11 changes: 11 additions & 0 deletions charts/gitops-runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ See [Use OCI-based registries](https://helm.sh/docs/topics/registries/)
## Codefresh official documentation:
Prior to running the installation please see the official documentation at: https://codefresh.io/docs/docs/installation/gitops/hybrid-gitops-helm-installation/

## WARNING! ARGO-CD 7.x.x CHART BREAKING CHANGE

In the runtime release `0.12.0` we upgraded to the latest argo-cd `7.x.x` helm chart which
contains the breaking change in the values for providing cluster credentials
(in this chart it's located under the path `argo-cd.configs.clusterCredentials`).
`clusterCredentials` used to be of type `list` -- now it's a `map` (`object`).
See the [release notes](https://github.com/argoproj/argo-helm/releases/tag/argo-cd-7.0.0).

Codefresh Gitops Runtime does NOT use these values directly -- so the runtimes
with the default configuration are not affected.

## Using with private registries - Helper utility
The GitOps Runtime comprises multiple subcharts and container images. Subcharts also vary in values structure, making it difficult to override image specific values to use private registries.
We have created a helper utility to resolve this issue:
Expand Down

0 comments on commit aa00a8e

Please sign in to comment.