diff --git a/docs/user-guide.md b/docs/user-guide.md index a8a0072d0..1572ff25a 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -118,8 +118,8 @@ Let's walk through building an Akri installation command: 3. Upgrade the installation to deploy the Discovery Handler you wish to use. Discovery Handlers are deployed as DaemonSets like the Agent when `.discovery.enabled` is set. ```sh - helm upgrade akri akri-helm-charts/akri \ - --set .discovery.enabled + helm upgrade akri akri-helm-charts/akri-dev \ + --set .discovery.enabled=true ``` > Note: To install a full Agent with embedded udev, OPC UA, and ONVIF Discovery Handlers, set `agent.full=true` instead of enabling the Discovery Handlers. Note, this we restart the > Agent Pods. @@ -130,9 +130,9 @@ Let's walk through building an Akri installation command: 4. Upgrade the installation to apply a Configuration, which requests discovery of certain devices by a Discovery Handler. A Configuration is applied by setting `.configuration.enabled`. While some Configurations may not require any discovery details to be set, oftentimes setting details is preferable for narrowing the Discovery Handlers' search. These are set under `.configuration.discoveryDetails`. For example, udev rules are passed to the udev Discovery Handler to specify which devices in the Linux device file system it should search for by setting `udev.configuration.discoveryDetails.udevRules`. Akri can be instructed to automatically deploy workloads called "brokers" to each discovered device by setting a broker Pod image in a Configuration via `--set .configuration.brokerPod.image.repository=`. ```sh - helm upgrade akri akri-helm-charts/akri \ - --set .discovery.enabled \ - --set .configuration.enabled \ + helm upgrade akri akri-helm-charts/akri-dev \ + --set .discovery.enabled=true \ + --set .configuration.enabled=true \ # set any discovery details in the Configuration # specify any broker images in the Configuration ``` @@ -141,16 +141,16 @@ Installation could have been done in one step rather than a series of upgrades: ```sh helm repo add akri-helm-charts https://deislabs.github.io/akri/ helm install akri akri-helm-charts/akri-dev \ - --set .discovery.enabled \ - --set .configuration.enabled \ + --set .discovery.enabled=true \ + --set .configuration.enabled=true \ # set any discovery details in the Configuration # specify any broker images in the Configuration ``` As a real example, Akri's Controller, Agents, udev Discovery Handlers, and a udev Configuration that specifies the discovery of only USB video devices and an nginx broker image are installed like so: ```sh helm install akri akri-helm-charts/akri-dev \ - --set udev.discovery.enabled \ - --set udev.configuration.enabled \ + --set udev.discovery.enabled=true \ + --set udev.configuration.enabled=true \ --set udev.configuration.discoveryDetails.udevRules[0]='KERNEL=="video[0-9]*"' \ --set udev.configuration.brokerPod.image.repository=nginx ```