Options
All
  • Public
  • Public/Protected
  • All
Menu

Goal that initiates deploying an application to a Kubernetes cluster. Deploying the application is completed by the kubernetesDeployHandler event handler. By default, this goal will be configured such that it is fulfilled by the SDM that creates it. To have this goal be executed by another SDM, set the fulfillment name to the name of that SDM:

const deploy = new KubernetesDeploy()
    .with({ name: otherSdm.configuration.name });

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly callbacks

callbacks: GoalFulfillmentCallback[] = []

Readonly context

Readonly definition

definition: GoalDefinition

definitionOrGoal

definitionOrGoal: PredicatedGoalDefinition | Goal

Readonly dependsOn

dependsOn: Goal[]

Readonly details

Define unique aspects of this Kubernetes deployment, see KubernetesDeploy.details.

Readonly fulfillments

fulfillments: Fulfillment[] = []

Readonly goalListeners

goalListeners: GoalExecutionListener[] = []

Readonly projectListeners

projectListeners: GoalProjectListenerRegistration[] = []

Readonly registrations

registrations: KubernetesDeployRegistration[] = []

sdm

Accessors

canceledDescription

  • get canceledDescription(): string

environment

  • get environment(): string

failureDescription

  • get failureDescription(): string

inProcessDescription

  • get inProcessDescription(): string

name

  • get name(): string

plannedDescription

  • get plannedDescription(): string

requestedDescription

  • get requestedDescription(): string

skippedDescription

  • get skippedDescription(): string

stoppedDescription

  • get stoppedDescription(): string

successDescription

  • get successDescription(): string

uniqueName

  • get uniqueName(): string

waitingForApprovalDescription

  • get waitingForApprovalDescription(): string

waitingForPreApprovalDescription

  • get waitingForPreApprovalDescription(): string

Methods

Protected addFulfillment

Protected addFulfillmentCallback

plan

register

Private updateGoalName

  • updateGoalName(fulfillment: string): this
  • Set the goal "name" and goal definition "displayName". If any goal definition description is not set, populate it with a reasonable default.

    Parameters

    • fulfillment: string

      Name of fulfillment, typically the cluster-scoped name of k8s-sdm

    Returns this

    object

with

withExecutionListener

withProjectListener

withService

Generated using TypeDoc