package
0.0.0-20230628214157-3bfe64699e82
Repository: https://github.com/gravitational/gravity.git
Documentation: pkg.go.dev

# Packages

Package credentials provides interface for retrieving local user credentials.

# Functions

ClusterApps returns apps service for the local cluster.
ClusterOperator returns the local cluster ops service.
ClusterPackages returns the local cluster packages service.
DetectCluster attempts to detect whether there is a deployed cluster.
InGravity returns full path to specified subdirectory of local state dir.
LocalCluster returns the local cluster.
LocalGravityDir returns host directory where local environment stores its data on this node.
LoginRemote creates remote environment and logs into with provided creds.
LoginWizard creates remote environment and logs into it as a wizard user.
New is a shortcut that creates a local environment from provided state directory.
NewAppsClient creates a new app service client.
NewClusterEnvironment initializes local cluster services and returns a new instance of cluster environment.
NewImageEnvironment returns a new environment for a specified image.
NewLocalEnvironment creates a new LocalEnvironment given the specified configuration arguments.
NewLocalWizardEnvironment creates a new local environment to access wizard-specific state.
NewOpsClient creates a new client to Operator service using the specified login entry, address of the Ops Center and a set of optional connection options.
NewRemoteEnvironment creates a new remote environment.
NewTarballEnvironment creates new environment for the cluster image unpacked at the configured location.
SiteDir returns host directory where gravity site stores its data on this node.
SitePackagesDir returns host directory where packages are stored on this node.
SiteUnpackedDir returns host directory where unpacked packages are stored on this node.
WithCleanup cleans up an image environment state directory on close.
WithClient is an option to override the kubernetes client to use in the cluster environment.
WithEtcdTimeout is an option to override the etcd timeout.

# Structs

AppConfig is applications-specific configuration.
ClusterEnvironment provides access to local cluster services.
ImageEnvironment is a special case of a local environment with the state directory rooted in the unpacked application/cluster image tarball.
LocalEnvironment sets up local gravity environment and services that make sense for it: * local package service * local site service * access to local OpsCenter.
LocalEnvironmentArgs holds configuration values for opening or creating a LocalEnvironment.
LocalState describes the local state of the cluster as represented by the information found in the node-local backend.
RemoteEnvironment provides access to a remote Ops Center services.
TarballEnvironment describes application environment in the directory with unpacked installer.
TarballEnvironmentArgs defines configuration for the environment.

# Type aliases

ClusterEnvironmentOption describes a functional option for customizing a cluster environment.
DNSConfig is the DNS configuration with a fallback to storage.DefaultDNSConfig.
ImageEnvironmentOption defines an image environment functional argument.
Silent implements a silent flag and controls console output.