Class BackstageAddOn

Main class to instantiate the Helm chart

Hierarchy (view full)

HelmAddOn
- BackstageAddOn

Index

Constructors

Properties

options props failOnVersionValidation validateHelmVersions

Methods

addHelmChart deploy populateValues validateVersion

Constructors

constructor

new BackstageAddOn(props?): BackstageAddOn
Parameters
- Optionalprops: BackstageAddOnProps
Returns BackstageAddOn
Overrides HelmAddOn.constructor
- Defined in lib/addons/backstage/index.ts:75

Properties

`Readonly`options

options: BackstageAddOnProps

props

props: HelmChartConfiguration

`Static`failOnVersionValidation

failOnVersionValidation: boolean = false

`Static`validateHelmVersions

validateHelmVersions: boolean = false

Methods

`Protected`addHelmChart

addHelmChart(clusterInfo, values?, createNamespace?, wait?, timeout?): Construct
Deploys the helm chart in the cluster.
Parameters
- clusterInfo: ClusterInfo
- Optionalvalues: Values
- OptionalcreateNamespace: boolean
- Optionalwait: boolean
- Optionaltimeout: Duration
Returns Construct
Inherited from HelmAddOn.addHelmChart
- Defined in lib/addons/helm-addon/index.ts:88

deploy

deploy(clusterInfo): Promise<Construct>
Expected to be implemented in concrete subclasses.
Parameters
- clusterInfo: ClusterInfo
Returns Promise<Construct>
Overrides HelmAddOn.deploy
- Defined in lib/addons/backstage/index.ts:81

populateValues

populateValues(clusterInfo, helmOptions): Values
populateValues populates the appropriate values used to customize the Helm chart
Parameters
- clusterInfo: ClusterInfo
- helmOptions: BackstageAddOnProps
  User provided values to customize the chart
Returns Values
- Defined in lib/addons/backstage/index.ts:98

`Static`validateVersion

validateVersion(helmChart): void
Parameters
- helmChart: HelmChartVersion
Returns void
Inherited from HelmAddOn.validateVersion
- Defined in lib/addons/helm-addon/index.ts:62