link

package module

v0.2.1 Latest Latest Go to latest Published: Apr 7, 2023 License: MPL-2.0 Imports: 17 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hashicorp/hcp-link

Links

Open Source Insights

README ¶

HCP Link

Golang library used to connect self-managed resources to HashiCorp Cloud Platform (HCP).

Who uses it

HCP Link is used internally at HashiCorp.

Where to go

We encourage you to consult HashiCorp Community Guidelines.

How to contribute

Thanks for considering contributing to this project. Unfortunately, HashiCorp does not currently accept new contributions on this project.

License

This code is released under the Mozilla Public License 2.0. Please see LICENSE for more details.

Documentation ¶

Overview ¶

Package link implements routines for self-managed resources to connect to HashiCorp Cloud Platform (HCP).

Index ¶

Constants
type Link
- func New(config *config.Config) (Link, error)

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.

func New ¶

func New(config *config.Config) (Link, error)

New creates a new instance of a Link interface, that allows access to functionality of linked HCP services.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gen
proto/go/hashicorp/cloud/hcp_link/link_status/v1
proto/go/hashicorp/cloud/hcp_link/node_status/v1
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).
version

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