localerr

Documentation

Index

• Variables
• type LocalError
  • func (e *LocalError) Error() string
  • func (e *LocalError) Help() string

Variables

var (
	// ErrAirbyteDir is returned anytime an there is an issue in accessing the paths.Airbyte directory.
	ErrAirbyteDir = &LocalError{
		msg: "airbyte directory is inaccessible",
		help: `The ~/.airbyte directory is inaccessible.
You may need to remove this directory before trying your command again.`,
	}

	// ErrClusterNotFound is returned in the event that no cluster was located.
	ErrClusterNotFound = &LocalError{
		msg: "no existing cluster found",
		help: `No cluster was found. If this is unexpected,
you may need to run the "local install" command again.`,
	}

	// ErrDocker is returned anytime an error occurs when attempting to communicate with docker.
	ErrDocker = &LocalError{
		msg: "error communicating with docker",
		help: `An error occurred while communicating with the Docker daemon.
Ensure that Docker is running and is accessible.  You may need to upgrade to a newer version of Docker.
For additional help please visit https://docs.docker.com/get-docker/`,
	}

	// ErrKubernetes is returned anytime an error occurs when attempting to communicate with the kubernetes cluster.
	ErrKubernetes = &LocalError{
		msg: "error communicating with kubernetes",
		help: `An error occurred while communicating with the Kubernetes cluster.
		If this error persists, you may need to run the uninstall command before attempting to run
		the install command again.`,
	}

	// ErrIngress is returned in the event that ingress configuration failed.
	ErrIngress = &LocalError{
		msg: "error configuring ingress",
		help: `An error occurred while configuring ingress.
This could be in indication that the ingress port is already in use by a different application.
The ingress port can be changed by passing the flag --port.`,
	}

	// ErrPort is returned in the event that the requested port is unavailable.
	ErrPort = &LocalError{
		msg: "error verifying port availability",
		help: `An error occurred while verifying if the request port is available.
This could be in indication that the ingress port is already in use by a different application.
The ingress port can be changed by passing the flag --port.`,
	}

	ErrIpAddressForHostFlag = &LocalError{
		msg: "invalid host - can't use an IP address",
		help: `Looks like you provided an IP address to the --host flag.
This won't work, because Kubernetes ingress rules require a lowercase domain name.

By default, abctl will allow access from any hostname or IP, so you might not need the --host flag.`,
	}

	ErrInvalidHostFlag = &LocalError{
		msg: "invalid host",
		help: `The --host flag expects a lowercase domain name, e.g. "example.com". 
IP addresses won't work. Ports won't work (e.g. example:8000). URLs won't work (e.g. http://example.com).

By default, abctl will allow access from any hostname or IP, so you might not need the --host flag.`,
	}
)

Types

type LocalError

type LocalError struct {
	// contains filtered or unexported fields
}

LocalError adds a user-friendly help message to specific errors.

func (*LocalError) Error

func (e *LocalError) Error() string

Error returns the error message.

func (*LocalError) Help

func (e *LocalError) Help() string

Help will displayed to the user if this specific error is ever returned.