env

Documentation

Index

• Variables
• func VerifyDaemonEnvs() error
• func VerifyIterumEnvs() error
• func VerifyMessageQueueEnvs() error
• func VerifyMinioEnvs() error
• type EnvironmentError
  • func ErrEnvironment(variable, value string) *EnvironmentError
  • func (err *EnvironmentError) Error() string
  • func (err *EnvironmentError) Unwrap() error

Variables

var DaemonCommitHash = os.Getenv(daemonCommitHashEnv)

DaemonCommitHash is the hash of the idv dataset commit to use

var DaemonDataset = os.Getenv(daemonDatasetEnv)

DaemonDataset is the idv dataset to use

var DaemonURL = os.Getenv(daemonURLEnv)

DaemonURL is the URL at which to reach the idv daemon

var DataVolumePath = os.Getenv(dataVolumePathEnv)

DataVolumePath is the path to the shared volume within this pod

var MQBrokerURL = os.Getenv(mqBrokerURLEnv)

MQBrokerURL is the url at which we can reach the message queueing system

var MQInputQueue = os.Getenv(mqInputQueueEnv)

MQInputQueue is the queue from which we pull the remote fragment descriptions

var MQOutputQueue = os.Getenv(mqOutputQueueEnv)

MQOutputQueue is the queue into which we push the remote fragment descriptions

var ManagerURL = os.Getenv(managerURLEnv)

ManagerURL is the url at which we can reach this pipeline's manager

var MinioAccessKey = os.Getenv(minioAccessKeyEnv)

MinioAccessKey is the access key for minio

var MinioSecretKey = os.Getenv(minioSecretKeyEnv)

MinioSecretKey is the secret access key for minio

var MinioTargetBucket = os.Getenv(minioTargetBucketEnv)

MinioTargetBucket is the bucket to which storage should go

var MinioURL = os.Getenv(minioURLEnv)

MinioURL is the url at which the minio client can be reached

var MinioUseSSL = os.Getenv(minioUseSSLEnv)

MinioUseSSL is a string val denoting whether minio client uses SSL

var PipelineHash = os.Getenv(pipelineHashEnv)

PipelineHash is the hash associated with this pipeline run

var ProcessConfig = os.Getenv(configEnv)

ProcessConfig contains a stringified JSON object containing config for the target (allowed to be empty)

var ProcessName = os.Getenv(nameEnv)

ProcessName is the name (user defined) for this transformation step/fragmenter/etc

Functions

func VerifyDaemonEnvs

func VerifyDaemonEnvs() error

VerifyDaemonEnvs checks whether each of the environment variables returned a non-empty value

func VerifyIterumEnvs

func VerifyIterumEnvs() error

VerifyIterumEnvs checks whether each of the environment variables returned a non-empty value

func VerifyMessageQueueEnvs

func VerifyMessageQueueEnvs() error

VerifyMessageQueueEnvs checks whether each of the environment variables returned a non-empty value

func VerifyMinioEnvs

func VerifyMinioEnvs() error

VerifyMinioEnvs checks whether each of the environment variables returned a non-empty value

Types

type EnvironmentError

type EnvironmentError struct {
	Variable string
	Value    string
}

EnvironmentError is raised when an environment variable that is verified turns up empty

func ErrEnvironment

func ErrEnvironment(variable, value string) *EnvironmentError

ErrEnvironment is used to raise a EnvironmentError

func (*EnvironmentError) Error

func (err *EnvironmentError) Error() string

func (*EnvironmentError) Unwrap

func (err *EnvironmentError) Unwrap() error