Deploy cnvrg CORE using the cnvrg Operator

Helm is the easiest way to quickly deploy cnvrg CORE using any cluster, on-premise, Minikube or on any cloud cluster (AKS, EKS, GKE).

In this guide, you will learn how to:

• Use Helm to deploy cnvrg CORE

Requirements

Before you can complete the installation you must install and prepare the following dependencies on your local machine:

• kubectl
• Helm 3.2 and above
• Kubernetes cluster (1.16+) with 15 CPU, 26GB of memory and 350GB of storage^*.

NOTE

Haven't created a cluster yet? Check our guides for setting up an AWS EKS, GCP GKE, Azure EKS or Minikube cluster.

Install and Update the Helm repo

Run the following command to download the most updated cnvrg helm charts:

helm repo add cnvrgv3 https://charts.v3.cnvrg.io
helm repo update 
helm search repo cnvrgv3/cnvrg -l

Run the Helm Chart

Now all you need to do is run the helm install command and all of the services and systems will be automatically installed on your cluster. The process can take up to 15 minutes.

Deploy cnvrg

The simplest way to install cnvrg is to use the default helm install commands as indicated below. Alternatively you can modify the command using the available helm options.

This example will install cnvrg on any cluster using Istio for ingress and MinIO for storage.

Before deploying cnvrg you will need:

• The external ip address of the cluster

helm install cnvrg cnvrgv3/cnvrg --create-namespace -n cnvrg --timeout 1500s \
  --set clusterDomain=<app.<ip-of-cluster>.nip.io\

Using nip.io in the above example will automatically configure a domain that you can use to access cnvrg.

Alternatively, you can use a custom domain for clusterDomain, but you will need to set up the routing between the ip of the cluster and the domain you have chosen, within your DNS. You will need to create a CNAME/A listing for *.<your_domain> with the ip address of the autoscaler for the cluster. Make sure you include the wildcard: *. The domain is the same domain you should enter as clusterDomain in the helm command.

To get the ip address of the cluster run the following command after cnvrg has been deployed:

kubectl -n cnvrg get svc | grep ingress | awk "{print $4}"

There are three main ways to deploy cnvrg on-premise:

1. NodePort, MinIO, Hostpath
2. NodePort, MinIO, NFS
3. Istio, MinIO, HostPath, SMTP, micro storage profile

You can also use the micro profile to install a lightweight version of cnvrg.

NodePort

---

This example deploys cnvrg on-premise using NodePort for ingress and using Kubernetes Hostpath for MinIO storage.

Before deploying cnvrg you will need:

• The external ip address of the cluster
• The name of the node on which you will deploy cnvrg

To deploy cnvrg on an on-premise Kubernetes cluster use the following command:

helm install cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
    --set clusterDomain=<node-ip> \
    --set networking.ingressType="nodeport" \
    --set storage.enabled="true" \
    --set storage.hostpath.enabled="true" \
    --set storage.hostpath.defaultSc="true" \
    --set storage.hostpath.nodeName="<k8s-node>"

Nodeport with NFS

---

This example deploys cnvrg on-premise using NodePort for ingress and using an NFS server for MinIO storage.

Before deploying cnvrg you will need:

• The external ip address of the cluster
• The details of the NFS server

To deploy cnvrg on an on-premise Kubernetes cluster use the following command:

helm cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
    --set clusterDomain=192.168.1.2 \
    --set networking.ingressType="nodeport" \
    --set storage.enabled="true" \
    --set storage.nfs.enabled="true" \
    --set storage.nfs.defaultSc="true" \
    --set storage.nfs.server="storage.nfs.SERVER.IP" \
    --set storage.nfs.path="/shared/nfs/directory"

The nfs.path is the path inside your nfs server that will be used for storing data. For example /shared/nfs/cnvrg

Istio

---

This example deploys cnvrg on-premise using Istio for ingress, Kubernetes Hostpath for MinIO storage and with an SMTP server attached.

Before deploying cnvrg you will need:

• The ip address of your cluster
• The details of your SMTP server
• The name of the node on which you will deploy cnvrg

To deploy cnvrg on an on-premise cluster using a domain use the following command:

helm cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
    --set clusterDomain=app.<ip-of-cluster>.nip.io  \
    --set storage.enabled="true" \
    --set storage.hostpath.enabled="true" \
    --set storage.hostpath.nodeName="k8s-node-name" \
    --set cnvrgApp.conf.smtp.server="smtp-server" \
    --set cnvrgApp.conf.smtp.port="smtp-port" \
    --set cnvrgApp.conf.smtp.username="smtp-user" \
    --set cnvrgApp.conf.smtp.password="smtp-pass" \
    --set cnvrgApp.conf.smtp.domain="domain"

Using nip.io in the above example will automatically configure a domain that you can use to access cnvrg.

Alternatively, you can use a custom domain for clusterDomain, but you will need to set up the routing between the ip of the cluster and the domain you have chosen, within your DNS. You will need to create a CNAME/A listing for *.<your_domain> with the ip address of the autoscaler for the cluster. Make sure you include the wildcard: *. The domain is the same domain you should enter as clusterDomain in the helm command.

To get the ip address of the cluster run the following command after cnvrg has been deployed:

kubectl -n cnvrg get svc | grep ingress | awk "{print $4}"

This example deploys cnvrg for AWS using an S3 bucket for storage.

Before deploying cnvrg you will need:

• The ip address of your cluster
• The details of the S3 bucket

To deploy cnvrg on an Amazon Web Services EKS Kubernetes cluster use the following command:

helm install cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
        --set clusterDomain=<your_custom_domain> \
        --set cnvrgApp.conf.cnvrgStorageType=aws \
        --set cnvrgApp.conf.cnvrgStorageBucket=s3bucket-name \
        --set cnvrgApp.conf.cnvrgStorageAccessKey=ACCESSKEY \
        --set cnvrgApp.conf.cnvrgStorageSecretKey=SECRETKEY \
        --set cnvrgApp.conf.cnvrgStorageRegion=aws-region

• clusterDomain is the domain you want to provide to the cnvrg installation. for example - cnvrg.yourdomain.com Once you have cnvrg installed you should get your LoadBalanacer domain routed to your provided cluster domain.

  For example, if your domain is managed in Route53 you will create a new record with the following details (assuming your domain was: cnvrg.yourdomain.com):

  *.cnvrg.yourdomain.com assigned with CNAME that was provided to the LB

  To get the ip address of the cluster run the following command after cnvrg has been deployed:

  kubectl -n cnvrg get svc | grep ingress | awk "{print $4}"
  

This example deploys cnvrg on GCP using GCP storage for storage.

Before deploying cnvrg you will need:

• The ip address of your cluster
• The details of the GCP storage project

To deploy cnvrg on a Google Cloud Platform GKE Kubernetes cluster use the following command:

helm install cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
        --set clusterDomain=app.<ip-of-cluster>.nip.io \
        --set cnvrgApp.conf.cnvrgStorageType=gcp \
        --set cnvrgApp.conf.cnvrgStorageProject=gcp-storage-project

Using nip.io in the above example will automatically configure a domain that you can use to access cnvrg.

Alternatively, you can use a custom domain for clusterDomain, but you will need to set up the routing between the ip of the cluster and the domain you have chosen, within your DNS. You will need to create a CNAME/A listing for *.<your_domain> with the ip address of the autoscaler for the cluster. Make sure you include the wildcard: *. The domain is the same domain you should enter as clusterDomain in the helm command.

To get the ip address of the cluster run the following command after cnvrg has been deployed:

kubectl -n cnvrg get svc | grep ingress | awk "{print $4}"

This example deploys cnvrg on Azure using an Azure Storage Container for storage.

Before deploying cnvrg you will need:

• The ip address of your cluster
• The details of the Azure Storage Container

To deploy cnvrg on a Microsoft Azure Kubernetes cluster use the following command:

helm install cnvrg cnvrgv3/cnvrg -n cnvrg --create-namespace --timeout 1500s --wait \
        --set clusterDomain=app.<ip-of-cluster>.nip.io \
        --set cnvrgApp.conf.cnvrgStorageType=azure \
        --set cnvrgApp.conf.cnvrgStorageAzureAccessKey=azure-storage-account-access-key \
        --set cnvrgApp.conf.cnvrgStorageAzureAccountName=azure-storage-account-name \
        --set cnvrgApp.conf.cnvrgStorageAzureContainer=azure-storage-container-name

Using nip.io in the above example will automatically configure a domain that you can use to access cnvrg.

Alternatively, you can use a custom domain for clusterDomain, but you will need to set up the routing between the ip of the cluster and the domain you have chosen, within your DNS. You will need to create a CNAME/A listing for *.<your_domain> with the ip address of the autoscaler for the cluster. Make sure you include the wildcard: *. The domain is the same domain you should enter as clusterDomain in the helm command.

To get the ip address of the cluster run the following command after cnvrg has been deployed:

kubectl -n cnvrg get svc | grep ingress | awk "{print $4}"

Advanced Helm Options

There are numerous ways to customize the installation to best fit your own infrastructure and requirement, including disk sizes, memory information, versions and so on. For the full list of customizable flags, click here.

Completing the Setup

The helm install command can take up to 10 minutes. When the deployment completes, you can go to the url of your newly deployed cnvrg or add the new cluster as a resource inside your organization. The helm command will inform you of the correct url:

🚀 Thank you for installing cnvrg.io!

Your installation of cnvrg.io is now available, and can be reached via:
http://app.mydomain.com

Talk to our team via email at hi@cnvrg.io

Monitoring the deployment

You can monitor and validate the deployment process by running the following command:

kubectl -n cnvrg get pods

When the status of all the containers is running or completed, cnvrg will have been successfully deployed. It should look similar to the below output example:

NAME                                    READY   STATUS      RESTARTS   AGE
cnvrg-app-69fbb9df98-6xrgf              1/1     Running     0          2m
cnvrg-sidekiq-b9d54d889-5x4fc           1/1     Running     0          2m
controller-65895b47d4-s96v6             1/1     Running     0          2m
init-app-vs-config-wv9c4                0/1     Completed   0          9m
init-gateway-vs-config-2zbpp            0/1     Completed   0          9m
init-minio-vs-config-cd2rg              0/1     Completed   0          9m
istio-citadel-c58d68844-bcwv7           1/1     Running     0          2m
istio-galley-67dfcd65c5-vb2jf           1/1     Running     0          2m
istio-ingressgateway-6d48767f5b-mw4q8   1/1     Running     0          2m
istio-pilot-7bb78bbfb9-dpq6q            2/2     Running     0          2m
minio-0                                 1/1     Running     0          2m
postgres-0                              1/1     Running     0          2m
redis-695c49c986-kcbt9                  1/1     Running     0          2m
seeder-wh655                            0/1     Completed   0          2m
speaker-5sghr                           1/1     Running     0          2m

NOTE

The exact list of pods may be different, as it depends on the flags that you used with the helm install command. As long as the statuses are running or completed, the deployment will have been successful.

Monitoring your cluster using Kibana and Grafana

Now that cnvrg has been deployed, you can access the Kibana and Grafana dashboards of your cluster.

They are great tools for monitoring the health of your cluster and analyzing the logs of your cluster.

To access Kibana, go to: kibana.<your_domain>.com

To access Grafana, go to: grafana.<your_domain>.com

Delete cnvrg CORE

If you would like to delete the cnvrg deployment using Helm, run the following command:

helm uninstall cnvrg -n cnvrg

Upgrade a cnvrg Installation

If you would like to upgrade an existing Helm installation, run the following command with the other settings as required for your install:

helm upgrade cnvrg cnvrgv3/cnvrg --reuse-values \
  --set cnvrgApp.image=<image>