Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright © 2021 Iter8 authors ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func ExecTemplate(t executable, exp *Experiment) error
- func Execute()
- func Generate() (result *bytes.Buffer, err error)
- func NewAssertCmd() *cobra.Command
- func NewReportCmd() *cobra.Command
- func NewRunCmd() *cobra.Command
- func RegisterHTMLTemplate(name string, tpl *ht.Template)
- func RegisterTextTemplate(name string, tpl *template.Template)
- func RenderGoTpl(v chartutil.Values, filePath string) (*bytes.Buffer, error)
- func RenderTpl(k8sExp k8sExperiment, filePath string) (*bytes.Buffer, error)
- func ResultFromBytes(b []byte) (*base.ExperimentResult, error)
- func SpecFromBytes(b []byte) ([]base.TaskSpec, error)
- type AssertOptionsType
- type BuildInfo
- type ExpIO
- type Experiment
- func (exp *Experiment) Assert(conditions []string, to time.Duration) (bool, error)
- func (exp *Experiment) Completed() bool
- func (e *Experiment) ContainsInsight(in base.InsightType) bool
- func (e *Experiment) HTMLHistCharts() string
- func (e *Experiment) HTMLHistData() string
- func (e *Experiment) HTMLHistMetricsSection() string
- func (e *Experiment) HTMLMetricsSection() string
- func (e *Experiment) HTMLSLOSection() string
- func (e *Experiment) HTMLStatus() string
- func (e *Experiment) HistData() []histograms
- func (exp *Experiment) NoFailure() bool
- func (exp *Experiment) Report(outputFormat string) error
- func (e *Experiment) Run(expio ExpIO) error
- type FileExpIO
- type ReportOptionsType
Constants ¶
const ( // Completed states that the experiment is complete Completed = "completed" // NoFailure states that none of the tasks in the experiment have failed NoFailure = "nofailure" // SLOs states that all app versions participating in the experiment satisfies SLOs SLOs = "slos" // SLOsByPrefix is used for ensuring that a specific app version participating in the // experiment satisfies SLOs SLOsByPrefix = "slosby" )
const ( // TextOutputFormat is the output format used to create text output TextOutputFormatKey = "text" // HTMLOutputFormat is the output format used to create html output HTMLOutputFormatKey = "html" )
const (
// Iter8Hub is the location of the public Iter8 Hub.
Iter8Hub = "github.com/iter8-tools/iter8.git//hub"
)
Variables ¶
var AssertOptions = AssertOptionsType{}
AssertOptions stores the options used by the assert command
var GenOptions = values.Options{}
GenOptions are the options used by the gen subcommands. They store values that can be combined with templates for generating experiment.yaml files Kubernetes manifests.
var ReportOptions = ReportOptionsType{ OutputFormat: TextOutputFormatKey, }
ReportOptions stores the options used by thee report command
var RootCmd = &cobra.Command{
Use: "iter8",
Short: "Kubernetes release engineering",
Long: globalUsage,
}
RootCmd represents the base command when called without any subcommands
Functions ¶
func ExecTemplate ¶
func ExecTemplate(t executable, exp *Experiment) error
ExecTemplate executes text or html template using experiment as the data
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func NewAssertCmd ¶
NewAssertCmd creates an assert command with the assert flagset
func RegisterHTMLTemplate ¶
RegisterHTMLTemplate registers an HTML template
func RegisterTextTemplate ¶
RegisterTextTemplate registers a text template
func RenderGoTpl ¶
RenderGoTpl creates output from go.tpl
func ResultFromBytes ¶
func ResultFromBytes(b []byte) (*base.ExperimentResult, error)
ResultFromBytes reads experiment result from bytes
Types ¶
type AssertOptionsType ¶
type AssertOptionsType struct {
// Conds is the list of conditions that are asserted
Conds []string
// Timeout for assert conditions to be satisfied
Timeout time.Duration
}
AssertOptionsType is used to store the options used by the assert command
type BuildInfo ¶ added in v0.8.8
type BuildInfo struct {
// Version is the current semver.
Version string `json:"version,omitempty"`
// GitCommit is the git sha1.
GitCommit string `json:"git_commit,omitempty"`
// GitTreeState is the state of the git tree.
GitTreeState string `json:"git_tree_state,omitempty"`
// GoVersion is the version of the Go compiler used to compile Iter8.
GoVersion string `json:"go_version,omitempty"`
}
BuildInfo describes the compile time information.
type ExpIO ¶
type ExpIO interface {
// ReadSpec reads the experiment spec
ReadSpec() ([]base.TaskSpec, error)
// ReadResult reads the experiment results
ReadResult() (*base.ExperimentResult, error)
// WriteResult writes the experimeent results
WriteResult(r *Experiment) error
}
ExpIO enables interacting with experiment spec and result stored externally
type Experiment ¶
type Experiment struct {
*base.Experiment
// contains filtered or unexported fields
}
Experiment type that includes a list of runnable tasks derived from the experiment spec
func (*Experiment) Completed ¶
func (exp *Experiment) Completed() bool
Completed returns true if the experiment is complete if the result stanza is missing, this function returns false
func (*Experiment) ContainsInsight ¶
func (e *Experiment) ContainsInsight(in base.InsightType) bool
ContainsInsight checks if the experiment contains insight
func (*Experiment) HTMLHistCharts ¶
func (e *Experiment) HTMLHistCharts() string
HTMLHistCharts returns histogram charts section in HTML report
func (*Experiment) HTMLHistData ¶
func (e *Experiment) HTMLHistData() string
HTMLHistData returns histogram data section in HTML report
func (*Experiment) HTMLHistMetricsSection ¶
func (e *Experiment) HTMLHistMetricsSection() string
HTMLHistMetricsSection prints histogram metrics in the HTML report
func (*Experiment) HTMLMetricsSection ¶
func (e *Experiment) HTMLMetricsSection() string
HTMLMetricsSection prints metrics in the HTML report
func (*Experiment) HTMLSLOSection ¶
func (e *Experiment) HTMLSLOSection() string
HTMLSLOSection prints the SLO section in HTML report
func (*Experiment) HTMLStatus ¶
func (e *Experiment) HTMLStatus() string
HTMLStatus prints the current state of the experiment
func (*Experiment) HistData ¶
func (e *Experiment) HistData() []histograms
HistData provides histogram data for all histogram metrics
func (*Experiment) NoFailure ¶
func (exp *Experiment) NoFailure() bool
NoFailure returns true if no task int he experiment has failed if the result stanza is missing, this function returns false
func (*Experiment) Report ¶
func (exp *Experiment) Report(outputFormat string) error
Report creates a report from experiment as per outputFormat
type FileExpIO ¶
type FileExpIO struct{}
FileExpIO enables reading and writing experiment spec and result files
func (*FileExpIO) ReadResult ¶
func (f *FileExpIO) ReadResult() (*base.ExperimentResult, error)
ReadResult reads experiment result from file
func (*FileExpIO) WriteResult ¶
func (f *FileExpIO) WriteResult(r *Experiment) error
WriteResult writes experiment result to file
type ReportOptionsType ¶
type ReportOptionsType struct {
// OutputFormat holds the output format to be used by report
OutputFormat string
}
ReportOptionsType enables options for the report command
Source Files