common

Documentation

Index

• Constants
• Variables
• func GenerateEvaluationName(checkType CheckType, evalName string) string
• func GenerateTaskName(checkType CheckType, taskName string) string
• func GetShortPhaseName(phase string) string
• func TruncateString(s string, max int) string
• type CheckType
• type GaugeFloatValue
• type GaugeValue
• type KeptnMeters
• type KeptnPhase
• type KeptnPhaseType
  • func (p KeptnPhaseType) IsEvaluation() bool
  • func (p KeptnPhaseType) IsPostEvaluation() bool
  • func (p KeptnPhaseType) IsPostTask() bool
  • func (p KeptnPhaseType) IsPreEvaluation() bool
  • func (p KeptnPhaseType) IsPreTask() bool
  • func (p KeptnPhaseType) IsTask() bool
• type KeptnState
  • func GetOverallState(s StatusSummary) KeptnState
  • func (k KeptnState) IsCancelled() bool
  • func (k KeptnState) IsCompleted() bool
  • func (k KeptnState) IsFailed() bool
  • func (k KeptnState) IsPending() bool
  • func (k KeptnState) IsSucceeded() bool
• type PhaseTraceID
  • func (pid PhaseTraceID) GetPhaseTraceID(phase string) propagation.MapCarrier
  • func (pid PhaseTraceID) SetPhaseTraceID(phase string, carrier propagation.MapCarrier)
• type StatusSummary
  • func UpdateStatusSummary(status KeptnState, summary StatusSummary) StatusSummary
  • func (s StatusSummary) GetTotalCount() int

Constants

const (
	AppName                 attribute.Key = attribute.Key("keptn.deployment.app.name")
	AppVersion              attribute.Key = attribute.Key("keptn.deployment.app.version")
	AppNamespace            attribute.Key = attribute.Key("keptn.deployment.app.namespace")
	AppStatus               attribute.Key = attribute.Key("keptn.deployment.app.status")
	AppPreviousVersion      attribute.Key = attribute.Key("keptn.deployment.app.previousversion")
	WorkloadName            attribute.Key = attribute.Key("keptn.deployment.workload.name")
	WorkloadVersion         attribute.Key = attribute.Key("keptn.deployment.workload.version")
	WorkloadPreviousVersion attribute.Key = attribute.Key("keptn.deployment.workload.previousversion")
	WorkloadNamespace       attribute.Key = attribute.Key("keptn.deployment.workload.namespace")
	WorkloadStatus          attribute.Key = attribute.Key("keptn.deployment.workload.status")
	TaskStatus              attribute.Key = attribute.Key("keptn.deployment.task.status")
	TaskName                attribute.Key = attribute.Key("keptn.deployment.task.name")
	TaskType                attribute.Key = attribute.Key("keptn.deployment.task.type")
	EvaluationStatus        attribute.Key = attribute.Key("keptn.deployment.evaluation.status")
	EvaluationName          attribute.Key = attribute.Key("keptn.deployment.evaluation.name")
	EvaluationType          attribute.Key = attribute.Key("keptn.deployment.evaluation.type")
)

const AppAnnotation = "keptn.sh/app"

const CreateAppEvalSpanName = "create_%s_app_evaluation"

const CreateAppTaskSpanName = "create_%s_app_task"

const CreateWorkloadEvalSpanName = "create_%s_deployment_evaluation"

const CreateWorkloadTaskSpanName = "create_%s_deployment_task"

const K8sRecommendedAppAnnotations = "app.kubernetes.io/part-of"

const K8sRecommendedVersionAnnotations = "app.kubernetes.io/version"

const K8sRecommendedWorkloadAnnotations = "app.kubernetes.io/name"

const MaxAppNameLength = 25

const MaxTaskNameLength = 25

const MaxVersionLength = 12

const MaxWorkloadNameLength = 25

const NamespaceEnabledAnnotation = "keptn.sh/lifecycle-toolkit"

const PostDeploymentEvaluationAnnotation = "keptn.sh/post-deployment-evaluations"

const PostDeploymentTaskAnnotation = "keptn.sh/post-deployment-tasks"

const PreDeploymentEvaluationAnnotation = "keptn.sh/pre-deployment-evaluations"

const PreDeploymentTaskAnnotation = "keptn.sh/pre-deployment-tasks"

const TaskNameAnnotation = "keptn.sh/task-name"

const VersionAnnotation = "keptn.sh/version"

const WorkloadAnnotation = "keptn.sh/workload"

Variables

var (
	PhaseWorkloadPreDeployment  = KeptnPhaseType{LongName: "Workload Pre-Deployment Tasks", ShortName: "WorkloadPreDeployTasks"}
	PhaseWorkloadPostDeployment = KeptnPhaseType{LongName: "Workload Post-Deployment Tasks", ShortName: "WorkloadPostDeployTasks"}
	PhaseWorkloadPreEvaluation  = KeptnPhaseType{LongName: "Workload Pre-Deployment Evaluations", ShortName: "WorkloadPreDeployEvaluations"}
	PhaseWorkloadPostEvaluation = KeptnPhaseType{LongName: "Workload Post-Deployment Evaluations", ShortName: "WorkloadPostDeployEvaluations"}
	PhaseWorkloadDeployment     = KeptnPhaseType{LongName: "Workload Deployment", ShortName: "WorkloadDeploy"}
	PhaseAppPreDeployment       = KeptnPhaseType{LongName: "App Pre-Deployment Tasks", ShortName: "AppPreDeployTasks"}
	PhaseAppPostDeployment      = KeptnPhaseType{LongName: "App Post-Deployment Tasks", ShortName: "AppPostDeployTasks"}
	PhaseAppPreEvaluation       = KeptnPhaseType{LongName: "App Pre-Deployment Evaluations", ShortName: "AppPreDeployEvaluations"}
	PhaseAppPostEvaluation      = KeptnPhaseType{LongName: "App Post-Deployment Evaluations", ShortName: "AppPostDeployEvaluations"}
	PhaseAppDeployment          = KeptnPhaseType{LongName: "App Deployment", ShortName: "AppDeploy"}
	PhaseReconcileEvaluation    = KeptnPhaseType{LongName: "Reconcile Evaluation", ShortName: "ReconcileEvaluation"}
	PhaseCreateEvaluation       = KeptnPhaseType{LongName: "Create Evaluation", ShortName: "Create Evaluation"}
	PhaseCompleted              = KeptnPhaseType{LongName: "Completed", ShortName: "Completed"}
	PhaseCancelled              = KeptnPhaseType{LongName: "Cancelled", ShortName: "Cancelled"}
)

var ErrCannotCastKeptnApp = errors.New("cannot cast KeptnApp to v1alpha3")

var ErrCannotCastKeptnAppVersion = errors.New("cannot cast KeptnAppVersion to v1alpha3")

var ErrCannotCastKeptnEvaluationProvider = errors.New("cannot cast KeptnEvaluationDefinition to v1alpha3")

var ErrCannotCastKeptnWorkloadInstance = errors.New("cannot cast KeptnWorkloadInstance to v1alpha3")

Functions

func GenerateEvaluationName

func GenerateEvaluationName(checkType CheckType, evalName string) string

func GenerateTaskName

func GenerateTaskName(checkType CheckType, taskName string) string

func GetShortPhaseName

func GetShortPhaseName(phase string) string

func TruncateString

func TruncateString(s string, max int) string

Types

type CheckType

type CheckType string

const PostDeploymentCheckType CheckType = "post"

const PostDeploymentEvaluationCheckType CheckType = "post-eval"

const PreDeploymentCheckType CheckType = "pre"

const PreDeploymentEvaluationCheckType CheckType = "pre-eval"

type GaugeFloatValue

type GaugeFloatValue struct {
	Value      float64
	Attributes []attribute.KeyValue
}

type GaugeValue

type GaugeValue struct {
	Value      int64
	Attributes []attribute.KeyValue
}

type KeptnMeters

type KeptnMeters struct {
	TaskCount          metric.Int64Counter
	TaskDuration       metric.Float64Histogram
	DeploymentCount    metric.Int64Counter
	DeploymentDuration metric.Float64Histogram
	AppCount           metric.Int64Counter
	AppDuration        metric.Float64Histogram
	EvaluationCount    metric.Int64Counter
	EvaluationDuration metric.Float64Histogram
}

type KeptnPhase

type KeptnPhase KeptnPhaseType

type KeptnPhaseType

type KeptnPhaseType struct {
	LongName  string
	ShortName string
}

func (KeptnPhaseType) IsEvaluation

func (p KeptnPhaseType) IsEvaluation() bool

func (KeptnPhaseType) IsPostEvaluation

func (p KeptnPhaseType) IsPostEvaluation() bool

func (KeptnPhaseType) IsPostTask

func (p KeptnPhaseType) IsPostTask() bool

func (KeptnPhaseType) IsPreEvaluation

func (p KeptnPhaseType) IsPreEvaluation() bool

func (KeptnPhaseType) IsPreTask

func (p KeptnPhaseType) IsPreTask() bool

func (KeptnPhaseType) IsTask

func (p KeptnPhaseType) IsTask() bool

type KeptnState

type KeptnState string

const (
	StateProgressing KeptnState = "Progressing"
	StateSucceeded   KeptnState = "Succeeded"
	StateFailed      KeptnState = "Failed"
	StateUnknown     KeptnState = "Unknown"
	StatePending     KeptnState = "Pending"
	StateCancelled   KeptnState = "Cancelled"
)

func GetOverallState

func GetOverallState(s StatusSummary) KeptnState

func (KeptnState) IsCancelled

func (k KeptnState) IsCancelled() bool

func (KeptnState) IsCompleted

func (k KeptnState) IsCompleted() bool

func (KeptnState) IsFailed

func (k KeptnState) IsFailed() bool

func (KeptnState) IsPending

func (k KeptnState) IsPending() bool

func (KeptnState) IsSucceeded

func (k KeptnState) IsSucceeded() bool

type PhaseTraceID

type PhaseTraceID map[string]propagation.MapCarrier

func (PhaseTraceID) GetPhaseTraceID

func (pid PhaseTraceID) GetPhaseTraceID(phase string) propagation.MapCarrier

func (PhaseTraceID) SetPhaseTraceID

func (pid PhaseTraceID) SetPhaseTraceID(phase string, carrier propagation.MapCarrier)

type StatusSummary

type StatusSummary struct {
	Total       int
	Progressing int
	Failed      int
	Succeeded   int
	Pending     int
	Unknown     int
	Cancelled   int
}

func UpdateStatusSummary

func UpdateStatusSummary(status KeptnState, summary StatusSummary) StatusSummary

func (StatusSummary) GetTotalCount

func (s StatusSummary) GetTotalCount() int