environment

Documentation

Index

• Constants
• func GetApplicationNamespace() string
• func GetCSPPath() string
• func GetControllerNamespace() string
• func GetDataCatalogServiceAddress() string
• func GetDataDir() string
• func GetDataPathMaxSize() (int, error)
• func GetDefaultModulesNamespace() string
• func GetEnvAsFloat32(key string, defaultValue float32) float32
• func GetEnvAsInt(key string, defaultValue int) int
• func GetHelmWaitTimeout() (time.Duration, error)
• func GetLocalClusterName() string
• func GetLocalRegion() string
• func GetLocalVaultAuthPath() string
• func GetLocalZone() string
• func GetMinTLSVersion(log *zerolog.Logger) uint16
• func GetModulesRole() string
• func GetResourcesPollingInterval() (time.Duration, error)
• func GetSystemNamespace() string
• func GetVaultAddress() string
• func IsUsingMTLS() bool
• func IsUsingTLS() bool
• func IsVaultEnabled() bool
• func LogEnvVariables(log *zerolog.Logger)
• func MustGetEnv(key string) (string, error)
• func UseCSP() bool

Constants

const (
	CatalogConnectorServiceAddressKey string = "CATALOG_CONNECTOR_URL"
	VaultEnabledKey                   string = "VAULT_ENABLED"
	VaultAddressKey                   string = "VAULT_ADDRESS"
	VaultModulesRoleKey               string = "VAULT_MODULES_ROLE"
	EnableWebhooksKey                 string = "ENABLE_WEBHOOKS"
	MainPolicyManagerNameKey          string = "MAIN_POLICY_MANAGER_NAME"
	MainPolicyManagerConnectorURLKey  string = "MAIN_POLICY_MANAGER_CONNECTOR_URL"
	LoggingVerbosityKey               string = "LOGGING_VERBOSITY"
	PrettyLoggingKey                  string = "PRETTY_LOGGING"
	CatalogProviderNameKey            string = "CATALOG_PROVIDER_NAME"
	DatapathLimitKey                  string = "DATAPATH_LIMIT"
	UseCSPKey                         string = "USE_CSP"
	CSPPathKey                        string = "CSP_PATH"
	DataDir                           string = "DATA_DIR"
	ModuleNamespace                   string = "MODULES_NAMESPACE"
	ControllerNamespace               string = "CONTROLLER_NAMESPACE"
	ApplicationNamespace              string = "APPLICATION_NAMESPACE"
	UseTLS                            string = "USE_TLS"
	UseMTLS                           string = "USE_MTLS"
	MinTLSVersion                     string = "MIN_TLS_VERSION"
	LocalClusterName                  string = "ClusterName"
	LocalZone                         string = "Zone"
	LocalRegion                       string = "Region"
	LocalVaultAuthPath                string = "VaultAuthPath"
	ResourcesPollingInterval          string = "RESOURCE_POLLING_INTERVAL"
	HelmWaitTimeout                   string = "HELM_WAIT_TIMEOUT"
)

Attributes that are defined in a config map or the runtime environment

const DefaultControllerNamespace = "fybrik-system"

DefaultControllerNamespace defines a default namespace where fybrik control plane is running

const DefaultModulesNamespace = "fybrik-blueprints"

DefaultModulesNamespace defines a default namespace where module resources will be allocated

Functions

func GetApplicationNamespace

func GetApplicationNamespace() string

func GetCSPPath

func GetCSPPath() string

GetCSPPath returns the path of the CSP solver to use when generating a plotter, or "" if no CSP solver is defined

func GetControllerNamespace

func GetControllerNamespace() string

func GetDataCatalogServiceAddress

func GetDataCatalogServiceAddress() string

GetDataCatalogServiceAddress returns the address where data catalog is running

func GetDataDir

func GetDataDir() string

GetDataDir returns the directory where the data resides.

func GetDataPathMaxSize

func GetDataPathMaxSize() (int, error)

GetDataPathMaxSize bounds the data path size (number of modules that access data for read/write/copy, not including transformations) The function returns a default value if an error occurs or if DatapathLimitKey env var is undefined.

func GetDefaultModulesNamespace

func GetDefaultModulesNamespace() string

func GetEnvAsFloat32

func GetEnvAsFloat32(key string, defaultValue float32) float32

Returns the float32 value of an environment variable. If the environment variable is not set or cannot be parsed the default value is returned.

func GetEnvAsInt

func GetEnvAsInt(key string, defaultValue int) int

Returns the integer value of an environment variable. If the environment variable is not set or cannot be parsed the default value is returned.

func GetHelmWaitTimeout

func GetHelmWaitTimeout() (time.Duration, error)

GetHelmWaitTimeout returns the time to wait for helm operation on the resources deployed by the manager to complete. Currently used only in uninstall operation. The timeout is specified in seconds. The function returns a default value if an error occurs or if HelmWaitTimeout env var is undefined.

func GetLocalClusterName

func GetLocalClusterName() string

func GetLocalRegion

func GetLocalRegion() string

func GetLocalVaultAuthPath

func GetLocalVaultAuthPath() string

func GetLocalZone

func GetLocalZone() string

func GetMinTLSVersion

func GetMinTLSVersion(log *zerolog.Logger) uint16

GetMinTLSVersion returns the minimum TLS version that is acceptable. if not provided it returns zero which means that the system default value is used.

func GetModulesRole

func GetModulesRole() string

GetModulesRole returns the modules assigned authentication role for accessing dataset credentials

func GetResourcesPollingInterval

func GetResourcesPollingInterval() (time.Duration, error)

GetResourcesPollingInterval returns the time interval to check the status of the resources deployed by the manager. The interval is specified in milliseconds. The function returns a default value if an error occurs or if ResourcesPollingInterval env var is undefined.

func GetSystemNamespace

func GetSystemNamespace() string

GetSystemNamespace returns the namespace of control plane

func GetVaultAddress

func GetVaultAddress() string

GetVaultAddress returns the address and port of the vault system, which is used for managing data set credentials

func IsUsingMTLS

func IsUsingMTLS() bool

IsUsingMTLS returns true if the connector communication should use mtls.

func IsUsingTLS

func IsUsingTLS() bool

IsUsingTLS returns true if the connector communication should use tls.

func IsVaultEnabled

func IsVaultEnabled() bool

func LogEnvVariables

func LogEnvVariables(log *zerolog.Logger)

func MustGetEnv

func MustGetEnv(key string) (string, error)

func UseCSP

func UseCSP() bool

UseCSP return true if a CSP solver should be used when generating a plotter