common

Documentation

Index

• Constants
• func GetCurrentNamespace(fallback string) string

Constants

const (
	KeyImageName        = "a01.reserved.imagename"
	KeyImagePullSecret  = "a01.reserved.imagepullsecret"
	KeySecretName       = "a01.reserved.secret"
	KeyStorageShare     = "a01.reserved.storageshare"
	KeyTestQuery        = "a01.reserved.testquery"
	KeyTestExcludeQuery = "a01.reserved.testexcludequery"
	KeyUserEmail        = "a01.reserved.useremail"
	KeyRemark           = "a01.reserved.remark"
	KeyInitParallelism  = "a01.reserved.initparallelism"
	KeyLiveMode         = "a01.reserved.livemode"
	KeyTestModel        = "a01.reserved.testmode"
	KeyFromFailure      = "a01.reserved.fromrunfailure"
	KeyProduct          = "a01.reserved.product"
	KeyAgentVersion     = "a01.reserved.agentver"
	KeyRunID            = "a01.reserved.runid"
	KeyJobName          = "a01.reserved.jobname"
	KeyTaskLogPath      = "a01.reserved.tasklogpath"
	KeyTaskRecordPath   = "a01.reserved.taskrecordpath"
)

Defines the reserved task settings keys

const (
	// EnvKeyStoreName stores store service's host name and path prefix
	EnvKeyStoreName = "A01_STORE_NAME"

	// EnvKeyInternalCommunicationKey stores the internal communication authorization header value
	EnvKeyInternalCommunicationKey = "A01_INTERNAL_COMKEY"

	// EnvKeyRunID stores the current run ID
	EnvKeyRunID = "A01_DROID_RUN_ID"

	// EnvPodName stores the current pod name
	EnvPodName = "ENV_POD_NAME"

	// EnvNodeName stores the current node name
	EnvNodeName = "ENV_NODE_NAME"

	// EnvJobName stores the parent job name if a pod is created in a job
	EnvJobName = "ENV_JOB_NAME"
)

const (
	StorageVolumeNameArtifacts = "artifacts-storage"
	StorageVolumeNameSecrets   = "secrets-storage"
	StorageVolumeNameTools     = "tools-storage"
	DNSNameTaskStore           = "data-store-svc"
	DNSNameEmailService        = "email-report-svc"
	DNSNameReportService       = "report-internal-svc"
	SecretNameAgents           = "agent-secrets"
	SystemConfigMapName        = "a01-system-config"
)

Defines well-known names in the A01 system

const (
	// RunStatusInitialized is set when a run is just created
	RunStatusInitialized = "Initialized"

	// RunStatusPublished is set when tasks are added to the task broker queue
	RunStatusPublished = "Published"

	// RunStatusRunning is set when test job is created and start running
	RunStatusRunning = "Running"

	// RunStatusCompleted is set when all tasks are accomplished
	RunStatusCompleted = "Completed"
)

const (
	ConfigKeyEndpointTaskBroker    = "endpoint.taskbroker"
	ConfigKeyUsernameTaskBroker    = "username.taskbroker"
	ConfigKeyPasswordKeyTaskBroker = "password.taskbroker"
	ConfigKeySecretTaskBroker      = "secret.taskbroker"
)

Defines well-known keys in the a01 system config

const (
	PathMountArtifacts   = "/mnt/storage"
	PathMountSecrets     = "/mnt/secrets"
	PathMountTools       = "/mnt/tools"
	PathScriptPreparePod = "/app/prepare_pod"
	PathScriptAfterTest  = "/app/after_test"
	PathScriptGetIndex   = "/app/get_index"
	PathMetadataYml      = "/app/metadata.yml"
)

Defines the well know paths on the image

const (
	PathKubeNamespace = "/var/run/secrets/kubernetes.io/serviceaccount/namespace"
)

Defines the Kubernetes specific paths

const (
	// PathTemplateTaskLog defines the relative path of a task's log file in a file share.
	// It is <run_id>/task_<task_id>.log
	PathTemplateTaskLog = "%d/task_%d.log"
)

Defines the path template for logs

const (
	ProductSecretKeyLogPathTemplate = "log.path.template"
)

Defines well-known keys in a product specific secret

Functions

func GetCurrentNamespace

func GetCurrentNamespace(fallback string) string

GetCurrentNamespace returns the namespace this Pod belongs to. If it fails to resolve the name, it uses the fallback name.