Skip to content
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

Reference Akri's release Helm chart in documentation #325

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/customizing-akri-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Discovery Handler using Helm (more information about the Akri Helm charts can be
To install Akri without any protocol Configurations, run this:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev
helm install akri akri-helm-charts/akri
```
This will deploy the Akri Controller and deploy Akri Agents.

Expand Down Expand Up @@ -44,7 +44,7 @@ If you want your end application to consume frames from both IP cameras and loca
installed from the start with both the ONVIF and udev Configurations like so:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.configuration.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.discoveryDetails.udevRules[0]='KERNEL=="video[0-9]*"'
Expand Down Expand Up @@ -214,14 +214,14 @@ kubectl delete akric akri-onvif
The Agent discovers devices via Discovery Handlers. Akri supports an Agent image that includes all supported Discovery Handlers.
This Agent will be used if `agent.full=true`, like so:
```bash
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set agent.full=true
```

By default, a slim Agent without any embedded Discovery Handlers is deployed and the required Discovery Handlers can be deployed as DaemonSets by specifying
`<discovery handler name>.discovery.enabled=true` when installing Akri. For example, Akri is installed with the OPC UA and ONVIF Discovery Handlers like so:
```bash
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set onvif.discovery.enabled=true
```
Expand Down
4 changes: 2 additions & 2 deletions docs/debug-echo-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To install Akri with **external** Debug Echo Discovery Handlers and a Configurat
devices, run:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set agent.allowDebugEcho=true \
--set debugEcho.discovery.enabled=true \
--set debugEcho.configuration.enabled=true \
Expand All @@ -33,7 +33,7 @@ helm install akri akri-helm-charts/akri-dev \
> remove `debugEcho.discovery.enabled=true` like in the following installation:
>```bash
>helm repo add akri-helm-charts https://deislabs.github.io/akri/
>helm install akri akri-helm-charts/akri-dev \
>helm install akri akri-helm-charts/akri \
> --set agent.allowDebugEcho=true \
> --set agent.full=true \
> --set debugEcho.configuration.enabled=true \
Expand Down
6 changes: 3 additions & 3 deletions docs/discovery-handler-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ come together as the following Akri installation command:
> additional configuration.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set imagePullSecrets[0].name="crPullSecret" \
--set custom.discovery.enabled=true \
--set custom.discovery.image.repository=$DH_IMAGE \
Expand All @@ -233,7 +233,7 @@ come together as the following Akri installation command:
> Note: if your Discovery Handler's `discoveryDetails` cannot be easily set using Helm, generate a Configuration file
> and modify it as needed. configuration.enabled`.)
> ```bash
> helm install akri akri-helm-charts/akri-dev \
> helm install akri akri-helm-charts/akri \
> --set imagePullSecrets[0].name="crPullSecret" \
> --set custom.discovery.enabled=true \
> --set custom.discovery.image.repository=$DH_IMAGE \
Expand Down Expand Up @@ -270,7 +270,7 @@ resources](./requesting-akri-resources.md). Alternatively, you could have Akri a
discovered devices. We call these workloads brokers. To quickly see this, deploy empty nginx pods to discovered
resources, by updating our Configuration to include a broker PodSpec.
```bash
helm upgrade akri akri-helm-charts/akri-dev \
helm upgrade akri akri-helm-charts/akri \
--set imagePullSecrets[0].name="crPullSecret" \
--set custom.discovery.enabled=true \
--set custom.discovery.image.repository=$DH_IMAGE \
Expand Down
2 changes: 1 addition & 1 deletion docs/end-to-end-demo-rpi4.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ In order for the Agent to know how to discover video devices, the udev Discovery
1. Add the Akri Helm chart and run the install command, setting Helm values as described above.
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.name=akri-udev-video \
Expand Down
2 changes: 1 addition & 1 deletion docs/end-to-end-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ In order for the Agent to know how to discover video devices, the udev Discovery
1. Add the Akri Helm chart and run the install command, setting Helm values as described above.
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
$AKRI_HELM_CRICTL_CONFIGURATION \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
Expand Down
6 changes: 3 additions & 3 deletions docs/extensibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ installation command:
> additional configuration.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set imagePullSecrets[0].name="crPullSecret" \
--set custom.discovery.enabled=true \
--set custom.discovery.image.repository=$DH_IMAGE \
Expand All @@ -468,7 +468,7 @@ resources](./requesting-akri-resources.md). Alternatively, you could have Akri a
discovered devices. We call these workloads brokers. To quickly see this, lets deploy empty nginx pods to discovered
resources, by updating our Configuration to include a broker PodSpec.
```bash
helm upgrade akri akri-helm-charts/akri-dev \
helm upgrade akri akri-helm-charts/akri \
--set imagePullSecrets[0].name="crPullSecret" \
--set custom.discovery.enabled=true \
--set custom.discovery.image.repository=$DH_IMAGE \
Expand Down Expand Up @@ -653,7 +653,7 @@ docker push ${BROKER_IMAGE_TAGGED}
Now that the HTTP broker has been created, we can substitute it's image in for the simple nginx broker we previously
used in our installation command.
```bash
helm upgrade akri akri-helm-charts/akri-dev \
helm upgrade akri akri-helm-charts/akri \
--set imagePullSecrets[0].name="crPullSecret" \
--set custom.discovery.enabled=true \
--set custom.discovery.image.repository=$DH_IMAGE \
Expand Down
8 changes: 4 additions & 4 deletions docs/onvif-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Leveraging the above settings, Akri can be installed with the ONVIF Discovery Ha

```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.discovery.enabled=true \
--set onvif.configuration.enabled=true \
--set onvif.configuration.brokerPod.image.repository="ghcr.io/deislabs/akri/onvif-video-broker" \
Expand All @@ -76,7 +76,7 @@ The ONVIF Discovery Handler supports basic filter capabilities has been provided
For example, the following enables discovery of every camera that does not have an IP address of 10.0.0.1:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.discovery.enabled=true \
--set onvif.configuration.enabled=true \
--set onvif.configuration.brokerPod.image.repository="ghcr.io/deislabs/akri/onvif-video-broker" \
Expand All @@ -87,7 +87,7 @@ helm install akri akri-helm-charts/akri-dev \
You can enable cluster access for every camera with a specific name, you can modify the Configuration like so:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.discovery.enabled=true \
--set onvif.configuration.enabled=true \
--set onvif.configuration.brokerPod.image.repository="ghcr.io/deislabs/akri/onvif-video-broker" \
Expand All @@ -101,7 +101,7 @@ The ONVIF Discovery Handler will search for up to `discoveryTimeoutSeconds` for
decreased as desired, and defaults to 1 second if not configured. It can be set in the Configuration like this:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.discovery.enabled=true \
--set onvif.configuration.enabled=true \
--set onvif.configuration.brokerPod.image.repository="ghcr.io/deislabs/akri/onvif-video-broker" \
Expand Down
16 changes: 8 additions & 8 deletions docs/opcua-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ pod, you can update the Configuration like this by setting `opcua.configuration.
Leveraging the above settings, Akri can be installed with the OPC UA Discovery Handler and an OPC UA Configuration that specifies discovery via the default LDS DiscoveryURL:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true
```
Expand All @@ -69,7 +69,7 @@ If you have a workload that you would like to automatically be deployed to each
empty nginx pod for each server. Instead, you should point to your image, say `ghcr.io/<USERNAME>/opcua-broker`.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.brokerPod.image.repository=nginx
Expand All @@ -90,7 +90,7 @@ using the default `opc.tcp://localhost:4840/` LDS DiscoveryURL, an operator can
Local Discovery Servers, like in the following example:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.discoveryUrls[0]="opc.tcp://10.1.2.3:4840/" \
Expand All @@ -101,7 +101,7 @@ helm install akri akri-helm-charts/akri-dev \
If you know the DiscoveryURLs for the OPC UA Servers you want Akri to discover, manually list them when deploying Akri, like in the following:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.discoveryUrls[0]="opc.tcp://10.123.456.7:4855/"
Expand All @@ -112,7 +112,7 @@ OPC UA discovery can also receive a list of both OPC UA LDS DiscoveryURLs and sp

```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.discoveryUrls[0]="opc.tcp://10.1.2.3:4840/" \
Expand All @@ -130,7 +130,7 @@ as specified by [OPC UA Specification](https://reference.opcfoundation.org/v104/
the server named "Duke", do the following.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.applicationNames.action=Exclude \
Expand All @@ -139,7 +139,7 @@ helm install akri akri-helm-charts/akri-dev \
Alternatively, to only discover the server named "Go Tar Heels!", do the following:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.applicationNames.action=Include \
Expand Down Expand Up @@ -174,7 +174,7 @@ template](../deployment/helm/templates/opcua.configuration.yaml). This is the pa
certificates. The following is an example how to enable security:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.mountCertificates='true'
Expand Down
14 changes: 7 additions & 7 deletions docs/opcua-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ to the OPC Foundation's .NET Console Reference Server.
security, uncomment `--set opcua.configuration.mountCertificates='true'`.
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.name=akri-opcua-monitoring \
Expand Down Expand Up @@ -307,7 +307,7 @@ Kubernetes) cluster.
`--set opcua.configuration.mountCertificates='true'` if using security. Watch as the broker terminates and then four
come online in a Running state.
```sh
helm upgrade akri akri-helm-charts/akri-dev \
helm upgrade akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.name=akri-opcua-monitoring \
Expand Down Expand Up @@ -363,7 +363,7 @@ install Akri with the OPC UA Configuration, passing in the LDS DiscoveryURL inst
Replace "Windows host IP address" with the IP address of the Windows machine you installed the LDS on (and is hosting
the servers). Be sure to uncomment mounting certificates if you are enabling security:
```sh
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.name=akri-opcua-monitoring \
Expand All @@ -388,7 +388,7 @@ include or exclude a list of application names (the `applicationName` property o
specified by UA Specification 12). For example, to discover all servers registered with the default LDS except for the
server named "SomeServer0", do the following.
```bash
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.name=akri-opcua-monitoring \
Expand All @@ -402,7 +402,7 @@ helm install akri akri-helm-charts/akri-dev \
```
Alternatively, to only discover the server named "SomeServer0", do the following:
```bash
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.name=akri-opcua-monitoring \
Expand All @@ -425,7 +425,7 @@ additional information passed to it at all. Decide whether to pass environment v
set the broker pod image to be your container image, say `ghcr.io/<USERNAME>/opcua-broker`.
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set opcua.discovery.enabled=true \
--set opcua.configuration.enabled=true \
--set opcua.configuration.discoveryDetails.discoveryUrls[0]="opc.tcp://<IP address>:<port>/" \
Expand All @@ -441,7 +441,7 @@ apply it to your Kubernetes cluster.

### Creating a new OPC UA Configuration
Helm allows us to parametrize the commonly modified fields in our Configuration files, and we have provided many. Run
`helm inspect values akri-helm-charts/akri-dev` to see what values of the generic OPC UA Configuration can be
`helm inspect values akri-helm-charts/akri` to see what values of the generic OPC UA Configuration can be
customized, such as the Configuration and Instance `ServiceSpec`s, `capacity`, and broker `PodSpec`. We saw in the
previous section how broker Pod environment variables can be specified via `--set
opcua.configuration.brokerProperties.KEY='VALUE'`. For more advanced configuration changes that are not aided by the
Expand Down
4 changes: 2 additions & 2 deletions docs/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ installing Akri.
Install Akri and expose the Controller and Agent's metrics to Prometheus by running:
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set prometheus.enabled=true
```
> **Note**: This documentation assumes you are using vanilla Kubernetes. Be sure to reference the [user
Expand Down Expand Up @@ -100,7 +100,7 @@ process metrics and the custom `akri_frame_count` metric to port 8080 at a `/met
Configuration name of `akri-udev-video`, by running:
```sh
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.enabled=true \
--set udev.name=akri-udev-video \
--set udev.udevRules[0]='KERNEL=="video[0-9]*"' \
Expand Down
2 changes: 1 addition & 1 deletion docs/requesting-akri-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lets walk through how this works, using the ONVIF Discovery Handler as an exampl
omitting a broker pod image.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set onvif.discovery.enabled=true \
--set onvif.configuration.enabled=true
```
Expand Down
8 changes: 4 additions & 4 deletions docs/udev-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ To test which devices Akri will discover with a udev rule, you can run the rule
Leveraging the above settings, Akri can be installed with the udev Discovery Handler and a udev Configuration with our udev rule specified.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.discoveryDetails.udevRules[0]='SUBSYSTEM=="sound"\, ATTR{vendor}=="Great Vendor"'
Expand All @@ -129,7 +129,7 @@ our Helm chart, we suggest creating a Configuration file using Helm and then man
The udev Discovery Handler will find all devices that are described by ANY of the udev rules. For example, to discover devices made by either Great Vendor or Awesome Vendor, you could add a second udev rule.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.discoveryDetails.udevRules[0]='SUBSYSTEM=="sound"\, ATTR{vendor}=="Great Vendor"' \
Expand All @@ -152,7 +152,7 @@ environment variable and proceed to interact with the device. To add a broker to
empty nginx pod for each instance. Instead, you can point to your image, say `ghcr.io/<USERNAME>/sound-broker`.
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.discoveryDetails.udevRules[0]='SUBSYSTEM=="sound"\, ATTR{vendor}=="Great Vendor"' \
Expand All @@ -172,7 +172,7 @@ By default in the generic udev Configuration, the udev broker is run in privileg
Helm. For example, to instead run all processes in the Pod with user ID 1000 and group 1000, do the following:
```bash
helm repo add akri-helm-charts https://deislabs.github.io/akri/
helm install akri akri-helm-charts/akri-dev \
helm install akri akri-helm-charts/akri \
--set udev.discovery.enabled=true \
--set udev.configuration.enabled=true \
--set udev.configuration.discoveryDetails.udevRules[0]='SUBSYSTEM=="sound"\, ATTR{vendor}=="Great Vendor"' \
Expand Down
Loading