docs: reach MVP milestone #49
Conversation
README.md
Outdated
|
|
||
| ## Known limitations | ||
| - the networks being hot-plugged **must** feature the `name` attribute in the `spec.config`. This is tracked in this [issue](https://github.com/maiqueb/multus-dynamic-networks-controller/issues/45). | ||
| - the pod controller is not level driven. This is tracked in this [RFE](https://github.com/maiqueb/multus-dynamic-networks-controller/issues/48). |
There was a problem hiding this comment.
Is "level driven" a well known (kubernetes) lingo?
There was a problem hiding this comment.
hmm. No. This predates all that; its a term from circuits - edge trigger vs level trigger.
There was a problem hiding this comment.
Oh you are such a nerd! I'm familiar with edge vs level there, but I would never make the connection in this README
There was a problem hiding this comment.
Does the provided stack overflow answer help ? ...
I am open to any other suggestions @phoracek
There was a problem hiding this comment.
perhaps "hot-plug requests done while the controller was offline won't be acted upon (or reconciled) once the controller comes back online"?
There was a problem hiding this comment.
whoops. /me facepalms
| @@ -151,3 +151,7 @@ Below you can find information on how to push local code changes to a kind clust | |||
| - push image to local registry: `podman push localhost:5000/maiqueb/multus-dynamic-networks-controller` | |||
| - update manifests to use the generated image: `IMAGE_REGISTRY=localhost:5000/maiqueb make manifests` | |||
| - deploy the controller: `kubectl apply -f manifests/dynamic-networks-controller.yaml` | |||
|
|
|||
| ## Known limitations | |||
There was a problem hiding this comment.
So we allow hot-unplug of cold-plugged (?) interfaces?
There was a problem hiding this comment.
Currently ? Yes.
Do we want to ?... Not sure.
I'm inclined to say no.
| @@ -151,3 +151,7 @@ Below you can find information on how to push local code changes to a kind clust | |||
| - push image to local registry: `podman push localhost:5000/maiqueb/multus-dynamic-networks-controller` | |||
| - update manifests to use the generated image: `IMAGE_REGISTRY=localhost:5000/maiqueb make manifests` | |||
| - deploy the controller: `kubectl apply -f manifests/dynamic-networks-controller.yaml` | |||
|
|
|||
| ## Known limitations | |||
There was a problem hiding this comment.
Could we mention device plugin based CNIs? And that requested network resources must be available on the node, we won't reschedule if they are not
There was a problem hiding this comment.
Sure.
But I do not plan on supporting that for the near future.
Signed-off-by: Miguel Duarte Barroso <mdbarroso@redhat.com>
What this PR does / why we need it:
This PR updates the documentation indicating the project has reached what I consider to be the MVP.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #
Special notes for your reviewer (optional):