Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "pack/k8s/container"

Index

Type aliases

K8sContainerSpecCallback

K8sContainerSpecCallback: (r: K8sContainerRegistration, p: GitProject, g: Container, e: SdmGoalEvent, ctx: RepoContext) => Promise<Omit<K8sContainerRegistration, "callback">>

Function signature for callback that can modify and return the ContainerRegistration object.

Type declaration

K8sGoalContainer

K8sGoalContainer: Merge<GoalContainer, V1Container> & Pick<GoalContainer, "name" | "image">

Merge of base and Kubernetes goal container interfaces.

K8sGoalContainerVolume

K8sGoalContainerVolume: Merge<V1Volume, GoalContainerVolume>

Merge of base and Kubernetes goal container volume interfaces.

Variables

Const K8sContainerFulfillerName

K8sContainerFulfillerName: "Kubernetes Container Goal Fulfiller" = "Kubernetes Container Goal Fulfiller"

Deterministic name for Kubernetes container goal fulfiller.

Functions

containerCleanup

Const containerExecutor

containerStarted

  • Wait for container in pod to start, return when it does.

    Parameters

    • container: K8sContainer

      Information about container to check

    • Default value attempts: number = 240

      Maximum number of attempts, waiting 500 ms between

    Returns Promise<void>

containerWatch

  • Watch pod until container container.name exits and its log stream is done being written to. Resolve promise with status if container container.name exits with status 0. If container exits with non-zero status, reject promise and includ pod status in the podStatus property of the error. If any other error occurs, e.g., a watch or log error or timeout exceeded, reject immediately upon receipt of error.

    Parameters

    • container: K8sContainer

      Information about container to watch

    • timeout: number

      Milliseconds to allow container to run

    Returns Promise<V1PodStatus>

    Status of pod after container terminates

executeK8sJob

k8sContainerFulfiller

Const k8sContainerScheduler

k8sFulfillmentCallback

Const k8sSkillContainerScheduler

Const scheduleK8sJob

Object literals

Const containerFulfillerCacheRestore

containerFulfillerCacheRestore: object

Restore cache input entries before fulfilling goal.

events

events: before[] = [GoalProjectListenerEvent.before]

name

name: string = "cache restore"

listener

Generated using TypeDoc