Update documentation for Cluster-API and Flux
[icn.git] / deploy / kud-plugin-addons / README.md
1 kud-plugin-addons provides the scripts and yaml files to install kud-addons on working node which includes: device plugins, nfd, prometheus, rook etc.
2 1. device plugin:
3 (1) driver: include scripts to install driver on working node
4 collect_XX.sh: invoked by collect.sh in build machine to generate the driver installation package (e.g. qat_driver-0.1.tar.gz etc.), the package will be installed on /opt/icn/driver in icn infra-local-controller. BPA can install this package on cluster node, then install the driver with below commands:
5 $ tar xzvf qat_driver-0.1.tar.gz
6 $ cd qat_driver
7 $ bash install.sh
8
9 (2) yaml: include the yaml file to install k8s device plugin
10 collect_XX.sh: invoked by collect.sh in build machine to generate the k8s device plugin installation package (e.g. qat_yaml-0.1.tar.gz etc.), the package will be installed on /opt/icn/yaml in icn infra-local-controller. BPA can install this package on cluster node, then install the device plugin with below commands(it assumed that k8s cluster had been installed by kud):
11 $ tar xzvf qat_yaml-0.1.tar.gz
12 $ cd qat_yaml
13 $ bash install.sh
14
15 (3) test: include the test yaml file with sample workloads to use the device plugin 
16
17 2. nfd
18 3. prometheus
19 4. rook
20