Skip to content

Commit 5460d45

Browse files
committed
docs: enhance plugins installation methods with operator support
Refactor documentation structure to incorporate the operator as an additional method for installing and deploying nri-plugins. Signed-off-by: Feruzjon Muyassarov <feruzjon.muyassarov@intel.com>
1 parent 53b009b commit 5460d45

File tree

17 files changed

+60
-40
lines changed

17 files changed

+60
-40
lines changed

deployment/operator/README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
1-
# nri-plugins-operator
1+
# NRI-Plugins-Operator
2+
3+
## Introduction
24

35
The nri-plugins-operator is an Ansible-based operator created with operator-sdk to manage the life cycle of the
46
nri-plugins. The operator deploys community maintained [nri-plugins](https://github.com/containers/nri-plugins) in
57
Kubernetes cluster. When operator is installed, it doesn't do anything apart from watching for custom resources called
68
NriPluginDeployment. When NriPluginDeployment object is created, reconciliation loops kicks off and installs the
79
nri-plugin specified in the NriPluginDeployment.
810

9-
## nriPluginDeployment object
11+
## Installation
12+
13+
Build the operator image and push it to some registry
14+
```shell
15+
make docker-build docker-push IMG="my-registry.com/nri-plugins-operator:unstable"
16+
```
17+
18+
Deploy the operator in your cluster
19+
```shell
20+
make deploy
21+
```
22+
23+
Uninstall the operator
24+
```shell
25+
make undeploy
26+
```
27+
28+
## Operator CRD
1029

1130
```YAML
1231
apiVersion: config.nri/v1alpha1
@@ -48,23 +67,3 @@ spec:
4867
requiring users to recreate the object to pass new values.
4968
- `spec.status`: Tracks the basic state of the resource and includes basic messages in case the operator encounters
5069
issues while reconciling the object.
51-
52-
## Operator installation
53-
54-
Build the operator image and push it to some registry
55-
```shell
56-
make docker-build docker-push IMG="my-registry.com/nri-plugins-operator:unstable"
57-
```
58-
59-
Deploy the operator in your cluster
60-
```shell
61-
make deploy
62-
```
63-
64-
Uninstall the operator
65-
```shell
66-
make undeploy
67-
```
68-
69-
# License
70-
Licensed under [Apache 2.0](https://github.com/containers/nri-plugins-operator/blob/main/LICENSE).

docs/deployment/balloons.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/deployment/helm/balloons.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/balloons/README.md
2+
```

docs/deployment/helm/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Helm
2+
3+
```{toctree}
4+
---
5+
maxdepth: 2
6+
caption: Contents
7+
---
8+
balloons.md
9+
topology-aware.md
10+
template.md
11+
memory-qos.md
12+
memtierd.md
13+
sgx-epc.md
14+
```

docs/deployment/helm/memory-qos.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/memory-qos/README.md
2+
```

docs/deployment/helm/memtierd.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/memtierd/README.md
2+
```

docs/deployment/helm/sgx-epc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/sgx-epc/README.md
2+
```

docs/deployment/helm/template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/template/README.md
2+
```
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../deployment/helm/topology-aware/README.md
2+
```

docs/deployment/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ through Helm.
88
maxdepth: 2
99
caption: Contents
1010
---
11-
balloons.md
12-
topology-aware.md
13-
template.md
14-
memory-qos.md
15-
memtierd.md
16-
sgx-epc.md
11+
helm/index.md
12+
operator/index.md
1713
```

0 commit comments

Comments
 (0)