Prerequisites

Before you deploy Self-Hosted Deployment on premises

읽는 시간 5분

최근 업데이트: 8일 전

Access to the container registry

Ensure that you have credentials for the Unity private container registry

uccmpprivatecloud.azurecr.io

. Unity provides these credentials. You need this information to download the vpctl CLI tool, pull release packages, and sync container images and ORAS artifacts to your private registry.

Tooling

Ensure that you have this tooling:

Access to a terminal, and basic knowledge of the command line
One of these tools if you use Microsoft Windows:
- Windows Subsystem for Linux (WSL)
- Git for Windows
ORAS CLI, to download the vpctl tool and the pull release packages from the registry
Helm (version 3.0 or later), to install the Helm charts
kubectl, to interact with your Kubernetes cluster
Docker, to sync the container images to your private registry
ArgoCD (recommended), for continuous delivery via GitOps. If you choose the ArgoCD deployment method, install it in the target cluster before you deploy: vpctl applies a single bootstrap
```
Application
```
and ArgoCD takes over from there. If you deploy with Helm, you don't need ArgoCD at all.
vpctl is the Unity CLI tool that manages the entire deployment lifecycle. To install it, refer to Install vpctl.

참고

We recommend ArgoCD as the deployment method. ArgoCD handles CRD installation ordering and detects configuration drift automatically, which makes ongoing operations more reliable. Helm is also fully supported if you prefer direct deployments without a GitOps workflow.

Install the vpctl tool

The vpctl install steps, requirements, and registry credential setup are documented separately. For more information, refer to Install vpctl.

Kubernetes

The deployment requires a Kubernetes cluster that you manage.

Use Kubernetes version 1.33 or later. Newer versions might also work, but we haven't tested them extensively.

Your cluster must include at least 3 schedulable nodes in the general workloads pool. Several stateful components run as 3-replica clusters by default and place each replica on a different node by using

podAntiAffinity

kubernetes.io/hostname

. These components include MongoDB (Percona Server for MongoDB), RabbitMQ, and Garage object storage. PostgreSQL also runs 3 replicas by default. If your cluster has only two nodes, some pods remain in the

Pending

state because the scheduler can't satisfy the anti-affinity requirement.

Storage classes

The cluster must provide two storage classes:

A default storage class for general-purpose persistent volumes (block storage). For example, a local-path provisioner, a SAN-backed CSI driver, or any block storage provisioner.
A ReadWriteMany (RWX) storage class for shared volumes that multiple pods can mount simultaneously. For example, an NFS provisioner, a distributed filesystem, or any CSI driver that supports the
```
ReadWriteMany
```
access mode.

You configure these storage class names in the manifest file during deployment.

Metrics API

The cluster must serve the

metrics.k8s.io

API, which the platform's horizontal pod autoscalers require. Most distributions provide it through

metrics-server

. Without it, autoscaled workloads can't read their resource usage and don't scale.

Namespaces

Services come preconfigured for use within a single Kubernetes namespace. You configure the target namespace in the manifest file.

Create the namespace before you deploy. The deployment doesn't create it for you.

Node pools

The platform separates general application workloads from asset transformation jobs. Configure your cluster with three node pools (or equivalent node groups):

Node pool	Node label	Taint	Recommended node size	Purpose
General workloads	None required	None	8–32 vCPUs; compute, general-purpose, or memory-optimized instances	Application services, databases, messaging
Transformations	`aks-node-pool=argocpu`	None	8–32 vCPUs; compute, general-purpose, or memory-optimized instances	Transformation workflow pods
Transformations (large)	`aks-node-pool=argocpu-large`	`aks-node-pool=argocpu-large:NoSchedule`	32–64 vCPUs; general-purpose or memory-optimized instances	Escalation pool for memory-intensive transformations; only pods that explicitly tolerate the taint are scheduled here

The exact mechanism to create node pools depends on your Kubernetes distribution (for example, static node labels, a node autoscaler, or a cluster API provider).

Network policies

During deployment to an existing cluster, you may need to control the flow of network traffic by using network policies. You can deploy most Kubernetes resources in a single namespace, which you can use to scope network isolation from other services that run in your cluster.

Container registry

By default, the platform pulls container images directly from the Unity source registry (

uccmpprivatecloud.azurecr.io

). This is the simplest setup and doesn't require a separate registry.

If your environment is air-gapped or if you need full control over artifact distribution, you can mirror artifacts to your own private container registry. Any OCI-compliant registry is supported, for example Harbor, JFrog Artifactory, or a cloud-managed registry such as Amazon ECR or Azure Container Registry. Use these commands to mirror artifacts from the Unity source registry to your private registry:

```
vpctl artifact sync images
```
: this command syncs the Docker container images.
```
vpctl artifact sync oras
```
; this command syncs the ORAS artifacts, for example, the Pixyz workflow templates.
```
vpctl artifact sync charts
```
: this command syncs the OCI Helm charts. This command is required only if your manifest opts in to the
```
deployment.helmChartMode: remote
```
preview. This command mirrors only the charts that have been published to the Unity OCI Helm registry so far.

System requirements

Ensure that you have these elements:

A valid hostname that can be updated to point to the IP of the load balancer
A valid Plastic license to run the UVCS server
A valid Unity Asset Transformer SDK license to run transformations on assets

A valid Unity Asset Transformer license is required for all users who perform asset transformations. The platform uses static licenses, so a floating license server is not required.

Validate your cluster

Check the prerequisites on this page automatically:


vpctl cluster check

The command verifies:

The Kubernetes version.
The number of schedulable nodes.
The transformation node pools.
The storage classes.
The target namespace.
The metrics API.
The in-cluster ArgoCD installation if your manifest configures ArgoCD. On the Helm deployment path, these checks are skipped.

The command reads from the cluster and doesn't change it. It prints a remediation hint for anything that doesn't pass.

Add

--probe-storage

to verify that each storage class can provision a volume, including

ReadWriteMany

support.

The command requires vpctl 0.13.0 or newer. For the full list of checks and options, refer to vpctl cluster commands.

Next steps

Deploy Self-Hosted Deployment

기술 자료

Development

User Acquisition

Monetization

산업 분야

기술 자료

Development

User Acquisition

Monetization

산업 분야

Self-Hosted Deployment

Amazon Web Services

Microsoft Azure

On premises

vpctl