Add Documentation #18
Conversation
adrianchiris
commented
May 9, 2023
adrianchiris
commented
- Update README
- Add CONTRIBUTING doc
adrianchiris
force-pushed
the
update-readme
branch
from
9273cc5
to
785468a
Compare
adrianchiris
force-pushed
the
update-readme
branch
from
785468a
to
e12adbf
Compare
README.md
Outdated
| @@ -23,20 +165,101 @@ data: | |||
| config: | | |||
| { | |||
| "pools": { | |||
| "pool1": {"subnet": "192.168.0.0/16", "perNodeBlockSize": 100 , "gateway": "192.168.0.1"}, | |||
| "pool2": {"subnet": "172.16.0.0/16", "perNodeBlockSize": 50 , "gateway": "172.16.0.1"} | |||
| "my-pool": {"subnet": "192.168.0.0/16", "perNodeBlockSize": 100 , "gateway": "192.168.0.1"}, | |||
There was a problem hiding this comment.
remove last , so it will be valid json
README.md
Outdated
| The address the probe endpoint binds to. (default ":8081") | ||
| --kubeconfig string | ||
| Paths to a kubeconfig. Only required if out-of-cluster. | ||
| --leader-elect |
There was a problem hiding this comment.
I thought we don't support it. Maybe we should document only the things that will work
There was a problem hiding this comment.
In the code it is supported.
I added [1] extra config option to configure namespace for leader election process. Also enabled leader election by default to protect from the situation when a user decided to manually scale the deployment.
[1] #19
There was a problem hiding this comment.
These are the supported flags by the binary, should i remove or keep ?
either way #19 would need to update this file as well once we merge it.
There was a problem hiding this comment.
removing leader elect flag for now
adrianchiris
force-pushed
the
update-readme
branch
from
b3b183d
to
4aa2c1e
Compare
|
@ykulazhenkov @moshe010 PTAL lets get this one in |
- Update README - Add CONTRIBUTING doc Signed-off-by: adrianc <adrianc@nvidia.com>
adrianchiris
force-pushed
the
update-readme
branch
from
4aa2c1e
to
3f1f3d9
Compare
|
|
||
| ## Contributing | ||
|
|
||
| We welcome your feedback and contributions to this project. Please see the [CONTRIBUTING.md](https://github.com/Mellanox/nvidia-k8s-ipam/blob/main/CONTRIBUTING.md) |
There was a problem hiding this comment.
nit: Do we want to use relative link here? [CONTRIBUTING.md](CONTRIBUTING.md)
There was a problem hiding this comment.
we will address it in follow-up
