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.md to kube-fledged helm chart #136

Closed
senthilrch opened this issue Feb 23, 2022 · 5 comments
Closed

Add README.md to kube-fledged helm chart #136

senthilrch opened this issue Feb 23, 2022 · 5 comments
Assignees
Labels
enhancement Enhancement to existing feature good first issue Good for newcomers
Milestone

Comments

@senthilrch
Copy link
Owner

It is a good practice to include README.md in helm chart. Add a README.md file to kube-fledged's helm chart located in:
./deploy/kubefledged-operator/helm-charts/kubefledged

The README should have following info:-

@senthilrch senthilrch added enhancement Enhancement to existing feature good first issue Good for newcomers SODACODE2022 labels Feb 23, 2022
@senthilrch senthilrch added this to the v0.10.0 milestone Feb 23, 2022
@senthilrch
Copy link
Owner Author

SODACODE22: Raise PR against "develop" branch.

@anubhav06
Copy link
Contributor

  • Short description of kube-fledged
    kube-fledged is a kubernetes operator for creating and managing a cache of container images directly on the worker nodes of a kubernetes cluster. It allows a user to define a list of images and onto which worker nodes those images should be cached (i.e. pulled). As a result, application pods start almost instantly, since the images need not be pulled from the registry. kube-fledged provides CRUD APIs to manage the lifecycle of the image cache, and supports several configurable parameters to customize the functioning as per one's needs.

Hi! The README should contain the exact description which you have mentioned and nothing in addition to that, right ?

@senthilrch
Copy link
Owner Author

Yes right!

@anubhav06
Copy link
Contributor

Great! Can I work on this ?

@senthilrch
Copy link
Owner Author

Yes

anubhav06 added a commit to anubhav06/kube-fledged that referenced this issue Mar 4, 2022
senthilrch added a commit that referenced this issue Mar 4, 2022
added readme to kube-fledged helm chart (#136)
senthilrch pushed a commit that referenced this issue Mar 4, 2022
terrych0u pushed a commit to terrych0u/kube-fledged that referenced this issue Sep 1, 2022
terrych0u pushed a commit to terrych0u/kube-fledged that referenced this issue Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement to existing feature good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants