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.

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

dps: how to configure mutliple hubs #154

Merged
merged 4 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 3 additions & 0 deletions content/en/docs/configuration/device-provisioning-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ Enrollment group entry configuration.
| `enrollmentGroups.[].preSharedKeyFile` | string | `File path to the pre-shared key that will be stored on the device for the owner. It must be empty or have 16 characters in the preSharedKeyFile.` | `""` |
| `enrollmentGroups.[].attestationMechanism.x509.certificateChain` | string | `File path to certificate chain in PEM format.` | `""` |
| `enrollmentGroups.[].attestationMechanism.x509.expiredCertificateEnabled` | bool | `Accept device connections with an expired certificate.` | `false` |
| `enrollmentGroups.[].Hub` | object | `Defines configuration of the plgd hub where the device connects after it's successfully provisioned.` | `{}` |
| `enrollmentGroups.[].Hubs` | []object | `Defines configuration of the multiple plgd hubs where the device connects after it's successfully provisioned.` | `[]` |

#### Hub

Expand All @@ -132,6 +134,7 @@ Defines configuration of the plgd hub where the device connects after it's succe
| `enrollmentGroups.[].hub.caPool` | string | `File path to the root certificate in PEM format. Multiple certificates in a single file are supported.` | `""` |
| `enrollmentGroups.[].hub.hubID` | string | `Uniqhe id of the plgd hub instance.` | `""` |
| `enrollmentGroups.[].hub.coapGateway` | string | `plgd hub CoAP gateway endpoint where the devices should connect to after successful provisioning.Format <IP:PORT>.` | `""` |
| `enrollmentGroups.[].hub.gateways` | []string | `plgd hub gateway multiple endpoints where the devices should connect to after successful provisioning. Format <SCHEME>://<IP:PORT>, for example coaps+tcp://plgd.cloud:1234` | `[]` |
jkralik marked this conversation as resolved.
Show resolved Hide resolved
| `enrollmentGroups.[].hub.certificateAuthority.grpc.address` | string | `plgd hub Certificate Authority endpoint used to sign device identity CSRs. Format <IP:PORT>.` | `""` |
| `enrollmentGroups.[].hub.certificateAuthority.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` |
| `enrollmentGroups.[].hub.certificateAuthority.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` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,17 @@ Step number 4 and 9 are optional.
9. Device provisioning doesn't require to connect the device to the plgd hub. In such a case, device is ready to be securely used for your Device-to-Device scenarios.

{{< /note >}}

### Multiple PLGD Hubs

The DPS supports multiple PLGD hubs or CoAP gateways. This feature enables users to configure multiple PLGD hubs or CoAP gateways for the device through enrollment group configuration.

To configure multiple CoAP gateways, set the helm value `.enrollmentGroups.[].hub.gateways` to the list of CoAP gateways in the format `SCHEME://HOST:PORT`. For example, `[ "coaps+tcp://plgd.cloud:5684", ... ]`.

To set multiple PLGD hubs, set the helm value `.enrollmentGroups.[].hubs` to the list of PLGD hub objects, which contain the same values as the `.enrollmentGroups.[].hub` object in the enrollment group configuration.

{{< note >}}

For multiple hubs, it is expected that the hubs are different instances.

{{< /note >}}
jkralik marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ weight: 2
- **&#x2611; Rotate device certificates:** This feature allows for the [rotation of device certificates](/docs/services/device-provisioning-service/client-library#certificate-renewal), enhancing security and maintaining up-to-date certificates.
- **&#x2611; HTTP API to configure access devices:** This feature provides an HTTP API that allows users to configure the enrollment groups.
- **&#x2611; HTTP API to get provisioned configuration to the devices:** This feature offers an HTTP API to retrieve provisioned configurations of the devices.
- **&#x2611; Multiple plgd hubs:** This feature enables users to configure multiple PLGD hubs or CoAP gateways for the device.
jkralik marked this conversation as resolved.
Show resolved Hide resolved

### Planned features

Expand Down
Loading