Package intrinsic_proto.inversion.v1
Services
service IpcUpdater intrinsic/kubernetes/inversion/v1/inversion.proto
The IpcUpdater service manages updates of a single IPC. It is intended for use by an HMI or similar so that updates will not be applied until they are approved by an operator.
It can also be used the command inctl cluster upgrade approve.
This document is based on the protobuf definition.
rpc ReportUpdateInfo
Request: intrinsic_proto.inversion.v1.GetUpdateInfoRequest
Response:
intrinsic_proto.inversion.v1.UpdateInfo
ReportUpdateInfo reports the current status regarding the installed version and available updates.
rpc ApproveUpdate
Request: intrinsic_proto.inversion.v1.ApproveUpdateRequest
Response:
intrinsic_proto.inversion.v1.ApproveUpdateResponse
ApproveUpdate approves the update to the given version.
It must be called with a version_id that matches the available version reported by ReportUpdateInfo, otherwise it will return the FAILED_PRECONDITION error code. This ensures that the process only completes for the version the user has approved.
Note that approval is only required when the IPC is configured to require it. By default, the IPC applies updates as soon as they are available.
Messages
message ApproveUpdateRequest intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | approved |
intrinsic_proto.inversion.v1.IntrinsicVersion
|
The version to approve. The version_id should be copied from the available version reported by ReportUpdateInfo. If any other fields are provided, they are ignored. |
message ApproveUpdateResponse intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description |
|---|
message GetUpdateInfoRequest intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description |
|---|
message IntrinsicVersion intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | version_id |
string
|
An opaque string that identifies the version. |
| 2 | update_notes |
optional
string
|
Information about the version pulled from InversionSpec.UpdateNotes. |
message Progress intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | current_step |
optional
uint32
|
The current step of the update, starting at 0. |
| 2 | total_steps |
optional
uint32
|
The total number of steps in the update. |
| 3 | description |
optional
string
|
An English-language description of the current step. |
message UpdateInfo intrinsic/kubernetes/inversion/v1/inversion.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | state |
intrinsic_proto.inversion.v1.UpdateInfo.State
|
Indicates whether an update in available or in-progress. |
| 2 | current |
intrinsic_proto.inversion.v1.IntrinsicVersion
|
Indicates the running version of the Intrinsic software. |
| 3 | available |
optional
intrinsic_proto.inversion.v1.IntrinsicVersion
|
If an update is available, this will be populated to indicate the version. |
| 4 | progress |
optional
intrinsic_proto.inversion.v1.Progress
|
If an update is in-progress, this will be populated to indicate the current progress. |
Enums
enum State intrinsic/kubernetes/inversion/v1/inversion.proto
| Name | Number | Description |
|---|---|---|
STATE_UNSPECIFIED |
0 | Placeholder, unused. |
STATE_UPDATE_AVAILABLE |
1 | A new update is available. No update is current in-progress. |
STATE_UPDATE_RUNNING |
2 | An update is currently in-progress. |
STATE_UP_TO_DATE |
3 | No update is in-progress or available. |
STATE_FAULT |
4 | The previous update failed and the IPC has returned to the previous version. This requires user intervention to retry or resolve. Possible causes include incompatibility between the new version and the IPC, or power loss during the update process. |