api

Documentation

Index

• type Cloud
• type GatewayDeployInput
• type GatewayDeployer
• type PortSpec
• type PrepareForSubmarinerInput
• type Reporter
  • func NewLoggingReporter() Reporter

Types

type Cloud

type Cloud interface {
	// PrepareForSubmariner will prepare the cloud for Submariner to operate on.
	PrepareForSubmariner(input PrepareForSubmarinerInput, reporter Reporter) error

	// CleanupAfterSubmariner will clean up the cloud after Submariner is removed.
	CleanupAfterSubmariner(reporter Reporter) 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
}

type GatewayDeployer

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

	// Cleanup any dedicated gateways that were previously deployed.
	Cleanup(reporter Reporter) 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.

type PrepareForSubmarinerInput

type PrepareForSubmarinerInput struct {
	// List of ports to open inside the cluster for proper communication between Submariner services.
	InternalPorts []PortSpec
}

type Reporter

type Reporter interface {
	// Started will report that an operation started on the cloud.
	Started(message string, args ...interface{})

	// Succeeded will report that the last operation on the cloud has succeeded.
	Succeeded(message string, args ...interface{})

	// Failed will report that the last operation on the cloud has failed.
	Failed(errs ...error)
}

Reporter is responsible for reporting back on the progress of the cloud preparation.

func NewLoggingReporter

func NewLoggingReporter() Reporter