v2

Documentation

Index

• Constants
• func ApplicationLog(podName, containerName, prefix, message, formattedMessage string)
• func AutoTriggerDiff(phase constants.Phase, val bool) (bool, error)
• func BuildCanceled(artifact string, err error)
• func BuildFailed(artifact string, err error)
• func BuildInProgress(artifact string)
• func BuildSucceeded(artifact string)
• func CacheCheckHit(artifact string)
• func CacheCheckInProgress(artifact string)
• func CacheCheckMiss(artifact string)
• func DebuggingContainerStarted(podName, containerName, namespace, artifact, runtime, workingDir string, ...)
• func DebuggingContainerTerminated(podName, containerName, namespace, artifact, runtime, workingDir string, ...)
• func DeployFailed(id int, err error)
• func DeployInProgress(id int)
• func DeploySucceeded(id int)
• func ForEachApplicationLog(callback func(*proto.Event) error) error
• func ForEachEvent(callback func(*proto.Event) error) error
• func GetIteration() int
• func GetState() (*proto.State, error)
• func Handle(event *proto.Event) error
• func InitializeState(cfg Config)
• func LogMetaEvent()
• func NewLogHook() logrus.Hook
• func NewLogger(phase constants.Phase, subtaskID string) io.Writer
• func PortForwarded(localPort int32, remotePort util.IntOrString, ...)
• func RendererFailed(id int, err error)
• func RendererInProgress(id int)
• func RendererSucceeded(id int)
• func ResetStateOnBuild()
• func ResetStateOnDeploy()
• func ResetStateOnTest()
• func ResourceStatusCheckEventCompleted(r string, ae *proto.ActionableErr)
• func ResourceStatusCheckEventCompletedMessage(r string, message string, ae *proto.ActionableErr)
• func ResourceStatusCheckEventUpdated(r string, ae *proto.ActionableErr)
• func ResourceStatusCheckEventUpdatedMessage(r string, message string, ae *proto.ActionableErr)
• func SaveEventsToFile(fp string) error
• func SaveLastLog(fp string) error
• func SendErrorMessageOnce(task constants.Phase, subtaskID string, err error)
• func TaskFailed(task constants.Phase, err error)
• func TaskInProgress(task constants.Phase, description string)
• func TaskSucceeded(task constants.Phase)
• func TesterFailed(id int, err error)
• func TesterInProgress(id int)
• func TesterSucceeded(id int)
• func UpdateStateAutoBuildTrigger(t bool)
• func UpdateStateAutoDeployTrigger(t bool)
• func UpdateStateAutoSyncTrigger(t bool)
• func WaitForConnection()
• type Config

Constants

const (
	Cache = "Cache"
	Build = "Build"
)

const (
	NotStarted = "NotStarted"
	InProgress = "InProgress"
	Complete   = "Complete"
	Failed     = "Failed"
	Info       = "Information"
	Started    = "Started"
	Succeeded  = "Succeeded"
	Terminated = "Terminated"
	Canceled   = "Canceled"
)

Functions

func ApplicationLog

func ApplicationLog(podName, containerName, prefix, message, formattedMessage string)

func AutoTriggerDiff

func AutoTriggerDiff(phase constants.Phase, val bool) (bool, error)

func BuildCanceled

func BuildCanceled(artifact string, err error)

func BuildFailed

func BuildFailed(artifact string, err error)

func BuildInProgress

func BuildInProgress(artifact string)

func BuildSucceeded

func BuildSucceeded(artifact string)

func CacheCheckHit

func CacheCheckHit(artifact string)

func CacheCheckInProgress

func CacheCheckInProgress(artifact string)

func CacheCheckMiss

func CacheCheckMiss(artifact string)

func DebuggingContainerStarted

func DebuggingContainerStarted(podName, containerName, namespace, artifact, runtime, workingDir string, debugPorts map[string]uint32)

DebuggingContainerStarted notifies that a debuggable container has appeared.

func DebuggingContainerTerminated

func DebuggingContainerTerminated(podName, containerName, namespace, artifact, runtime, workingDir string, debugPorts map[string]uint32)

DebuggingContainerTerminated notifies that a debuggable container has disappeared.

func DeployFailed

func DeployFailed(id int, err error)

func DeployInProgress

func DeployInProgress(id int)

func DeploySucceeded

func DeploySucceeded(id int)

func ForEachApplicationLog

func ForEachApplicationLog(callback func(*proto.Event) error) error

func ForEachEvent

func ForEachEvent(callback func(*proto.Event) error) error

func GetIteration

func GetIteration() int

func GetState

func GetState() (*proto.State, error)

func Handle

func Handle(event *proto.Event) error

func InitializeState

func InitializeState(cfg Config)

InitializeState instantiates the global state of the skaffold runner, as well as the event log.

func LogMetaEvent

func LogMetaEvent()

func NewLogHook

func NewLogHook() logrus.Hook

func NewLogger

func NewLogger(phase constants.Phase, subtaskID string) io.Writer

func PortForwarded

func PortForwarded(localPort int32, remotePort util.IntOrString, podName, containerName, namespace string, portName string, resourceType, resourceName, address string)

PortForwarded notifies that a remote port has been forwarded locally.

func RendererFailed

func RendererFailed(id int, err error)

RendererFailed adds an event to mark a render process has been failed.

func RendererInProgress

func RendererInProgress(id int)

RendererInProgress adds an event to mark a render process starts.

func RendererSucceeded

func RendererSucceeded(id int)

RendererSucceeded adds an event to mark a render process has been succeeded.

func ResetStateOnBuild

func ResetStateOnBuild()

ResetStateOnBuild resets the build, test, deploy and sync state

func ResetStateOnDeploy

func ResetStateOnDeploy()

ResetStateOnDeploy resets the deploy, sync and status check state

func ResetStateOnTest

func ResetStateOnTest()

ResetStateOnTest resets the test, deploy, sync and status check state

func ResourceStatusCheckEventCompleted

func ResourceStatusCheckEventCompleted(r string, ae *proto.ActionableErr)

func ResourceStatusCheckEventCompletedMessage

func ResourceStatusCheckEventCompletedMessage(r string, message string, ae *proto.ActionableErr)

func ResourceStatusCheckEventUpdated

func ResourceStatusCheckEventUpdated(r string, ae *proto.ActionableErr)

func ResourceStatusCheckEventUpdatedMessage

func ResourceStatusCheckEventUpdatedMessage(r string, message string, ae *proto.ActionableErr)

func SaveEventsToFile

func SaveEventsToFile(fp string) error

SaveEventsToFile saves the current event log to the filepath provided

func SaveLastLog

func SaveLastLog(fp string) error

SaveLastLog writes the output from the previous run to the specified filepath

func SendErrorMessageOnce

func SendErrorMessageOnce(task constants.Phase, subtaskID string, err error)

SendErrorMessageOnce sends an error message to skaffold log events stream only once. Use it if you want to avoid sending duplicate error messages.

func TaskFailed

func TaskFailed(task constants.Phase, err error)

func TaskInProgress

func TaskInProgress(task constants.Phase, description string)

func TaskSucceeded

func TaskSucceeded(task constants.Phase)

func TesterFailed

func TesterFailed(id int, err error)

func TesterInProgress

func TesterInProgress(id int)

func TesterSucceeded

func TesterSucceeded(id int)

func UpdateStateAutoBuildTrigger

func UpdateStateAutoBuildTrigger(t bool)

func UpdateStateAutoDeployTrigger

func UpdateStateAutoDeployTrigger(t bool)

func UpdateStateAutoSyncTrigger

func UpdateStateAutoSyncTrigger(t bool)

func WaitForConnection

func WaitForConnection()

WaitForConnection will block execution until the server receives a connection

Types

type Config

type Config interface {
	GetKubeContext() string
	AutoBuild() bool
	AutoDeploy() bool
	AutoSync() bool
	GetPipelines() []latestV1.Pipeline
	GetRunID() string
}