common

Documentation

Index

• Constants
• Variables
• type AllFlags
• type DescriptorFlags
• type DockerFlags
• type LoggingFlags
  • func (l LoggingFlags) ShouldOutputLogs() bool
• type ProxyFlags
• type SSHFlags

Constants

const (
	LOG_CLI_IMAGE         = "Ekara installer image: %s\n"
	LOG_COMMAND_COMPLETED = "Command completed"
	LOG_CONTAINER_LOG_IS  = "The installer logs will be written into %s\n"
	LOG_SSH_CONFIRMATION  = "Using specified SSH keys"

	//Actions
	LOG_VALIDATING_ENV = "Validating environment: %s \n"
	LOG_DUMPING_ENV    = "Dumping environment: %s \n"
	LOG_APPLYING_ENV   = "Applying environment: %s \n"

	//DOCKER IMAGE AND CONTAINER
	LOG_GET_IMAGE             = "Get or refresh the latest CLI image"
	LOG_WAITING_DOWNLOAD      = "Waiting for the download to be completed"
	LOG_DOWNLOAD_COMPLETED    = "Image download completed"
	LOG_WAITING_STOP          = "Waiting for the container to stop"
	LOG_STOPPED               = "Container stopped"
	LOG_CONTAINER_LOG_WRITTEN = "The container logs have been written into %s\n"

	// Prompt messages
	PROMPT_RESTART             = "Are you sure you want to recreate the starter container now (Y/N) "
	LOG_FAIL_ON_PROMPT_RESTART = "Cannot go further if you refuse to stop the running container!"

	LOG_PASSING_CONTAINER_ENVARS = "Env passed to the container %v\n"

	LOG_QUALIFIED_NAME = "The environment qualified name is :%s"

	ERROR_REQUIRED_DESCRIPTOR_URL = "The \"descriptor url\" should be defined"
	ERROR_REQUIRED_FLAG           = "The flag \"%s\" should be defined"
	ERROR_REQUIRED_ENV            = "The environment variable \"%s\" should be defined"
	ERROR_REQUIRED_SSH_PUBLIC     = "The flag \"public_ssh\" must be defined"
	ERROR_REQUIRED_SSH_PRIVATE    = "The flag \"private_ssh\" must be defined"
	ERROR_COPYING_SSH_PUB         = "Error copying the SSH public key %s"
	ERROR_COPYING_SSH_PRIV        = "Error copying the SSH public key %s"

	ERROR_CREATING_EXCHANGE_FOLDER  = "Error creating the exchange folder %s"
	ERROR_UNREACHABLE_PARAM_FILE    = "Error, the file \"%s\" cannot be located"
	ERROR_CREATING_EKARA_ENGINE     = "Error creating the Ekara engine %s"
	ERROR_INITIALIZING_EKARA_ENGINE = "Error initializing the Ekara engine %s"
)

Variables

var Flags = AllFlags{}

Flags holds actual CLI flag values

var Logger = log.New(ioutil.Discard, "", log.LstdFlags)

Types

type AllFlags

type AllFlags struct {
	Debug      bool
	Docker     DockerFlags
	Descriptor DescriptorFlags
	Logging    LoggingFlags
	Proxy      ProxyFlags
	SSH        SSHFlags
}

AllFlags regroups all possible CLI flags

type DescriptorFlags

type DescriptorFlags struct {
	// The name of the environment descriptor
	File string
	// The name of the parameters files
	ParamFile string
	// The login required to reach the descriptor
	Login string
	// The password required to reach the descriptor
	Password string
}

DescriptorFlags regroups descriptor-related flags

type DockerFlags

type DockerFlags struct {
	// The docker host
	Host string
	// The docker certificates location
	Cert string
	// TLS using for daemon communication
	TLS bool
	// Docker daemon API version if any
	APIVersion string
}

DockerFlags regroups docker-related flags

type LoggingFlags

type LoggingFlags struct {
	Verbose     bool
	VeryVerbose bool
	File        string
}

LoggingFlags regroups logging-related flags

func (LoggingFlags) ShouldOutputLogs

func (l LoggingFlags) ShouldOutputLogs() bool

ShouldOutputLogs returns true if (very) verbose mode is enabled

type ProxyFlags

type ProxyFlags struct {
	HTTP       string
	HTTPS      string
	Exclusions string
}

ProxyFlags regroups proxy-related flags

type SSHFlags

type SSHFlags struct {
	// The public SSH key used to log on the created environment
	PublicSSHKey string
	// The private SSH key used to log on the created environment
	PrivateSSHKey string
}

SSHFlags regroups SSH-related flags