@aws-quickstart/eks-blueprints
    Preparing search index...

    Interface JupyterHubAddOnProps

    Configuration options for the add-on.

    interface JupyterHubAddOnProps {
        certificateResourceName?: string;
        chart?: string;
        dependencyMode?: boolean;
        ebsConfig?: { capacity: string; storageClass: string };
        efsConfig?: {
            capacity: string;
            pvcName: string;
            removalPolicy: RemovalPolicy;
        };
        ingressAnnotations?: { [key: string]: string };
        ingressHosts?: string[];
        name?: string;
        namespace?: string;
        notebookStack?: string;
        oidcConfig?: {
            authUrl: string;
            callbackUrl: string;
            clientId: string;
            clientSecret: string;
            scope?: string[];
            tokenUrl: string;
            userDataUrl: string;
            usernameKey?: string;
        };
        release?: string;
        repository?: string;
        serviceType: JupyterHubServiceType;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    certificateResourceName? chart? dependencyMode? ebsConfig? efsConfig? ingressAnnotations? ingressHosts? name? namespace? notebookStack? oidcConfig? release? repository? serviceType skipVersionValidation? values? version?

    Properties

    certificateResourceName?: string

    Name of the certificate NamedResourceProvider to be used for certificate look up.

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    chart?: string

    Chart name

    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

    true
    ebsConfig?: { capacity: string; storageClass: string }

    Configurations necessary to use EBS as Persistent Volume

    efsConfig?: { capacity: string; pvcName: string; removalPolicy: RemovalPolicy }

    Configuration necessary to use EFS as Persistent Volume

    ingressAnnotations?: { [key: string]: string }

    Ingress annotations - only apply if Ingress is enabled, otherwise throws an error

    ingressHosts?: string[]

    Ingress host - only if Ingress is enabled It is a list of available hosts to be routed upon request

    name?: string

    Name of the helm chart (add-on)

    namespace?: string

    Namespace where helm release will be installed

    notebookStack?: string

    Notebook stack as defined using Docker Stacks for Jupyter here: https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#core-stacks

    oidcConfig?: {
        authUrl: string;
        callbackUrl: string;
        clientId: string;
        clientSecret: string;
        scope?: string[];
        tokenUrl: string;
        userDataUrl: string;
        usernameKey?: string;
    }

    Configuration settings for OpenID Connect authentication protocol

    release?: string

    Helm release

    repository?: string

    Helm repository

    serviceType: JupyterHubServiceType

    Configuration to set how the hub service will be exposed See enum jupyterHubService for choices

    skipVersionValidation?: boolean

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

    values?: Values

    Optional values for the helm chart.

    version?: string

    Helm chart version.

    Settings

    Member Visibility

    On This Page

    Properties