Skip to content

Commit

Permalink
Fix docs layout
Browse files Browse the repository at this point in the history
  • Loading branch information
stefannica committed Feb 3, 2025
1 parent 68565ea commit 7831c8d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/book/getting-started/zenml-pro/self-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,9 +282,7 @@ First, you'll need a machine with both internet access and sufficient storage sp
1. Follow the authentication steps described above to gain access to the private repositories
2. Install the required tools:
- Docker
- AWS CLI
- Helm
- A tool like `skopeo` for copying container images (optional but recommended)

**2. Download All Required Artifacts**

Expand All @@ -307,7 +305,7 @@ mkdir -p zenml-artifacts/charts
# Use the following if you're pulling from the ZenML private ECR registry
ZENML_PRO_REGISTRY="715803424590.dkr.ecr.eu-west-1.amazonaws.com"
ZENML_PRO_SERVER_REGISTRY="715803424590.dkr.ecr.eu-central-1.amazonaws.com"
# Use the following if you're pulling from the ZenML public GCP Artifact Registry
# Use the following if you're pulling from the ZenML private GCP Artifact Registry
# ZENML_PRO_REGISTRY="europe-west3-docker.pkg.dev/zenml-cloud/zenml-pro"
# ZENML_PRO_SERVER_REGISTRY=$ZENML_PRO_REGISTRY
ZENML_HELM_REGISTRY="public.ecr.aws/zenml"
Expand Down Expand Up @@ -491,9 +489,7 @@ To deploy the ZenML Pro control plane and one or more ZenML Pro tenant servers,
- Value: `<Load Balancer IP>`
- Use a DNS propagation checker to confirm that the DNS record is resolving correctly.

{% hint style="warning" %}
Make sure you don't use a simple DNS prefix for the servers (e.g. `https://zenml.cluster` is not recommended). This is especially relevant for the TLS certificates that you have to prepare for these endpoints. Always use a fully qualified domain name (FQDN) (e.g. `https://zenml.ml.cluster`). The TLS certificates will not be accepted by some browsers otherwise (e.g. Chrome).
{% endhint %}
{% hint style="warning" %}Make sure you don't use a simple DNS prefix for the servers (e.g. `https://zenml.cluster` is not recommended). This is especially relevant for the TLS certificates that you have to prepare for these endpoints. Always use a fully qualified domain name (FQDN) (e.g. `https://zenml.ml.cluster`). The TLS certificates will not be accepted by some browsers otherwise (e.g. Chrome).{% endhint %}
5. **SSL Certificate**
Expand All @@ -507,9 +503,7 @@ To deploy the ZenML Pro control plane and one or more ZenML Pro tenant servers,
- Free services like [Let's Encrypt](https://letsencrypt.org/) for domain validation and issuance.
- Self-signed certificates (not recommended for production environments).

{% hint style="warning" %}
If you are using self-signed certificates, it is highly recommended to use the same self-signed CA certificate for all the ZenML Pro services (control plane and tenant servers), otherwise it will be difficult to manage the certificates on the client machines. With only one CA certificate, you can install it system-wide on all the client machines only once and then use it to sign all the TLS certificates for the ZenML Pro services.
{% endhint %}
{% hint style="warning" %}If you are using self-signed certificates, it is highly recommended to use the same self-signed CA certificate for all the ZenML Pro services (control plane and tenant servers), otherwise it will be difficult to manage the certificates on the client machines. With only one CA certificate, you can install it system-wide on all the client machines only once and then use it to sign all the TLS certificates for the ZenML Pro services.{% endhint %}

- **Configuring SSL Termination**

Expand Down Expand Up @@ -591,6 +585,12 @@ To deploy the ZenML Pro control plane and one or more ZenML Pro tenant servers,
- Reference the domain in your IngressRoute or Middleware configuration.
The above are infrastructure requirements for ZenML Pro. If, in addition to ZenML, you would also like to reuse the same Kubernetes cluster to run machine learning workloads with ZenML, you will require the following additional infrastructure resources and services to be able to set up [a remote ZenML Stack](../../user-guide/production-guide/understand-stacks.md):
- [a Kubernetes ZenML Orchestrator](../../component-guide/orchestrators/kubernetes.md) can be set up to run on the same cluster as ZenML Pro. For authentication, you will be able to configure [a ZenML Kubernetes Service Connector using service account tokens](../../how-to/infrastructure-deployment/auth-management/kubernetes-service-connector.md)
- you'll need a container registry to store the container images built by ZenML. If you don't have one already, you can install [Docker registry](https://github.com/twuni/docker-registry.helm) on the same cluster as ZenML Pro.
- you'll also need some form of centralized object storage to store the artifacts generated by ZenML. If you don't have one already, you can install [MinIO](https://artifacthub.io/packages/helm/bitnami/minio) on the same cluster as ZenML Pro and then configure the [ZenML S3 Artifact Store](../../component-guide/artifact-stores/s3.md) to use it.
## Stage 1/2: Install the ZenML Pro Control Plane
### Set up Credentials
Expand Down

0 comments on commit 7831c8d

Please sign in to comment.