Skip to content

Commit

Permalink
fix errors in user guide (#302)
Browse files Browse the repository at this point in the history
  • Loading branch information
kate-goldenring authored Apr 9, 2021
1 parent f0fa791 commit 33f872d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 handler name>.discovery.enabled` is set.
```sh
helm upgrade akri akri-helm-charts/akri \
--set <discovery handler name>.discovery.enabled
helm upgrade akri akri-helm-charts/akri-dev \
--set <discovery handler name>.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.
Expand All @@ -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 `<discovery handler name>.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 `<discovery handler name>.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 <protocol>.configuration.brokerPod.image.repository=<your broker image>`.
```sh
helm upgrade akri akri-helm-charts/akri \
--set <discovery handler name>.discovery.enabled \
--set <discovery handler name>.configuration.enabled \
helm upgrade akri akri-helm-charts/akri-dev \
--set <discovery handler name>.discovery.enabled=true \
--set <discovery handler name>.configuration.enabled=true \
# set any discovery details in the Configuration
# specify any broker images in the Configuration
```
Expand All @@ -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 handler name>.discovery.enabled \
--set <discovery handler name>.configuration.enabled \
--set <discovery handler name>.discovery.enabled=true \
--set <discovery handler name>.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
```
Expand Down

0 comments on commit 33f872d

Please sign in to comment.