Class: Builder

Defined in: builder.d.ts:11

Constructors

Constructor

new Builder(): Builder;

Defined in: builder.d.ts:12

Returns

Builder

Constructor

new Builder(options): Builder;

Defined in: builder.d.ts:13

Parameters

Parameter	Type
options	BuilderOptions

Returns

Builder

Constructor

new Builder(
   version, 
   distribution, 
   environmentType): Builder;

Defined in: builder.d.ts:14

Parameters

Parameter	Type
version	string | Version
distribution	string
environmentType	string

Returns

Builder

Properties

Property	Type	Description	Defined in
components	Component[]	All components that will be run by this builder. Don't add to this array directly, use Builder.addComponent instead.	builder.d.ts:19
options	BuilderOptions	Common options that are used by the builder components.	builder.d.ts:22

Methods

addAdditionalFile()

Call Signature

addAdditionalFile(additionalFile): void;

Defined in: builder.d.ts:76

Adds the given additional file to a DocumentGroup named "" during the steps.generateResources step.

Checks for an existing DocumentGroup with the name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
additionalFile	AdditionalFile

Returns

void

Call Signature

addAdditionalFile(documentGroupPath, additionalFile): void;

Defined in: builder.d.ts:84

Adds the given additional file to a DocumentGroup with the given name during the steps.generateResources step.

Checks for an existing DocumentGroup with the same name and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
documentGroupPath	string
additionalFile	AdditionalFile

Returns

void

---

addComponent()

addComponent(component): void;

Defined in: builder.d.ts:28

Adds given component to the list of components.

Parameters

Parameter	Type
component	Component

Returns

void

---

addDocument()

Call Signature

addDocument(document): void;

Defined in: builder.d.ts:47

Parses the given YAML string as a Document and adds it to a DocumentGroup named "" during the steps.generateResources step.

Checks for an existing DocumentGroup with the name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
document	string

Returns

void

Call Signature

addDocument(document): void;

Defined in: builder.d.ts:55

Adds the given document to a DocumentGroup named "" during the steps.generateResources step.

Checks for an existing DocumentGroup with the name "" and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
document	Document

Returns

void

Call Signature

addDocument(options): void;

Defined in: builder.d.ts:63

Adds a new document using the provided options during the steps.generateResources step.

Checks for an existing DocumentGroup with the same name as options.documentGroup and adds the document to it if it exists. Creates a new DocumentGroup if it doesn't exist.

Parameters

Parameter	Type
options	NewDocumentOptions

Returns

void

---

addDocumentGroup()

addDocumentGroup(documentGroup): void;

Defined in: builder.d.ts:68

Adds the given DocumentGroup during the steps.generateResources step.

Parameters

Parameter	Type
documentGroup	DocumentGroup

Returns

void

---

addHelmChart()

addHelmChart(
   chartIdentifier, 
   releaseName, 
   values?): void;

Defined in: helm.d.ts:11

Creates a document group from the Helm chart using the given values on steps.generateResources step. Chart identifier can be a local path or a URL.

Parameters

Parameter	Type
chartIdentifier	string
releaseName	string
values?	string

Returns

void

---

addProvisionCheckpoint()

addProvisionCheckpoint(name): Component;

Defined in: builder.d.ts:38

Adds a component that creates a document group with the given name during steps.generateResources. Document group doesn't contain any documents, it serves as a placeholder for provision dependencies.

Parameters

Parameter	Type	Description
name	string

Returns

Component

---

apply()

apply(options?): Component;

Defined in: apply.d.ts:10

Applies the generated manifests to the Kubernetes cluster at the steps.apply step.

Parameters

Parameter	Type	Description
options?	Options	Options for applying manifests.

Returns

Component

---

build()

build(): void;

Defined in: builder.d.ts:25

Runs all the components that were added to the builder.

Returns

void

---

deleteOutputDirectory()

deleteOutputDirectory(options?): Component;

Defined in: deleteOutputDirectory.d.ts:12

Adds a Component that deletes the output directory. This component is used to clean up the output directory before generating new content. It is executed before the steps.output step.

Parameters

Parameter	Type	Description
options?	Options	Options for deleting the output directory.

Returns

Component

---

onGenerateResources()

onGenerateResources(callback): Component;

Defined in: builder.d.ts:105

Creates a new component with the given action that will be run during steps.generateResources and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onGenerateResourcesBasedOnOtherResources()

onGenerateResourcesBasedOnOtherResources(callback): Component;

Defined in: builder.d.ts:111

Creates a new component with the given action that will be run during steps.generateResourcesBasedOnOtherResources and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onModify()

onModify(callback): Component;

Defined in: builder.d.ts:117

Creates a new component with the given action that will be run during steps.modify and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onPopulateKubernetesResources()

onPopulateKubernetesResources(callback): Component;

Defined in: builder.d.ts:93

Creates a new component with the given action that will be run during steps.populateKubernetesResources and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onSanitize()

onSanitize(callback): Component;

Defined in: builder.d.ts:99

Creates a new component with the given action that will be run during steps.sanitize and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onSpecifyProvisionerDependencies()

onSpecifyProvisionerDependencies(callback): Component;

Defined in: builder.d.ts:123

Creates a new component with the given action that will be run during steps.specifyProvisionerDependencies and adds it to the list of components.

Parameters

Parameter	Type
callback	(context) => void

Returns

Component

---

onStep()

onStep(step, callback): Component;

Defined in: builder.d.ts:87

Creates a new component with the given action and adds it to the list of components.

Parameters

Parameter	Type
step	Step
callback	(context) => void

Returns

Component

---

removeComponent()

removeComponent(component): void;

Defined in: builder.d.ts:31

Removes given component from the list of components.

Parameters

Parameter	Type
component	Component

Returns

void

---

writeDocuments()

writeDocuments(options?): Component;

Defined in: writeDocuments.d.ts:11

Adds a Component that writes the documents from all document groups to the output directory as YAML files during the steps.output step.

Parameters

Parameter	Type	Description
options?	Options	Options for writing documents.

Returns

Component