Resource Directory maintains projection of devices which were requested by clients through the plgd gateways.
docker pull ghcr.io/plgd-dev/hub/resource-directory:latest
A configuration template is available on resource-directory/config.yaml.
| Property | Type | Description | Default |
|---|---|---|---|
log.level | string | Logging enabled from level. | "info" |
log.encoding | string | Logging format. The supported values are: "json", "console" | "json" |
log.stacktrace.enabled | bool | Log stacktrace. | false |
log.stacktrace.level | string | Stacktrace from level. | "warn" |
log.encoderConfig.timeEncoder | string | Time format for logs. The supported values are: "rfc3339nano", "rfc3339". | "rfc3339nano" |
gRPC API of the Resource Directory service.
| Property | Type | Description | Default |
|---|---|---|---|
apis.grpc.address | string | Listening address in the format <host>:<port> for accepting gRPC client connections. | "0.0.0.0:9100" |
apis.grpc.sendMsgSize | int32 | Set the max message size in bytes the server can send. 0 means 2147483647. | 4194304 |
apis.grpc.recvMsgSize | int32 | Set the max message size in bytes the server can receive. 0 means 4194304. | 4194304 |
apis.grpc.ownerCacheExpiration | string | Time limit of how long to keep subscribed to device updates after last use of the given cache item. | 1m |
apis.grpc.enforcementPolicy.minTime | string | The minimum amount of time a client should wait before sending a keepalive ping. Otherwise, the server closes the connection. | 5s |
apis.grpc.enforcementPolicy.permitWithoutStream | bool | If true, the server allows keepalive pings even when there are no active streams (RPCs). Otherwise, the server closes the connection. | true |
apis.grpc.keepAlive.maxConnectionIdle | string | A duration for the amount of time after which an idle connection would be closed by sending a GoAway. 0s means infinity. | 0s |
apis.grpc.keepAlive.maxConnectionAge | string | A duration for the maximum amount of time a connection may exist before it will be closed by sending a GoAway. 0s means infinity. | 0s |
apis.grpc.keepAlive.maxConnectionAgeGrace | string | An additive period after MaxConnectionAge, after which the connection will be forcibly closed. 0s means infinity. | 0s |
apis.grpc.keepAlive.time | string | After a duration of this time if the server doesn't see any activity it pings the client to see if the transport is still alive. | 2h |
apis.grpc.keepAlive.timeout | string | After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. | 20s |
apis.grpc.tls.caPool | []string | File paths to the root certificates in PEM format. The file may contain multiple certificates. | [] |
apis.grpc.tls.keyFile | string | File path to private key in PEM format. | "" |
apis.grpc.tls.certFile | string | File path to certificate in PEM format. | "" |
apis.grpc.tls.clientCertificateRequired | bool | If true, require client certificate. | true |
apis.grpc.authorization.ownerClaim | string | Claim used to identify owner of the device. | "sub" |
apis.grpc.authorization.audience | string | Identifier of the API configured in your OAuth provider. | "" |
apis.grpc.authorization.endpoints[].authority | string | Authority is the address of the token-issuing authentication server. Services will use this URI to find and retrieve the public key that can be used to validate the token’s signature. | "" |
apis.grpc.authorization.endpoints[].http.maxIdleConns | int | It controls the maximum number of idle (keep-alive) connections across all hosts. Zero means no limit. | 16 |
apis.grpc.authorization.endpoints[].http.maxConnsPerHost | int | It optionally limits the total number of connections per host, including connections in the dialing, active, and idle states. On limit violation, dials will block. Zero means no limit. | 32 |
apis.grpc.authorization.endpoints[].http.maxIdleConnsPerHost | int | If non-zero, controls the maximum idle (keep-alive) connections to keep per-host. If zero, DefaultMaxIdleConnsPerHost is used. | 16 |
apis.grpc.authorization.endpoints[].http.idleConnTimeout | string | The maximum amount of time an idle (keep-alive) connection will remain idle before closing itself. Zero means no limit. | 30s |
apis.grpc.authorization.endpoints[].http.timeout | string | A time limit for requests made by this Client. A Timeout of zero means no timeout. | 10s |
apis.grpc.authorization.endpoints[].http.tls.caPool | []string | File paths to the root certificates in PEM format. The file may contain multiple certificates. | [] |
apis.grpc.authorization.endpoints[].http.tls.keyFile | string | File path to private key in PEM format. | "" |
apis.grpc.authorization.endpoints[].http.tls.certFile | string | File path to certificate in PEM format. | "" |
apis.grpc.authorization.endpoints[].http.tls.useSystemCAPool | bool | If true, use system certification pool. | false |
apis.grpc.authorization.tokenTrustVerification.cacheExpiration | string | Duration for which a valid token is kept in a runtime cache before re-verification is required. | 30s |
plgd hub uses NATS messaging system as a event bus.
| Property | Type | Description | Default |
|---|---|---|---|
clients.eventBus.goPoolSize | int | Number of routines to process events in projection. | 16 |
clients.eventBus.nats.url | string | URL to nats messaging system. | "nats://localhost:4222" |
clients.eventBus.nats.pendingLimits.msgLimit | int | Limit number of messages in queue. -1 means unlimited | 524288 |
clients.eventBus.nats.pendingLimits.bytesLimit | int | Limit buffer size of queue. -1 means unlimited | 67108864 |
clients.eventBus.nats.tls.caPool | []string | File paths to the root certificates in PEM format. The file may contain multiple certificates. | [] |
clients.eventBus.nats.tls.keyFile | string | File name of private key in PEM format. | "" |
clients.eventBus.nats.tls.certFile | string | File name of certificate in PEM format. | "" |
clients.eventBus.nats.tls.useSystemCAPool | bool | If true, use system certification pool. | false |
clients.eventBus.nats.leadResourceType.enabled | bool | If true, subscribe to NATS with lead resource type subject token included. | false |
plgd hub uses MongoDB database as a event store.
| Property | Type | Description | Default |
|---|---|---|---|
clients.eventStore.cacheExpiration | string | Expiration time of cached resource in projection. | 20m |
clients.eventStore.mongoDB.uri | string | URI to mongo database. | "mongodb://localhost:27017" |
clients.eventStore.mongoDB.database | string | Name of database | "eventStore" |
clients.eventStore.mongoDB.maxPoolSize | int | Limits number of connections. | 16 |
clients.eventStore.mongoDB.maxConnIdleTime | string | Close connection when idle time reach the value. | 4m |
clients.eventStore.mongoDB.tls.caPool | []string | File paths to the root certificates in PEM format. The file may contain multiple certificates. | [] |
clients.eventStore.mongoDB.tls.keyFile | string | File path to private key in PEM format. | "" |
clients.eventStore.mongoDB.tls.certFile | string | File path to certificate in PEM format. | "" |
clients.eventStore.mongoDB.tls.useSystemCAPool | bool | If true, use system certification pool. | false |
Client configurations to internally connect to Identity Store service.
| Property | Type | Description | Default |
|---|---|---|---|
clients.identityStore.grpc.address | string | Identity Store service address. | "127.0.0.1:9100" |
clients.identityStore.grpc.tls.caPool | []string | File paths to the root certificates in PEM format. The file may contain multiple certificates. | [] |
clients.identityStore.grpc.tls.keyFile | string | File path to private key in PEM format. | "" |
clients.identityStore.grpc.tls.certFile | string | File path to certificate in PEM format. | "" |
clients.identityStore.grpc.tls.useSystemCAPool | bool | If true, use system certification pool. | false |
clients.identityStore.grpc.keepAlive.time | string | After a duration of this time if the client doesn't see any activity it pings the server to see if the transport is still alive. | 10s |
clients.identityStore.grpc.keepAlive.timeout | string | After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. | 20s |
clients.identityStore.grpc.keepAlive.permitWithoutStream | bool | If true, client sends keepalive pings even with no active RPCs. If false, when there are no active RPCs, Time and Timeout will be ignored and no keepalive pings will be sent. | false |
The plgd open telemetry exporter configuration.
| Property | Type | Description | Default |
|---|---|---|---|
clients.openTelemetryCollector.grpc.enabled | bool | Enable OTLP gRPC exporter | false |
clients.openTelemetryCollector.grpc.address | string | The gRPC collector to which the exporter is going to send data | "" |
clients.openTelemetryCollector.grpc.keepAlive.time | string | After a duration of this time if the client doesn't see any activity it pings the server to see if the transport is still alive. | 10s |
clients.openTelemetryCollector.grpc.keepAlive.timeout | string | After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. | 20s |
clients.openTelemetryCollector.grpc.keepAlive.permitWithoutStream | bool | If true, client sends keepalive pings even with no active RPCs. If false, when there are no active RPCs, Time and Timeout will be ignored and no keepalive pings will be sent. | true |
clients.openTelemetryCollector.grpc.tls.caPool | string | File path to the root certificate in PEM format which might contain multiple certificates in a single file. | "" |
clients.openTelemetryCollector.grpc.tls.keyFile | string | File path to private key in PEM format. | "" |
clients.openTelemetryCollector.grpc.tls.certFile | string | File path to certificate in PEM format. | "" |
clients.openTelemetryCollector.grpc.tls.useSystemCAPool | bool | If true, use system certification pool. | false |
These configurations are CoAP Cloud Conf information for device registration to plgd hub as well as root CA certificate, certificate authority address to get identity certificate for ssl connection to plgd hub before device registration.
This will be served by HTTP Gateway API as defined here and also see hub-configuration.
| Property | Type | Description | Default |
|---|---|---|---|
publicConfiguration.caPool | string | File path to root CA which was used to sign coap-gw certificate. | "" |
publicConfiguration.ownerClaim | string | Claim used to identify owner of the device. | "sub" |
publicConfiguration.deviceIDClaim | string | Claim used to identify device id of the device. Empty means that JWT doesn't contain it. | "" |
publicConfiguration.hubID | string | Hub ID which is stored in coap-gw certificate. | "" |
publicConfiguration.coapGateway | string | CoAP gateway for onboard device. | "" |
publicConfiguration.defaultCommandTimeToLive | string | Exposes default command time to live for CreateResource, RetrieveResource, UpdateResource, DeleteResource, and UpdateDeviceMetadata commands when it is not set in the request. 0s - means forever. | "0s" |
publicConfiguration.authorizationServer | string | Authority is the address of the token-issuing authentication server. Services will use this URI to find and retrieve the public key that can be used to validate the token’s signature. Must be same as in coap-gateway configuration. | "" |
Note that the string type related to time (i.e. timeout, idleConnTimeout, expirationTime) is decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us”, “ms”, “s”, “m”, “h”.
plgd makes it simpler to build a successful IoT initiative – to create a proof of concept, evaluate, optimize, and scale.
