-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #643 from klihub/docs/fixes/DougTW
docs: a bunch of grammatical and stylistic fixes by DougTW.
- Loading branch information
Showing
9 changed files
with
214 additions
and
182 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
# CRI Resource Manager for Kubernetes | ||
# CRI Resource Manager for Kubernetes\* | ||
|
||
Welcome! | ||
|
||
### See our [Documentation][documentation] site for detailed documentation. | ||
|
||
[documentation]: https://intel.github.io/cri-resource-manager | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
# Contributing | ||
|
||
Please use the GitHub infrastructure for contributing to | ||
Please use the GitHub\* infrastructure for contributing to | ||
CRI Resource Manager. | ||
Use [pull requests](https://github.com/intel/cri-resource-manager/pulls) | ||
to contribute code, bug fixes, or if you want to discuss your ideas in terms of code. | ||
Open [issues](https://github.com/intel/cri-resource-manager/issues) to report bugs, | ||
request new features, or if you want to discuss any other topics related to CRI Resource | ||
Manager or orchestration resource management in general. | ||
to contribute code, bug fixes, or if you want to discuss your ideas in terms of | ||
code. Open [issues](https://github.com/intel/cri-resource-manager/issues) to | ||
report bugs, request new features, or if you want to discuss any other topics | ||
related to CRI Resource Manager or orchestration resource management in | ||
general. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,36 @@ | ||
# Node Agent | ||
|
||
CRI Resource Manager can be configured dynamically using the CRI Resource | ||
Manager Node Agent and Kubernetes ConfigMaps. The agent can be build using | ||
the [provided Dockerfile](/cmd/cri-resmgr-agent/Dockerfile). It can be deployed | ||
as a `DaemonSet` in the cluster using the [provided deployment file](/cmd/cri-resmgr-agent/agent-deployment.yaml). | ||
Manager Node Agent and Kubernetes\* ConfigMaps. The agent can be build using | ||
the [provided Dockerfile](/cmd/cri-resmgr-agent/Dockerfile). It can be | ||
deployed as a `DaemonSet` in the cluster using the | ||
[provided deployment file](/cmd/cri-resmgr-agent/agent-deployment.yaml). | ||
|
||
To run the agent manually or as a `systemd` service, set the environment variable | ||
`NODE_NAME` to the name of the cluster node the agent is running on. If necessary | ||
pass it the credentials for accessing the cluster using the the `-kubeconfig <file>` | ||
command line option. | ||
To run the agent manually or as a `systemd` service, set the environment | ||
variable `NODE_NAME` to the name of the cluster node the agent is running | ||
on. If necessary pass it the credentials for accessing the cluster using | ||
the `-kubeconfig <file>` command line option. | ||
|
||
The agent monitors two ConfigMaps for the node, a primary node-specific one, and | ||
a secondary group-specific or default one, depending on whether the node belongs | ||
to a configuration group. The node-specific ConfigMap always takes precedence over | ||
the others. | ||
The agent monitors two ConfigMaps for the node, a primary node-specific one | ||
and a secondary group-specific or default one, depending on whether the node | ||
belongs to a configuration group. The node-specific ConfigMap always takes | ||
precedence over the others. | ||
|
||
The names of these ConfigMaps are | ||
|
||
1. `cri-resmgr-config.node.$NODE_NAME`: primary, node-specific configuration | ||
2. `cri-resmgr-config.group.$GROUP_NAME`: secondary group-specific node configuration | ||
3. `cri-resmgr-config.default`: secondary: secondary default node configuration | ||
2. `cri-resmgr-config.group.$GROUP_NAME`: secondary group-specific node | ||
configuration | ||
3. `cri-resmgr-config.default`: secondary: secondary default node | ||
configuration | ||
|
||
You can assign a node to a configuration group by setting the | ||
`cri-resource-manager.intel.com/group` label on the node to the name of | ||
the configuration group. You can remove a node from its group by deleting the node | ||
group label. | ||
|
||
There is a [sample ConfigMap spec](/sample-configs/cri-resmgr-configmap.example.yaml) | ||
that contains anode-specific, a group-specific, and a default ConfigMap examples. | ||
See [any available policy-specific documentation](policy/index.rst) for more information on the | ||
policy configurations. | ||
|
||
|
||
the configuration group. You can remove a node from its group by deleting | ||
the node group label. | ||
|
||
There is a | ||
[sample ConfigMap spec](/sample-configs/cri-resmgr-configmap.example.yaml) | ||
that contains a node-specific, a group-specific, and a default ConfigMap | ||
example. See [any available policy-specific documentation](policy/index.rst) | ||
for more information on the policy configurations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
# Reporting a Potential Security Vulnerability | ||
|
||
Please visit [intel.com/security](https://intel.com/security) for reporting security issues. | ||
Please visit [intel.com/security](https://intel.com/security) to report | ||
security issues. |
Oops, something went wrong.