README
¶
IoT Management Service
The Management service is the end-user web interface to monitor and manage IoT devices. The service integrates with the IoT Identity and IoT Device Twin services to provide device management for Ubuntu devices.
Design
Build
See Dockerfile
Run
go run cmd/management/main.go
The service uses a settings.yaml file for configuration.
Contributing
Before contributing you should sign Canonical's contributor agreement, it’s the easiest way for you to give us permission to use your contributions.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth provides functionality that allows the service to use and consume tokens from various sources
|
Package auth provides functionality that allows the service to use and consume tokens from various sources |
|
bin
|
|
|
cmd
|
|
|
management
Package management is the top-level and subcommands for the management binary\
|
Package management is the top-level and subcommands for the management binary\ |
|
Package config provides the functionality and types to load configuration from file or environment with the latter override the former
|
Package config provides the functionality and types to load configuration from file or environment with the latter override the former |
|
configkey
Package configkey provides the constant keys for getting a configuration value
|
Package configkey provides the constant keys for getting a configuration value |
|
Package crypt provides the method to create a secret
|
Package crypt provides the method to create a secret |
|
Package datastore provides the DataStore interface and entity types
|
Package datastore provides the DataStore interface and entity types |
|
memory
Package memory is an in-memory implementation of the DataStore
|
Package memory is an in-memory implementation of the DataStore |
|
models
Package models provides the models for database types with GORM
|
Package models provides the models for database types with GORM |
|
postgres
Package postgres provides the postgres based DataStore implementation
|
Package postgres provides the postgres based DataStore implementation |
|
Package domain provides types specific to the management service
|
Package domain provides types specific to the management service |
|
Package identityapi provides an interface and types for interacting with the Identity REST API
|
Package identityapi provides an interface and types for interacting with the Identity REST API |
|
Package requests provides functionality common to manipulating REST requests
|
Package requests provides functionality common to manipulating REST requests |
|
service
|
|
|
factory
Package factory provides a way to instantiate a DataStore based on the provided driver string
|
Package factory provides a way to instantiate a DataStore based on the provided driver string |
|
manage
Package manage provides the interface and implementation of the Manage service
|
Package manage provides the interface and implementation of the Manage service |
|
Package twinapi provides the interface and implementation of Client to interact with the DeviceTwin REST API
|
Package twinapi provides the interface and implementation of Client to interact with the DeviceTwin REST API |
|
Package versions provides a way to read component versions from disk, cache and provide
|
Package versions provides a way to read component versions from disk, cache and provide |
|
Package web provides types and functionality for the REST API and web app static files
|
Package web provides types and functionality for the REST API and web app static files |
|
usso
Package usso provides types and functionality for the Ubuntu Single Sign-on Server
|
Package usso provides types and functionality for the Ubuntu Single Sign-on Server |
Click to show internal directories.
Click to hide internal directories.