b1ackd0t
a0c40ba462
* chore(license): update copyright notices Add CI check for non go files to check that the files contain a license Signed-off-by: Rodney Osodo <28790446+rodneyosodo@users.noreply.github.com> * fix(ci): log failed files When the CI fails during check for license header, log the failed file to console so that someone can check on the actual file. Also simplify the grep check to make it more human readable and understandable Signed-off-by: Rodney Osodo <28790446+rodneyosodo@users.noreply.github.com> --------- Signed-off-by: Rodney Osodo <28790446+rodneyosodo@users.noreply.github.com>
BOOTSTRAP SERVICE
New devices need to be configured properly and connected to the Magistrala. Bootstrap service is used in order to accomplish that. This service provides the following features:
- Creating new Magistrala Things
- Providing basic configuration for the newly created Things
- Enabling/disabling Things
Pre-provisioning a new Thing is as simple as sending Configuration data to the Bootstrap service. Once the Thing is online, it sends a request for initial config to Bootstrap service. Bootstrap service provides an API for enabling and disabling Things. Only enabled Things can exchange messages over Magistrala. Bootstrapping does not implicitly enable Things, it has to be done manually.
In order to bootstrap successfully, the Thing needs to send bootstrapping request to the specific URL, as well as a secret key. This key and URL are pre-provisioned during the manufacturing process. If the Thing is provisioned on the Bootstrap service side, the corresponding configuration will be sent as a response. Otherwise, the Thing will be saved so that it can be provisioned later.
Thing Configuration Entity
Thing Configuration consists of two logical parts: the custom configuration that can be interpreted by the Thing itself and Magistrala-related configuration. Magistrala config contains:
- corresponding Magistrala Thing ID
- corresponding Magistrala Thing key
- list of the Magistrala channels the Thing is connected to
Note: list of channels contains IDs of the Magistrala channels. These channels are pre-provisioned on the Magistrala side and, unlike corresponding Magistrala Thing, Bootstrap service is not able to create Magistrala Channels.
Enabling and disabling Thing (adding Thing to/from whitelist) is as simple as connecting corresponding Magistrala Thing to the given list of Channels. Configuration keeps state of the Thing:
| State | What it means |
|---|---|
| Inactive | Thing is created, but isn't enabled |
| Active | Thing is able to communicate using Magistrala |
Switching between states Active and Inactive enables and disables Thing, respectively.
Thing configuration also contains the so-called external ID and external key. An external ID is a unique identifier of corresponding Thing. For example, a device MAC address is a good choice for external ID. External key is a secret key that is used for authentication during the bootstrapping procedure.
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_BOOTSTRAP_LOG_LEVEL | Log level for Bootstrap (debug, info, warn, error) | info |
| MG_BOOTSTRAP_DB_HOST | Database host address | localhost |
| MG_BOOTSTRAP_DB_PORT | Database host port | 5432 |
| MG_BOOTSTRAP_DB_USER | Database user | magistrala |
| MG_BOOTSTRAP_DB_PASS | Database password | magistrala |
| MG_BOOTSTRAP_DB_NAME | Name of the database used by the service | bootstrap |
| MG_BOOTSTRAP_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_BOOTSTRAP_DB_SSL_CERT | Path to the PEM encoded certificate file | |
| MG_BOOTSTRAP_DB_SSL_KEY | Path to the PEM encoded key file | |
| MG_BOOTSTRAP_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | |
| MG_BOOTSTRAP_ENCRYPT_KEY | Secret key for secure bootstrapping encryption | v7aT0HGxJxt2gULzr3RHwf4WIf6DusPphG5Ftm2bNCWD8mTpyr |
| MG_BOOTSTRAP_HTTP_HOST | Bootstrap service HTTP host | |
| MG_BOOTSTRAP_HTTP_PORT | Bootstrap service HTTP port | 9013 |
| MG_BOOTSTRAP_HTTP_SERVER_CERT | Path to server certificate in pem format | |
| MG_BOOTSTRAP_HTTP_SERVER_KEY | Path to server key in pem format | |
| MG_BOOTSTRAP_EVENT_CONSUMER | Bootstrap service event source consumer name | bootstrap |
| MG_BOOTSTRAP_ES_URL | Bootstrap service event source URL | localhost:6379 |
| MG_BOOTSTRAP_ES_PASS | Bootstrap service event source password | |
| MG_BOOTSTRAP_ES_DB | Bootstrap service event source database | 0 |
| MG_AUTH_GRPC_URL | Users service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Users service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Enable TLS for gRPC client | false |
| MG_AUTH_GRPC_CA_CERTS | CA certificates for gRPC client | |
| MG_THINGS_URL | Base url for Magistrala Things | http://localhost:9000 |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_BOOTSTRAP_INSTANCE_ID | Bootstrap service instance ID |
Deployment
The service itself is distributed as Docker container. Check the boostrap service section in
docker-compose 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/absmach/magistrala
cd magistrala
# compile the service
make bootstrap
# copy binary to bin
make install
# set the environment variables and run the service
MG_BOOTSTRAP_LOG_LEVEL=[Bootstrap log level] \
MG_BOOTSTRAP_ENCRYPT_KEY=[Hex-encoded encryption key used for secure bootstrap] \
MG_BOOTSTRAP_EVENT_CONSUMER=[Bootstrap service event source consumer name] \
MG_BOOTSTRAP_ES_URL=[Bootstrap service event source URL] \
MG_BOOTSTRAP_ES_PASS=[Bootstrap service event source password] \
MG_BOOTSTRAP_ES_DB=[Bootstrap service event source database] \
MG_BOOTSTRAP_HTTP_HOST=[Bootstrap service HTTP host] \
MG_BOOTSTRAP_HTTP_PORT=[Bootstrap service HTTP port] \
MG_BOOTSTRAP_HTTP_SERVER_CERT=[Path to HTTP server certificate in pem format] \
MG_BOOTSTRAP_HTTP_SERVER_KEY=[Path to HTTP server key in pem format] \
MG_BOOTSTRAP_DB_HOST=[Database host address] \
MG_BOOTSTRAP_DB_PORT=[Database host port] \
MG_BOOTSTRAP_DB_USER=[Database user] \
MG_BOOTSTRAP_DB_PASS=[Database password] \
MG_BOOTSTRAP_DB_NAME=[Name of the database used by the service] \
MG_BOOTSTRAP_DB_SSL_MODE=[SSL mode to connect to the database with] \
MG_BOOTSTRAP_DB_SSL_CERT=[Path to the PEM encoded certificate file] \
MG_BOOTSTRAP_DB_SSL_KEY=[Path to the PEM encoded key file] \
MG_BOOTSTRAP_DB_SSL_ROOT_CERT=[Path to the PEM encoded root certificate file] \
MG_AUTH_GRPC_URL=[Users service gRPC URL] \
MG_AUTH_GRPC_TIMEOUT=[Users service gRPC request timeout in seconds] \
MG_AUTH_GRPC_CLIENT_TLS=[Boolean value to enable/disable client TLS] \
MG_AUTH_GRPC_CA_CERT=[Path to trusted CAs in PEM format] \
MG_THINGS_URL=[Base url for Magistrala Things] \
MG_JAEGER_URL=[Jaeger server URL] \
MG_SEND_TELEMETRY=[Send telemetry to magistrala call home server] \
MG_BOOTSTRAP_INSTANCE_ID=[Bootstrap instance ID] \
$GOBIN/magistrala-bootstrap
Setting MG_BOOTSTRAP_CA_CERTS expects a file in PEM format of trusted CAs. This will enable TLS against the Users gRPC endpoint trusting only those CAs that are provided.
Usage
For more information about service capabilities and its usage, please check out the API documentation.