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

Proposal: Image PrePull Feature Enhancement #5567

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

hyp4293
Copy link

@hyp4293 hyp4293 commented Apr 26, 2024

What type of PR is this?
/kind feature

What this PR does / why we need it:
Image PrePull Feature Enhancement
In the latest release, KubeEdge has implemented the ability for image pre pull. However, each task execution only supports images from the same image repository currently. We hope to enhance this feature to support capabilities like overriding images and secrets, complete end-to-end tests for this feature.

#5341

@kubeedge-bot kubeedge-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 26, 2024
@kubeedge-bot
Copy link
Collaborator

Welcome @hyp4293! It looks like this is your first PR to kubeedge/kubeedge 🎉

@kubeedge-bot kubeedge-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 26, 2024
Signed-off-by: hyp4293 <429302517@qq.com>
@Shelley-BaoYue Shelley-BaoYue changed the title topic2 image prepull expand Feature Design image prepull expand Feature Design Apr 26, 2024
@Shelley-BaoYue Shelley-BaoYue changed the title image prepull expand Feature Design Proposal: Image PrePull Feature Enhancement Apr 26, 2024
Copy link
Collaborator

@Shelley-BaoYue Shelley-BaoYue left a comment

Choose a reason for hiding this comment

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

for the proposal images:

  • Don't use Chinese
  • Please differentiate between the proposal and usage guide. For example, how to generate a secret and how to manually pull an image do not need to be described in the proposal.
  • Please describe the override content in the image.

@@ -0,0 +1,252 @@
# Image PrePulling Feature Enhancement
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please add header at the top of proposal like:
image


### Goals

In the previous version, each task execution currently only supports images from the same image warehouse, and only supports the configuration of one secret. Now, we will enhance this function, which will support covering images and secrets, and can configure multiple secrets to pull images from multiple warehouses.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be motivation but not Goals. The format of the goals is generally similar to "support configure multiple secret in one imagepulljob"


### Architecture

![kubeedge镜像预拉取增强](../images/proposals/image-prepull-expand.png)
Copy link
Collaborator

Choose a reason for hiding this comment

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

It is not friendly to add Chinese in documents of the community, including the Chinese in the design image.




### override manager
Copy link
Collaborator

Choose a reason for hiding this comment

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

What is override manager? Is it a module? What the capability of override manager and which fields can be overridden by the overmanager?


```

Kubectl Secret
Copy link
Collaborator

Choose a reason for hiding this comment

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

How to generate secrets is a common function of Kubernetes and does not need to be described in the proposal, including the design diagram.




### Image PrePull API
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't need to list all the existing APIs. Focus on what you've added or modified in this feature.

// ImagePrePullTemplate represents original templates of imagePrePull
ImagePrePullTemplate ImagePrePullTemplate `json:"imagePrePullTemplate,omitempty"`

// ImagePrePullScope represents the override rules that would apply on imagePrePull job.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't see your definition of override api.

@kubeedge-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign qizha after the PR has been reviewed.
You can assign the PR to them by writing /assign @qizha in a comment when ready.

The full list of commands accepted by this bot can be found 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

Copy link
Collaborator

@Shelley-BaoYue Shelley-BaoYue left a comment

Choose a reason for hiding this comment

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

Please update the proposal according the review comments. And this PR should not contain the code implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants