providerregistry

Documentation

Index

• Variables
• func ParseUses(uses string) (providerType string, version string, err error)
• type ProviderRegistry
  • func Registry() ProviderRegistry
  • func (pr ProviderRegistry) All() map[string]RegisteredProvider
  • func (r ProviderRegistry) CLIOptions() []string
  • func (r ProviderRegistry) FromCLIOption(opt string) (uses string, p RegisteredProvider, err error)
  • func (r ProviderRegistry) GetLatestByShortType(providerType string) (latestVersion string, p *RegisteredProvider, err error)
  • func (r ProviderRegistry) GetLatestByType(providerType string) (latestVersion string, p *RegisteredProvider, err error)
  • func (r ProviderRegistry) Lookup(providerType, version string) (*RegisteredProvider, error)
  • func (r ProviderRegistry) LookupByUses(uses string) (*RegisteredProvider, error)
• type RegisteredProvider

Variables

var (
	ErrProviderTypeNotFound = errors.New("provider type not found")
)

Functions

func ParseUses

func ParseUses(uses string) (providerType string, version string, err error)

Types

type ProviderRegistry

type ProviderRegistry struct {
	Providers map[string]map[string]RegisteredProvider
}

func Registry

func Registry() ProviderRegistry

func (ProviderRegistry) All

func (pr ProviderRegistry) All() map[string]RegisteredProvider

All returns all the registered providers. The key of the map is a 'uses' field like "commonfate/okta@v1"

func (ProviderRegistry) CLIOptions

func (r ProviderRegistry) CLIOptions() []string

func (ProviderRegistry) FromCLIOption

func (r ProviderRegistry) FromCLIOption(opt string) (uses string, p RegisteredProvider, err error)

func (ProviderRegistry) GetLatestByShortType

func (r ProviderRegistry) GetLatestByShortType(providerType string) (latestVersion string, p *RegisteredProvider, err error)

GetLatestByShortType prepends 'commonfate/' to the providerType then calls GetLatestByType

func (ProviderRegistry) GetLatestByType

func (r ProviderRegistry) GetLatestByType(providerType string) (latestVersion string, p *RegisteredProvider, err error)

GetLatestByType gets the latest version of a particular provider by it's type.

func (ProviderRegistry) Lookup

func (r ProviderRegistry) Lookup(providerType, version string) (*RegisteredProvider, error)

func (ProviderRegistry) LookupByUses

func (r ProviderRegistry) LookupByUses(uses string) (*RegisteredProvider, error)

Lookup a provider by the 'uses' string.

type RegisteredProvider

type RegisteredProvider struct {
	Provider    providers.Accessor
	DefaultID   string
	Description string
	// Hidden providers can be used in testing but should be hidden from cli and setup docs
	Hidden bool
}