External module "lib/events/kubernetesDeploy"

Index

Classes

KubernetesDeployParameters

Functions

Functions

Const HandleKubernetesDeploy

HandleKubernetesDeploy(ef: EventFired<Subscription>, context: HandlerContext, params: KubernetesDeployParameters): Promise<HandlerResult>

- Defined in lib/events/kubernetesDeploy.ts:73
Event handler for deploying an application to a Kubernetes cluster. The definition of the application to be deployed is handled by the KubernetesDeploy goal of this or another SDM. This SDM will execute deployments configured for it, see [[eligibleDeployGoal]] and [[verifyKubernetesApplicationDeploy]] for details.

Parameters
- ef: EventFired<Subscription>
- context: HandlerContext
- params: KubernetesDeployParameters
Returns Promise<HandlerResult>

failGoal

failGoal(context: HandlerContext, goalEvent: SdmGoalEvent, message: string, log: ProgressLog): Promise<HandlerResult>

- Defined in lib/events/kubernetesDeploy.ts:140
Fail the provided goal using the message to set the description and error message.

Parameters
- context: HandlerContext
  
  handler context to use to send the update
- goalEvent: SdmGoalEvent
  
  SDM goal to update
- message: string
  
  informative error message
- log: ProgressLog
Returns Promise<HandlerResult>

a failure handler result using the provided error message

goalEventString

goalEventString(goalEvent: SdmGoalEvent): string

- Defined in lib/events/kubernetesDeploy.ts:158
Unique string for goal event.

Parameters
- goalEvent: SdmGoalEvent
Returns string

kubernetesDeployHandler

kubernetesDeployHandler(self: string): EventHandlerRegistration<Subscription, KubernetesDeployParameters>

- Defined in lib/events/kubernetesDeploy.ts:119
Create an event handler registration for this SDM to deploy requested Kubernetes applications.

Parameters
- self: string
Returns EventHandlerRegistration<Subscription, KubernetesDeployParameters>

Generated using TypeDoc