models

Documentation

Index

• type Remediation
• type RemediationAction
• type Remediations
• type ServiceIndicator
• type ServiceIndicatorQueryObject
• type ServiceIndicators
• type ServiceObjective
• type ServiceObjectives
• type Shipyard

Types

type Remediation

type Remediation struct {
	Name    string               `json:"name" yaml:"name"`
	Actions []*RemediationAction `json:"actions" yaml:"actions"`
}

Remediation represents a remediation

type RemediationAction

type RemediationAction struct {
	Action string `json:"action" yaml:"action"`
	Value  string `json:"value" yaml:"value"`
}

RemediationAction represents a remediation action

type Remediations

type Remediations struct {
	Remediations []*Remediation `json:"remediations" yaml:"remediations"`
}

Remediations contains remediation definitions for a service

type ServiceIndicator

type ServiceIndicator struct {
	Metric      string                         `json:"metric" yaml:"metric"`
	Source      string                         `json:"source" yaml:"source"`
	Query       string                         `json:"query" yaml:"query"`
	QueryObject []*ServiceIndicatorQueryObject `json:"queryObject" yaml:"queryObject"`
}

ServiceIndicator describes a service indicator

type ServiceIndicatorQueryObject

type ServiceIndicatorQueryObject struct {
	Key   string `json:"key" yaml:"key"`
	Value string `json:"value" yaml:"value"`
}

type ServiceIndicators

type ServiceIndicators struct {
	Indicators []*ServiceIndicator `json:"indicators" yaml:"indicators"`
}

ServiceIndicators contains the definition of service indicators

type ServiceObjective

type ServiceObjective struct {
	Metric    string  `json:"metric" yaml:"metric"`
	Threshold float32 `json:"threshold" yaml:"threshold"`
	Timeframe string  `json:"timeframe" yaml:"timeframe"`
	Score     float32 `json:"score" yaml:"score"`
}

ServiceObjective describes a service objective

type ServiceObjectives

type ServiceObjectives struct {
	Pass       int                 `json:"pass" yaml:"pass"`
	Warning    int                 `json:"warning" yaml:"warning"`
	Objectives []*ServiceObjective `json:"objectives" yaml:"objectives"`
}

ServiceObjectives describes objectives for a service

type Shipyard

type Shipyard struct {
	Stages []struct {
		Name                string `json:"name" yaml:"name"`
		DeploymentStrategy  string `json:"deployment_strategy" yaml:"deployment_strategy"`
		TestStrategy        string `json:"test_strategy,omitempty" yaml:"test_strategy"`
		RemediationStrategy string `json:"remediation_strategy,omitempty" yaml:"remediation_strategy"`
	} `json:"stages" yaml:"stages"`
}

Shipyard defines the name, deployment strategy and test strategy of each stage