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

🌱 Update Cluster API Visualizer chart to v1.0.0 #7018

Merged
merged 1 commit into from
Sep 2, 2022

Conversation

Jont828
Copy link
Contributor

@Jont828 Jont828 commented Aug 5, 2022

What this PR does / why we need it: Update Cluster API Visualizer chart to v1.0.0

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 5, 2022
@k8s-ci-robot
Copy link
Contributor

@Jont828: This issue is currently awaiting triage.

If CAPI contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 5, 2022
@@ -3,9 +3,8 @@ replicas: 1
image:
repository: ghcr.io/jont828
name: cluster-api-visualizer
tag: latest # TODO: do we want to pin this to latest?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@fabriziopandini One way we can use the latest version of the chart is to pin the tag to latest in the values file. I did notice an issue where we aren't fetching the latest version of the chart if the directory hack/observability/visualizer/charts already exists. If we change the tilt-prepare logic to always fetch the latest version of the Helm chart instead, we could keep it up to date that way.

Copy link
Member

@fabriziopandini fabriziopandini Aug 5, 2022

Choose a reason for hiding this comment

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

I would prefer if tilt-prepare treats the chart as a black box, so let's keep tag: latest in the values file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good to me. One thing I want to test on my end is if tilt-prepare will fetch the latest version of the chart if hack/observability/visualizer/charts/cluster-api-visualizer folder exists with an older version.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think kustomize does not pull a chart again if a chart already exists locally and it looks like any changes to kustomization.yaml (or values.yaml) does not trigger a re-pull. I hit a similar issue when working with other observability tools.

From Kustomize documentation:

If a chart exists, kustomize will not overwrite it (so to suppress a pull, simply assure the chart is already in your kustomization root). kustomize won't check dates or version numbers or do anything that smells like cache management.

With this it looks like each person might be using a different version of the chart depedning on when they pulled it for the first time.

One way to work around this might be to clean up the charts folder under each of the enabled observability tools (eg: delete hack/observability/visualizer/charts) in tilt-prepare before the kustomize task is run. This should force a re-pull.

cc @killianmuldoon This is similar to the issue we hit with promtail.

Copy link
Contributor

Choose a reason for hiding this comment

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

That would add to the set-up time, but we could make it configurable somewhere. Another option - I'll also state this on the other issue - might be to drop the helm charting and install directly from manifests.

Copy link
Contributor

Choose a reason for hiding this comment

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

In all other places pinned tags are used.

Probably a separate discussion: Looks like the images for a particular chart version are pinned but our kustomization.yaml for the observability tools do not pin a chart version. For a user, depnending on when they run tilt up for the first time it be pulling down a different version of the chart (and potentially a differente version of the component?). I have observed this locally. I had a discussion with @killianmuldoon about this and I will be openning an issue to pin these versions.

Dropping this here as it seems kinda relevant.

Copy link
Member

@sbueringer sbueringer Aug 18, 2022

Choose a reason for hiding this comment

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

You could argue that for dev it's fine to just use the latest charts, especially as we don't really do any testing for our tilt dev env with those charts and whatever they publish upstream should be fine for us.

But it's definitely a more controlled way to pin it all, so no objections from my side.

Independent of that, I would definitely prefer if released charts are not using latest themselves internally, as that would mean that a specific Chart version could break retroactively when new versions of the image are released.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Based on what we saw from the kustomize docs, it looks like there isn't a great way to pull the latest version of the chart. The options I can think of for now are to (1) add a flow for cleaning up existing charts, i.e. have make clean remove the local copy of charts` or (2) modify the tilt-prepare logic to pin it to a version. Do you have any thoughts on how we can proceed?

Copy link
Member

Choose a reason for hiding this comment

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

I would favor an additional make clean-tilt (exact name TBD) target which deletes the charts. I think considering we're talking about a dev env this should be fine for now.

Copy link
Member

Choose a reason for hiding this comment

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

Regarding the values.yaml here. I would drop all image related fields so we use them from the chart (then we always take the version that is published in the corresponding Chart version)

@Jont828
Copy link
Contributor Author

Jont828 commented Aug 5, 2022

@CecileRobertMichon What do you think about trying to implement some functionality to automatically keep this up to date with the latest image version? One idea is to change the tilt-prepare logic to always fetch the latest version of the chart. Another idea is to pin the version to latest and override the default appVersion.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 24, 2022
@Jont828 Jont828 marked this pull request as ready for review August 25, 2022 16:19
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 25, 2022
@Jont828
Copy link
Contributor Author

Jont828 commented Aug 25, 2022

/hold
Rebased this on #7097

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 25, 2022
@sbueringer
Copy link
Member

@Jont828 What do you think about dropping the first commit and merging the second one?

I think they don't depend on each other and I would like to use the new version of the visualizer without having to change my source files :)

@Jont828
Copy link
Contributor Author

Jont828 commented Sep 1, 2022

Sure I'm happy to merge this first. The reason I rebased it off of the Makefile PR is because people probably won't be able to see the update on the chart until they run make clean-charts and there's nothing documented currently to show that they won't get the update automatically

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 1, 2022
@Jont828
Copy link
Contributor Author

Jont828 commented Sep 1, 2022

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 1, 2022
Copy link
Contributor

@ykakarap ykakarap left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 2, 2022
@sbueringer
Copy link
Member

sbueringer commented Sep 2, 2022

Makes sense. Let's go ahead anyway. At least folks following the PRs are aware

@sbueringer
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 2, 2022
@k8s-ci-robot k8s-ci-robot merged commit af9492d into kubernetes-sigs:main Sep 2, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants