modules

Documentation

Index

• func Set(m Modules)
• func SetResources(r Resources)
• type Messager
• type Modules
  • func Get() Modules
• type Resources
  • func GetResources() Resources

Functions

func Set

func Set(m Modules)

Set sets the modules interface

func SetResources

func SetResources(r Resources)

SetResources sets the resources interface

Types

type Messager

type Messager interface {
	// PostInstallMessage returns a message that gets printed to console after successful installation
	PostInstallMessage() string
}

Messager provides methods for various informational messages

type Modules

type Modules interface {
	// ProcessModes returns a list of modes gravity process can run in
	ProcessModes() []string
	// InstallModes returns a list of modes gravity install supports
	InstallModes() []string
	// DefaultAuthPreference returns default authentication preference based on process mode
	DefaultAuthPreference(processMode string) (services.AuthPreference, error)
	// ProxyFeatures returns additional features Teleport proxy supports based on process mode
	ProxyFeatures(processMode string) []string
	// SupportedConnectors returns a list of supported auth connector kinds
	SupportedConnectors() []string
	// Version returns the tool version
	Version() proto.Version
	// TeleRepository returns the default repository for tele package cache
	TeleRepository() string
}

Modules allows to customize certain behavioral aspects of Gravity

func Get

func Get() Modules

Get returns the modules interface

type Resources

type Resources interface {
	// SupportedResources returns a list of resources that can be created/viewed
	SupportedResources() []string
	// SupportedResourcesToRemove returns a list of resources that can be removed
	SupportedResourcesToRemove() []string
	// CanonicalKind translates the specified kind to canonical form.
	// Returns an empty string if no canonical form exists
	CanonicalKind(kind string) string
}

Resources defines the interface to query tool resource support

func GetResources

func GetResources() Resources

GetResources returns the resources interface