Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KubernetesDeploy

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

  • Registerable
  • PlannableGoal

Index

Constructors

constructor

  • new KubernetesDeploy(details?: FulfillableGoalDetails, ...dependsOn: Goal[]): KubernetesDeploy
  • Create a KubernetesDeploy object.

    Parameters

    • Default value details: FulfillableGoalDetails = {}

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

    • Rest ...dependsOn: Goal[]

      Other goals that must complete successfully before scheduling this goal.

    Returns KubernetesDeploy

Properties

callbacks

callbacks: GoalFulfillmentCallback[]

context

context: GitHubStatusContext

definition

definition: GoalDefinition

definitionOrGoal

definitionOrGoal: PredicatedGoalDefinition | Goal

dependsOn

dependsOn: Goal[]

details

details: FulfillableGoalDetails

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

fulfillments

fulfillments: Fulfillment[]

goalListeners

goalListeners: GoalExecutionListener[]

projectListeners

projectListeners: GoalProjectListenerRegistration[]

registrations

sdm

sdm: SoftwareDeliveryMachine

Accessors

canceledDescription

  • get canceledDescription(): string
  • Returns string

environment

  • get environment(): string
  • Returns string

failureDescription

  • get failureDescription(): string
  • Returns string

inProcessDescription

  • get inProcessDescription(): string
  • Returns string

name

  • get name(): string
  • Returns string

plannedDescription

  • get plannedDescription(): string
  • Returns string

requestedDescription

  • get requestedDescription(): string
  • Returns string

skippedDescription

  • get skippedDescription(): string
  • Returns string

stoppedDescription

  • get stoppedDescription(): string
  • Returns string

successDescription

  • get successDescription(): string
  • Returns string

uniqueName

  • get uniqueName(): string
  • Returns string

waitingForApprovalDescription

  • get waitingForApprovalDescription(): string
  • Returns string

waitingForPreApprovalDescription

  • get waitingForPreApprovalDescription(): string
  • Returns string

Methods

Protected addFulfillment

  • Parameters

    Returns this

Protected addFulfillmentCallback

  • addFulfillmentCallback(cb: GoalFulfillmentCallback): this
  • Parameters

    • cb: GoalFulfillmentCallback

    Returns this

plan

  • plan(pli: StatefulPushListenerInvocation, goals: Goals): Promise<PlannedGoals | PlannedGoal>
  • Parameters

    • pli: StatefulPushListenerInvocation
    • goals: Goals

    Returns Promise<PlannedGoals | PlannedGoal>

register

  • register(sdm: SoftwareDeliveryMachine): void
  • Called by the SDM on initialization. This function calls super.register and adds a startup listener to the SDM.

    The startup listener registers a default goal fulfillment that adds itself as fulfiller of its deployment requests if this goal has no fulfillments or callbacks at startup.

    Parameters

    • sdm: SoftwareDeliveryMachine

    Returns void

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

  • withExecutionListener(listener: GoalExecutionListener): this
  • Parameters

    • listener: GoalExecutionListener

    Returns this

withProjectListener

  • withProjectListener(listener: GoalProjectListenerRegistration): this
  • Parameters

    • listener: GoalProjectListenerRegistration

    Returns this

withService

  • withService(registration: ServiceRegistration<any>): this
  • Parameters

    • registration: ServiceRegistration<any>

    Returns this

Generated using TypeDoc