Class JupyterHubAddOn

Implementation of the JupyterHub add-on

Hierarchy (View Summary)

HelmAddOn
- JupyterHubAddOn

Index

Constructors

Properties

options props failOnVersionValidation validateHelmVersions

Methods

addEbsStorage addEfsStorage addHelmChart deploy getAddonVersion setupEFS validateVersion

Constructors

constructor

new JupyterHubAddOn(props?: JupyterHubAddOnProps): JupyterHubAddOn
Parameters
- Optionalprops: JupyterHubAddOnProps
Returns JupyterHubAddOn
Overrides HelmAddOn.constructor
- Defined in lib/addons/jupyterhub/index.ts:134

Properties

`Readonly`options

options: JupyterHubAddOnProps

props

props: HelmChartConfiguration

`Static`failOnVersionValidation

failOnVersionValidation: boolean = false

`Static`validateHelmVersions

validateHelmVersions: boolean = false

Methods

`Protected`addEbsStorage

addEbsStorage(clusterInfo: ClusterInfo, values: any, ebsConfig: any): void
This is a helper function to create EBS persistent storage
Parameters
- clusterInfo: ClusterInfo
  Cluster Info
- values: any
  Helm Chart Values
- ebsConfig: any
  EBS Configurations supplied by user
Returns void
- Defined in lib/addons/jupyterhub/index.ts:263

`Protected`addEfsStorage

addEfsStorage(clusterInfo: ClusterInfo, values: any, efsConfig: any): void
This is a helper function to create EFS persistent storage
Parameters
- clusterInfo: ClusterInfo
  Cluster Info
- values: any
  Helm Chart Values
- efsConfig: any
  EFS Configurations supplied by user
Returns void
- Defined in lib/addons/jupyterhub/index.ts:282

`Protected`addHelmChart

addHelmChart(
    clusterInfo: ClusterInfo,
    values?: Values,
    createNamespace?: boolean,
    wait?: boolean,
    timeout?: Duration,
): 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:92

deploy

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

getAddonVersion

getAddonVersion(): string
Returns string
Inherited from HelmAddOn.getAddonVersion
- Defined in lib/addons/helm-addon/index.ts:62

`Protected`setupEFS

setupEFS(
    clusterInfo: ClusterInfo,
    namespace: string,
    pvcName: string,
    capacity: string,
    removalPolicy: RemovalPolicy,
): void
This is a helper function to use EFS as persistent storage including necessary security group with ingress rule, EFS File System, Kubernetes PV and PVC
Parameters
- clusterInfo: ClusterInfo
  Cluster Info
- namespace: string
  Namespace
- pvcName: string
  Name of the PV and PVC
- capacity: string
- removalPolicy: RemovalPolicy
  Removal Policy for EFS File System (RETAIN, DESTROY or SNAPSHOT)
Returns void
- Defined in lib/addons/jupyterhub/index.ts:309

`Static`validateVersion

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