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 readme #12

Merged
merged 1 commit into from
Aug 30, 2022
Merged

Update readme #12

merged 1 commit into from
Aug 30, 2022

Conversation

maiqueb
Copy link
Collaborator

@maiqueb maiqueb commented Aug 24, 2022

Fixes: #9

Here's the doc preview.

This PR updates the project's README, indicating:

  • project's description
  • how to install
  • how to remove
  • how to use
  • developer info (getting your code changes in a live cluster)

@maiqueb maiqueb added the documentation Improvements or additions to documentation label Aug 24, 2022
@maiqueb maiqueb requested a review from phoracek August 30, 2022 09:39
@maiqueb maiqueb marked this pull request as ready for review August 30, 2022 09:41
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
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

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 23 to 24
Currently, it doesn't do much - it doesn't invoke the delegates.
As such, it'll only watch for multus network annotations changes.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
examples/interface-add.yaml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@maiqueb maiqueb left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
spec:
containers:
- name: macvlan-worker1
image: docker.io/library/alpine:latest
Copy link
Collaborator Author

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 Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated
Comment on lines 23 to 24
Currently, it doesn't do much - it doesn't invoke the delegates.
As such, it'll only watch for multus network annotations changes.
Copy link
Collaborator Author

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
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link

@orelmisan orelmisan left a 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!

@maiqueb maiqueb merged commit 1e9c544 into main Aug 30, 2022
@maiqueb maiqueb deleted the update-readme branch August 30, 2022 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
3 participants