serverinstall

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 17, 2021 License: MPL-2.0 Imports: 37 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Platforms = map[string]Installer{
	"kubernetes": &K8sInstaller{},
	"nomad":      &NomadInstaller{},
	"docker":     &DockerInstaller{},
}

Functions

This section is empty.

Types

type DockerInstaller added in v0.2.0 

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

func (*DockerInstaller) Install added in v0.2.0 

func (i *DockerInstaller) Install(
	ctx context.Context,
	opts *InstallOpts,
) (*InstallResults, error)

Install is a method of DockerInstaller and implements the Installer interface to create a waypoint-server as a Docker container

func (*DockerInstaller) InstallFlags added in v0.2.0 

func (i *DockerInstaller) InstallFlags(set *flag.Set)

func (*DockerInstaller) Uninstall added in v0.2.1 

func (i *DockerInstaller) Uninstall(
	ctx context.Context,
	opts *InstallOpts,
) error

Install is a method of DockerInstaller and implements the Installer interface to remove the waypoint-server Docker container and associated image and volume

func (*DockerInstaller) UninstallFlags added in v0.2.1 

func (i *DockerInstaller) UninstallFlags(set *flag.Set)

func (*DockerInstaller) Upgrade added in v0.2.1 

func (i *DockerInstaller) Upgrade(
	ctx context.Context, opts *InstallOpts, serverCfg serverconfig.Client) (
	*InstallResults, error,
)

Upgrade is a method of DockerInstaller and implements the Installer interface to upgrade a waypoint-server as a Docker container

func (*DockerInstaller) UpgradeFlags added in v0.2.1 

func (i *DockerInstaller) UpgradeFlags(set *flag.Set)

type InstallOpts added in v0.2.1 

type InstallOpts struct {
	Log hclog.Logger
	UI  terminal.UI
}

InstallOpts are the options sent to Installer.Install.

type InstallResults added in v0.2.1 

type InstallResults struct {
	// Context is the connection context that can be used to connect from
	// the CLI to the server. This will be used to establish an API client.
	Context *clicontext.Config

	// AdvertiseAddr is the configuration for the advertised address
	// that entrypoints (deployed workloads) will use to communicate back
	// to the server. This may be different from the context info because this
	// may be a private address.
	AdvertiseAddr *pb.ServerConfig_AdvertiseAddr

	// HTTPAddr is the address to the HTTP listener on the server. This generally
	// is reachable from the CLI immediately and not a private address.
	HTTPAddr string
}

InstallResults are the results expected for a successful Installer.Install.

type Installer added in v0.2.0 

type Installer interface {
	// Install expects the Waypoint server to be installed.
	Install(context.Context, *InstallOpts) (*InstallResults, error)

	// InstallFlags is called prior to Install and allows the installer to
	// specify flags for the install CLI. The flags should be prefixed with
	// the platform name to avoid conflicts with other flags.
	InstallFlags(*flag.Set)

	// Upgrade expects the Waypoint server to be upgraded from a previous install
	Upgrade(ctx context.Context, opts *InstallOpts, serverCfg serverconfig.Client) (*InstallResults, error)

	// UpgradeFlags is called prior to Upgrade and allows the upgrader to
	// specify flags for the upgrade CLI. The flags should be prefixed with
	// the platform name to avoid conflicts with other flags.
	UpgradeFlags(*flag.Set)

	// Uninstall expects the Waypoint server to be uninstalled.
	Uninstall(context.Context, *InstallOpts) error

	// UninstallFlags is called prior to Uninstall and allows the Uninstaller to
	// specify flags for the uninstall CLI. The flags should be prefixed with the
	// platform name to avoid conflicts with other flags.
	UninstallFlags(*flag.Set)
}

Installer is implemented by the server platforms and is responsible for managing the installation of the Waypoint server.

type K8sInstaller added in v0.2.0 

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

func (*K8sInstaller) Install added in v0.2.0 

func (i *K8sInstaller) Install(
	ctx context.Context,
	opts *InstallOpts,
) (*InstallResults, error)

Install is a method of K8sInstaller and implements the Installer interface to register a waypoint-server in a Kubernetes cluster

func (*K8sInstaller) InstallFlags added in v0.2.0 

func (i *K8sInstaller) InstallFlags(set *flag.Set)

func (*K8sInstaller) Uninstall added in v0.2.1 

func (i *K8sInstaller) Uninstall(ctx context.Context, opts *InstallOpts) error

Uninstall is a method of K8sInstaller and implements the Installer interface to remove a waypoint-server statefulset and the associated PVC and service from a Kubernetes cluster

func (*K8sInstaller) UninstallFlags added in v0.2.1 

func (i *K8sInstaller) UninstallFlags(set *flag.Set)

func (*K8sInstaller) Upgrade added in v0.2.1 

func (i *K8sInstaller) Upgrade(
	ctx context.Context, opts *InstallOpts, serverCfg serverconfig.Client) (
	*InstallResults, error,
)

Upgrade is a method of K8sInstaller and implements the Installer interface to upgrade a waypoint-server in a Kubernetes cluster

func (*K8sInstaller) UpgradeFlags added in v0.2.1 

func (i *K8sInstaller) UpgradeFlags(set *flag.Set)

type NomadInstaller added in v0.2.0 

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

func (*NomadInstaller) Install added in v0.2.0 

func (i *NomadInstaller) Install(
	ctx context.Context,
	opts *InstallOpts,
) (*InstallResults, error)

Install is a method of NomadInstaller and implements the Installer interface to register a waypoint-server job with a Nomad cluster

func (*NomadInstaller) InstallFlags added in v0.2.0 

func (i *NomadInstaller) InstallFlags(set *flag.Set)

func (*NomadInstaller) Uninstall added in v0.2.1 

func (i *NomadInstaller) Uninstall(ctx context.Context, opts *InstallOpts) error

Unnstall is a method of NomadInstaller and implements the Installer interface to stop, and optionally purge, the waypoint-server job on a Nomad cluster

func (*NomadInstaller) UninstallFlags added in v0.2.1 

func (i *NomadInstaller) UninstallFlags(set *flag.Set)

func (*NomadInstaller) Upgrade added in v0.2.1 

func (i *NomadInstaller) Upgrade(
	ctx context.Context, opts *InstallOpts, serverCfg serverconfig.Client) (
	*InstallResults, error,
)

Upgrade is a method of NomadInstaller and implements the Installer interface to upgrade a waypoint-server in a Nomad cluster

func (*NomadInstaller) UpgradeFlags added in v0.2.1 

func (i *NomadInstaller) UpgradeFlags(set *flag.Set)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.