utils

Documentation

Index

• Constants
• Variables
• func CertsDir(name string) string
• func CreateFolders()
• func CreateKubeConfigPath(name string) (dir, filePath string, dockerPath string)
• func FQDN(name, module, typeName string) string
• func FQDNVolumeName(name string) string
• func GetBlueprintFolder(blueprint string) (string, error)
• func GetBlueprintLocalFolder(blueprint string) string
• func GetConnectorLogFile() string
• func GetConnectorPIDFile() string
• func GetDataFolder(p string, perms os.FileMode) string
• func GetDockerHost() string
• func GetDockerIP() string
• func GetHelmLocalFolder(chart string) string
• func GetHostname() string
• func GetLocalIPAddresses() []string
• func GetLocalIPAndHostname() (string, string)
• func GetReleasesFolder() string
• func GetShipyardBinaryPath() string
• func HTTPProxyAddress() string
• func HTTPSProxyAddress() string
• func HomeEnvName() string
• func HomeFolder() string
• func ImageCacheLog() string
• func IsHCLFile(path string) bool
• func IsLocalFolder(path string) bool
• func JumppadHome() string
• func LogsDir() string
• func ReplaceNonURIChars(s string) (string, error)
• func ShipyardTemp() string
• func StateDir() string
• func StatePath() string
• func SubnetIPs(subnet string) ([]string, error)
• func ValidateName(name string) (bool, error)
• type ClusterConfig
  • func (n *ClusterConfig) APIAddress(context Context) string
  • func (n *ClusterConfig) ConnectorAddress(context Context) string
  • func (n *ClusterConfig) Load(file string) error
  • func (n *ClusterConfig) Save(file string) error
• type Context

Constants

const CacheResourceName string = "docker-cache"

Name of the Cache resource

const ImageVolumeName string = "images"

ImageVolumeName is the name of the volume which stores the images for clusters

const MaxRandomPort = 32767

const MinRandomPort = 30000

const ProxyBypass string = "localhost,127.0.0.1,cluster.local,jumppad.dev,svc,consul"

Addresses to bypass when using a HTTP Proxy

Variables

var InvalidBlueprintURIError = fmt.Errorf("Inavlid blueprint URI")

var NameContainsInvalidCharactersError = fmt.Errorf("Name contains invalid characters characters must be either a-z, A-Z, 0-9, -, _")

var NameExceedsMaxLengthError = fmt.Errorf("Name exceeds the max length of 128 characters")

Functions

func CertsDir

func CertsDir(name string) string

CertsDir returns the location of the certificates for the given resource used to secure the Shipyard ingress, usually rooted at $HOME/.shipyard/certs

func CreateFolders

func CreateFolders()

Creates the required file structure in the users Home directory

func CreateKubeConfigPath

func CreateKubeConfigPath(name string) (dir, filePath string, dockerPath string)

CreateKubeConfigPath creates the file path for the KubeConfig file when using Kubernetes cluster

func FQDN

func FQDN(name, module, typeName string) string

FQDN generates the full qualified name for a container

func FQDNVolumeName

func FQDNVolumeName(name string) string

FQDNVolumeName creates a full qualified volume name

func GetBlueprintFolder

func GetBlueprintFolder(blueprint string) (string, error)

GetBlueprintFolder parses a blueprint uri and returns the top level blueprint folder if the URI is not a blueprint will return an error

func GetBlueprintLocalFolder

func GetBlueprintLocalFolder(blueprint string) string

GetBlueprintLocalFolder returns the full storage path for the given blueprint URI

func GetConnectorLogFile

func GetConnectorLogFile() string

GetConnectorLogFile returns the log file used by the connector

func GetConnectorPIDFile

func GetConnectorPIDFile() string

GetConnectorPIDFile returns the connector PID file used by the connector

func GetDataFolder

func GetDataFolder(p string, perms os.FileMode) string

GetDataFolder creates the data directory used by the application

func GetDockerHost

func GetDockerHost() string

GetDockerHost returns the location of the Docker API depending on the platform

func GetDockerIP

func GetDockerIP() string

GetDockerIP returns the location of the Docker Server IP address

func GetHelmLocalFolder

func GetHelmLocalFolder(chart string) string

GetHelmLocalFolder returns the full storage path for the given blueprint URI

func GetHostname

func GetHostname() string

GetHostname returns the hostname for the current machine

func GetLocalIPAddresses

func GetLocalIPAddresses() []string

GetLocalIPAddress returns a list of ip addressses for the local machine

func GetLocalIPAndHostname

func GetLocalIPAndHostname() (string, string)

GetLocalIPAndHostname returns the IP Address of the machine

func GetReleasesFolder

func GetReleasesFolder() string

GetReleasesFolder return the path of the Shipyard releases

func GetShipyardBinaryPath

func GetShipyardBinaryPath() string

GetShipyardBinaryPath returns the path to the running Shipyard binary

func HTTPProxyAddress

func HTTPProxyAddress() string

HTTPProxyAddress returns the default HTTPProxy used by Nomad and Kubernetes clusters unless the environment variable HTTP_PROXY is set when it returns this value

func HTTPSProxyAddress

func HTTPSProxyAddress() string

HTTPSProxyAddress returns the default HTTPProxy used by Nomad and Kubernetes clusters unless the environment variable HTTPS_PROXY is set when it returns this value

func HomeEnvName

func HomeEnvName() string

HomeEnvName returns the environment variable used to store the home path

func HomeFolder

func HomeFolder() string

HomeFolder returns the users homefolder this will be $HOME on windows and mac and USERPROFILE on windows

func ImageCacheLog

func ImageCacheLog() string

ImageCacheLog returns the location of the image cache log

func IsHCLFile

func IsHCLFile(path string) bool

IsHCLFile tests if the given path resolves to a HCL config file

func IsLocalFolder

func IsLocalFolder(path string) bool

IsLocalFolder tests if the given path is a localfolder and can exist in the current filesystem TODO make more robust with error messages to improve UX

func JumppadHome

func JumppadHome() string

JumppadHome returns the location of the shipyard folder, usually $HOME/.shipyard

func LogsDir

func LogsDir() string

LogsDir returns the location of the logs used to secure the Shipyard ingress, usually $HOME/.shipyard/logs

func ReplaceNonURIChars

func ReplaceNonURIChars(s string) (string, error)

ReplaceNonURIChars replaces any characters in the resrouce name which can not be used in a URI

func ShipyardTemp

func ShipyardTemp() string

ShipyardTemp returns a temporary folder

func StateDir

func StateDir() string

StateDir returns the location of the shipyard state, usually $HOME/.shipyard/state

func StatePath

func StatePath() string

StatePath returns the full path for the state file

func SubnetIPs

func SubnetIPs(subnet string) ([]string, error)

get all ipaddresses in a subnet

func ValidateName

func ValidateName(name string) (bool, error)

ValidateName ensures that the name for a resource is within certain boundaries Valid characters: [a-z] [A-Z] _ - [0-9] Max length: 128

Types

type ClusterConfig

type ClusterConfig struct {
	// Location of the Cluster
	LocalAddress  string `json:"local_address"`
	RemoteAddress string `json:"remote_address"`

	// Port the API Server is running on
	APIPort int `json:"api_port"`

	// Port the API Server is running on reachable from
	// a remote network
	RemoteAPIPort int `json:"remote_api_port"`

	// Port where the connector is running
	ConnectorPort int `json:"connector_port"`

	// Number of nodes in the cluster
	NodeCount int `json:"node_count"`

	// Does the API use SSL?
	SSL bool `json:"ssl"`
	// contains filtered or unexported fields
}

ClusterConfig defines a config file which is used to store Nomad cluster connection info

func (*ClusterConfig) APIAddress

func (n *ClusterConfig) APIAddress(context Context) string

APIAddress returns the FQDN for the API server

func (*ClusterConfig) ConnectorAddress

func (n *ClusterConfig) ConnectorAddress(context Context) string

ConnectorAddress returns the FQDN for the gRPC endpoing of the Connector

func (*ClusterConfig) Load

func (n *ClusterConfig) Load(file string) error

Load the config from a file

func (*ClusterConfig) Save

func (n *ClusterConfig) Save(file string) error

Save the config to a file

type Context

type Context string

Context is a type which stores the context for the cluster

const LocalContext Context = "local"

LocalContext defines a constant for the local context

const RemoteContext Context = "remote"

RemoteContext defines a constant for the remote context