config

Documentation

Overview

Package config holds the typed objects that define the schemas for assorted ConfigMap objects on which the ClusterIngress controller depends.

Index

• Constants
• func ToContext(ctx context.Context, c *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) *Config
• type Gateway
  • func (in *Gateway) DeepCopy() *Gateway
  • func (in *Gateway) DeepCopyInto(out *Gateway)
  • func (g Gateway) QualifiedName() string
• type Istio
  • func NewIstioFromConfigMap(configMap *corev1.ConfigMap) (*Istio, error)
  • func (in *Istio) DeepCopy() *Istio
  • func (in *Istio) DeepCopyInto(out *Istio)
• type Store
  • func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store
  • func (s *Store) Load() *Config
  • func (s *Store) ToContext(ctx context.Context) context.Context

Constants

const (
	// IstioConfigName is the name of the configmap containing all
	// customizations for istio related features.
	IstioConfigName = "config-istio"

	// GatewayKeyPrefix is the prefix of all keys to configure Istio gateways for public ClusterIngresses.
	GatewayKeyPrefix = "gateway."

	// LocalGatewayKeyPrefix is the prefix of all keys to configure Istio gateways for public & private ClusterIngresses.
	LocalGatewayKeyPrefix = "local-gateway."

	// ReconcileExternalGatewayKey the is the name of the configuration entry that specifies
	// reconciling external Istio Gateways or not.
	ReconcileExternalGatewayKey = "reconcileExternalGateway"
)

Functions

func ToContext

func ToContext(ctx context.Context, c *Config) context.Context

ToContext adds config to given context.

Types

type Config

type Config struct {
	Istio   *Istio
	Network *network.Config
}

Config of Istio. +k8s:deepcopy-gen=false

func FromContext

func FromContext(ctx context.Context) *Config

FromContext fetch config from context.

type Gateway

type Gateway struct {
	Namespace  string
	Name       string
	ServiceURL string
}

Gateway specifies the name of the Gateway and the K8s Service backing it.

func (*Gateway) DeepCopy

func (in *Gateway) DeepCopy() *Gateway

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Gateway.

func (*Gateway) DeepCopyInto

func (in *Gateway) DeepCopyInto(out *Gateway)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Gateway) QualifiedName

func (g Gateway) QualifiedName() string

QualifiedName returns gateway name in '{namespace}/{name}' format.

type Istio

type Istio struct {
	// IngressGateway specifies the gateway urls for public ClusterIngress.
	IngressGateways []Gateway

	// LocalGateway specifies the gateway urls for public & private ClusterIngress.
	LocalGateways []Gateway

	// ReconcileExternalGateway specifies if external Istio Gateways will be reconciled or not.
	ReconcileExternalGateway bool
}

Istio contains istio related configuration defined in the istio config map.

func NewIstioFromConfigMap

func NewIstioFromConfigMap(configMap *corev1.ConfigMap) (*Istio, error)

NewIstioFromConfigMap creates an Istio config from the supplied ConfigMap

func (*Istio) DeepCopy

func (in *Istio) DeepCopy() *Istio

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Istio.

func (*Istio) DeepCopyInto

func (in *Istio) DeepCopyInto(out *Istio)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Store

type Store struct {
	*configmap.UntypedStore
}

Store is configmap.UntypedStore based config store. +k8s:deepcopy-gen=false

func NewStore

func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store

NewStore creates a configmap.UntypedStore based config store.

logger must be non-nil implementation of configmap.Logger (commonly used loggers conform)

onAfterStore is a variadic list of callbacks to run after the ConfigMap has been processed and stored.

See also: configmap.NewUntypedStore().

func (*Store) Load

func (s *Store) Load() *Config

Load fetches config from Store.

func (*Store) ToContext

func (s *Store) ToContext(ctx context.Context) context.Context

ToContext adds Store contents to given context.