cmd

Documentation

Index

• Variables
• func DeployViaHavenerConfig(hvnr havener.Havener, havenerConfig string) error
• func Execute()
• func GetHumanReadableTime(date time.Time) string
• func ListManifestFiles(release string) (map[string]*yamlv3.Node, error)
• func LogTask()
• func NewHvnrRootCmd() *cobra.Command
• func PrintOutputMessage(messages chan OutputMsg) error
• func PrintOutputMessageAsBlock(messages chan OutputMsg)
• func PromptUser(message string) bool
• func PurgeHelmReleases(hvnr havener.Havener, helmReleaseNames ...string) error
• func RenderNodeDetails(topDetails *havener.TopDetails) string
• func UpgradeViaHavenerConfig(hvnr havener.Havener, havenerConfig string) error
• func WaitCmdFunc(hvnr *havener.Hvnr, settings WaitCmdSettings) error
• type OutputMsg
• type WaitCmdSettings

Variables

var NoUserPrompt = false

NoUserPrompt defines whether a user confirmation is required or should be omitted

Functions

func DeployViaHavenerConfig

func DeployViaHavenerConfig(hvnr havener.Havener, havenerConfig string) error

DeployViaHavenerConfig entry function for running a helm install

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 GetHumanReadableTime

func GetHumanReadableTime(date time.Time) string

GetHumanReadableTime returns the time as string in the format: hh:mm:ss from a date object.

func ListManifestFiles

func ListManifestFiles(release string) (map[string]*yamlv3.Node, error)

ListManifestFiles breaks up the manifest string of a Helm Release to return a map with the template filename as the key and the unmarshaled YAML data as the value.

func LogTask

func LogTask()

LogTask processes all log messages coming from havener package.

func NewHvnrRootCmd

func NewHvnrRootCmd() *cobra.Command

NewHvnrRootCmd returns the cobra base cmd

func PrintOutputMessage

func PrintOutputMessage(messages chan OutputMsg) error

PrintOutputMessage reads from the given output message channel and prints the respective messages without any buffering or sorting.

func PrintOutputMessageAsBlock

func PrintOutputMessageAsBlock(messages chan OutputMsg)

PrintOutputMessageAsBlock reads from the given output message channel and buffers the input until the channel is closed. Once closed, it prints the output messages sorted by the origin.

func PromptUser

func PromptUser(message string) bool

PromptUser prompts the user via STDIN to confirm the message with either 'yes', or 'no' -- yes being translated into true, everything else is false.

func PurgeHelmReleases

func PurgeHelmReleases(hvnr havener.Havener, helmReleaseNames ...string) error

PurgeHelmReleases delete releases via helm

func RenderNodeDetails

func RenderNodeDetails(topDetails *havener.TopDetails) string

RenderNodeDetails renders a box with usage details per node

func UpgradeViaHavenerConfig

func UpgradeViaHavenerConfig(hvnr havener.Havener, havenerConfig string) error

UpgradeViaHavenerConfig override an existing helm chart

func WaitCmdFunc

func WaitCmdFunc(hvnr *havener.Hvnr, settings WaitCmdSettings) error

WaitCmdFunc blocks until either the configured condition is reached or the timeout occurred.

Types

type OutputMsg

type OutputMsg struct {
	Timestamp time.Time
	Stream    string
	Origin    string
	Message   string
}

OutputMsg is a message with additional context like time, an origin (name), and stream (for example stdout).

type WaitCmdSettings

type WaitCmdSettings struct {
	Quiet        bool
	Namespace    string
	PodStartWith string
	Interval     time.Duration
	Timeout      time.Duration
}

WaitCmdSettings contains all possible settings of the wait command