External module "goal/container/util"

Index

Functions

Functions

containerEnvVars

containerEnvVars(goalEvent: SdmGoalEvent, ctx: SdmContext): Promise<Array<object>>

- Defined in goal/container/util.ts:45
Return environment variables required by the container goal execution machinery.

Parameters
- goalEvent: SdmGoalEvent
  
  SDM goal event being executed as a container goal
- ctx: SdmContext
  
  SDM context for goal execution
Returns Promise<Array<object>>

SDM goal environment variables

copyProject

copyProject(src: string, dest: string): Promise<void>

- Defined in goal/container/util.ts:90
Copy cloned project to location that can be mounted into container. It ensures the destination direction exists and is empty. If it fails it throws an error and tries to ensure the destination directory does not exist.

Parameters
- src: string
  
  Location of project directory
- dest: string
  
  Location to copy project to
Returns Promise<void>

loglog

loglog(msg: string, l: LeveledLogMethod, p: ProgressLog): void

- Defined in goal/container/util.ts:117
Write to client and progress logs. Add newline to progress log.

Parameters
- msg: string
  
  Message to write, should not have newline at end
- l: LeveledLogMethod
  
  Logger method, e.g., logger.warn
- p: ProgressLog
  
  Progress log
Returns void

runningInK8s

runningInK8s(): boolean

- Defined in goal/container/util.ts:33
Simple test to see if SDM is running in Kubernetes. It is called from a non-async function, so it must be non-async.

Returns boolean

true if process is running in Kubernetes, false otherwise.

Generated using TypeDoc