Interface BackstageAddOnProps

User provided options for the Helm Chart

interface BackstageAddOnProps {
    certificateResourceName: string;
    chart?: string;
    databaseResourceName: string;
    databaseSecretTargetName: string;
    dependencyMode?: boolean;
    imageRegistry: string;
    imageRepository: string;
    imageTag?: string;
    name?: string;
    namespace?: string;
    release?: string;
    repository?: string;
    skipVersionValidation?: boolean;
    subdomain: string;
    values?: Values;
    version?: string;
}

Hierarchy (view full)

Properties

certificateResourceName chart? databaseResourceName databaseSecretTargetName dependencyMode? imageRegistry imageRepository imageTag? name? namespace? release? repository? skipVersionValidation? subdomain values? version?

Properties

certificateResourceName

certificateResourceName: string

The resource name of the certificate to be assigned to the Load Balancer.

Optionalchart

chart?: string

Chart name

databaseResourceName

databaseResourceName: string

The resource name of the database.

databaseSecretTargetName

databaseSecretTargetName: string

The name of the Kubernetes Secret which will be created by the add-on and injected with the database credentials.

OptionaldependencyMode

dependencyMode?: boolean

Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. This value is only used to turn off dependency mode in case customers choose to copy the whole helm chart into their repo

Default

true

imageRegistry

imageRegistry: string

The registry URL of the Backstage application's Docker image.

imageRepository

imageRepository: string

The repository name in the "imageRegistry".

OptionalimageTag

imageTag?: string

The tag of the Backstage application's Docker image.

Default

'latest'

Optionalname

name?: string

Name of the helm chart (add-on)

Optionalnamespace

namespace?: string

Namespace where helm release will be installed

Optionalrelease

release?: string

Helm release

Optionalrepository

repository?: string

Helm repository

OptionalskipVersionValidation

skipVersionValidation?: boolean

When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

subdomain

subdomain: string

The subdomain that will be assigned to the Backstage application.

Optionalvalues

values?: Values

Optional values for the helm chart.

Optionalversion

version?: string

Helm chart version.

Settings

Member Visibility

On This Page

Properties