-
Notifications
You must be signed in to change notification settings - Fork 13
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 readme #12
Update readme #12
Conversation
README.md
Outdated
This project provides a Kubernetes controller granting the ability to plug/unplug network interfaces | ||
to / from running pods. | ||
|
||
This controller is listening to pod's network selection elements, and whenever those change |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This controller is listening to pod's network selection elements, and whenever those change | |
This controller is listening to Multus [pod's network selection elements](https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/docs/quickstart.md#creating-a-pod-that-attaches-an-additional-interface), and whenever those change |
This explenation is found bellow, I suggest to move it here:
... pod network selection elements - i.e. the
k8s.v1.cni.cncf.io/networks
annotation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
README.md
Outdated
Currently, it doesn't do much - it doesn't invoke the delegates. | ||
As such, it'll only watch for multus network annotations changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest to move it above the usage title, so people will not install it and be disappointed that major functionality is missing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Signed-off-by: Miguel Duarte Barroso <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review @orelmisan .
Good suggestions.
spec: | ||
containers: | ||
- name: macvlan-worker1 | ||
image: docker.io/library/alpine:latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could not find an official alpine img on quay - imo the whole search functionality there is broken - I never find what I want (might be me ...)
If you happen to find / know where it is, I'll happily oblige.
README.md
Outdated
Currently, it doesn't do much - it doesn't invoke the delegates. | ||
As such, it'll only watch for multus network annotations changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
README.md
Outdated
This project provides a Kubernetes controller granting the ability to plug/unplug network interfaces | ||
to / from running pods. | ||
|
||
This controller is listening to pod's network selection elements, and whenever those change |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the changes!
Fixes: #9
Here's the doc preview.
This PR updates the project's README, indicating: