Getting Started on Kubernetes (BETA)

This documentation outlines how to use HEAVY.AI’s Helm Chart within a Kubernetes environment. It assumes the user is a network administrator within your organization and is an experienced Kubernetes administrator. This is not a beginner guide and does not instruct on Kubernetes installation or administration. It is quite possible you will require additional manifest files for your environment.

Overview

The HEAVY.AI Helm Chart is a template of how to configure deployment of the HEAVY.AI platform. The following files need to be updated/created to reflect the customer’s deployment environment.

• values.yml
• <customer_created>-pv.yml
• <customer_created>-pvc.yml

Once the files are updated/created, follow the installation instructions below to install the Helm Chart into your Kubernetes environment.

Where to get the Helm Chart?

The Helm Chart is located in the HEAVY.AI github repository. It can be found here: https://releases.heavy.ai/ee/helm/heavyai-1.0.0.tgz

What’s included?

Helm-workspace
    ↳ heavyai
        ↳ Chart.yml
        ↳ values.yml
        ↳ templates
            ↳ README.pdf
            ↳ deployment.yml
    ↳ misc
        ↳ example-heavyai-pv.yml
        ↳ example-heavyai-pvc.yml

How to install?

1. Before installing, create a PV/PVC that the deployment will use. Save these files in the regular PVC/PV location used in the customer’s environment. Reference the README.pdf file found in the Helm Chart under templates and the example PV/PVC manifests in the misc folder in the helm chart. The PVC name is then provided to the helm install command.
2. In your current directory; copy the values.yml file from the HEAVY.AI Helm Chart and customize for your needs.
3. Run the helm install command with the desired deployment name and Helm Chart.

   1. When using a values.yml file:

      $ helm install heavyai --values values.yml heavyaihelmchart-1.0.0.tgz

   2. When not using a values.yml file:

      If you only need to change a value or two from the default values.yml file you can use —set instead of a custom values.yml file. For example:

      $ helm install heavyai --set pvcName=MyPVCName heavyaihelmchart-1.0.0.tgz

How to uninstall?

To uninstall the helm installed HEAVY.AI instance:

$ helm uninstall heavyai

Example: values.yml

1
# Default values for heavyai.
2
# This is a YAML-formatted file.
3
# Declare variables to be passed into your templates.
4
#
5
# Version of heavyai to install in the format 'v7.0.0' or 'latest' for the latest version released.
6
version: v7.0.0
7
# Persistant volume claim name to use with heavyai.
8
pvcName: heavyai-pvc
9
# Namespace to install heavyai in.
10
nameSpace: heavyai
11
# Number or GPU's to assign to heavyai or 0 to run the CPU version of heavyai.
12
gpuNumber: 1
13
# NodeName to install heavyai on, if you wish to let Kubernetes schedule a host, leave it blank.
14
nodeName: heavyai-node
15
# Immerse port redirect of 6273.
16
hostPortImmerse: 9273
17
# TCP port redirect of 6274.
18
hostPortTCP: 9274
19
# HTTP port redirect of 6278.
20
hostPortHTTP: 9278

Example: example-heavyai-pvc.yml

1
apiVersion: v1
2
kind: PersistentVolumeClaim
3
metadata:
4
 name: heavyai-pvc
5
 namespace: heavyai
6
spec:
7
 volumeMode: Filesystem
8
 accessModes:
9
   - ReadWriteOnce
10
 resources:
11
   requests:
12
     storage: 100Gi
13
 storageClassName: heavyai

Example: example-heavyai-pv.yml

1
apiVersion: v1
2
kind: PersistentVolume
3
metadata:
4
 name: heavyai-pv
5
spec:
6
 capacity:
7
   storage: 100Gi
8
 volumeMode: Filesystem
9
 accessModes:
10
   - ReadWriteOnce
11
 persistentVolumeReclaimPolicy: Retain
12
 storageClassName: heavyai
13
 mountOptions:
14
   - hard
15
   - nfsvers=4.1
16
 nfs:
17
   path: {your nfs path goes here }
18
   server: { your nfs server name goes here }