Documentation
¶
Overview ¶
Package action contains the logic for each action that Iter8 can perform.
This is a library for calling top-level Iter8 actions like 'launch' and 'assert'. Actions approximately match the command line invocations that the Iter8 CLI uses.
Index ¶
Constants ¶
const ( // DefaultHelmRepository is the URL of the default Helm repository DefaultHelmRepository = "https://iter8-tools.github.io/iter8" // DefaultChartName is the default name of the Iter8 chart DefaultChartName = "iter8" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeleteOpts ¶ added in v0.10.0
type DeleteOpts struct {
// KubeDriver enables access to Kubernetes cluster
*driver.KubeDriver
}
DeleteOpts are the options used for deleting experiment groups
func NewDeleteOpts ¶ added in v0.10.0
func NewDeleteOpts(kd *driver.KubeDriver) *DeleteOpts
NewDeleteOpts initializes and returns launch opts
func (*DeleteOpts) KubeRun ¶ added in v0.10.0
func (dOpts *DeleteOpts) KubeRun() error
KubeRun deletes a Kubernetes experiment
type LaunchOpts ¶
type LaunchOpts struct {
// DryRun enables simulating a launch
DryRun bool
// ChartPathOptions
action.ChartPathOptions
// ChartName is the name of the chart
ChartName string
// Options provides the values to be combined with the experiment chart
values.Options
// Rundir is the directory where experiment.yaml file is located
RunDir string
// KubeDriver enables Kubernetes experiment run
*driver.KubeDriver
// LocalChart indicates the chart is on the local filesystem
LocalChart bool
}
LaunchOpts are the options used for launching experiments
func NewLaunchOpts ¶
func NewLaunchOpts(kd *driver.KubeDriver) *LaunchOpts
NewLaunchOpts initializes and returns launch opts
func (*LaunchOpts) KubeRun ¶
func (lOpts *LaunchOpts) KubeRun() error
KubeRun launches a Kubernetes experiment
type LogOpts ¶
type LogOpts struct {
// KubeDriver enables interaction with Kubernetes cluster
*driver.KubeDriver
}
LogOpts enables fetching logs from Kubernetes
func NewLogOpts ¶
func NewLogOpts(kd *driver.KubeDriver) *LogOpts
NewLogOpts initializes and returns log opts
type RunOpts ¶
type RunOpts struct {
// Rundir is the directory of the local experiment.yaml file
RunDir string
// KubeDriver enables Kubernetes experiment run
*driver.KubeDriver
// ReuseResult configures Iter8 to reuse the experiment result instead of
// creating a new one for looping experiments.
ReuseResult bool
}
RunOpts are the options used for running an experiment
func NewRunOpts ¶
func NewRunOpts(kd *driver.KubeDriver) *RunOpts
NewRunOpts initializes and returns run opts
Source Files