Preparations

The Syntho Application Helm chart can be found here in the Github repo deployment-tools under the Releases here. The files to be downloaded are ray-helm-chart.tar.gz and syntho-ui-helm-chart.tar.gz. These charts can be used to deploy the Syntho Application.

For this deployment, the following charts are included:

• syntho-ui

  • Helm chart containing the web UI application and necessary API's

• ray

  • Helm chart for deploying the cluster to be used for parallelizing ML and heavy workloads

Please request access to the Docker images necessary for this deployment. These images will have all the necessary software installed to run the Syntho application correctly. We will set the credentials for pulling them in Kubernetes using ImagePullSecrets later.

The images necessary for this deployment:

• syntho-core-api

  • The Syntho Core API is responsible for the core operations of the Syntho Platform.

  • Used in chart: syntho-ui

• syntho-frontend

  • The Syntho UI is a container that contains the web UI for the Syntho Platform.

  • Used in chart: syntho-ui

• syntho-backend

  • The Syntho Backend is responsible for user management and workspace management.

  • Used in chart: syntho-ui

• syntho-ray

  • Has the latest Ray version installed that is compatible with the Syntho Application.

  • Used in chart: ray

• syntho-ray-operator

  • Operator image for Ray cluster.

  • Used in chart: ray

Create namespace

For this example, we will deploy the application in a dedicated namespace in Kubernetes, which we call syntho for now. If the namespace does not exist, create it by running:

kubectl create namespace syntho

The remaining sections will be focused on configuring the Helm chart for your environment.

Setting up a Kubernetes Secret

Depending on the received credentials from Syntho, a Kubernetes Secret should be created to use to pull the latest image from our docker registry. Read more about creating Secrets here.

We will assume that a secret named syntho-cr-secret has been created at this point. Please contact the Syntho Support Team for your credentials. An example of creating a secret for a docker registry via kubectl can be found below:

kubectl create secret docker-registry syntho-cr-secret --namespace syntho --docker-server=<registry> --docker-username=<username> --docker-password=<password>

In both the Helm charts for Ray and the Syntho application, we can set the secret under the imagePullSecrets section.

imagePullSecrets: 
  - name: syntho-cr-secret

The Syntho Team may indicate different versions (or tags) to be used. Using the latest tag is not always recommended, so the Syntho Team may specify a specific version to be used.