Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KubeInterface

Provide a simplified interface to the Kubernetes API Server.

Hierarchy

  • KubeInterface

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private #createCRDs

#createCRDs: boolean

client

client: Client

Underlying Kubernetes Client.

config

config: KubeConfig

KubeConfig for this interface.

crds

crds: any[]

List of CustomResourceDefinitions.

Methods

canI

  • Check if the current authenticated user can perform an action on Kubernetes Resources.

    Parameters

    Returns Promise<boolean>

    true if the action is allowed, false otherwise.

canThey

  • Check if an authenticated user can perform an action on Kubernetes Resources.

    Parameters

    Returns Promise<boolean>

    true if the action is allowed, false otherwise.

create

  • Create Kubernetes resources.

    Parameters

    • Rest ...resources: Resource[]

      Resources to create.

    Returns Promise<Resource[]>

    Created resources.

delete

  • Delete a Kubernetes Resource.

    Parameters

    Returns Promise<Resource>

    Deleted Kubernetes Resource.

exec

  • exec(__namedParameters: Exec): Promise<string>

  • Execute a command inside a Kubernetes Pod container.

    Parameters

    • __namedParameters: Exec

    Returns Promise<string>

    Executed command's logs.

get

  • Get a single Kubernetes Resource.

    Parameters

    • __namedParameters: Get

    Returns Promise<Resource>

    Kubernetes Resource.

list

  • List Kubernetes Resources.

    Parameters

    • __namedParameters: List

    Returns Promise<Resource[]>

    Collection of Kubernetes Resources

load

  • load(): Promise<void>

  • Load the Kubernetes OpenAPI specification and its CustomResourceDefinitions.

    Returns Promise<void>

logs

  • logs(__namedParameters: Logs): Promise<string>

  • Fetch logs from a Kubernetes Pod container.

    Parameters

    • __namedParameters: Logs

    Returns Promise<string>

    Logs.

myAccessRules

  • myAccessRules(__namedParameters: Object): Promise<any>

  • Fetch authorized actions for the current authenticated user.

    Parameters

    • __namedParameters: Object

    Returns Promise<any>

    Authorized actions.

patch

  • Patch a Kubernetes Resource.

    Parameters

    • __namedParameters: Patch

    Returns Promise<Resource>

    Patched Kubernetes Resource.

replace

  • Replace a Kubernetes Resource.

    Parameters

    Returns Promise<Resource>

    Replaced Kubernetes Resource.

waitCondition

  • waitCondition(__namedParameters: WaitCondition): Promise<unknown>

  • Wait for a Kubernetes Resource to match a condition.

    Parameters

    Returns Promise<unknown>

    Condition callback's result.

watch

  • watch(__namedParameters: Watch): Promise<any>

  • Watch ADDED, MODIFIED and DELETED events on Kubernetes Resources

    Parameters

    • __namedParameters: Watch

    Returns Promise<any>

    A stream of events.

Generated using TypeDoc