link

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

const (

	// Capability defines the name of the SCADA capability that is used to expose
	// the Link status and node status gRPC services.
	Capability = "link"
)

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.