Interface AppMeshAddOnProps

Configuration options for the add-on.

interface AppMeshAddOnProps {
    chart?: string;
    dependencyMode?: boolean;
    enableTracing?: boolean;
    name?: string;
    namespace?: string;
    release?: string;
    repository?: string;
    skipVersionValidation?: boolean;
    tracingAddress?: string;
    tracingPort?: string;
    tracingProvider?: "x-ray" | "jaeger" | "datadog";
    values?: Values;
    version?: string;
}

Hierarchy (view full)

Properties

chart? dependencyMode? enableTracing? name? namespace? release? repository? skipVersionValidation? tracingAddress? tracingPort? tracingProvider? values? version?

Properties

Optionalchart

chart?: string

Chart name

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

OptionalenableTracing

enableTracing?: boolean

If set to true, will enable tracing through App Mesh sidecars, such as X-Ray distributed tracing. Note: support for X-Ray tracing does not depend on the XRay Daemon AddOn installed.

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.

OptionaltracingAddress

tracingAddress?: string

Used for Datadog or Jaeger tracing. Example values: datadog.appmesh-system. Refer to https://aws.github.io/aws-app-mesh-controller-for-k8s/guide/tracing/ for more information. Ignored for X-Ray.

OptionaltracingPort

tracingPort?: string

Jaeger or Datadog agent port (ignored for X-Ray)

OptionaltracingProvider

tracingProvider?: "x-ray" | "jaeger" | "datadog"

Tracing provider. Supported values are x-ray, jaeger, datadog

Optionalvalues

values?: Values

Optional values for the helm chart.

Optionalversion

version?: string

Helm chart version.

Settings

Member Visibility

On This Page

Properties