Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align with community image overrides format #576

Open
seaneagan opened this issue Jun 3, 2021 · 4 comments
Open

Align with community image overrides format #576

seaneagan opened this issue Jun 3, 2021 · 4 comments
Labels
2-Manifests Relates to manifest/document set related issues priority/low Items that are considered non-critical for functionality, such as quality of life improvements size m
Milestone

Comments

@seaneagan
Copy link
Contributor

Problem description (if applicable)

The charts in this repository have an image overrides format which uses a format such as:

https://github.com/airshipit/charts/blob/510ead0632c880e8bb61cff55fa1f0077bf4bcaf/charts/dex-aio/values.yaml#L7-L10

instead of the more common format from the community:

https://github.com/prometheus-community/helm-charts/blob/5f585df3bc13ab525f3841638f939f9fab018ecf/charts/kube-state-metrics/values.yaml#L3-L6

the versions catalog attempts to smooth over the differences:

name:
description: Name is an optional property that is used to
specify the name of an image. Typically, this format is
only needed for charts such as dex-aio, which uses "repo",
"name", and "tag" properties to declare images, rather than
the more commonly used "repository" and "tag". In such cases,
"repository" should contain only the name of the repository
(e.g. "quay.io") and the "name" property should contain
the image name (e.g. "metal3-io/ironic").
type: string
repository:
type: string

but the "repository"/"repo" difference means that replacement rules can't simply plug in all the images with a single rule, and instead rules for each image/field are needed:

https://review.opendev.org/c/airship/treasuremap/+/791835/25/manifests/function/dex-aio/replacements/update-dex.yaml#30

Proposed change

One of the following:

  1. rename the "repo" field to "repository", this will allow for a single replacement rule for these charts via the same format as other community charts. Could consider also eliminating the "repository" / "name" split if we want to be further aligned.
  2. Update the versions catalogue schema to separate out these different formats under two different keys e.g. image_components and image_components_airship.

Potential impacts

If we go with 1. then any consumers of these charts will need to be updated to match the new name.

@seaneagan seaneagan transferred this issue from airshipit/charts Jun 9, 2021
@lb4368 lb4368 added the triage Needs evaluation by project members label Jun 22, 2021
@jezogwza jezogwza added this to the Future milestone Jun 23, 2021
@jezogwza jezogwza added priority/low Items that are considered non-critical for functionality, such as quality of life improvements 2-Manifests Relates to manifest/document set related issues and removed triage Needs evaluation by project members labels Jun 23, 2021
@jezogwza jezogwza modified the milestones: Future, v2.1 Jul 7, 2021
@vetbijaya
Copy link
Contributor

Can someone assign this to me? Thank you.

@eak13
Copy link

eak13 commented Jul 8, 2021

@vetbijaya all yours

@eak13 eak13 added the size m label Jul 12, 2021
@seaneagan seaneagan self-assigned this Jul 13, 2021
@seaneagan
Copy link
Contributor Author

@vetbijaya i guess airshipbot is not working, here is the patchset i have for this: https://review.opendev.org/c/airship/airshipctl/+/795702

@vetbijaya
Copy link
Contributor

@seaneagan, seems like that, thank you for checking.

@vetbijaya vetbijaya removed their assignment Jul 13, 2021
@lb4368 lb4368 modified the milestones: v2.1, Future Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2-Manifests Relates to manifest/document set related issues priority/low Items that are considered non-critical for functionality, such as quality of life improvements size m
Projects
None yet
Development

No branches or pull requests

5 participants