instant3Dhub on single node - WINDOWS#

Read First#

This guide targets those who wants to run instant3Dhub for local testing on a WINDOWS machine. Installing the license server is not part of this guide as it requires Linux machine and we do not support WINDOWS.

Prerequisites#

The machine where you want to run instant3Dhub should have the following requirements in order to run the system properly:

These minimal resources are required to run instant3Dhub

  • CPU-only: CPU=4 Cores, Mem=16GB

  • with GPU: CPU=8 Cores, Mem=32GB, GPU=1 NVIDIA GPU

Installation#

  1. Install Docker Desktop: Docker Desktop is freely available in a community edition, for WINDOWS and Mac. Start by downloading and installing docker desktop: https://hub.docker.com/editions/community/docker-ce-desktop-windows.

  2. Enable Kubernetes

    1. Make sure you have Docker Desktop running - in the taskbar in WINDOWS you’ll see Docker’s whale logo. Click the whale and select Settings.

    2. A new screen opens with all of Docker Desktop’s configuration options. Click on Kubernetes and check the Enable Kubernetes checkbox.

    3. Docker Desktop will download all the Kubernetes images in the background and get everything started up. When it’s ready you’ll see two green lights in the bottom of the settings screen saying Docker running and Kubernetes running.

    4. Verify your Kubernetes cluster by running the following command

      kubectl get nodes
      

      You should see a single node in the output called docker-desktop. That’s a full Kubernetes cluster, with a single node that runs the Kubernetes API and your own applications.

  3. Install helm: We provide a Helm Chart repository for the deployment of instant3Dhub on Kubernetes. Therefore, helm should be installed first: Please follow the instructions from the official helm documentation to get helm on WINDOWS: https://helm.sh/docs/intro/install/

  4. Now, open a command prompt and run the following command to add the instant3Dhub Helm repository:

    helm repo add instant3Dhub https://repo.threedy.io/api/v4/projects/2/packages/helm/stable \
    && helm repo update
    
  5. Run helm install to deploy instant3Dhub

    helm install -n i3dhub i3dhub-windows instant3Dhub/instant3Dhub \
     --set licenseServer=license.yourdomain.com:8200 \
     --set storage.class=hostpath \
     --set entrypoints={http://localhost:30042} \
     --set registry=images.threedy.io
    
  6. The startup and initialization of all containers can take a few minutes, depending on your cluster and registry connection speed. To check the status of the containers run:

    kubectl get pods -n i3dhub
    

#. Once all containers are running, you should be able to access the splash page at http://localhost:30042