-
Notifications
You must be signed in to change notification settings - Fork 208
Add INSTALL.md with pointers to plugin and operator installation + new HELM instructions #1314
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,132 @@ | ||
# Installing device plugins to cluster | ||
|
||
## Install device plugins via a DaemonSet | ||
|
||
Each plugin can be installed via a DaemonSet. The install changes slightly based on the desired plugin. See install instructions per [plugin](README.md#plugins). | ||
|
||
Installing plugins via DaemonSets deployes them to the ```default``` (or currently active) namespace. Use kubectl's ```--namespace``` argument to change the deployment namespace. | ||
|
||
## Install device plugins via device plugin operator | ||
|
||
A more advanced install method is via device plugin operator. Operator configures plugin deployments based on the supplied device plugin CRDs (Custom Resource Definitions). See installation instructions in the [operator README](cmd/operator/README.md#installation). | ||
|
||
Operator installs device plugins to the same namespace where the operator itself is deployed. The default operator namespace is ```inteldeviceplugins-system```. | ||
|
||
## Install with HELM charts | ||
|
||
Device plugins can also be installed to a cluster using the device plugin [operator Helm chart](https://github.com/intel/helm-charts/tree/main/charts/device-plugin-operator) (depending on cert-manager and NFD). Individual plugin projects are under https://github.com/intel/helm-charts/tree/main/charts/. | ||
|
||
These steps will install device plugin operator and plugins under ```inteldeviceplugins-system``` namespace. It's possible to change the target namespace by changing the ```--namespace``` value in the helm install command. | ||
|
||
### Installing HELM repositories | ||
|
||
```bash | ||
helm repo add jetstack https://charts.jetstack.io # for cert-manager | ||
helm repo add nfd https://kubernetes-sigs.github.io/node-feature-discovery/charts # for NFD | ||
helm repo add intel https://intel.github.io/helm-charts/ # for device-plugin-operator and plugins | ||
helm repo update | ||
``` | ||
|
||
### Installing cert-manager | ||
|
||
```bash | ||
helm install --wait \ | ||
cert-manager jetstack/cert-manager \ | ||
--namespace cert-manager \ | ||
--create-namespace \ | ||
--version v1.11.0 \ | ||
--set installCRDs=true | ||
``` | ||
|
||
NOTE: cert-manager install takes a while to complete. | ||
|
||
### Installing NFD | ||
|
||
```bash | ||
helm install nfd nfd/node-feature-discovery \ | ||
--namespace node-feature-discovery --create-namespace --version 0.12.1 \ | ||
--set 'master.extraLabelNs={gpu.intel.com,sgx.intel.com}' \ | ||
--set 'master.resourceLabels={gpu.intel.com/millicores,gpu.intel.com/memory.max,gpu.intel.com/tiles,sgx.intel.com/epc}' | ||
``` | ||
|
||
### Installing operator | ||
|
||
```bash | ||
helm install dp-operator intel/intel-device-plugins-operator --namespace inteldeviceplugins-system --create-namespace | ||
``` | ||
|
||
### Installing specific plugins | ||
|
||
Replace PLUGIN with the desired plugin name. At least the following plugins are supported: **gpu, sgx, qat, dlb, dsa & iaa**. | ||
|
||
```bash | ||
helm install <PLUGIN> intel/intel-device-plugins-<PLUGIN> --namespace inteldeviceplugins-system --create-namespace \ | ||
--set nodeFeatureRule=true | ||
``` | ||
|
||
### Listing available versions | ||
|
||
Use helm's search functionality to list available versions. | ||
|
||
```bash | ||
helm search repo intel/intel-device-plugins-operator --versions | ||
helm search repo intel/intel-device-plugins-<plugin> --versions | ||
``` | ||
|
||
For example, operator chart versions with development versions included. | ||
```bash | ||
$ helm search repo intel/intel-device-plugins-operator --versions --devel | ||
NAME CHART VERSION APP VERSION DESCRIPTION | ||
intel/intel-device-plugins-operator 0.26.0 0.26.0 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.25.1 0.25.1 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.25.1-helm.0 0.25.0 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.25.0 0.25.0 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.24.1 0.24.1 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.24.1-helm.0 0.24.0 A Helm chart for Intel Device Plugins Operator ... | ||
intel/intel-device-plugins-operator 0.24.0 0.24.0 A Helm chart for Intel Device Plugins Operator ... | ||
``` | ||
|
||
### Customizing plugins | ||
|
||
To customize plugin features, see the available chart values: | ||
```bash | ||
helm show values intel/intel-device-plugins-<PLUGIN> | ||
``` | ||
|
||
For example, qat plugin has these values: | ||
```bash | ||
$ helm show values intel/intel-device-plugins-qat | ||
name: qatdeviceplugin-sample | ||
|
||
image: | ||
hub: intel | ||
tag: "" | ||
|
||
initImage: | ||
hub: intel | ||
tag: "" | ||
|
||
dpdkDriver: vfio-pci | ||
kernelVfDrivers: | ||
- c6xxvf | ||
- 4xxxvf | ||
maxNumDevices: 128 | ||
logLevel: 4 | ||
|
||
nodeSelector: | ||
intel.feature.node.kubernetes.io/qat: 'true' | ||
|
||
nodeFeatureRule: true | ||
``` | ||
|
||
### Uninstall | ||
|
||
Uninstall each installed component with ```helm uninstall```: | ||
|
||
```bash | ||
# repeat first step as many times as there are plugins installed | ||
helm uninstall -n inteldeviceplugins-system <PLUGIN> | ||
helm uninstall -n inteldeviceplugins-system dp-operator | ||
helm uninstall -n node-feature-discovery nfd | ||
helm uninstall -n cert-manager cert-manager | ||
``` |
5 changes: 0 additions & 5 deletions
5
deployments/dsa_plugin/overlays/namespace_kube-system/add-namespace-kube-system.yaml
This file was deleted.
Oops, something went wrong.
4 changes: 0 additions & 4 deletions
4
deployments/dsa_plugin/overlays/namespace_kube-system/kustomization.yaml
This file was deleted.
Oops, something went wrong.
5 changes: 0 additions & 5 deletions
5
deployments/gpu_plugin/overlays/namespace_kube-system/add-namespace-kube-system.yaml
This file was deleted.
Oops, something went wrong.
4 changes: 0 additions & 4 deletions
4
deployments/gpu_plugin/overlays/namespace_kube-system/kustomization.yaml
This file was deleted.
Oops, something went wrong.
5 changes: 0 additions & 5 deletions
5
deployments/vpu_plugin/overlays/namespace_kube-system/add-namespace-kube-system.yaml
This file was deleted.
Oops, something went wrong.
4 changes: 0 additions & 4 deletions
4
deployments/vpu_plugin/overlays/namespace_kube-system/kustomization.yaml
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.