check

Documentation

Index

• Variables
• func NewCommand(o *Options) *cobra.Command
• func NewConfigCommand(o *ConfigOptions) *cobra.Command
• func NewControllerCommand(o *ControllerOptions) *cobra.Command
• func NewExperimentCommand(o *ExperimentOptions) *cobra.Command
• func NewVersionCommand(o *VersionOptions) *cobra.Command
• type APIError
  • func (e *APIError) Error() string
• type Asset
• type ConfigOptions
• type ControllerOptions
  • func (o *ControllerOptions) CheckController(ctx context.Context) error
• type ExperimentOptions
• type Options
• type Release
  • func (r *Release) AssetByName(name string) *Asset
• type ReleaseList
  • func (rl ReleaseList) Latest() *Release
• type VersionOptions

Variables

var GitHubReleasesURL = "https://api.github.com/repos/thestormforge/optimize-controller/releases"

Functions

func NewCommand

func NewCommand(o *Options) *cobra.Command

NewCommand creates a new command for checking components

func NewConfigCommand

func NewConfigCommand(o *ConfigOptions) *cobra.Command

NewConfigCommand creates a new command for checking the Optimize Configuration

func NewControllerCommand

func NewControllerCommand(o *ControllerOptions) *cobra.Command

NewControllerCommand creates a new command for checking an Optimize controller

func NewExperimentCommand

func NewExperimentCommand(o *ExperimentOptions) *cobra.Command

NewExperimentCommand creates a new command for checking an experiment manifest

func NewVersionCommand

func NewVersionCommand(o *VersionOptions) *cobra.Command

NewVersionCommand creates a new command for checking the current version of the product

Types

type APIError

type APIError struct {
	StatusCode       int    `json:"-"`
	Message          string `json:"message"`
	DocumentationURL string `json:"documentation_url"`
}

func (*APIError) Error

func (e *APIError) Error() string

type Asset

type Asset struct {
	Name               string `json:"name"`
	BrowserDownloadURL string `json:"browser_download_url"`
}

type ConfigOptions

type ConfigOptions struct {
	// Config is the Optimize Configuration to check
	Config *config.OptimizeConfig
	// ExperimentsAPI is used to interact with the Optimize Experiments API
	ExperimentsAPI experimentsv1alpha1.API
	// IOStreams are used to access the standard process streams
	commander.IOStreams
}

ConfigOptions are the options for checking an Optimize Configuration

type ControllerOptions

type ControllerOptions struct {
	// Config is the Optimize Configuration for connecting to the cluster
	Config *config.OptimizeConfig
	// IOStreams are used to access the standard process streams
	commander.IOStreams

	// Wait for the controller to be ready
	Wait bool
}

ControllerOptions are the options for checking an Optimize controller

func (*ControllerOptions) CheckController

func (o *ControllerOptions) CheckController(ctx context.Context) error

type ExperimentOptions

type ExperimentOptions struct {
	// IOStreams are used to access the standard process streams
	commander.IOStreams

	Filename string
}

ExperimentOptions are the options for checking an experiment manifest

type Options

type Options struct {
	// Config is the Optimize Configuration
	Config *config.OptimizeConfig
}

Options includes the configuration for the subcommands

type Release

type Release struct {
	Name       string  `json:"name"`
	TagName    string  `json:"tag_name"`
	Draft      bool    `json:"draft"`
	Prerelease bool    `json:"prerelease"`
	Assets     []Asset `json:"assets"`
}

func (*Release) AssetByName

func (r *Release) AssetByName(name string) *Asset

type ReleaseList

type ReleaseList []Release

func (ReleaseList) Latest

func (rl ReleaseList) Latest() *Release

type VersionOptions

type VersionOptions struct {
	// IOStreams are used to access the standard process streams
	commander.IOStreams
}

VersionOptions are the options for checking the current version of the product