Class: Builder

Defined in: builder.d.ts:9

Constructors

Constructor

new Builder(options): Builder;

Defined in: builder.d.ts:10

Parameters

Parameter	Type
options	BuilderOptions

Returns

Builder

Constructor

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

Defined in: builder.d.ts:11

Parameters

Parameter	Type
version	string | Version
distribution	KubernetesDistribution
environmentType	EnvironmentType

Returns

Builder

Properties

Property	Type	Description	Defined in
components	readonly Component[]	All components that will be run by this builder. Don't modify this array directly, use Builder.addComponent or Builder.removeComponent instead.	builder.d.ts:17
options	BuilderOptions	Common options that are used by the builder components.	builder.d.ts:20

Methods

addAdditionalFile()

Call Signature

addAdditionalFile(additionalFile): void;

Defined in: builder.d.ts:86

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(documentGroupName, additionalFile): void;

Defined in: builder.d.ts:94

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
documentGroupName	string
additionalFile	AdditionalFile

Returns

void

---

addComponent()

addComponent(component): void;

Defined in: builder.d.ts:23

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:34

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(documentGroupName, document): void;

Defined in: builder.d.ts:42

Adds the given document 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
documentGroupName	string
document	Document

Returns

void

Call Signature

addDocument(path, yamlContent): void;

Defined in: builder.d.ts:51

Adds a new document to a DocumentGroup named "" during the steps.generateResources step by parsing given YAML string as a Document.

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
path	string
yamlContent	string

Returns

void

Call Signature

addDocument(
   documentGroupName, 
   path, 
   yamlContent): void;

Defined in: builder.d.ts:60

Adds a new document to a DocumentGroup with the given name during the steps.generateResources step by parsing given YAML string as a Document.

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
documentGroupName	string
path	string
yamlContent	string

Returns

void

Call Signature

addDocument(path, root): void;

Defined in: builder.d.ts:69

Adds a new document to a DocumentGroup named "" during the steps.generateResources step by converting given object to a Document.

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
path	string
root	object | Mapping

Returns

void

Call Signature

addDocument(
   documentGroupName, 
   path, 
   root): void;

Defined in: builder.d.ts:78

Adds a new document to a DocumentGroup with the given name during the steps.generateResources step by converting given object to a Document.

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
documentGroupName	string
path	string
root	object | Mapping

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

---

apply()

apply(options?): Component;

Defined in: apply.d.ts:12

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:118

Runs all the components that were added to the builder.

Returns

void

---

collectCRDs()

collectCRDs(options?): Component;

Defined in: collectCRDs.d.ts:11

Adds a Component that collects Custom Resource Definitions (CRDs) from all the document groups and moves them into a new document group after the steps.modify step.

Parameters

Parameter	Type	Description
options?	Options	Options for collecting CRDs.

Returns

Component

---

collectNamespaces()

collectNamespaces(options?): Component;

Defined in: collectNamespaces.d.ts:11

Adds a Component that collects namespace definitions from all the document groups and moves them into a new document group after the steps.modify step.

Parameters

Parameter	Type	Description
options?	Options	Options for collecting namespaces.

Returns

Component

---

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:109

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

---

onModify()

onModify(callback): Component;

Defined in: builder.d.ts:115

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

---

onSanitize()

onSanitize(callback): Component;

Defined in: builder.d.ts:103

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

---

onStep()

onStep(step, callback): Component;

Defined in: builder.d.ts:97

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:26

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