Skip to content

Commit 7afd930

Browse files
authored
update READMEs (#3)
1 parent 423996e commit 7afd930

File tree

4 files changed

+134
-0
lines changed

4 files changed

+134
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Intel Device Plugins Operator Helm Chart
2+
3+
## Prerequisites
4+
- cert-manager
5+
- NFD charts [optional]
6+
7+
## Get Helm Repository Info
8+
```
9+
helm repo add intel https://intel.github.io/helm-charts/
10+
helm repo update
11+
```
12+
13+
You can execute `helm search repo intel` command to see pulled charts [optional].
14+
15+
## Install Helm Chart
16+
CRDs of the device plugin operator are installed as part of the chart.
17+
18+
```
19+
helm install device-plugin-operator intel/device-plugin-operator [flags]
20+
```
21+
22+
## Upgrade Chart
23+
```
24+
helm upgrade device-plugin-operator intel/device-plugin-operator [flags]
25+
```
26+
27+
## Uninstall Chart
28+
```
29+
helm uninstall device-plugin-operator
30+
```
31+
CRDs are not uninstalled.
32+
33+
## Configuration
34+
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments:
35+
36+
```console
37+
helm show values intel/device-plugin-operator
38+
```
39+
40+
You may also run `helm show values` on this chart's dependencies for additional options.
41+
42+
|parameter| value |
43+
|---------|-----------|
44+
| `hub` | `intel` |
45+
| `tag` | `0.24.0` |
46+
| `pullPolicy` | `IfNotPresent` |
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
Thank you for installing {{ .Chart.Name }}.
2+
3+
The next step would be to install the device (plugin) specific chart.

charts/qat-device-plugin/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Intel QAT Device Plugin Helm Chart
2+
3+
## Get Helm Repository Info
4+
```
5+
helm repo add intel https://intel.github.io/helm-charts/
6+
helm repo update
7+
```
8+
9+
You can execute `helm search repo intel` command to see pulled charts [optional].
10+
11+
## Install Helm Chart
12+
```
13+
helm install qat-device-plugin intel/qat-device-plugin [flags]
14+
```
15+
16+
## Upgrade Chart
17+
```
18+
helm upgrade qat-device-plugin intel/qat-device-plugin [flags]
19+
```
20+
21+
## Uninstall Chart
22+
```
23+
helm uninstall qat-device-plugin
24+
```
25+
26+
## Configuration
27+
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments:
28+
29+
```console
30+
helm show values intel/qat-device-plugin
31+
```
32+
33+
You may also run `helm show values` on this chart's dependencies for additional options.
34+
35+
|parameter| value |
36+
|---------|-----------|
37+
| `image` | `intel/intel-qat-plugin:0.24.0` |
38+
| `initImage` | `intel/intel-qat-initcontainer:0.24.0` |
39+
| `dpdkDriver` | `vfio-pci` |
40+
| `kernelVfDrivers` | `c6xxvf`, `4xxxvf` |
41+
| `maxNumDevices` | `128` |
42+
| `logLevel` | `4` |
43+

charts/sgx-device-plugin/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Intel SGX Device Plugin Helm Chart
2+
3+
## Get Helm Repository Info
4+
```
5+
helm repo add intel https://intel.github.io/helm-charts/
6+
helm repo update
7+
```
8+
9+
You can execute `helm search repo intel` command to see pulled charts [optional].
10+
11+
## Install Helm Chart
12+
```
13+
helm install sgx-device-plugin intel/sgx-device-plugin [flags]
14+
```
15+
## Upgrade Chart
16+
```
17+
helm upgrade sgx-device-plugin intel/sgx-device-plugin [flags]
18+
```
19+
20+
## Uninstall Chart
21+
```
22+
helm uninstall sgx-device-plugin
23+
```
24+
25+
## Configuration
26+
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments:
27+
28+
```console
29+
helm show values intel/sgx-device-plugin
30+
```
31+
32+
You may also run `helm show values` on this chart's dependencies for additional options.
33+
34+
|parameter| value |
35+
|---------|-----------|
36+
| `image` | `intel/intel-sgx-plugin:0.24.0` |
37+
| `initImage` | `intel/intel-sgx-initcontainer:0.24.0` |
38+
| `enclaveLimit` | `110` |
39+
| `provisionLimit` | `110` |
40+
| `logLevel` | `4` |
41+
42+
43+

0 commit comments

Comments
 (0)