configurator

package
v1.2.4 Latest Latest
Warning

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

Go to latest
Published: Apr 20, 2023 License: Apache-2.0 Imports: 18 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

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client is the type used to represent the Kubernetes Client for the config.openservicemesh.io API group

func NewConfigurator

func NewConfigurator(informerCollection *informers.InformerCollection, osmNamespace, meshConfigName string, msgBroker *messaging.Broker) *Client

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

func (*Client) GetCertKeyBitSize added in v1.2.0

func (c *Client) GetCertKeyBitSize() int

GetCertKeyBitSize returns the certificate key bit size to be used

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) GetEnvoyWindowsImage added in v1.2.0

func (c *Client) GetEnvoyWindowsImage() string

GetEnvoyWindowsImage returns the envoy windows image

func (*Client) GetFeatureFlags added in v0.9.1

func (c *Client) GetFeatureFlags() configv1alpha2.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) GetIngressGatewayCertValidityPeriod added in v1.2.0

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

GetIngressGatewayCertValidityPeriod returns the validity duration for ingress gateway certificates, and a default in case of unspecified or invalid duration

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) GetMeshConfig added in v1.2.0

func (c *Client) GetMeshConfig() configv1alpha2.MeshConfig

GetMeshConfig returns the MeshConfig resource corresponding to the control plane

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) 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

type Configurator

type Configurator interface {
	// GetMeshConfig returns the MeshConfig resource corresponding to the control plane
	GetMeshConfig() configv1alpha2.MeshConfig

	// 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

	// 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

	// GetEnvoyWindowsImage returns the envoy windows image
	GetEnvoyWindowsImage() string

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

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

	// GetIngressGatewayCertValidityPeriod returns the validity duration for the Ingress
	// Gateway certificate, default value if not specified
	GetIngressGatewayCertValidityPeriod() time.Duration

	// GetCertKeyBitSize returns the certificate key bit size
	GetCertKeyBitSize() 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() configv1alpha2.FeatureFlags
}

Configurator is the controller interface for K8s 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

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

func (*MockConfigurator) GetCertKeyBitSize added in v0.10.0

func (m *MockConfigurator) GetCertKeyBitSize() int

GetCertKeyBitSize mocks base method.

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) GetEnvoyWindowsImage added in v0.10.0

func (m *MockConfigurator) GetEnvoyWindowsImage() string

GetEnvoyWindowsImage mocks base method.

func (*MockConfigurator) GetFeatureFlags added in v0.9.1

func (m *MockConfigurator) GetFeatureFlags() v1alpha2.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) GetIngressGatewayCertValidityPeriod added in v1.2.0

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

GetIngressGatewayCertValidityPeriod 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) GetMeshConfig added in v0.10.0

func (m *MockConfigurator) GetMeshConfig() v1alpha2.MeshConfig

GetMeshConfig 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) 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.

type MockConfiguratorMockRecorder added in v0.4.0

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

MockConfiguratorMockRecorder is the mock recorder for MockConfigurator.

func (*MockConfiguratorMockRecorder) GetCertKeyBitSize added in v0.10.0

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

GetCertKeyBitSize indicates an expected call of GetCertKeyBitSize.

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) GetEnvoyWindowsImage added in v0.10.0

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

GetEnvoyWindowsImage indicates an expected call of GetEnvoyWindowsImage.

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) GetIngressGatewayCertValidityPeriod added in v1.2.0

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

GetIngressGatewayCertValidityPeriod indicates an expected call of GetIngressGatewayCertValidityPeriod.

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) GetMeshConfig added in v0.10.0

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

GetMeshConfig indicates an expected call of GetMeshConfig.

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) 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL