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

docs: convert all rst to md #80

Merged
merged 3 commits into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Welcome to NRI Plugins documentation

```{toctree}
---
maxdepth: 2
caption: Contents
---
introduction.md
resource-policy/index.rst
contributing.md
Project GitHub repository <https://github.com/containers/nri-plugins>
```
16 changes: 0 additions & 16 deletions docs/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

The NRI plugins is a collection of NRI (Node Resource Interface) based plugins
to manage various aspects of pod and container life cycle.
For example the [resource policy plugins](resource_policies) can be used to modify
For example the [resource policy plugins](resource-policy/policy/index.md) can be used to modify
the container resource allocation depending on available system resources.
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ the node group label.
There is a
[sample ConfigMap spec](/sample-configs/nri-resource-policy-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)
example. See [any available policy-specific documentation](policy/index.md)
for more information on the policy configurations.
7 changes: 0 additions & 7 deletions docs/resource-policy/configuration.rst

This file was deleted.

10 changes: 10 additions & 0 deletions docs/resource-policy/developers-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Developer's Guide

```{toctree}
---
maxdepth: 1
---
architecture.md
testing.rst
cpu-allocator.md
```
8 changes: 0 additions & 8 deletions docs/resource-policy/developers-guide/index.rst

This file was deleted.

9 changes: 9 additions & 0 deletions docs/resource-policy/developers-guide/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Testing

```{toctree}
---
maxdepth: 1
---
unit-test.md
e2e-test.md
```
8 changes: 0 additions & 8 deletions docs/resource-policy/developers-guide/testing.rst

This file was deleted.

14 changes: 14 additions & 0 deletions docs/resource-policy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Resource Policy Plugins

```{toctree}
---
maxdepth: 2
caption: Contents
---
introduction.md
installation.md
setup.md
configuration.md
policy/index.md
developers-guide/index.rst
```
13 changes: 0 additions & 13 deletions docs/resource-policy/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _resource_policies:

Policies
########
# Policies

Currently there are two resource policies:

Expand All @@ -11,8 +8,10 @@ policy that allocates resources evenly in order to avoid the "noisy neighbor" pr
The Balloons resource policy allows user to allocate workloads to resources in a more
user controlled way.

.. toctree::
:maxdepth: 1

topology-aware.md
balloons.md
```{toctree}
---
maxdepth: 1
---
topology-aware.md
balloons.md
```
10 changes: 5 additions & 5 deletions docs/resource-policy/policy/topology-aware.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,11 @@ policy:

## Configuring the Policy

The policy has a number of configuration options which affect its default behavior.
These options can be supplied as part of the
[dynamic configuration](../setup.md#using-nri-resource-policy-agent-and-a-configmap)
received via the [`node agent`](../node-agent.md), or in a fallback or forced
configuration file. These configuration options are
The policy has a number of configuration options which affect its default
behavior. These options can be supplied as part of the
[dynamic configuration](../setup.md#dynamic-configuration-with-configmaps)
or in a fallback or forced configuration file. These configuration options
are

- `PinCPU`
* whether to pin workloads to assigned pool CPU sets
Expand Down
24 changes: 11 additions & 13 deletions docs/resource-policy/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,18 @@ You can edit it as needed.

## Setting up NRI Resource Policy

### Using NRI Resource Policy Agent and a ConfigMap

The [NRI Resource Policy Node Agent][agent] can monitor and fetch configuration
from the ConfigMap and pass it on to NRI Resource Policy plugin.
By default, it automatically tries to use the agent to acquire configuration,
unless you override this by forcing a static local configuration using
the `--force-config <config-file>` option.
When using the agent, it is also possible to provide an initial fallback for
configuration using the `--fallback-config <config-file>`. This file is
used before the very first configuration is successfully acquired from the
agent.
### Dynamic configuration with ConfigMaps

See the [Node Agent][agent] about how to set up and configure the agent.
The resource policies plugins support[dynamic configuration][configuration]
using ConfigMaps. Plugins watch changes in the ConfigMap and reconfigure
themselves on any update. Tt is possible to provide an initial fallback for
configuration using the `--fallback-config <config-file>` flag. This file is
used before the very first configuration is successfully acquired from the
ConfigMap.

Dynamic configuration can be disabled with a static local configuration using
the `--force-config <config-file>` flag. See the [Node Agent][agent] about
how to set up and configure the agent.

## Logging and debugging

Expand Down Expand Up @@ -58,4 +56,4 @@ the environment but off in the configuration, it will be turned off
eventually.

<!-- Links -->
[agent]: node-agent.md
[configuration]: configuration.md