Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "core/goal/container/util"

Index

Variables

Build

Build: any

Functions

containerEnvVars

  • containerEnvVars(goalEvent: SdmGoalEvent, ctx: SdmContext, projectDir?: string, inputDir?: string, outputDir?: string): Promise<Array<{ name: string; value: string }>>
  • 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

    • Default value projectDir: string = ContainerProjectHome
    • Default value inputDir: string = ContainerInput
    • Default value outputDir: string = ContainerOutput

    Returns Promise<Array<{ name: string; value: string }>>

    SDM goal environment variables

convertData

  • convertData(data: any): string

prepareInputAndOutput

processResult

runningAsGoogleCloudFunction

  • runningAsGoogleCloudFunction(): boolean
  • Simple test to see if SDM is running as a Google Cloud Function.

    Returns boolean

    true if process is running as Google Cloud Function, false otherwise.

runningInK8s

  • runningInK8s(): boolean
  • 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