package
0.5.61
Repository: https://github.com/jumppad-labs/jumppad.git
Documentation: pkg.go.dev

# Packages

Package dirhash defines hashes over directory trees.

# Functions

BlueprintFolder parses a blueprint uri and returns the top level blueprint folder if the URI is not a blueprint will return an error.
BlueprintLocalFolder returns the full storage path for the given blueprint URI.
CacheFolder creates the cache directory used by the a provider unlike DataFolders, cache folders are not removed when down is called.
CertsDir returns the location of the certificates for the given resource used to secure the Jumppad ingress, usually rooted at $HOME/.jumppad/certs.
InterfaceChecksum returns a checksum of the given interface Note: the checksum is positional, should an element in a map or list change position then a different checksum will be returned.
Creates the required file structure in the users Home directory.
CreateKubeConfigPath creates the file path for the KubeConfig file when using Kubernetes cluster.
DataFolder creates the data directory used by the application.
EnsureAbsolute ensure that the given path is either absolute or if relative is converted to abasolute based on the path of the config.
FQDN generates the full qualified name for a container.
FQDNVolumeName creates a full qualified volume name.
GetConnectorLogFile returns the log file used by the connector.
GetConnectorPIDFile returns the connector PID file used by the connector.
GetDockerHost returns the location of the Docker API depending on the platform.
GetDockerIP returns the location of the Docker Server IP address.
GetHostname returns the hostname for the current machine.
GetJumppadBinaryPath returns the path to the running Jumppad binary.
GetLocalIPAddress returns a list of ip addressses for the local machine.
GetLocalIPAndHostname returns the IP Address of the machine.
HashDir generates a hash of the given directory optionally a list of arguments to be ignored can be passed these arguments are expresed as a glob pattern.
HashFile returns a sha256 hash of the given file.
HashString returns a sha256 hash of the given string.
HelmLocalFolder returns the full storage path for the given blueprint URI.
HomeEnvName returns the environment variable used to store the home path.
HomeFolder returns the users homefolder this will be $HOME on windows and mac and USERPROFILE on windows.
ImageCacheADDR returns the default Image cache used by Nomad and Kubernetes clusters unless the environment variable IMAGE_CACHE_ADDR is set when it returns this value.
ImageCacheLog returns the location of the image cache log.
IsHCLFile tests if the given path resolves to a HCL config file.
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.
JumppadHome returns the location of the jumppad folder, usually $HOME/.jumppad.
JumppadTemp returns a temporary folder.
LibraryFolder creates the library directory used by the application.
LogsDir returns the location of the logs used to secure the Jumppad ingress, usually $HOME/.jumppad/logs.
PluginsDir returns the location of the plugins.
RandomAvailablePort returns a random free port in the given range.
ReleasesFolder return the path of the Shipyard releases.
ReplaceNonURIChars replaces any characters in the resource name which can not be used in a URI.
StateDir returns the location of the jumppad state, usually $HOME/.jumppad/state.
StatePath returns the full path for the state file.
get all ipaddresses in a subnet.
ValidateName ensures that the name for a resource is within certain boundaries Valid characters: [a-z] [A-Z] _ - [0-9] Max length: 128.

# Constants

BuildImagePrefix is the default prefix added to any image built by jumppad.
Name of the Cache resource.
ImageVolumeName is the name of the volume which stores the images for clusters.
LocalContext defines a constant for the local context.
No description provided by the author
No description provided by the author
Addresses to bypass when using a HTTP Proxy.
RemoteContext defines a constant for the remote context.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

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

# Type aliases

Context is a type which stores the context for the cluster.