Module "pack/k8s/deploy/goal"

Index

Enumerations

KubernetesDeployDataSources

Classes

KubernetesDeploy

Interfaces

KubernetesDeployRegistration

Type aliases

KubernetesApplicationDataCallback

Functions

Type aliases

KubernetesApplicationDataCallback

KubernetesApplicationDataCallback: (a: KubernetesApplication, p: GitProject, g: KubernetesDeploy, e: SdmGoalEvent, ctx: HandlerContext) => Promise<KubernetesApplication>

Function signature for callback that can modify and return the KubernetesApplication object.

Type declaration

- (a: KubernetesApplication, p: GitProject, g: KubernetesDeploy, e: SdmGoalEvent, ctx: HandlerContext): Promise<KubernetesApplication>
- Parameters
  - a: KubernetesApplication
  - p: GitProject
  - g: KubernetesDeploy
  - e: SdmGoalEvent
  - ctx: HandlerContext
  Returns Promise<KubernetesApplication>

Functions

defaultDataSources

defaultDataSources(registration: KubernetesDeployRegistration): KubernetesDeployRegistration

- Defined in lib/pack/k8s/deploy/goal.ts:210
Populate data sources properrty of registration with all possible KubernetesGoalDataSources if it is not defined. Otherwise, leave it as is. The registration object is modified directly and returned.

Parameters
- registration: KubernetesDeployRegistration
  
  Kubernetes deploy object registration
Returns KubernetesDeployRegistration

registration with data sources

goalEventSlug

goalEventSlug(goalEvent: SdmGoalEvent): string

- Defined in lib/pack/k8s/deploy/goal.ts:47
Return repository slug for SDM goal event.

Parameters
- goalEvent: SdmGoalEvent
Returns string

initiateKubernetesDeploy

initiateKubernetesDeploy(k8Deploy: KubernetesDeploy, registration: KubernetesDeployRegistration): ExecuteGoal

- Defined in lib/pack/k8s/deploy/goal.ts:236
If in SDM team mode, this goal executor generates and stores the Kubernetes application data for deploying an application to Kubernetes. It returns the augmented SdmGoalEvent with the Kubernetes application information in the data property and the state of the SdmGoalEvent set to "requested". The actual deployment is done by the kubernetesDeployHandler event handler.

It will call defaultDataSources to populate the default repository data sources if none are provided in the registration.

If in SDM local mode, generate the Kubernetes application data and deploy the application.

Parameters
- k8Deploy: KubernetesDeploy
  
  Kubernetes deploy object
- registration: KubernetesDeployRegistration
  
  Kubernetes deploy object registration
Returns ExecuteGoal

An ExecuteGoal result that is not really a result, but an intermediate state.

Generated using TypeDoc