acp

Documentation

Index

• Constants
• func Initialize(url string, enabled bool, timeout time.Duration)
• func SetAPI(acp TridentACP)
• type REST
• type TridentACP
  • func API() TridentACP

Constants

const (
	DefaultBaseURL = "http://127.0.0.1:8100"

	FeatureSnapshotRestore      = "SnapshotRestore"
	FeatureSnapshotMirrorUpdate = "SnapshotMirrorUpdate"
	FeatureReadOnlyClone        = "ReadOnlyClone"
	FeatureInflightEncryption   = "InflightEncryption"
)

Functions

func Initialize

func Initialize(url string, enabled bool, timeout time.Duration)

Initialize creates a singleton Trident-ACP API instance. This should only be called once during startup.

func SetAPI

func SetAPI(acp TridentACP)

SetAPI should only be used for testing. It enables testing by replacing the package-level Trident-ACP API with a mock ACP API. This should not be used anywhere outside unit tests.

Types

type REST

type REST interface {
	GetVersion(context.Context) (*version.Version, error)
	Entitled(context.Context, string) error
}

REST is a set of methods for interacting with Trident-ACP REST APIs.

type TridentACP

type TridentACP interface {
	Enabled() bool
	GetVersion(context.Context) (*version.Version, error)
	GetVersionWithBackoff(context.Context) (*version.Version, error)
	IsFeatureEnabled(context.Context, string) error
}

TridentACP is a set of methods for exposing Trident-ACP REST APIs to Trident.

func API

func API() TridentACP

API returns a singleton Trident-ACP API client.