utils

Documentation

Index

• Constants
• Variables
• func ExtractAndParseAddons(indexImage, addonIdentifier string) ([]registry.Bundle, error)
• func GetBundleNameVersion(b registry.Bundle) (string, error)
• func GetLatestImageSetVersion(dir string) (string, error)
• func PrintValidationErrors(errs []error)
• type DefaultBundleParser
  • func (obj DefaultBundleParser) ParseBundles(addonName, manifestsDir string) ([]registry.Bundle, error)
• type DefaultIndexImageExtractor
  • func (obj DefaultIndexImageExtractor) CacheHit(key string) bool
  • func (obj DefaultIndexImageExtractor) CacheKey(indexImage, addonName string) string
  • func (obj DefaultIndexImageExtractor) CacheLocation() string
  • func (obj DefaultIndexImageExtractor) ExtractBundlesFromImage(indexImage, extractTo string) error
  • func (obj DefaultIndexImageExtractor) ExtractionPath() string
  • func (obj DefaultIndexImageExtractor) ManifestsPath(addonName string) string
  • func (obj DefaultIndexImageExtractor) WriteToCache(value string) error
• type DefaultOCMClient
  • func NewDefaultOCMClient(opts ...DefaultOCMClientOption) (*DefaultOCMClient, error)
  • func (c *DefaultOCMClient) CloseConnection() error
  • func (c *DefaultOCMClient) GetSKURules(ctx context.Context, quotaName string) ([]*amv1.SkuRule, error)
  • func (c *DefaultOCMClient) Option(opt DefaultOCMClientOption)
• type DefaultOCMClientOption
  • func DefaultOCMClientAPIURL(url string) DefaultOCMClientOption
  • func DefaultOCMClientTokenProvider(tp OCMTokenProvider) DefaultOCMClientOption
• type EnvOCMTokenProvider
  • func NewEnvOCMTokenProvider(envVar string) EnvOCMTokenProvider
  • func (tp EnvOCMTokenProvider) ProvideToken() (string, error)
• type MetaLoader
  • func NewMetaLoader(addonDir, env, version string) MetaLoader
• type OCMResponseError
  • func (e OCMResponseError) Error() string
  • func (e OCMResponseError) ServerSide() bool
• type OCMTokenProvider

Constants

const (
	// (sblaisdo) sretoolbox also uses /tmp/mtcli to extract binary archive
	DefaultDownloadPath  = "/tmp/mtcli-07b10894-0673-4d95-b6ef-0cbd9701c9c3"
	DefaultCacheDir      = "/tmp/mtcli-07b10894-0673-4d95-b6ef-0cbd9701c9c3"
	DefaultCacheFileName = ".cache"
)

const AllAddonsIdentifier = "all"

Variables

var (
	// colors for stdout
	Green            = color.New(color.FgGreen).SprintFunc()
	Red              = color.New(color.FgRed).SprintFunc()
	Yellow           = color.New(color.FgYellow).SprintFunc()
	Bold             = color.New(color.Bold).SprintFunc()
	IntenselyBoldRed = color.New(color.Bold, color.FgHiRed).SprintFunc()
)

Functions

func ExtractAndParseAddons

func ExtractAndParseAddons(indexImage, addonIdentifier string) ([]registry.Bundle, error)

func GetBundleNameVersion

func GetBundleNameVersion(b registry.Bundle) (string, error)

GetBundleNameVersion - useful for validation error reporting

func GetLatestImageSetVersion

func GetLatestImageSetVersion(dir string) (string, error)

func PrintValidationErrors

func PrintValidationErrors(errs []error)

PrintValidationErrors - helper to pretty print validationErrors

Types

type DefaultBundleParser

type DefaultBundleParser struct{}

func (DefaultBundleParser) ParseBundles

func (obj DefaultBundleParser) ParseBundles(addonName, manifestsDir string) ([]registry.Bundle, error)

type DefaultIndexImageExtractor

type DefaultIndexImageExtractor struct {
	// contains filtered or unexported fields
}

func (DefaultIndexImageExtractor) CacheHit

func (obj DefaultIndexImageExtractor) CacheHit(key string) bool

func (DefaultIndexImageExtractor) CacheKey

func (obj DefaultIndexImageExtractor) CacheKey(indexImage, addonName string) string

func (DefaultIndexImageExtractor) CacheLocation

func (obj DefaultIndexImageExtractor) CacheLocation() string

func (DefaultIndexImageExtractor) ExtractBundlesFromImage

func (obj DefaultIndexImageExtractor) ExtractBundlesFromImage(indexImage, extractTo string) error

func (DefaultIndexImageExtractor) ExtractionPath

func (obj DefaultIndexImageExtractor) ExtractionPath() string

func (DefaultIndexImageExtractor) ManifestsPath

func (obj DefaultIndexImageExtractor) ManifestsPath(addonName string) string

func (DefaultIndexImageExtractor) WriteToCache

func (obj DefaultIndexImageExtractor) WriteToCache(value string) error

type DefaultOCMClient

type DefaultOCMClient struct {
	// contains filtered or unexported fields
}

DefaultOCMClient implements the 'types.OCMClient' interface and exposes methods by which validators can communicate with OCM.

func NewDefaultOCMClient

func NewDefaultOCMClient(opts ...DefaultOCMClientOption) (*DefaultOCMClient, error)

NewDefaultOCMClient takes a variadic slice of options to configure a default OCM client and applies defaults if no appropriate option is given. An error may be returned if an unusable OCM token is provided or a connection cannot be initialized otherwise the default client is returned.

func (*DefaultOCMClient) CloseConnection

func (c *DefaultOCMClient) CloseConnection() error

func (*DefaultOCMClient) GetSKURules

func (c *DefaultOCMClient) GetSKURules(ctx context.Context, quotaName string) ([]*amv1.SkuRule, error)

func (*DefaultOCMClient) Option

func (c *DefaultOCMClient) Option(opt DefaultOCMClientOption)

Option applies the given option to an instance of the DefaultOCMClient.

type DefaultOCMClientOption

type DefaultOCMClientOption func(c *DefaultOCMClient)

DefaultOCMClientOption describes a function which configures a DefaultOCMClient instance.

func DefaultOCMClientAPIURL

func DefaultOCMClientAPIURL(url string) DefaultOCMClientOption

DefaultOCMClientAPIURL updates the URL used to connect to OCM. This option only takes effect if applied prior to connection initialization.

func DefaultOCMClientTokenProvider

func DefaultOCMClientTokenProvider(tp OCMTokenProvider) DefaultOCMClientOption

DefaultOCMClientAPIURL updates the URL used to connect to OCM. This option only takes effect if applied prior to connection initialization.

type EnvOCMTokenProvider

type EnvOCMTokenProvider struct {
	// contains filtered or unexported fields
}

EnvOCMTokenProvider provides OCM tokens from the current environment.

func NewEnvOCMTokenProvider

func NewEnvOCMTokenProvider(envVar string) EnvOCMTokenProvider

NewEnvOCMTokenProvider returns an instance of EnvOCMTokenProvider which retrieves OCM tokens from the environment by the given envVar name.

func (EnvOCMTokenProvider) ProvideToken

func (tp EnvOCMTokenProvider) ProvideToken() (string, error)

type MetaLoader

type MetaLoader interface {
	Load() (*addonsv1alpha1.AddonMetadataSpec, error)
}

func NewMetaLoader

func NewMetaLoader(addonDir, env, version string) MetaLoader

NewMetaLoader - returns default implementation of the AddonMetaLoader

type OCMResponseError

type OCMResponseError int

OCMResponseError is used to wrap HTTP error (400 - 599) response codes which are returned from a request to OCM.

func (OCMResponseError) Error

func (e OCMResponseError) Error() string

func (OCMResponseError) ServerSide

func (e OCMResponseError) ServerSide() bool

type OCMTokenProvider

type OCMTokenProvider interface {
	// ProvideToken returns either an access token as an encoded JWT token
	// or an error if a token could not be provided.
	ProvideToken() (string, error)
}

OCMTokenProvider provides OCM tokens to clients.