---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://ydb.tech/docs/en/devops/enterprise-manager.md?version=main
  - https://ydb.tech/docs/ru/devops/enterprise-manager.md?version=main
sourcePath: en/core/devops/enterprise-manager/index.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/en/llms.txt

# YDB Enterprise Manager

YDB Enterprise Manager (hereinafter referred to as YDB EM) is a tool for centralized management of YDB clusters through a web interface and API.

{% note info %}

Deploying YDB clusters is possible without YDB EM — using [Ansible](https://ydb.tech/docs/en/devops/deployment-options/ansible/index.md?version=main), [Kubernetes](https://ydb.tech/docs/en/devops/deployment-options/kubernetes/index.md?version=main), or [manually](https://ydb.tech/docs/en/devops/deployment-options/manual/index.md?version=main). YDB EM provides a convenient web interface on top of existing clusters.

{% endnote %}

## Purpose {#purpose}

YDB EM connects to existing YDB clusters and provides a graphical interface and API for the following tasks:

* centralized access to databases and YDB clusters from a single interface;
* managing dynamic nodes of a cluster — starting, stopping, and scaling;
* managing databases — creating, deleting, and modifying parameters;
* monitoring cluster and node status;
* managing resources (CPU, RAM) allocated to dynamic nodes;
* advisor — diagnostics and recommendations for resolving the most common issues;
* advanced SQL editor for running queries against databases;
* AI assistant for working with YDB.

{% note warning %}

YDB EM does not deploy YDB clusters. Before using YDB EM, the cluster must be deployed using one of the [deployment options](https://ydb.tech/docs/en/devops/deployment-options/index.md?version=main).

{% endnote %}

## Architecture {#architecture}

YDB EM consists of three components:

* **Gateway** — web interface and API backend. Accepts requests from users (via a browser or API) and communicates with the Control Plane and the YDB EM database.
* **Control Plane (CP)** — coordinates cluster management. Receives commands from Gateway, stores configuration in the YDB EM database, and dispatches tasks to agents.
* **Agent** — runs on each YDB cluster host where dynamic nodes operate. The agent executes Control Plane commands: starts and stops YDB node processes, monitors their state, and reports information about available host resources.

To store its own metadata (cluster configuration, node state), YDB EM uses a YDB database — it can reside in the same cluster that EM manages.

### Interaction diagram {#interaction-diagram}


```mermaid
flowchart LR
    User[User] -- "HTTP/HTTPS" --> Gateway

    subgraph YDBEM [YDB EM]
        Gateway[Gateway]
        CP[Control Plane]
        EMDB[(YDB EM DB)]
        Gateway -- "gRPC" --> CP
        Gateway -- "gRPC" --> EMDB
        CP -- "gRPC" --> EMDB
    end

    subgraph Cluster [YDB Cluster]
        subgraph Host1 [Host 1]
            Node1[YDB Node]
            Agent1[Agent]
        end
        subgraph Host2 [Host 2]
            Node2[YDB Node]
            Agent2[Agent]
        end
        subgraph Host3 [Host N]
            Node3[YDB Node]
            Agent3[Agent]
        end
    end

    CP -- "gRPC" --> Agent1
    CP -- "gRPC" --> Agent2
    CP -- "gRPC" --> Agent3
    Agent1 -- "gRPC" --> CP
    Agent2 -- "gRPC" --> CP
    Agent3 -- "gRPC" --> CP
```


The user interacts with Gateway through a browser or API. Gateway forwards requests to the Control Plane, which coordinates the work of agents on cluster hosts. Agents manage YDB node processes and report host status.

## Key topics {#materials}

- [Initial deployment of YDB EM](https://ydb.tech/docs/en/devops/enterprise-manager/initial-deployment.md?version=main)
- [Configuring S3 backups for YDB EM](https://ydb.tech/docs/en/devops/enterprise-manager/s3-backups.md?version=main)
- [Configuring AI assistant in YDB EM](https://ydb.tech/docs/en/devops/enterprise-manager/ai-assistant.md?version=main)