package
0.102.0
Repository: https://github.com/elastic/elastic-package.git
Documentation: pkg.go.dev

# Functions

AutodetectShell returns the detected shell used.
BootUp function boots up the Elastic stack.
BuildProvider returns the provider for the given name.
DockerComposeProjectName returns the docker compose project name for a given profile.
Dump function exports stack data and dumps them as local artifacts, which can be used for debug purposes.
EnsureStackNetworkUp function verifies if stack network is up and running.
FindCACertificate looks for the CA certificate for the stack in the current profile.
No description provided by the author
Network function returns the stack network name.
NewElasticsearchClient creates an Elasticsearch client with the settings provided by the shellinit environment variables.
NewElasticsearchClientFromProfile creates an Elasticsearch client with the settings provided by the shellinit environment variables.
NewKibanaClient creates a kibana client with the settings provided by the shellinit environment variables.
NewKibanaClientFromProfile creates a kibana client with the settings provided by the shellinit environment variables.
ParseLogs returns all the logs for a given service name.
No description provided by the author
ShellInit method exposes environment variables that can be used for testing purposes.
No description provided by the author
Status shows the status for each service.
TearDown function takes down the testing stack.
UndefinedEnvError formats an error reported for undefined variable.
Update pulls down the most recent versions of the Docker images.

# Constants

No description provided by the author
ComposeFile is the docker compose file.
ElasticAgentEnvFile is the elastic agent environment variables file.
No description provided by the author
ElasticsearchConfigFile is the elasticsearch config file.
FleetServerHealthcheckFile is the Fleet Server healthcheck.
KibanaConfigFile is the kibana config file.
KibanaHealthcheckFile is the kibana healthcheck.
LogstashConfigFile is the logstash config file.
PackageRegistryBaseImage is the base Docker image of the Elastic Package Registry.
PackageRegistryConfigFile is the config file for the Elastic Package registry.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Environment variables describing the stack.
CACertificateFile is the path to the CA certificate file inside a profile.
CAEnvFile is the path to the file with environment variables about the CA.
CAKeyFile is the path to the CA key file inside a profile.
CertificatesDirectory is the path to the certificates directory inside a profile.
No description provided by the author
Environment variables describing the stack.
Environment variables describing the stack.
Environment variables describing the stack.
ErrUnavailableStack is an error about an unavailable Elastic stack.
Environment variables describing the stack.
No description provided by the author

# Structs

No description provided by the author
DumpOptions defines dumping options for Elatic stack data.
DumpResult contains the result of a dump operation.
ErrNotImplemented is an error about a feature not implemented in a stack provider.
ErrUndefinedEnv is an error about an undefined environment variable for the current profile.
No description provided by the author
No description provided by the author
No description provided by the author
Options defines available image booting options.
No description provided by the author
No description provided by the author

# Interfaces

Printer is the interface that can be used to print information on operations.
Provider is the implementation of a stack provider.