Framework clusters
The framework provides several ready-to-use clusters that complement the clusters you build yourself. Each framework cluster is a self-contained Neos application that covers a cross-cutting concern (multitenant administration, licensing, scheduled tasks, AI monitoring, error reporting) and can be plugged into your environment without having to develop it.
What is a framework cluster?
A framework cluster is shipped and maintained by the Neos team and runs alongside your business clusters. It exposes its own UI, its own API and its own database, and integrates with your business clusters through standard Neos mechanisms (inter-cluster communication, dedicated client modules, etc.).
Available framework clusters:
- Tenant Management — Administration of tenants for multitenant clusters.
- License Management — Licensing of your clusters.
- Task Scheduler — Scheduling and execution of background tasks.
- Neos AI — Monitoring of artificial intelligence agents.
- Support Center — Collection and investigation of error reports submitted by end users.
Installation
Framework clusters fall into three categories depending on how they are made available to your environment.
Bundled with Neos
These clusters are installed at the same time as the Neos framework. No additional installation step is required, you only need to enable them.
| Cluster | Local enablement (neos run) |
|---|---|
| Tenant Management | --multitenant (-mt) |
See the neos run command reference for the full list of options.
Installed on demand via neos install-cluster
These clusters are distributed as separate NuGet packages and must be installed locally before they can be used. Run neos setup once to initialize the NuGet source, then install the cluster you need with neos install-cluster :
neos install-cluster LicenseManagement
neos install-cluster TaskScheduler
neos install-cluster NeosAI
Once installed, each cluster can be started locally via the matching neos run option:
| Cluster | NuGet package name | Local enablement (neos run) |
|---|---|---|
| License Management | LicenseManagement |
--license-management (-l) |
| Task Scheduler | TaskScheduler |
--task-scheduler (-ts) |
| Neos AI | NeosAI |
--neos-ai (-i) |
Use neos upgrade-cluster to update an installed cluster, and neos uninstall-cluster to remove it.
Note
Each on-demand cluster still requires its own configuration (database connection string, dedicated YAML file, etc.). Refer to the dedicated article of the cluster for the configuration details.
Available only in deployed environments
| Cluster | Notes |
|---|---|
| Support Center | Not started by neos run. It is deployed alongside other clusters in a Kubernetes namespace and discovered automatically. See Support Center for details. |