From 923eb2e98ab50775d7fb9b14adb99197b85c0251 Mon Sep 17 00:00:00 2001 From: Stefan Nica Date: Tue, 21 Jan 2025 18:24:15 +0100 Subject: [PATCH] Add notes on missing features --- .../getting-started/zenml-pro/self-hosted.md | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/docs/book/getting-started/zenml-pro/self-hosted.md b/docs/book/getting-started/zenml-pro/self-hosted.md index 56b5e58625..4d483fd8f6 100644 --- a/docs/book/getting-started/zenml-pro/self-hosted.md +++ b/docs/book/getting-started/zenml-pro/self-hosted.md @@ -9,19 +9,34 @@ This page provides instructions for installing ZenML Pro - the ZenML Pro Control ## Overview -ZenML Pro can be installed as an self-hosted deployment. You need to be granted access to the ZenML Pro container images and you'll have to provide your own infrastructure: a Kubernetes cluster, a database server and a few other common prerequisites usually needed to expose Kubernetes services via HTTPs - a load balancer, an Ingress controller, HTTPs certificate(s) and DNS rule(s). +ZenML Pro can be installed as a self-hosted deployment. You need to be granted access to the ZenML Pro container images and you'll have to provide your own infrastructure: a Kubernetes cluster, a database server and a few other common prerequisites usually needed to expose Kubernetes services via HTTPs - a load balancer, an Ingress controller, HTTPs certificate(s) and DNS rule(s). This document will guide you through the process. +{% hint style="info" %} +Please note that the SSO (Single Sign-On) and running Pipeline Templates (i.e. running pipelines from the dashboard) features are currently not available in the on-prem version of ZenML Pro. These features are on our roadmap and will be added in future releases. +{% endhint %} + + ## Preparation and prerequisites ### Software Artifacts -The ZenML Pro on-prem installation relies on a set of container images and Helm charts. The container images are stored in private ZenML AWS ECR container registries located at `715803424590.dkr.ecr.eu-west-1.amazonaws.com`. +The ZenML Pro on-prem installation relies on a set of container images and Helm charts. The container images are stored in private ZenML container registries that are not available to the public. If you haven't done so already, please [book a demo](https://www.zenml.io/book-your-demo) to get access to the private ZenML Pro container images. -To access these repositories, you need to set up an AWS IAM user or IAM role in your AWS account. The steps below outline how to create an AWS account, configure the necessary IAM entities, and pull images from the private repositories. If you're familiar with AWS or even plan on using an AWS EKS cluster to deploy ZenML Pro, then you can simply use your existing IAM user or IAM role and skip steps 1. and 2. +The following section provides instructions for how to access the private ZenML Pro container images through AWS. + +{% hint style="info" %} +Currently, ZenML Pro container images are only available in AWS Elastic Container Registry (ECR). Support for Google Cloud Platform (GCP) Artifact Registry and Azure Container Registry (ACR) is on our roadmap and will be added soon. + +The ZenML support team can provide temporary credentials upon request, which can be used to pull these images without the need to set up any cloud provider resources. Contact support if you'd prefer this option. +{% endhint %} + +#### AWS + +To access the ZenML Pro container images stored in AWS ECR, you need to set up an AWS IAM user or IAM role in your AWS account. The steps below outline how to create an AWS account, configure the necessary IAM entities, and pull images from the private repositories. If you're familiar with AWS or even plan on using an AWS EKS cluster to deploy ZenML Pro, then you can simply use your existing IAM user or IAM role and skip steps 1. and 2. --- @@ -327,14 +342,14 @@ The scripts provided above are examples and may need to be adjusted based on you After downloading the Helm charts, you can use their local paths instead of a remote OCI registry to deploy ZenML Pro components. Here's an example of how to use them: ```bash -# Install the ZenML Pro Control Plane -helm install zenml-pro ./zenml-artifacts/charts/zenml-pro-0.10.24.tgz \ +# Install the ZenML Pro Control Plane (e.g. zenml-pro-0.10.24.tgz) +helm install zenml-pro ./zenml-artifacts/charts/zenml-pro-.tgz \ --namespace zenml-pro \ --create-namespace \ --values your-values.yaml -# Install a ZenML Pro Tenant Server -helm install zenml-tenant ./zenml-artifacts/charts/zenml-0.73.0.tgz \ +# Install a ZenML Pro Tenant Server (e.g. zenml-0.73.0.tgz) +helm install zenml-tenant ./zenml-artifacts/charts/zenml-.tgz \ --namespace zenml-tenant \ --create-namespace \ --values your-tenant-values.yaml