gateways

Documentation

Index

• Constants
• func MergeDeployment(existing, desired *appsv1.Deployment)
• func MergeService(existing, desired *corev1.Service)
• func NewGatewayBuilder[T Gateway](gateway T, gatewayConfig GatewayConfig, ...) *gatewayBuilder[T]
• type Gateway
• type GatewayConfig
• type GatewayResources

Constants

const (
	MeshGatewayAnnotationKind = "mesh-gateway"
	APIGatewayAnnotationKind  = "api-gateway"
)

Functions

func MergeDeployment

func MergeDeployment(existing, desired *appsv1.Deployment)

MergeDeployment is used to update an appsv1.Deployment without overwriting any existing annotations or labels that were placed there by other vendors.

based on https://github.com/kubernetes-sigs/controller-runtime/blob/4000e996a202917ad7d40f02ed8a2079a9ce25e9/pkg/controller/controllerutil/example_test.go

func MergeService

func MergeService(existing, desired *corev1.Service)

MergeService is used to update a corev1.Service without overwriting any existing annotations or labels that were placed there by other vendors.

based on https://github.com/kubernetes-sigs/controller-runtime/blob/4000e996a202917ad7d40f02ed8a2079a9ce25e9/pkg/controller/controllerutil/example_test.go

func NewGatewayBuilder

func NewGatewayBuilder[T Gateway](gateway T, gatewayConfig GatewayConfig, gatewayClassConfig *meshv2beta1.GatewayClassConfig, gatewayKind string) *gatewayBuilder[T]

NewGatewayBuilder returns a new meshGatewayBuilder for the given MeshGateway, GatewayConfig, and GatewayClassConfig.

Types

type Gateway

type Gateway interface {
	*meshv2beta1.MeshGateway | *meshv2beta1.APIGateway
	client.Object
	ListenersToServicePorts(int32) []corev1.ServicePort
	ListenersToContainerPorts(int32, int32) []corev1.ContainerPort
}

type GatewayConfig

type GatewayConfig struct {
	// ImageDataplane is the Consul Dataplane image to use in gateway deployments.
	ImageDataplane string
	// ImageConsulK8S is the Consul Kubernetes Control Plane image to use in gateway deployments.
	ImageConsulK8S string
	// AuthMethod method used to authenticate with Consul Server.
	AuthMethod string

	// ConsulTenancyConfig is the configuration for the Consul Tenancy feature.
	ConsulTenancyConfig common.ConsulTenancyConfig

	// LogLevel is the logging level of the deployed Consul Dataplanes.
	LogLevel string
	// LogJSON if JSONLogging has been enabled.
	LogJSON bool
	// TLSEnabled is the value of whether or not TLS has been enabled in Consul.
	TLSEnabled bool
	// PeeringEnabled toggles whether or not Peering is enabled in Consul.
	PeeringEnabled bool
	// ConsulTLSServerName the name of the server running TLS.
	ConsulTLSServerName string
	// ConsulCACert contains the Consul Certificate Authority.
	ConsulCACert string
	// ConsulConfig configuration for the consul server address.
	ConsulConfig common.ConsulConfig

	// EnableOpenShift indicates whether we're deploying into an OpenShift environment
	EnableOpenShift bool

	// MapPrivilegedServicePorts is the value which Consul will add to privileged container port values (ports < 1024)
	// defined on a Gateway.
	MapPrivilegedServicePorts int

	// TODO(nathancoleman) Add doc
	SkipServerWatch bool
}

GatewayConfig is a combination of settings relevant to Gateways.

type GatewayResources

type GatewayResources struct {
	// GatewayClassConfigs is a list of GatewayClassConfig resources which are
	// responsible for defining configuration shared across all gateway kinds.
	GatewayClassConfigs []*v2beta1.GatewayClassConfig `json:"gatewayClassConfigs"`
	// MeshGateways is a list of MeshGateway resources which are responsible for
	// defining the configuration for a specific mesh gateway.
	// Deployments of mesh gateways have a one-to-one relationship with MeshGateway resources.
	MeshGateways []*v2beta1.MeshGateway `json:"meshGateways"`
}

GatewayResources is a collection of Kubernetes resources for a Gateway.