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

Add README to elemetal-operator helm chart #56

Merged
merged 1 commit into from
Jul 22, 2022
Merged

Conversation

mjura
Copy link
Contributor

@mjura mjura commented Jul 17, 2022

No description provided.

@codecov-commenter
Copy link

Codecov Report

Merging #56 (46612a9) into main (2381ebc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   27.06%   27.06%           
=======================================
  Files           5        5           
  Lines         351      351           
=======================================
  Hits           95       95           
  Misses        250      250           
  Partials        6        6           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2381ebc...46612a9. Read the comment docs.

@Itxaka
Copy link
Contributor

Itxaka commented Jul 17, 2022

I'm wondering how this makes sense with our splitter chart push. I.E. on this repo we push to our GitHub helm repo but on the readme we mention the opensuse OCI registry.

I guess we should have a different reqdme here pointing to our GitHub resources and then add a different reqdme on the obs build?

Also, would it be possible to generate the readme with some helm plugin that takes those parameters as flags maybe? That would be pretty cool and we could generate it as part of the chart build

Also, docker push jobs doesn't work with forks, only with branches off the main repo so we can ignora that job for now 😀

chart/README.md Outdated
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| image.empty | string | `rancher/pause:3.1` | |
| image.repository | string | `rancher/elemental-operator` | Source image for elemental-operator with repository name |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rancher/elemental would seem like the image is on dockerhub ... instead we have:
on github: quay.io/costoolkit/elemental-operator-ci
on OBS: registry.opensuse.org/isv/rancher/elemental/teal52/15.3/rancher/elemental-operator
should we put the full OBS path?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I have provided for now path to quay.io

@fgiudici
Copy link
Member

I'm wondering how this makes sense with our splitter chart push. I.E. on this repo we push to our GitHub helm repo but on the readme we mention the opensuse OCI registry.

I guess we should have a different reqdme here pointing to our GitHub resources and then add a different reqdme on the obs build?

Also, would it be possible to generate the readme with some helm plugin that takes those parameters as flags maybe? That would be pretty cool and we could generate it as part of the chart build

Also, docker push jobs doesn't work with forks, only with branches off the main repo so we can ignora that job for now grinning

Or should we mention that the official release is on OBS (all as in the current README) and keep a separate "Dev" instructions detailing the installation from the github?

@mjura mjura force-pushed the chart-readme branch 2 times, most recently from 9c288c6 to 765df11 Compare July 20, 2022 07:47
@mjura mjura requested a review from fgiudici July 20, 2022 07:47
@Itxaka
Copy link
Contributor

Itxaka commented Jul 20, 2022

Or should we mention that the official release is on OBS (all as in the current README) and keep a separate "Dev" instructions detailing the installation from the github?

That could also work, dev charts VS official charts, nice!

Copy link
Member

@fgiudici fgiudici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably we should add some more context, because we release the chart here on github, while we point to the OBS release in the README here. Anyway, I think this is a good start, we can improve this later.
LGTM, thanks @mjura !

@mjura mjura merged commit 9b9844b into rancher:main Jul 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants