things

README

Things

Things service provides an HTTP API for managing platform resources: things and channels. Through this API clients are able to do the following actions:

• provision new things
• create new channels
• "connect" things into the channels

For an in-depth explanation of the aforementioned scenarios, as well as thorough understanding of Magistrala, please check out the official documentation.

Configuration

The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.

Variable	Description	Default
MG_THINGS_LOG_LEVEL	Log level for Things (debug, info, warn, error)	info
MG_THINGS_HTTP_HOST	Things service HTTP host	localhost
MG_THINGS_HTTP_PORT	Things service HTTP port	9000
MG_THINGS_SERVER_CERT	Path to the PEM encoded server certificate file	""
MG_THINGS_SERVER_KEY	Path to the PEM encoded server key file	""
MG_THINGS_AUTH_GRPC_HOST	Things service gRPC host	localhost
MG_THINGS_AUTH_GRPC_PORT	Things service gRPC port	7016
MG_THINGS_AUTH_GRPC_SERVER_CERT	Path to the PEM encoded server certificate file	""
MG_THINGS_AUTH_GRPC_SERVER_KEY	Path to the PEM encoded server key file	""
MG_THINGS_DB_HOST	Database host address	localhost
MG_THINGS_DB_PORT	Database host port	5432
MG_THINGS_DB_USER	Database user	magistrala
MG_THINGS_DB_PASS	Database password	magistrala
MG_THINGS_DB_NAME	Name of the database used by the service	things
MG_THINGS_DB_SSL_MODE	Database connection SSL mode (disable, require, verify-ca, verify-full)	disable
MG_THINGS_DB_SSL_CERT	Path to the PEM encoded certificate file	""
MG_THINGS_DB_SSL_KEY	Path to the PEM encoded key file	""
MG_THINGS_DB_SSL_ROOT_CERT	Path to the PEM encoded root certificate file	""
MG_THINGS_CACHE_URL	Cache database URL	redis://localhost:6379/0
MG_THINGS_CACHE_KEY_DURATION	Cache key duration in seconds	3600
MG_THINGS_ES_URL	Event store URL	localhost:6379
MG_THINGS_ES_PASS	Event store password	""
MG_THINGS_ES_DB	Event store instance name	0
MG_THINGS_STANDALONE_ID	User ID for standalone mode (no gRPC communication with Auth)	""
MG_THINGS_STANDALONE_TOKEN	User token for standalone mode that should be passed in auth header	""
MG_JAEGER_URL	Jaeger server URL	http://jaeger:14268/api/traces
MG_AUTH_GRPC_URL	Auth service gRPC URL	localhost:7001
MG_AUTH_GRPC_TIMEOUT	Auth service gRPC request timeout in seconds	1s
MG_AUTH_GRPC_CLIENT_TLS	Enable TLS for gRPC client	false
MG_AUTH_GRPC_CA_CERT	Path to the CA certificate file	""
MG_SEND_TELEMETRY	Send telemetry to magistrala call home server.	true
MG_THINGS_INSTANCE_ID	Things instance ID	""

Note that if you want things service to have only one user locally, you should use MG_THINGS_STANDALONE env vars. By specifying these, you don't need auth service in your deployment for users' authorization.

Deployment

The service itself is distributed as Docker container. Check the things service section in docker-compose file to see how service is deployed.

To start the service outside of the container, execute the following shell script:

# download the latest version of the service
git clone https://github.com/andychao217/magistrala

cd magistrala

# compile the things
make things

# copy binary to bin
make install

# set the environment variables and run the service
MG_THINGS_LOG_LEVEL=[Things log level] \
MG_THINGS_STANDALONE_ID=[User ID for standalone mode (no gRPC communication with auth)] \
MG_THINGS_STANDALONE_TOKEN=[User token for standalone mode that should be passed in auth header] \
MG_THINGS_CACHE_KEY_DURATION=[Cache key duration in seconds] \
MG_THINGS_HTTP_HOST=[Things service HTTP host] \
MG_THINGS_HTTP_PORT=[Things service HTTP port] \
MG_THINGS_HTTP_SERVER_CERT=[Path to server certificate in pem format] \
MG_THINGS_HTTP_SERVER_KEY=[Path to server key in pem format] \
MG_THINGS_AUTH_GRPC_HOST=[Things service gRPC host] \
MG_THINGS_AUTH_GRPC_PORT=[Things service gRPC port] \
MG_THINGS_AUTH_GRPC_SERVER_CERT=[Path to server certificate in pem format] \
MG_THINGS_AUTH_GRPC_SERVER_KEY=[Path to server key in pem format] \
MG_THINGS_DB_HOST=[Database host address] \
MG_THINGS_DB_PORT=[Database host port] \
MG_THINGS_DB_USER=[Database user] \
MG_THINGS_DB_PASS=[Database password] \
MG_THINGS_DB_NAME=[Name of the database used by the service] \
MG_THINGS_DB_SSL_MODE=[SSL mode to connect to the database with] \
MG_THINGS_DB_SSL_CERT=[Path to the PEM encoded certificate file] \
MG_THINGS_DB_SSL_KEY=[Path to the PEM encoded key file] \
MG_THINGS_DB_SSL_ROOT_CERT=[Path to the PEM encoded root certificate file] \
MG_THINGS_CACHE_URL=[Cache database URL] \
MG_THINGS_ES_URL=[Event store URL] \
MG_THINGS_ES_PASS=[Event store password] \
MG_THINGS_ES_DB=[Event store instance name] \
MG_AUTH_GRPC_URL=[Auth service gRPC URL] \
MG_AUTH_GRPC_TIMEOUT=[Auth service gRPC request timeout in seconds] \
MG_AUTH_GRPC_CLIENT_TLS=[Enable TLS for gRPC client] \
MG_AUTH_GRPC_CA_CERT=[Path to trusted CA certificate file] \
MG_JAEGER_URL=[Jaeger server URL] \
MG_SEND_TELEMETRY=[Send telemetry to magistrala call home server] \
MG_THINGS_INSTANCE_ID=[Things instance ID] \
$GOBIN/magistrala-things

Setting MG_THINGS_CA_CERTS expects a file in PEM format of trusted CAs. This will enable TLS against the Auth gRPC endpoint trusting only those CAs that are provided.

In constrained environments, sometimes it makes sense to run Things service as a standalone to reduce network traffic and simplify deployment. This means that Things service operates only using a single user and is able to authorize it without gRPC communication with Auth service. To run service in a standalone mode, set MG_THINGS_STANDALONE_EMAIL and MG_THINGS_STANDALONE_TOKEN.

Usage

For more information about service capabilities and its usage, please check out the API documentation.

Documentation

Overview

Package things contains the domain concept definitions needed to support Magistrala things service functionality.

This package defines the core domain concepts and types necessary to handle things in the context of a Magistrala things service. It abstracts the underlying complexities of user management and provides a structured approach to working with things.

Copyright (c) Abstract Machines SPDX-License-Identifier: Apache-2.0

Index

• type Cache
• type Channel
• type ChannelListResponse
• type Service
  • func NewService(uauth magistrala.AuthServiceClient, c postgres.Repository, ...) Service

Types

type Cache

type Cache interface {
	// Save stores pair thing secret, thing id.
	Save(ctx context.Context, thingSecret, thingID string) error

	// ID returns thing ID for given thing secret.
	ID(ctx context.Context, thingSecret string) (string, error)

	// Removes thing from cache.
	Remove(ctx context.Context, thingID string) error
}

Cache contains thing caching interface.

type Channel

type Channel struct {
	ID        string `json:"id"`
	DomainID  string `json:"domain_id"`
	Name      string `json:"name"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	Status    string `json:"status"`
}

type ChannelListResponse

type ChannelListResponse struct {
	Total    int       `json:"total"`
	Offset   int       `json:"offset"`
	Channels []Channel `json:"groups"`
}

type Service

type Service interface {
	// CreateThings creates new client. In case of the failed registration, a
	// non-nil error value is returned.
	CreateThings(ctx context.Context, token string, client ...clients.Client) ([]clients.Client, error)

	// ViewClient retrieves client info for a given client ID and an authorized token.
	ViewClient(ctx context.Context, token, id string) (clients.Client, error)

	// ViewClientPerms retrieves permissions on the client id for the given authorized token.
	ViewClientPerms(ctx context.Context, token, id string) ([]string, error)

	// ListClients retrieves clients list for a valid auth token.
	ListClients(ctx context.Context, token string, reqUserID string, pm clients.Page) (clients.ClientsPage, error)

	// ListClientsByGroup retrieves data about subset of things that are
	// connected or not connected to specified channel and belong to the user identified by
	// the provided key.
	ListClientsByGroup(ctx context.Context, token, groupID string, pm clients.Page) (clients.MembersPage, error)

	// UpdateClient updates the client's name and metadata.
	UpdateClient(ctx context.Context, token string, client clients.Client) (clients.Client, error)

	// UpdateClientTags updates the client's tags.
	UpdateClientTags(ctx context.Context, token string, client clients.Client) (clients.Client, error)

	// UpdateClientSecret updates the client's secret
	UpdateClientSecret(ctx context.Context, token, id, key string) (clients.Client, error)

	// EnableClient logically enableds the client identified with the provided ID
	EnableClient(ctx context.Context, token, id string) (clients.Client, error)

	// DisableClient logically disables the client identified with the provided ID
	DisableClient(ctx context.Context, token, id string) (clients.Client, error)

	// Share add share policy to thing id with given relation for given user ids
	Share(ctx context.Context, token, id string, relation string, userids ...string) error

	// Unshare remove share policy to thing id with given relation for given user ids
	Unshare(ctx context.Context, token, id string, relation string, userids ...string) error

	// Identify returns thing ID for given thing key.
	Identify(ctx context.Context, key string) (string, error)

	// Authorize used for AuthZ gRPC server implementation and Things authorization.
	Authorize(ctx context.Context, req *magistrala.AuthorizeReq) (string, error)

	// DeleteClient deletes client with given ID.
	DeleteClient(ctx context.Context, token, id string) error
}

Service specifies an API that must be fullfiled by the domain service implementation, and all of its decorators (e.g. logging & metrics).

func NewService

func NewService(uauth magistrala.AuthServiceClient, c postgres.Repository, grepo mggroups.Repository, tcache Cache, idp magistrala.IDProvider) Service

NewService returns a new Clients service implementation.