multus

Documentation

Index

• Variables
• type Logger
• type SimpleStderrLogger
  • func (*SimpleStderrLogger) Debugf(format string, args ...interface{})
  • func (*SimpleStderrLogger) Infof(format string, args ...interface{})
  • func (*SimpleStderrLogger) Warningf(format string, args ...interface{})
• type ValidationTest
  • func (vt *ValidationTest) CleanUp(ctx context.Context) (*ValidationTestResults, error)
  • func (vt *ValidationTest) Run(ctx context.Context) (*ValidationTestResults, error)
• type ValidationTestConfig
  • func NewDefaultValidationTestConfig() *ValidationTestConfig
  • func ValidationTestConfigFromYAML(y string) (*ValidationTestConfig, error)
  • func (c *ValidationTestConfig) String() string
  • func (c *ValidationTestConfig) ToYAML() (string, error)
  • func (c *ValidationTestConfig) Validate() error
• type ValidationTestResults
  • func (vtr *ValidationTestResults) SuggestedDebuggingReport() string

Variables

var (
	DefaultValidationNamespace = "rook-ceph"

	// 1 mon, 3 osds, 1 mgr, 1 mds, 1 nfs, 1 rgw, 1 rbdmirror, 1 cephfsmirror,
	// (1 csi provisioner, 1 csi plugin) x3 for rbd, cephfs, and nfs CSI drivers
	DefaultValidationDaemonsPerNode = 16

	DefaultValidationNginxImage = "nginxinc/nginx-unprivileged:stable-alpine"

	DefaultValidationResourceTimeout = 3 * time.Minute
)

var (
	//go:embed config.yaml
	ConfigYaml string
)

Types

type Logger

type Logger interface {
	Infof(format string, args ...interface{})
	Debugf(format string, args ...interface{})
	Warningf(format string, args ...interface{})
}

Logger defines the log types that this library will use for outputting status information to the user. Because this library may be called interactively by a user or programmatically by another application, we allow the calling application to make a very simple Logger type that will be compatible with this library.

type SimpleStderrLogger

type SimpleStderrLogger struct{}

func (*SimpleStderrLogger) Debugf

func (*SimpleStderrLogger) Debugf(format string, args ...interface{})

func (*SimpleStderrLogger) Infof

func (*SimpleStderrLogger) Infof(format string, args ...interface{})

func (*SimpleStderrLogger) Warningf

func (*SimpleStderrLogger) Warningf(format string, args ...interface{})

type ValidationTest

type ValidationTest struct {
	Clientset kubernetes.Interface

	// The Logger will be used to render ongoing status by this library.
	Logger Logger

	ValidationTestConfig
}

A Multus ValidationTest runs a number of Multus-connected pods to validate that a Kubernetes environment is suitable for Rook to run Ceph in.

func (*ValidationTest) CleanUp

func (vt *ValidationTest) CleanUp(ctx context.Context) (*ValidationTestResults, error)

CleanUp cleans up Multus validation test resources. It returns a suggestion for manual action if clean up was unsuccessful.

func (*ValidationTest) Run

func (vt *ValidationTest) Run(ctx context.Context) (*ValidationTestResults, error)

Run the Multus validation test.

type ValidationTestConfig

type ValidationTestConfig struct {
	Namespace       string        `yaml:"namespace"`
	PublicNetwork   string        `yaml:"publicNetwork"`
	ClusterNetwork  string        `yaml:"clusterNetwork"`
	DaemonsPerNode  int           `yaml:"daemonsPerNode"`
	ResourceTimeout time.Duration `yaml:"resourceTimeout"`
	NginxImage      string        `yaml:"nginxImage"`
}

ValidationTestConfig is a configuration for a Multus validation test. To prevent documentation for this struct from getting out of date, see the output of ValidationTestConfig.ToYAML() for usage text for each field.

func NewDefaultValidationTestConfig

func NewDefaultValidationTestConfig() *ValidationTestConfig

NewDefaultValidationTestConfig returns a new ValidationTestConfig with default values.

func ValidationTestConfigFromYAML

func ValidationTestConfigFromYAML(y string) (*ValidationTestConfig, error)

ValidationTestConfigFromYAML loads a YAML-formatted string into a new ValidationTestConfig.

func (*ValidationTestConfig) String

func (c *ValidationTestConfig) String() string

String implements the Stringer interface

func (*ValidationTestConfig) ToYAML

func (c *ValidationTestConfig) ToYAML() (string, error)

ToYAML converts the validation test config into a YAML representation with user-readable comments describing how to use the various parameters.

func (*ValidationTestConfig) Validate

func (c *ValidationTestConfig) Validate() error

Validate reports any validation test configuration problems as errors.

type ValidationTestResults

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

ValidationTestResults contains results from a validation test.

func (*ValidationTestResults) SuggestedDebuggingReport

func (vtr *ValidationTestResults) SuggestedDebuggingReport() string