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.

Sign up for GitHub

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

docs(snap): Move usage instructions to docs #377

Merged
merged 2 commits into from
May 6, 2022
Merged

docs(snap): Move usage instructions to docs #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce2427e
docs(snap): Remove usage instructions from readme
MonicaisHer May 5, 2022
075872d
docs(snap): remove outdated release artifacts part
MonicaisHer May 5, 2022
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
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ For docker, please refer to the [Dockerfile](Dockerfile) and [Docker Compose Bui

For the snap, refer to the [snap](snap) directory.

The details of the EdgeX release artifacts are available [here](https://docs.edgexfoundry.org/2.1/design/adr/devops/0010-Release-Artifacts).

## Usage
Users can refer to [this document](https://docs.edgexfoundry.org/2.1/examples/Ch-ExamplesAddingMQTTDevice) to learn how to use this device service.

Expand Down
190 changes: 19 additions & 171 deletions snap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,190 +1,38 @@
# EdgeX MQTT Device Service Snap
[![snap store badge](https://raw.githubusercontent.com/snapcore/snap-store-badges/master/EN/%5BEN%5D-snap-store-black-uneditable.png)](https://snapcraft.io/edgex-device-mqtt)
[![edgex-device-mqtt](https://snapcraft.io/edgex-device-mqtt/badge.svg)](https://snapcraft.io/edgex-device-mqtt)

This folder contains snap packaging for the EdgeX MQTT Device Service Snap
This directory contains the snap packaging of the EdgeX MQTT device service.

The snap currently supports both `amd64` and `arm64` platforms.
The snap is built automatically and published on the Snap Store as [edgex-device-mqtt].

For usage instructions, please refer to Device MQTT section in [Getting Started using Snaps][docs].

## Installation

### Installing snapd
The snap can be installed on any system that supports snaps. You can see how to install
snaps on your system [here](https://snapcraft.io/docs/installing-snapd/6735).

However for full security confinement, the snap should be installed on an
Ubuntu 18.04 LTS or later (Desktop or Server), or a system running Ubuntu Core 18 or later.

### Installing EdgeX Device MQTT as a snap
The snap is published in the snap store at https://snapcraft.io/edgex-device-mqtt.
You can see the current revisions available for your machine's architecture by running the command:

```bash
$ snap info edgex-device-mqtt
```

The latest stable version of the snap can be installed using:

```bash
$ sudo snap install edgex-device-mqtt
```

The 2.0 (Ireland) release of the snap can be installed using:

```bash
$ sudo snap install edgex-device-mqtt --channel=2.0
```

The latest development version of the snap can be installed using:

```bash
$ sudo snap install edgex-device-mqtt --edge
```

**Note** - the snap has only been tested on Ubuntu Core, Desktop, and Server.


## Snap configuration

Device services implement a service dependency check on startup which ensures that all of the runtime dependencies of a particular service are met before the service transitions to active state.

Snapd doesn't support orchestration between services in different snaps. It is therefore possible on a reboot for a device service to come up faster than all of the required services running in the main edgexfoundry snap. If this happens, it's possible that the device service repeatedly fails startup, and if it exceeds the systemd default limits, then it might be left in a failed state. This situation might be more likely on constrained hardware (e.g. RPi).

This snap therefore implements a basic retry loop with a maximum duration and sleep interval. If the dependent services are not available, the service sleeps for the defined interval (default: 1s) and then tries again up to a maximum duration (default: 60s). These values can be overridden with the following commands:

To change the maximum duration, use the following command:

```bash
$ sudo snap set edgex-device-mqtt startup-duration=60
## Build from source
Execute the following command from the top-level directory of this repo:
```

To change the interval between retries, use the following command:

```bash
$ sudo snap set edgex-device-mqtt startup-interval=1
snapcraft
```

The service can then be started as follows. The "--enable" option
ensures that as well as starting the service now, it will be automatically started on boot:
This will create a snap package file with `.snap` extension. It can be installed locally by setting the `--dangerous` flag:
```bash
$ sudo snap start --enable edgex-device-mqtt.device-mqtt
```


### Using a content interface to set device configuration

The `device-config` content interface allows another snap to seed this device
snap with configuration files under the `$SNAP_DATA/config/device-mqtt/res` directory.

Note that the `device-config` content interface does NOT support seeding of the Secret Store Token because that file is expected at a different path.

To use, create a new snap with a directory containing the configuration files.
Your `snapcraft.yaml` file then needs to define a slot with read access to the directory you are sharing.

sudo snap install --dangerous <snap-file>
```
slots:
device-config:
interface: content
content: device-config
read:
- $SNAP/config
```

where `$SNAP/config` is configuration directory your snap is providing to the device snap.

Then connect the plug in the device snap to the slot in your snap, which will replace the configuration in the device snap. Do this with:
The [snapcraft overview](https://snapcraft.io/docs/snapcraft-overview) provides additional details.

```bash
$ sudo snap connect edgex-device-mqtt:device-config your-snap:device-config
```
### Obtain a Secret Store token
The `edgex-secretstore-token` snap slot makes it possible to automatically receive a token from a locally installed platform snap.

This needs to be done before the device service is started for the first time. Once you have set the configuration the device service can be started and it will then be configured using the settings you provided:
If the snap is built and installed locally, the interface will not auto-connect. You can check the status of the connections by running the `snap connections edgex-device-mqtt` command.

To manually connect and obtain a token:
```bash
$ sudo snap start edgex-device-mqtt.device-mqtt
```

**Note** - content interfaces from snaps installed from the Snap Store that have the same publisher connect automatically. For more information on snap content interfaces please refer to the snapcraft.io [Content Interface](https://snapcraft.io/docs/content-interface) documentation.

### Autostart
By default, the edgex-device-mqtt disables its service on install, as the expectation is that the default profile configuration files will be customized, and thus this behavior allows the profile `configuration.toml` files in $SNAP_DATA to be modified before the service is first started.

This behavior can be overridden by setting the `autostart` configuration setting to "true". This is useful when configuration and/or device profiles are being provided via configuration or gadget snap content interface.

**Note** - this option is typically set from a gadget snap.

### Rich Configuration
While it's possible on Ubuntu Core to provide additional profiles via gadget
snap content interface, quite often only minor changes to existing profiles are required.

These changes can be accomplished via support for EdgeX environment variable
configuration overrides via the snap's configure hook.
If the service has already been started, setting one of these overrides currently requires the
service to be restarted via the command-line or snapd's REST API.
If the overrides are provided via the snap configuration defaults capability of a gadget snap,
the overrides will be picked up when the services are first started.

The following syntax is used to specify service-specific configuration overrides:


```
env.<stanza>.<config option>
```
For instance, to setup an override of the service's Port use:
```
$ sudo snap set edgex-device-mqtt env.service.port=2112
```
And restart the service:
```
$ sudo snap restart edgex-device-mqtt.device-mqtt
```

**Note** - at this time changes to configuration values in the [Writable] section are not supported.
For details on the mapping of configuration options to Config options, please refer to "Service Environment Configuration Overrides".

## Service Environment Configuration Overrides
**Note** - all of the configuration options below must be specified with the prefix: 'env.'
sudo snap connect edgexfoundry:edgex-secretstore-token edgex-device-mqtt:edgex-secretstore-token
```
[Service]
service.health-check-interval // Service.HealthCheckInterval
service.host // Service.Host
service.server-bind-addr // Service.ServerBindAddr
service.port // Service.Port
service.max-result-count // Service.MaxResultCount
service.max-request-size // Service.MaxRequestSize
service.startup-msg // Service.StartupMsg
service.request-timeout // Service.RequestTimeout

[SecretStore]
secret-store.secrets-file // SecretStore.SecretsFile
secret-store.disable-scrub-secrets-file // SecretStore.DisableScrubSecretsFile

[Clients.core-data]
clients.core-data.port // Clients.core-data.Port

[Clients.core-metadata]
clients.core-metadata.port // Clients.core-metadata.Port
Please refer [here][secret-store-token] for further information.

[MQTTBrokerInfo]
mqttbrokerinfo.schema // MQTTBrokerInfo.Schema
mqttbrokerinfo.host // MQTTBrokerInfo.Host
mqttbrokerinfo.port // MQTTBrokerInfo.Port
mqttbrokerinfo.qos // MQTTBrokerInfo.Qos
mqttbrokerinfo.keep-alive // MQTTBrokerInfo.KeepAlive
mqttbrokerinfo.client-id // MQTTBrokerInfo.ClientId

mqttbrokerinfo.credentials-retry-time // MQTTBrokerInfo.CredentialsRetryTime
mqttbrokerinfo.credentials-retry-wait // MQTTBrokerInfo.CredentialsRetryWait
mqttbrokerinfo.conn-establishing-retry // MQTTBrokerInfo.ConnEstablishingRetry
mqttbrokerinfo.conn-retry-wait-time // MQTTBrokerInfo.ConnRetryWaitTime

mqttbrokerinfo.auth-mode // MQTTBrokerInfo.AuthMode
mqttbrokerinfo.credentials-path // MQTTBrokerInfo.CredentialsPath

mqttbrokerinfo.incoming-topic // MQTTBrokerInfo.IncomingTopic
mqttbrokerinfo.response-topic // MQTTBrokerInfo.responseTopic

[Device]
device.update-last-connected // Device.UpdateLastConnected
device.use-message-bus // Device.UseMessageBus
```
[edgex-device-mqtt]: https://snapcraft.io/edgex-device-mqtt
[docs]: https://docs.edgexfoundry.org/2.2/getting-started/Ch-GettingStartedSnapUsers/#device-mqtt
[secret-store-token]: https://docs.edgexfoundry.org/2.2/getting-started/Ch-GettingStartedSnapUsers/#secret-store-token