v1/verification.proto

Verification service provides endpoints to verify DPS deployment status

Services

VerificationService

VerificationService provides methods to verify DPS deployment status

Verify

rpc Verify(VerificationRequest) returns VerificationResponse

Verify performs comprehensive verification of DPS components

StartBMCHealthCheck

rpc StartBMCHealthCheck(BMCHealthCheckRequest) returns BMCHealthCheckHandle

StartBMCHealthCheck submits a deep BMC pre-requisite health check across the cluster and returns immediately with a task handle. The check itself can run for many minutes (large clusters with deep probe enabled), so the RPC is intentionally fire-and-forget to avoid holding the gRPC stream open for the entire run. Callers poll GetBMCHealthCheckStatus and GetBMCHealthCheckReport using BMCHealthCheckHandle.task_id to observe progress and retrieve the final report.

GetBMCHealthCheckStatus

rpc GetBMCHealthCheckStatus(BMCHealthCheckStatusRequest) returns BMCHealthCheckStatus

GetBMCHealthCheckStatus returns the live status (and coarse progress) of a previously started BMC health check.

GetBMCHealthCheckReport

rpc GetBMCHealthCheckReport(BMCHealthCheckReportRequest) returns BMCHealthCheckReportResponse

GetBMCHealthCheckReport fetches the final cluster-level report. Returns done=false with no payload while the underlying task is still running; callers should poll until done=true.

Messages

ComponentStatus

ComponentStatus represents the status of an individual component

Field	Type	Description
name	string	Component name
healthy	bool	Whether the component is healthy
message	string	Status message
oneof _details.details	optional string	Additional details if check was performed
skipped	bool	Whether this check was skipped
oneof _skip_reason.skip_reason	optional string	Reason for skipping the check

VerificationRequest

VerificationRequest is the request for DPS verification

Field	Type	Description
check_dps_server	bool	Perform DPS server connectivity checks
check_database	bool	Perform database connectivity checks
check_auth	bool	Perform authentication service checks
check_ui	bool	Perform UI accessibility checks
check_bcm	bool	Perform BCM connectivity checks (if BCM is configured)

VerificationResponse

VerificationResponse contains the results of DPS verification

Field	Type	Description
status	Status	Overall verification status
dps_server	ComponentStatus	Individual component check results
database	ComponentStatus	none
auth	ComponentStatus	none
ui	ComponentStatus	none
oneof _bcm.bcm	optional ComponentStatus	none

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str