Resource policy documentation #6
Conversation
jukkar
force-pushed
the
docs
branch
4 times, most recently
from
c79cd8f
to
45ba643
Compare
jukkar
changed the title
|
|
||
| ## Setting up NRI Resource Policy | ||
|
|
||
| ### Using NRI Resource Policy Agent and a ConfigMap |
There was a problem hiding this comment.
This stuff could be moved to the node-agent/dynamic configuration document, if not already covered there(?)
There was a problem hiding this comment.
I suggest we revisit all the setup, quick-start and relevant docs after the helm chart support is merged which is probably quite soon.
| When you want to try NRI Resource Policy, here is the list of things | ||
| you need to do, assuming you already have a Kubernetes\* cluster up and | ||
| running, using either `containerd` or `cri-o` as the runtime. | ||
|
|
||
| * [Install](installation.md) NRI Resource Policy DaemonSet deployment file. | ||
| * Runtime (containerd / cri-o) configuration | ||
|
|
||
| For NRI Resource Policy, you need to provide a configuration file. The default | ||
| configuration ConfigMap file can be found in the DaemonSet deployment yaml file. | ||
| You can edit it as needed. |
There was a problem hiding this comment.
I think this info should be part of the "Installation" doc, if not already covered there
There was a problem hiding this comment.
This file somehow feels overlapping/redundant at the moment. More comments below
| See the [Node Agent][agent] about how to set up and configure the agent. | ||
|
|
||
|
|
||
| ## Logging and debugging |
There was a problem hiding this comment.
Maybe this file should be renamed logging and debugging. Or then move also this section under the agent/configuration doc
Add documentation files and makefile rules to generate html documentation for the project. This is taken from cri-resource-manager and HEAD was at commit 5db1e8a5fc0ec15780f5ffa6fbb2a9d826cb221b Signed-off-by: Jukka Rissanen <[email protected]>
The heading level was wrong and was reported during doc generation. Signed-off-by: Jukka Rissanen <[email protected]>
The sample configuration files are referenced by the documentation so we need to have them here. Signed-off-by: Jukka Rissanen <[email protected]>
User can say "run.sh help" to get information about the functions available. Signed-off-by: Jukka Rissanen <[email protected]>
This is just a raw conversion and fixes so that "make docs" will pass and generate the documentation. Subsequent commits will do more changes to the actual content. Signed-off-by: Jukka Rissanen <[email protected]>
Changing the documentation so that it will describe how the nri-resource-policy plugin works. Also reshuffling the files around to better fit the overall documentation structure. Signed-off-by: Jukka Rissanen <[email protected]>
Thanks, I updated most of the documentation. The installation/setup/quick-start needs still some work but that needs to wait the #45. |
A big thanks for the thorough review ! |
There was a problem hiding this comment.
I'm fine with merging this and addressing the remaining comment and doing other restructuring with further PRs. How about others ? @marquiz @kad @fmuyassarov @askervin ?
|
Thinking from the users perspective, IMO the one thing that needs to be in reasonable shape are the deployment/installation instructions. Easy-to-follow step-by-step insrtuctions how to get the plugins running in a cluster. Something like IMAGE_REPO=my-custom-repo
make image
make image-push
kubectl apply -k deployment/overlays/topology-awareAnother concern/question: how to track the unresolved comments if this gets merged? |
I'm going to submit another documentation RP which will include that and other ways of installing the plugins. |
That's cool. I suggest to drop all the installation/quick start stuff from this PR, then. WDYT? |
These are to be rewritten by a Helm chart support commits coming in near future. Signed-off-by: Jukka Rissanen <[email protected]>
|
I think we could merge this. If we do, @jukkar could you create an issue tracking the unresolved comments? |
Created #58 for tracking pending work. |
Documentation from cri-rm updated for nri resource policy.