External module "goal/container/k8s"

Index

Interfaces

Type aliases

K8sContainerSpecCallback

Functions

Type aliases

K8sContainerSpecCallback

K8sContainerSpecCallback: function

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

Type declaration

- (r: K8sContainerRegistration, p: GitProject, g: Container, e: SdmGoalEvent, c: HandlerContext): Promise<K8sGoalContainerSpec>
- Parameters
  - r: K8sContainerRegistration
  - p: GitProject
  - g: Container
  - e: SdmGoalEvent
  - c: HandlerContext
  Returns Promise<K8sGoalContainerSpec>

Functions

containerStarted

containerStarted(container: K8sContainer, attempts?: number): Promise<void>

- Defined in goal/container/k8s.ts:343
Wait for container in pod to start, return when it does.

Parameters
- container: K8sContainer
  
  Information about container to check
- Default value attempts: number = 120
  
  Maximum number of attempts, waiting 500 ms between
Returns Promise<void>

containerWatch

containerWatch(container: K8sContainer): Promise<V1PodStatus>

- Defined in goal/container/k8s.ts:379
Watch pod until container container.name exits. Resolve promise with status if container container.name exits with status 0. Reject promise otherwise, including pod status in the podStatus property of the error.

Parameters
- container: K8sContainer
  
  Information about container to watch
Returns Promise<V1PodStatus>

Status of pod after container terminates

executeK8sJob

executeK8sJob(goal: Container, registration: K8sContainerRegistration): ExecuteGoal

- Defined in goal/container/k8s.ts:243
Wait for first container to exit and stream its logs to the progress log.

Parameters
- goal: Container
- registration: K8sContainerRegistration
Returns ExecuteGoal

followK8sLog

followK8sLog(container: K8sContainer): Request

- Defined in goal/container/k8s.ts:426
Set up log follower for container.

Parameters
- container: K8sContainer
Returns Request

Const k8sContainerScheduler

k8sContainerScheduler(goal: Container, registration: K8sContainerRegistration): void

- Defined in goal/container/k8s.ts:123
Parameters
- goal: Container
- registration: K8sContainerRegistration
Returns void

k8sFulfillmentCallback

k8sFulfillmentCallback(goal: Container, registration: K8sContainerRegistration): function

- Defined in goal/container/k8s.ts:140
Add Kubernetes job scheduling information to SDM goal event data for use by the KubernetesGoalScheduler.

Parameters
- goal: Container
- registration: K8sContainerRegistration
Returns function
- - (sge: SdmGoalEvent, rc: RepoContext): Promise<SdmGoalEvent>
  - Parameters
    - sge: SdmGoalEvent
    - rc: RepoContext
    Returns Promise<SdmGoalEvent>

Generated using TypeDoc