Resources / DeviceEnrolment
DeviceEnrolment
A one-time enrolment code for a phone (spec 0041): whoever holds the code may, until it expires, create exactly one Account of this name in this VPC (access station, only the public key free) and read it back. The code is shown once in the create response and stored only as a hash. The object is named like the Account it allows.
Overview
| API | network.etorm.com/v1alpha1 |
| Resource | deviceenrolments (cluster-scoped inside its cluster) |
| Short names | enrol |
| Available in | project clusters only |
| Status | none: the object is configuration only |
Minimal example
apiVersion: network.etorm.com/v1alpha1
kind: DeviceEnrolment
metadata:
name: example
spec:
vpcRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
vpcRef | reference to VPC | yes | | | The VPC the device may join. It needs a gateway with an access point, as for any Account with access station. Cannot be changed. |
ttlSeconds | integer | | | 60 to 900 | How long the code is valid, 60 to 900 seconds (default 900). Cannot be changed. |
Status
| Field | Type | Required | Default | Allowed | Description |
codeHash | string | | | | SHA-256 of the code's secret part. |
expiresAt | string | | | | RFC 3339 UTC: after this the code authenticates nothing. |
code | string | | | | The enrolment code (`etorm-enroll.<project>.<name>.<secret>`), returned once, in the create response only. |
Columns in listings
| Column | From |
|---|
| VPC | .spec.vpcRef.name |
| Expires | .status.expiresAt |
All resources