environment

package
v1.3.3 Latest Latest
Warning

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

 Go to latest Published: May 16, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	CatalogConnectorServiceAddressKey string = "CATALOG_CONNECTOR_URL"
	StorageManagerAddressKey          string = "STORAGE_MANAGER_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"
	CSPArgsKey                        string = "CSP_ARGS"
	DataDir                           string = "DATA_DIR"
	ModuleNamespace                   string = "MODULES_NAMESPACE"
	ControllerNamespace               string = "CONTROLLER_NAMESPACE"
	ApplicationNamespace              string = "APPLICATION_NAMESPACE"
	AdminCRsNamespace                 string = "ADMIN_CRS_NAMESPACE"
	InternalCRsNamespace              string = "INTERNAL_CRS_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"
	DiscoveryBurst                    string = "DISCOVERY_BURST"
	DiscoveryQPS                      string = "DISCOVERY_QPS"
)

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

View Source 
const DefaultControllerNamespace = "fybrik-system"

DefaultControllerNamespace defines a default namespace where fybrik control plane is running

View Source 
const DefaultModulesNamespace = "fybrik-blueprints"

DefaultModulesNamespace defines a default namespace where module resources will be allocated

Variables

This section is empty.

Functions

func GetAdminCRsNamespace added in v1.3.0 

func GetAdminCRsNamespace() string

func GetApplicationNamespace added in v1.0.0 

func GetApplicationNamespace() string

func GetCSPArgs added in v1.3.0 

func GetCSPArgs() string

GetCSPArgs returns CSP solver arguments

func GetCSPPath added in v1.0.0 

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 GetCatalogProvider added in v1.3.2 

func GetCatalogProvider() string

func GetControllerNamespace added in v1.0.0 

func GetControllerNamespace() string

func GetDataCatalogServiceAddress added in v1.0.0 

func GetDataCatalogServiceAddress() string

GetDataCatalogServiceAddress returns the address where data catalog is running

func GetDataDir added in v1.0.0 

func GetDataDir() string

GetDataDir returns the directory where the data resides.

func GetDataPathMaxSize added in v1.0.0 

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 added in v1.0.0 

func GetDefaultModulesNamespace() string

func GetDiscoveryBurst added in v1.2.0 

func GetDiscoveryBurst() (int, error)

GetDiscoveryBurst returns the K8s discovery burst value if it is set, otherwise it returns -1

func GetDiscoveryQPS added in v1.2.0 

func GetDiscoveryQPS() (float32, error)

GetDiscoveryQPS returns the K8s discovery QPS value if it is set, otherwise it returns -1

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 GetInternalCRsNamespace added in v1.3.0 

func GetInternalCRsNamespace() string

func GetLocalClusterName added in v1.0.0 

func GetLocalClusterName() string

func GetLocalRegion added in v1.0.0 

func GetLocalRegion() string

func GetLocalVaultAuthPath added in v1.0.0 

func GetLocalVaultAuthPath() string

func GetLocalZone added in v1.0.0 

func GetLocalZone() string

func GetMinTLSVersion added in v1.1.0 

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 added in v1.0.0 

func GetModulesRole() string

GetModulesRole returns the modules assigned authentication role for accessing dataset credentials

func GetResourcesPollingInterval added in v1.1.0 

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 GetStorageManagerAddress added in v1.3.0 

func GetStorageManagerAddress() string

GetStorageManagerAddress returns the address of storage manager

func GetVaultAddress added in v1.0.0 

func GetVaultAddress() string

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

func IsUsingMTLS added in v1.0.0 

func IsUsingMTLS() bool

IsUsingMTLS returns true if the connector communication should use mtls.

func IsUsingTLS added in v1.0.0 

func IsUsingTLS() bool

IsUsingTLS returns true if the connector communication should use tls.

func IsVaultEnabled added in v1.0.0 

func IsVaultEnabled() bool

func LogEnvVariables added in v1.0.0 

func LogEnvVariables(log *zerolog.Logger)

func MustGetEnv added in v0.6.0 

func MustGetEnv(key string) (string, error)

func UseCSP added in v1.0.0 

func UseCSP() bool

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

Types

This section is empty.

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.