Options
All
  • Public
  • Public/Protected
  • All
Menu

Module kube-interface/types

Type definitions for the kube-interface module.

Index

Type aliases

Type aliases

Delete

Delete: { apiVersion: string; kind: string; name: string; namespace?: string }

Parameters for KubeInterface.delete.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • name: string

    Kubernetes Resource name.

  • Optional namespace?: string

    Kubernetes Resource namespace.

Exec

Exec: { command: string[]; container: string; name: string; namespace: string }

Parameters for KubeInterface.exec.

Type declaration

  • command: string[]

    Command to execute.

  • container: string

    Kubernetes Pod container name.

  • name: string

    Kubernetes Resource name.

  • namespace: string

    Kubernetes Pod namespace.

Get

Get: { apiVersion: string; kind: string; name: string; namespace?: string }

Parameters for KubeInterface.get.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • name: string

    Kubernetes Resource name.

  • Optional namespace?: string

    Kubernetes Resource namespace.

KubeInterfaceOptions

KubeInterfaceOptions: { config?: KubeConfig | null; crds?: any[]; createCRDs?: boolean }

KubeInterface configuration.

Type declaration

  • Optional config?: KubeConfig | null

    KubeConfig to load (set to null to use the default one).

  • Optional crds?: any[]

    List of CustomResourceDefinition to load.

  • Optional createCRDs?: boolean

    If true, will create the CRDs if they do not exist on the Kubernetes API Server.

List

List: { apiVersion: string; kind: string; labels?: string; namespace?: string }

Parameters for KubeInterface.list.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • Optional labels?: string

    Kubernetes Resource label filter.

  • Optional namespace?: string

    Kubernetes Resource namespace.

Logs

Logs: { container: string; name: string; namespace: string }

Parameters for KubeInterface.logs.

Type declaration

  • container: string

    Kubernetes Pod container name.

  • name: string

    Kubernetes Resource name.

  • namespace: string

    Kubernetes Pod namespace.

Patch

Patch: { apiVersion: string; kind: string; name: string; namespace?: string; patch: Partial<Resource>; patchType?: "json" | "merge" | "strategic" }

Parameters for KubeInterface.patch.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • name: string

    Kubernetes Resource name.

  • Optional namespace?: string

    Kubernetes Resource namespace.

  • patch: Partial<Resource>

    Patch object.

  • Optional patchType?: "json" | "merge" | "strategic"

    Type of PATCH operation.

Resource

Resource: { apiVersion: string; kind: string; metadata?: { annotations?: {}; labels?: {}; name: string; namespace?: string } }

Kubernetes Resource.

Type declaration

  • [propName: string]: any
  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • Optional metadata?: { annotations?: {}; labels?: {}; name: string; namespace?: string }

    Kubernetes Resource metadata.

    • Optional annotations?: {}

      Kubernetes Resource annotations.

      • [name: string]: string
    • Optional labels?: {}

      Kubernetes Resource labels.

      • [name: string]: string
    • name: string

      Kubernetes Resource name.

    • Optional namespace?: string

      Kubernetes Resource namespace.

ReviewAction

ReviewAction: { apiVersion: string; kind: string; namespace?: string; verb: string }

Parameters for KubeInterface.canI and KubeInterface.canThey.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • Optional namespace?: string

    Kubernetes Resource namespace.

  • verb: string

    Kubernetes verb (example: create or list or watch).

WaitCallback

WaitCallback: (resource: Resource) => Promise<{ condition: boolean; res: any | null }>

Type declaration

    • (resource: Resource): Promise<{ condition: boolean; res: any | null }>

    • Condition callback

      Parameters

      • resource: Resource

        Kubernetes Resource to check.

      Returns Promise<{ condition: boolean; res: any | null }>

      {condition: false, res: null} if the condition is not met, {condition: true, res: some_value} otherwise.

WaitCondition

WaitCondition: { apiVersion: string; callback?: WaitCallback; kind: string; name?: string; namespace?: string }

Parameters for KubeInterface.waitCondition.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • Optional callback?: WaitCallback

    Condition callback.

  • kind: string

    Kubernetes Resource kind (example: Job).

  • Optional name?: string

    Kubernetes Resource name.

  • Optional namespace?: string

    Kubernetes Resource namespace.

Watch

Watch: { apiVersion: string; kind: string; name?: string; namespace?: string }

Parameters for KubeInterface.watch.

Type declaration

  • apiVersion: string

    Kubernetes Resource API Version (example: batch/v1).

  • kind: string

    Kubernetes Resource kind (example: Job).

  • Optional name?: string

    Kubernetes Resource name.

  • Optional namespace?: string

    Kubernetes Resource namespace.

Generated using TypeDoc