package
0.0.0-20241208190318-80fc79a84806
Repository: https://github.com/grevych/gobox.git
Documentation: pkg.go.dev

# Functions

ApplyEnvOverrides overrides a box configuration based on env vars.
EnsureBox loads a box if it already exists, or prompts the user for the box if not found.
EnsureBoxWithOptions loads a box if it already exists or returns an error.
InitializeBox prompts the user for a box config location, downloads it and then saves it to disk.
LoadBox loads the default box or returns an error.
LoadBoxStorage reads a serialized, storage wrapped box config from disk and returns it.
NewConfig makes a full initialized Config.
SaveBox takes a Storage wrapped box configuration, serializes it and then saves it to the well-known config path on disk.
WithAgent sets the SSH agent for fetching the box repository.
WithDefaults sets the default URLs to provided to a user when a box configuration doesn't exist locally.
WithLogger sets the logger to use when outputting to the user.
WithMinVersion sets a minimum version of a box configuration being required.

# Constants

SnapshotLockChannelRC is a release candidate (less stable) channel.
SnapshotLockChannelStable is a stable channel.
Version is the current version of the box spec.

# Variables

BoxConfigFile is the name of the box config storage file.
BoxConfigPath is the $HOME/<BoxConfigPath> location of the box config storage.

# Structs

AWSConfig configures AWS access for tools that support it.
CD contains the cd configuration settings that can be set in box.
CI contains the ci configuration settings that can be set in box.
Config is the basis of a box configuration.
No description provided by the author
DeveloperEnvironmentRuntimeConfig stores configuration specific to different runtimes.
DevelopmentRegistries contains a slice of DevelopmentRegistrys.
DevelopmentRegistry is a docker image registry used for development.
DevenvVersionResolvers is the configurations used to get the latest version.
No description provided by the author
LoftCluster is a loft cluster.
LoftRuntimeConfig is configuration for loft runtimes.
MaestroConfig contains configuration used by the maestro version resolver.
OktaConfig is the Okta-specific config used for AWS access.
RestoreStep maps to a set of resources included in the snapshot.
SnapshotConfig stores configuration for generated and accessing snapshots.
SnapshotGenerateConfig stores configuration for snapshots that should be generated.
SnapshotLock is an manifest of all the available snapshots.
SnapshotLockList contains a channel (different releases of snapshots) separated list of snapshots.
SnapshotLockListItem is a replacement for SnapshotLockTarget which is used by SnapshotLockList to provide details about a snapshot.
SnapshotLockTarget is a generated snapshot and metadata on it.
SnapshotTarget is the defn for a generated snapshot.
Storage is a wrapper type used for storing the box configuration.
VaultConfig is the configuration for accessing Vault.
VersionResolverConfig contains configuration for version resolvers.

# Type aliases

DevelopmentRegistriesSlice is a slice of DevelopmentRegistry.
No description provided by the author
LoftClusters is a container for a slice of LoftClusters.
SnapshotLockChannel is used to determine the quality of a given snapshot.