diff --git a/doc/index.html b/doc/index.html index fd0764d4..f64bd5bf 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1945,6 +1945,41 @@
EventServiceSendRequest.
+ + +| Field | Type | Label | Description |
| events | +EventServiceSendRequest.EventsEntry | +repeated | +Events grouped by machine IDs. |
+
| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +MachineProvisioningEvent | ++ |
|
+
EventServiceSendResponse.
+ + +| Field | Type | Label | Description |
| events | +uint64 | ++ | Events counts the number of events successfully stored in the database. |
+
| failed | +string | +repeated | +Failed contains IDs of all machines whose events could not be stored in the database. |
+
MachineProvisioningEvent contains details about an event.
+ + +| Field | Type | Label | Description |
| time | +google.protobuf.Timestamp | ++ | Time the event occurred at. |
+
| event | +ProvisioningEventType | ++ | Event that occurred. |
+
| message | +string | ++ | Message describing the event in more detail. |
+
ProvisioningEventType is a short description of a machine event.
+| Name | Number | Description |
| PROVISIONING_EVENT_TYPE_UNSPECIFIED | +0 | +PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified. |
+
| PROVISIONING_EVENT_TYPE_ALIVE | +1 | +PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago. |
+
| PROVISIONING_EVENT_TYPE_CRASHED | +2 | +PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle. |
+
| PROVISIONING_EVENT_TYPE_PXE_BOOTING | +3 | +PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE. |
+
| PROVISIONING_EVENT_TYPE_PLANNED_REBOOT | +4 | +PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot. |
+
| PROVISIONING_EVENT_TYPE_PREPARING | +5 | +PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started. |
+
| PROVISIONING_EVENT_TYPE_REGISTERING | +6 | +PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API. |
+
| PROVISIONING_EVENT_TYPE_WAITING | +7 | +PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation. |
+
| PROVISIONING_EVENT_TYPE_INSTALLING | +8 | +PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed. |
+
| PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL | +9 | +PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS. |
+
| PROVISIONING_EVENT_TYPE_PHONED_HOME | +10 | +PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness. |
+
| PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM | +11 | +PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines. |
+
EventService serves event related functions.
+| Method Name | Request Type | Response Type | Description |
| Send | +EventServiceSendRequest | +EventServiceSendResponse | +Send a series of machine provisioning events. |
+