Installation¶
Note
Orchest is in beta.
Tip
👉 Get a fully configured Orchest instance out of the box on our Orchest Cloud, for free!
Prerequisites¶
Kubernetes cluster¶
You need a Kubernetes (k8s) cluster to run Orchest: you can either pick a managed service by one of their certified cloud platforms, or create one locally using minikube:
# Start a minikube cluster with profile "minikube".
minikube start --cpus=4
Note
In order to be able to access orchest
nginx ingress controller has to be deployed, in minikube cluster
it can be done by running minikube addons enable ingress
.
Deploy orchest-controller
¶
The orchest-controller
is required to install and manage orchest
git clone https://github.com/orchest/orchest.git && cd orchest
# Create the orchest namespace, as the Orchest Controller and Cluster will be deployed in
# orchest namespace
kubectl create ns orchest
# Deploy orchest-controller
kubectl apply -f services/orchest-controller/deploy-controller
Install orchest-cli
¶
# Install orchest-cli via pip
pip install orchest-cli
Install orchest
via orchest-cli
¶
# Install orchest
orchest install
Now the cluster can be reached the IP returned by:
minikube ip
Note
We recommend to install Orchest on a clean cluster (a non-existing cluster) because it is hard to play well with other software already installed on the cluster, e.g, argo, etc.
Note
Authentication is disabled in default installation.
Tip
🎉 Now that you have installed Orchest, be sure to check out the quickstart tutorial.
Installing using an FQDN¶
If you would rather reach Orchest using a Fully Qualified Domain Name (FQDN) instead of using the cluster IP directly, you can install Orchest using:
orchest install --fqdn="localorchest.io"
# Set up the default Fully Qualified Domain Name (FQDN) in your
# /etc/hosts so that you can reach Orchest locally.
echo "$(minikube ip)\tlocalorchest.io" >> /etc/hosts
GPU support¶
Currently GPU support is not yet available. Coming soon!