Proposal: Custom CRD Download Strategy Support for Karmada Operator #5145

jabellard · 2024-07-05T23:31:58Z

What type of PR is this?

/kind design

What this PR does / why we need it:
Details are in the design document.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

karmada-bot · 2024-07-05T23:32:09Z

Welcome @jabellard! It looks like this is your first PR to karmada-io/karmada 🎉

codecov-commenter · 2024-07-05T23:43:55Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.26%. Comparing base (c4a81bf) to head (4611c55).
Report is 81 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5145      +/-   ##
==========================================
+ Coverage   28.21%   28.26%   +0.04%     
==========================================
  Files         632      632              
  Lines       43568    43739     +171     
==========================================
+ Hits        12294    12361      +67     
- Misses      30378    30477      +99     
- Partials      896      901       +5

Flag	Coverage Δ
unittests	`28.26% <ø> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

chaunceyjiang · 2024-07-08T06:54:49Z

/cc @calvin0327 PTAL.

docs/proposals/operator-custom-crd-download-url/README.md

RainbowMango · 2024-07-09T03:38:01Z

@jabellard Thank you very much for the excellent proposal.
I just realized that currently, the operator can only install the Karmada instance with the version of its release version.
It's a great chance to improve it!

RainbowMango · 2024-07-09T03:42:31Z

@calvin0327 Is there a chance for you to present this week's community meeting and talk with @jabellard and this proposal?

chaunceyjiang · 2024-07-09T15:27:36Z

docs/proposals/operator-custom-crd-download-url/README.md

+	// Omit if the intent is to provision a new Karmada instance with control plane components of the same version as the Karmada operator's release version.
+	// Otherwise, it should be explicitly set to ensure the right version of the CRDs is installed for this instance.
+	// +optional
+	CRDRemoteURL string `json:"crdRemoteURL,omitempty"`


In fact, within our company, we have copied the crd file into the image of karmada-operator.

So what I want to ask is, if my crd file is stored in the image, how should I fill in the crdRemoteURL?

we have copied the crd file into the image of karmada-operator.

How to do that? What I can imagine there are two ways to do that:

Using a private karmada-operator image, the tarball can be put into the image

Mount the tarball into the pod, by a ConfigMap when deploying the operator

The tarball is located in the cache, so karmada-opeator doesn't need to download the tarball from GitHub.

So what I mean is, should crdRemoteURL support a format like file:///var/loca/crds?

This is possible and can be supported, but can you please elaborate more on why that strategy would be preferred to downloading the CRDs from a remote location? How would you manually manage storage for multiple versions of the CRDs? Would that not require more work and maintenance on your part?

Kindly ping @chaunceyjiang
We need your input here :)

but can you please elaborate more on why that strategy would be preferred to downloading the CRDs from a remote location?

Simply put, we don't want our end users to download from remote http/https servers. Because that requires our end users to do some extra work, such as preparing additional http/https servers, etc. We would rather have the karmada-operator read the crd file from the karmada-operator image.

In this way, users only need to use our provided Web-UI function to deploy a brand new karmada instance with one click. There's no need for extra attention on where the crd is stored.

I get it, you build the image on your own, like put the tarball to the cache directory, then the karmada-operator won't download it from github.

jabellard · 2024-07-09T17:19:41Z

@RainbowMango , thanks so so much for the feedback. I'll push an update to the proposal based on what we discussed during the meeting.

jabellard · 2024-07-12T19:59:04Z

@RainbowMango , I just submitted a pr for the implementation of this proposal.

RainbowMango

/assign

docs/proposals/operator-custom-crd-download-url/README.md

docs/proposals/operator-custom-crd-download-strategy/README.md

RainbowMango

/lgtm

@chaunceyjiang Do you have any further comments?

docs/proposals/operator-custom-crd-download-strategy/README.md

Signed-off-by: Joe Nathan Abellard <[email protected]> Fix typos Signed-off-by: Joe Nathan Abellard <[email protected]> Update hash algo Signed-off-by: Joe Nathan Abellard <[email protected]> Address commands Signed-off-by: Joe Nathan Abellard <[email protected]> Address commands Signed-off-by: Joe Nathan Abellard <[email protected]> Address commands Signed-off-by: Joe Nathan Abellard <[email protected]> Fix typos Signed-off-by: Joe Nathan Abellard <[email protected]> Fix typos Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]> Address comments Signed-off-by: Joe Nathan Abellard <[email protected]>

chaunceyjiang

/lgtm

Thanks~

jabellard · 2024-07-23T19:35:14Z

Perfect! I opened the implementation pr.

RainbowMango

/approve
Thanks.

karmada-bot · 2024-07-27T12:47:43Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

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:

~~OWNERS~~ [RainbowMango]

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

karmada-bot added the kind/design Categorizes issue or PR as related to design. label Jul 5, 2024

karmada-bot requested review from Poor12 and Tingtal July 5, 2024 23:32

karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 5, 2024

jabellard mentioned this pull request Jul 5, 2024

Add the Ability to Provide a Custom CRD download URL for Karmada Operator #5122

Closed

jabellard force-pushed the operator_crd_url branch from 7b17c7f to 9da129a Compare July 6, 2024 00:04

RainbowMango reviewed Jul 9, 2024

View reviewed changes

docs/proposals/operator-custom-crd-download-url/README.md Outdated Show resolved Hide resolved

chaunceyjiang reviewed Jul 9, 2024

View reviewed changes

karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 9, 2024

jabellard mentioned this pull request Jul 12, 2024

Custom CRD Download Strategy Support for Karmada Operator #5185

Merged

RainbowMango reviewed Jul 16, 2024

View reviewed changes

karmada-bot assigned RainbowMango Jul 16, 2024

RainbowMango reviewed Jul 17, 2024

View reviewed changes

jabellard changed the title ~~Proposal: Custom CRD Download URL Support for Karmada Operator~~ Proposal: Custom CRD Download Strategy Support for Karmada Operator Jul 18, 2024

RainbowMango reviewed Jul 19, 2024

View reviewed changes

docs/proposals/operator-custom-crd-download-strategy/README.md Outdated Show resolved Hide resolved

jabellard force-pushed the operator_crd_url branch from 910d946 to 25e6fda Compare July 19, 2024 17:14

RainbowMango reviewed Jul 20, 2024

View reviewed changes

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 20, 2024

chaunceyjiang reviewed Jul 22, 2024

View reviewed changes

docs/proposals/operator-custom-crd-download-strategy/README.md Outdated Show resolved Hide resolved

jabellard force-pushed the operator_crd_url branch from 25e6fda to 4611c55 Compare July 22, 2024 15:41

karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2024

chaunceyjiang reviewed Jul 23, 2024

View reviewed changes

karmada-bot assigned chaunceyjiang Jul 23, 2024

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 23, 2024

RainbowMango approved these changes Jul 27, 2024

View reviewed changes

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 27, 2024

karmada-bot merged commit de744b1 into karmada-io:master Jul 27, 2024
12 checks passed

RainbowMango added this to the v1.11 milestone Aug 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposal: Custom CRD Download Strategy Support for Karmada Operator #5145

Proposal: Custom CRD Download Strategy Support for Karmada Operator #5145

jabellard commented Jul 5, 2024 •

edited

Loading

karmada-bot commented Jul 5, 2024

codecov-commenter commented Jul 5, 2024 •

edited

Loading

chaunceyjiang commented Jul 8, 2024

RainbowMango commented Jul 9, 2024

RainbowMango commented Jul 9, 2024

chaunceyjiang Jul 9, 2024

RainbowMango Jul 10, 2024

chaunceyjiang Jul 12, 2024

jabellard Jul 12, 2024 •

edited

Loading

RainbowMango Jul 18, 2024

chaunceyjiang Jul 22, 2024

RainbowMango Jul 22, 2024

jabellard commented Jul 9, 2024

jabellard commented Jul 12, 2024

RainbowMango left a comment

RainbowMango left a comment

chaunceyjiang left a comment

jabellard commented Jul 23, 2024

RainbowMango left a comment

karmada-bot commented Jul 27, 2024

Proposal: Custom CRD Download Strategy Support for Karmada Operator #5145

Proposal: Custom CRD Download Strategy Support for Karmada Operator #5145

Conversation

jabellard commented Jul 5, 2024 • edited Loading

karmada-bot commented Jul 5, 2024

codecov-commenter commented Jul 5, 2024 • edited Loading

Codecov Report

chaunceyjiang commented Jul 8, 2024

RainbowMango commented Jul 9, 2024

RainbowMango commented Jul 9, 2024

chaunceyjiang Jul 9, 2024

Choose a reason for hiding this comment

RainbowMango Jul 10, 2024

Choose a reason for hiding this comment

chaunceyjiang Jul 12, 2024

Choose a reason for hiding this comment

jabellard Jul 12, 2024 • edited Loading

Choose a reason for hiding this comment

RainbowMango Jul 18, 2024

Choose a reason for hiding this comment

chaunceyjiang Jul 22, 2024

Choose a reason for hiding this comment

RainbowMango Jul 22, 2024

Choose a reason for hiding this comment

jabellard commented Jul 9, 2024

jabellard commented Jul 12, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

RainbowMango left a comment

Choose a reason for hiding this comment

chaunceyjiang left a comment

Choose a reason for hiding this comment

jabellard commented Jul 23, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

karmada-bot commented Jul 27, 2024

jabellard commented Jul 5, 2024 •

edited

Loading

codecov-commenter commented Jul 5, 2024 •

edited

Loading

jabellard Jul 12, 2024 •

edited

Loading