nodestatus

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 7, 2023 License: MPL-2.0 Imports: 2 Imported by: 1

Documentation

Overview

Package nodestatus contains the interface that needs to be implements for a self-managed resource to report inforamtion to HashiCorp Cloud Platform (HCP).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type NodeStatus

type NodeStatus struct {
	// StatusVersion is the version of the status message format. To ensure
	// that the version is not omitted by accident the initial version is 1.
	StatusVersion uint32

	// Status contains product specific status information as a proto message.
	// The status message will be wrapped in a protobuf Any message.
	Status proto.Message
}

NodeStatus contains product specific information about a node's status.

type Reporter

type Reporter interface {
	// GetNodeStatus will return the node's current status. The information will
	// be transmitted to HCP.
	GetNodeStatus(context.Context) (NodeStatus, error)
}

Reporter is an interface that needs to be implemented to provide product specific status information about a node.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL