Documentation ¶
Overview ¶
Package link implements routines for self-managed resources to connect to HashiCorp Cloud Platform (HCP).
Index ¶
Constants ¶
View Source
const ( // Capability defines the name of the SCADA capability that is used to expose // the Link status and node status gRPC services. Capability = "link" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Link ¶
type Link interface { // Start will expose Link functionality to the control-plane. The SCADAProvider // used by Link will need to be started separately. Start() error // Stop will stop exposing Link functionality to the control-plane. Stop() error // ReportNodeStatus will get the most recent node status information from // the configured node status reporter and push it to HCP. // // This function only needs to be invoked in situations where it is // important that the node status is reported right away. HCP will regularly // poll for node status information. ReportNodeStatus(ctx context.Context) error }
Link offers functionality for linked HCP resources.
Directories ¶
Path | Synopsis |
---|---|
gen
|
|
internal
|
|
linkstatus
Package linkstatus provides a gRPC service that allows HashiCorp Cloud Platform (HCP) to query the status of the link library.
|
Package linkstatus provides a gRPC service that allows HashiCorp Cloud Platform (HCP) to query the status of the link library. |
nodestatus
Package nodestatus provides a gRPC service that allows HashiCorp Cloud Platform (HCP) to query the node status information.
|
Package nodestatus provides a gRPC service that allows HashiCorp Cloud Platform (HCP) to query the node status information. |
resource
Package resource provides various routines related to a resource.
|
Package resource provides various routines related to a resource. |
pkg
|
|
config
Package config contains the configuration required for a self-managed resource to connect to HashiCorp Cloud Platform (HCP).
|
Package config contains the configuration required for a self-managed resource to connect to HashiCorp Cloud Platform (HCP). |
nodestatus
Package nodestatus contains the interface that needs to be implements for a self-managed resource to report inforamtion to HashiCorp Cloud Platform (HCP).
|
Package nodestatus contains the interface that needs to be implements for a self-managed resource to report inforamtion to HashiCorp Cloud Platform (HCP). |
Click to show internal directories.
Click to hide internal directories.