api

Documentation

Index

• type Cloud
• type GatewayDeployInput
• type GatewayDeployer
• type PortSpec

Types

type Cloud

type Cloud interface {
	// OpenPorts inside the cloud for submariner to communicate through.
	OpenPorts(ports []PortSpec, status reporter.Interface) error

	// ClosePorts will close any internal ports that were opened, after Submariner is removed.
	ClosePorts(status reporter.Interface) error
}

Cloud is a potential cloud for installing Submariner on.

type GatewayDeployInput

type GatewayDeployInput struct {
	// List of ports to open externally so that Submariner can reach and be reached by other Submariners.
	PublicPorts []PortSpec

	// Amount of gateways that are being deployed.
	//
	// 0 = Deploy gateways per the default deployer policy (Default if not specified)
	//
	// 1-* = Deploy the amount of gateways requested (May fail if there aren't enough public subnets)
	Gateways int

	// Use service of type LoadBalancer to deploy Submariner
	UseLoadBalancer bool

	// Specifies if the underlying deployment is air-gapped.
	AirGapped bool
}

type GatewayDeployer

type GatewayDeployer interface {
	// Deploy dedicated gateways as requested.
	Deploy(input GatewayDeployInput, status reporter.Interface) error

	// Cleanup any dedicated gateways that were previously deployed.
	Cleanup(status reporter.Interface) error
}

GatewayDeployer will deploy and cleanup dedicated gateways according to the requested policy.

type PortSpec

type PortSpec struct {
	Port     uint16
	Protocol string
}

PortSpec is a specification of port+protocol to open.