configurator

package
v0.9.2-rc.1 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2021 License: Apache-2.0 Imports: 16 Imported by: 4

Documentation

Overview

Package configurator is a generated GoMock package.

Package configurator implements the Configurator interface that provides APIs to retrieve OSM control plane configurations.

Index

Constants

View Source 
const (

	// DefaultMeshConfigName is the default name of MeshConfig object
	DefaultMeshConfigName = "osm-mesh-config"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client is the k8s client struct for the MeshConfig CRD.

func (*Client) GetConfigResyncInterval added in v0.8.1 

func (c *Client) GetConfigResyncInterval() time.Duration

GetConfigResyncInterval returns the duration for resync interval. If error or non-parsable value, returns 0 duration

func (*Client) GetEnvoyImage added in v0.9.0 

func (c *Client) GetEnvoyImage() string

GetEnvoyImage returns the envoy image

func (*Client) GetEnvoyLogLevel added in v0.3.0 

func (c *Client) GetEnvoyLogLevel() string

GetEnvoyLogLevel returns the envoy log level

func (*Client) GetFeatureFlags added in v0.9.1 

func (c *Client) GetFeatureFlags() v1alpha1.FeatureFlags

GetFeatureFlags returns OSM's feature flags

func (*Client) GetInboundExternalAuthConfig added in v0.8.4 

func (c *Client) GetInboundExternalAuthConfig() auth.ExtAuthConfig

GetInboundExternalAuthConfig returns the External Authentication configuration for incoming traffic, if any

func (*Client) GetInboundPortExclusionList added in v0.9.1 

func (c *Client) GetInboundPortExclusionList() []int

GetInboundPortExclusionList returns the list of ports (positive integers) to exclude from inbound sidecar interception

func (*Client) GetInitContainerImage added in v0.9.0 

func (c *Client) GetInitContainerImage() string

GetInitContainerImage returns the init container image

func (*Client) GetMaxDataPlaneConnections added in v0.9.0 

func (c *Client) GetMaxDataPlaneConnections() int

GetMaxDataPlaneConnections returns the max data plane connections allowed, 0 if disabled

func (*Client) GetMeshConfigJSON added in v0.9.0 

func (c *Client) GetMeshConfigJSON() (string, error)

GetMeshConfigJSON returns the MeshConfig in pretty JSON.

func (*Client) GetOSMLogLevel added in v0.9.1 

func (c *Client) GetOSMLogLevel() string

GetOSMLogLevel returns the configured OSM log level

func (*Client) GetOSMNamespace 

func (c *Client) GetOSMNamespace() string

GetOSMNamespace returns the namespace in which the OSM controller pod resides.

func (*Client) GetOutboundIPRangeExclusionList added in v0.7.0 

func (c *Client) GetOutboundIPRangeExclusionList() []string

GetOutboundIPRangeExclusionList returns the list of IP ranges of the form x.x.x.x/y to exclude from outbound sidecar interception

func (*Client) GetOutboundPortExclusionList added in v0.9.0 

func (c *Client) GetOutboundPortExclusionList() []int

GetOutboundPortExclusionList returns the list of ports (positive integers) to exclude from outbound sidecar interception

func (*Client) GetProxyResources added in v0.9.0 

func (c *Client) GetProxyResources() corev1.ResourceRequirements

GetProxyResources returns the `Resources` configured for proxies, if any

func (*Client) GetServiceCertValidityPeriod added in v0.4.2 

func (c *Client) GetServiceCertValidityPeriod() time.Duration

GetServiceCertValidityPeriod returns the validity duration for service certificates, and a default in case of invalid duration

func (*Client) GetTracingEndpoint added in v0.4.0 

func (c *Client) GetTracingEndpoint() string

GetTracingEndpoint returns the listener's collector endpoint

func (*Client) GetTracingHost added in v0.4.0 

func (c *Client) GetTracingHost() string

GetTracingHost is the host to which we send tracing spans

func (*Client) GetTracingPort added in v0.4.0 

func (c *Client) GetTracingPort() uint32

GetTracingPort returns the tracing listener port

func (*Client) IsDebugServerEnabled added in v0.4.2 

func (c *Client) IsDebugServerEnabled() bool

IsDebugServerEnabled determines whether osm debug HTTP server is enabled

func (*Client) IsEgressEnabled 

func (c *Client) IsEgressEnabled() bool

IsEgressEnabled determines whether egress is globally enabled in the mesh or not.

func (*Client) IsPermissiveTrafficPolicyMode 

func (c *Client) IsPermissiveTrafficPolicyMode() bool

IsPermissiveTrafficPolicyMode tells us whether the OSM Control Plane is in permissive mode, where all existing traffic is allowed to flow as it is, or it is in SMI Spec mode, in which only traffic between source/destinations referenced in SMI policies is allowed.

func (*Client) IsPrivilegedInitContainer added in v0.8.0 

func (c *Client) IsPrivilegedInitContainer() bool

IsPrivilegedInitContainer returns whether init containers should be privileged

func (*Client) IsTracingEnabled added in v0.4.0 

func (c *Client) IsTracingEnabled() bool

IsTracingEnabled returns whether tracing is enabled

func (*Client) UseHTTPSIngress 

func (c *Client) UseHTTPSIngress() bool

UseHTTPSIngress determines whether traffic between ingress and backend pods should use HTTPS protocol

type Configurator 

type Configurator interface {
	// GetOSMNamespace returns the namespace in which OSM controller pod resides
	GetOSMNamespace() string

	// GetMeshConfigJSON returns the MeshConfig in pretty JSON (human readable)
	GetMeshConfigJSON() (string, error)

	// IsPermissiveTrafficPolicyMode determines whether we are in "allow-all" mode or SMI policy (block by default) mode
	IsPermissiveTrafficPolicyMode() bool

	// IsEgressEnabled determines whether egress is globally enabled in the mesh or not
	IsEgressEnabled() bool

	// IsDebugServerEnabled determines whether osm debug HTTP server is enabled
	IsDebugServerEnabled() bool

	// IsTracingEnabled returns whether tracing is enabled
	IsTracingEnabled() bool

	// GetTracingHost is the host to which we send tracing spans
	GetTracingHost() string

	// GetTracingPort returns the tracing listener port
	GetTracingPort() uint32

	// GetTracingEndpoint returns the collector endpoint
	GetTracingEndpoint() string

	// UseHTTPSIngress determines whether protocol used for traffic from ingress to backend pods should be HTTPS.
	UseHTTPSIngress() bool

	// GetMaxDataPlaneConnections returns the max data plane connections allowed, 0 if disabled
	GetMaxDataPlaneConnections() int

	// GetOsmLogLevel returns the configured OSM log level
	GetOSMLogLevel() string

	// GetEnvoyLogLevel returns the envoy log level
	GetEnvoyLogLevel() string

	// GetEnvoyImage returns the envoy image
	GetEnvoyImage() string

	// GetInitContainerImage returns the init container image
	GetInitContainerImage() string

	// GetServiceCertValidityPeriod returns the validity duration for service certificates
	GetServiceCertValidityPeriod() time.Duration

	// GetOutboundIPRangeExclusionList returns the list of IP ranges of the form x.x.x.x/y to exclude from outbound sidecar interception
	GetOutboundIPRangeExclusionList() []string

	// GetOutboundPortExclusionList returns the list of ports to exclude from outbound sidecar interception
	GetOutboundPortExclusionList() []int

	// GetInboundPortExclusionList returns the list of ports to exclude from inbound sidecar interception
	GetInboundPortExclusionList() []int

	// IsPrivilegedInitContainer determines whether init containers should be privileged
	IsPrivilegedInitContainer() bool

	// GetConfigResyncInterval returns the duration for resync interval.
	// If error or non-parsable value, returns 0 duration
	GetConfigResyncInterval() time.Duration

	// GetProxyResources returns the `Resources` configured for proxies, if any
	GetProxyResources() corev1.ResourceRequirements

	// GetInboundExternalAuthConfig returns the External Authentication configuration for incoming traffic, if any
	GetInboundExternalAuthConfig() auth.ExtAuthConfig

	// GetFeatureFlags returns OSM's feature flags
	GetFeatureFlags() v1alpha1.FeatureFlags
}

Configurator is the controller interface for K8s namespaces

func NewConfigurator 

func NewConfigurator(kubeClient versioned.Interface, stop <-chan struct{}, osmNamespace, meshConfigName string) Configurator

NewConfigurator implements configurator.Configurator and creates the Kubernetes client to manage namespaces.

type MockConfigurator added in v0.4.0 

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

MockConfigurator is a mock of Configurator interface

func NewMockConfigurator added in v0.4.0 

func NewMockConfigurator(ctrl *gomock.Controller) *MockConfigurator

NewMockConfigurator creates a new mock instance

func (*MockConfigurator) EXPECT added in v0.4.0 

func (m *MockConfigurator) EXPECT() *MockConfiguratorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockConfigurator) GetConfigResyncInterval added in v0.8.1 

func (m *MockConfigurator) GetConfigResyncInterval() time.Duration

GetConfigResyncInterval mocks base method

func (*MockConfigurator) GetEnvoyImage added in v0.9.0 

func (m *MockConfigurator) GetEnvoyImage() string

GetEnvoyImage mocks base method

func (*MockConfigurator) GetEnvoyLogLevel added in v0.4.0 

func (m *MockConfigurator) GetEnvoyLogLevel() string

GetEnvoyLogLevel mocks base method

func (*MockConfigurator) GetFeatureFlags added in v0.9.1 

func (m *MockConfigurator) GetFeatureFlags() v1alpha1.FeatureFlags

GetFeatureFlags mocks base method

func (*MockConfigurator) GetInboundExternalAuthConfig added in v0.8.4 

func (m *MockConfigurator) GetInboundExternalAuthConfig() auth.ExtAuthConfig

GetInboundExternalAuthConfig mocks base method

func (*MockConfigurator) GetInboundPortExclusionList added in v0.9.1 

func (m *MockConfigurator) GetInboundPortExclusionList() []int

GetInboundPortExclusionList mocks base method

func (*MockConfigurator) GetInitContainerImage added in v0.9.0 

func (m *MockConfigurator) GetInitContainerImage() string

GetInitContainerImage mocks base method

func (*MockConfigurator) GetMaxDataPlaneConnections added in v0.9.0 

func (m *MockConfigurator) GetMaxDataPlaneConnections() int

GetMaxDataPlaneConnections mocks base method

func (*MockConfigurator) GetMeshConfigJSON added in v0.9.0 

func (m *MockConfigurator) GetMeshConfigJSON() (string, error)

GetMeshConfigJSON mocks base method

func (*MockConfigurator) GetOSMLogLevel added in v0.9.1 

func (m *MockConfigurator) GetOSMLogLevel() string

GetOSMLogLevel mocks base method

func (*MockConfigurator) GetOSMNamespace added in v0.4.0 

func (m *MockConfigurator) GetOSMNamespace() string

GetOSMNamespace mocks base method

func (*MockConfigurator) GetOutboundIPRangeExclusionList added in v0.7.0 

func (m *MockConfigurator) GetOutboundIPRangeExclusionList() []string

GetOutboundIPRangeExclusionList mocks base method

func (*MockConfigurator) GetOutboundPortExclusionList added in v0.9.0 

func (m *MockConfigurator) GetOutboundPortExclusionList() []int

GetOutboundPortExclusionList mocks base method

func (*MockConfigurator) GetProxyResources added in v0.9.0 

func (m *MockConfigurator) GetProxyResources() v1.ResourceRequirements

GetProxyResources mocks base method

func (*MockConfigurator) GetServiceCertValidityPeriod added in v0.4.2 

func (m *MockConfigurator) GetServiceCertValidityPeriod() time.Duration

GetServiceCertValidityPeriod mocks base method

func (*MockConfigurator) GetTracingEndpoint added in v0.4.0 

func (m *MockConfigurator) GetTracingEndpoint() string

GetTracingEndpoint mocks base method

func (*MockConfigurator) GetTracingHost added in v0.4.0 

func (m *MockConfigurator) GetTracingHost() string

GetTracingHost mocks base method

func (*MockConfigurator) GetTracingPort added in v0.4.0 

func (m *MockConfigurator) GetTracingPort() uint32

GetTracingPort mocks base method

func (*MockConfigurator) IsDebugServerEnabled added in v0.4.2 

func (m *MockConfigurator) IsDebugServerEnabled() bool

IsDebugServerEnabled mocks base method

func (*MockConfigurator) IsEgressEnabled added in v0.4.0 

func (m *MockConfigurator) IsEgressEnabled() bool

IsEgressEnabled mocks base method

func (*MockConfigurator) IsPermissiveTrafficPolicyMode added in v0.4.0 

func (m *MockConfigurator) IsPermissiveTrafficPolicyMode() bool

IsPermissiveTrafficPolicyMode mocks base method

func (*MockConfigurator) IsPrivilegedInitContainer added in v0.8.0 

func (m *MockConfigurator) IsPrivilegedInitContainer() bool

IsPrivilegedInitContainer mocks base method

func (*MockConfigurator) IsTracingEnabled added in v0.4.0 

func (m *MockConfigurator) IsTracingEnabled() bool

IsTracingEnabled mocks base method

func (*MockConfigurator) UseHTTPSIngress added in v0.4.0 

func (m *MockConfigurator) UseHTTPSIngress() bool

UseHTTPSIngress mocks base method

type MockConfiguratorMockRecorder added in v0.4.0 

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

MockConfiguratorMockRecorder is the mock recorder for MockConfigurator

func (*MockConfiguratorMockRecorder) GetConfigResyncInterval added in v0.8.1 

func (mr *MockConfiguratorMockRecorder) GetConfigResyncInterval() *gomock.Call

GetConfigResyncInterval indicates an expected call of GetConfigResyncInterval

func (*MockConfiguratorMockRecorder) GetEnvoyImage added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetEnvoyImage() *gomock.Call

GetEnvoyImage indicates an expected call of GetEnvoyImage

func (*MockConfiguratorMockRecorder) GetEnvoyLogLevel added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) GetEnvoyLogLevel() *gomock.Call

GetEnvoyLogLevel indicates an expected call of GetEnvoyLogLevel

func (*MockConfiguratorMockRecorder) GetFeatureFlags added in v0.9.1 

func (mr *MockConfiguratorMockRecorder) GetFeatureFlags() *gomock.Call

GetFeatureFlags indicates an expected call of GetFeatureFlags

func (*MockConfiguratorMockRecorder) GetInboundExternalAuthConfig added in v0.8.4 

func (mr *MockConfiguratorMockRecorder) GetInboundExternalAuthConfig() *gomock.Call

GetInboundExternalAuthConfig indicates an expected call of GetInboundExternalAuthConfig

func (*MockConfiguratorMockRecorder) GetInboundPortExclusionList added in v0.9.1 

func (mr *MockConfiguratorMockRecorder) GetInboundPortExclusionList() *gomock.Call

GetInboundPortExclusionList indicates an expected call of GetInboundPortExclusionList

func (*MockConfiguratorMockRecorder) GetInitContainerImage added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetInitContainerImage() *gomock.Call

GetInitContainerImage indicates an expected call of GetInitContainerImage

func (*MockConfiguratorMockRecorder) GetMaxDataPlaneConnections added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetMaxDataPlaneConnections() *gomock.Call

GetMaxDataPlaneConnections indicates an expected call of GetMaxDataPlaneConnections

func (*MockConfiguratorMockRecorder) GetMeshConfigJSON added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetMeshConfigJSON() *gomock.Call

GetMeshConfigJSON indicates an expected call of GetMeshConfigJSON

func (*MockConfiguratorMockRecorder) GetOSMLogLevel added in v0.9.1 

func (mr *MockConfiguratorMockRecorder) GetOSMLogLevel() *gomock.Call

GetOSMLogLevel indicates an expected call of GetOSMLogLevel

func (*MockConfiguratorMockRecorder) GetOSMNamespace added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) GetOSMNamespace() *gomock.Call

GetOSMNamespace indicates an expected call of GetOSMNamespace

func (*MockConfiguratorMockRecorder) GetOutboundIPRangeExclusionList added in v0.7.0 

func (mr *MockConfiguratorMockRecorder) GetOutboundIPRangeExclusionList() *gomock.Call

GetOutboundIPRangeExclusionList indicates an expected call of GetOutboundIPRangeExclusionList

func (*MockConfiguratorMockRecorder) GetOutboundPortExclusionList added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetOutboundPortExclusionList() *gomock.Call

GetOutboundPortExclusionList indicates an expected call of GetOutboundPortExclusionList

func (*MockConfiguratorMockRecorder) GetProxyResources added in v0.9.0 

func (mr *MockConfiguratorMockRecorder) GetProxyResources() *gomock.Call

GetProxyResources indicates an expected call of GetProxyResources

func (*MockConfiguratorMockRecorder) GetServiceCertValidityPeriod added in v0.4.2 

func (mr *MockConfiguratorMockRecorder) GetServiceCertValidityPeriod() *gomock.Call

GetServiceCertValidityPeriod indicates an expected call of GetServiceCertValidityPeriod

func (*MockConfiguratorMockRecorder) GetTracingEndpoint added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) GetTracingEndpoint() *gomock.Call

GetTracingEndpoint indicates an expected call of GetTracingEndpoint

func (*MockConfiguratorMockRecorder) GetTracingHost added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) GetTracingHost() *gomock.Call

GetTracingHost indicates an expected call of GetTracingHost

func (*MockConfiguratorMockRecorder) GetTracingPort added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) GetTracingPort() *gomock.Call

GetTracingPort indicates an expected call of GetTracingPort

func (*MockConfiguratorMockRecorder) IsDebugServerEnabled added in v0.4.2 

func (mr *MockConfiguratorMockRecorder) IsDebugServerEnabled() *gomock.Call

IsDebugServerEnabled indicates an expected call of IsDebugServerEnabled

func (*MockConfiguratorMockRecorder) IsEgressEnabled added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) IsEgressEnabled() *gomock.Call

IsEgressEnabled indicates an expected call of IsEgressEnabled

func (*MockConfiguratorMockRecorder) IsPermissiveTrafficPolicyMode added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) IsPermissiveTrafficPolicyMode() *gomock.Call

IsPermissiveTrafficPolicyMode indicates an expected call of IsPermissiveTrafficPolicyMode

func (*MockConfiguratorMockRecorder) IsPrivilegedInitContainer added in v0.8.0 

func (mr *MockConfiguratorMockRecorder) IsPrivilegedInitContainer() *gomock.Call

IsPrivilegedInitContainer indicates an expected call of IsPrivilegedInitContainer

func (*MockConfiguratorMockRecorder) IsTracingEnabled added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) IsTracingEnabled() *gomock.Call

IsTracingEnabled indicates an expected call of IsTracingEnabled

func (*MockConfiguratorMockRecorder) UseHTTPSIngress added in v0.4.0 

func (mr *MockConfiguratorMockRecorder) UseHTTPSIngress() *gomock.Call

UseHTTPSIngress indicates an expected call of UseHTTPSIngress

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.