mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-20 23:18:01 +00:00
docs: Add Docs for Minimum Requirements (#19967)
* feat: Add Docs for Minimum Hardware Requirements * fix: Add s/w specifications and airflow specifications
This commit is contained in:
Akash Jain
GitHub
parent
dba37820d7
commit
cad7b6cfea
@ -1,9 +0,0 @@
|
|||||||
## Minimum Sizing Requirements
|
|
||||||
|
|
||||||
We recommend you to allocate openmetadata-server with minimum of 2vCPUs and 6 GiB Memory.
|
|
||||||
|
|
||||||
For External Services that openmetadata depends on -
|
|
||||||
- For the database, minimum 2 vCPUs and 2 GiB RAM (per instance) with 30 GiB of Storage Volume Attached (dynamic expansion up to 100 GiB)
|
|
||||||
- For Elasticsearch, minimum 2 vCPUs and 2 GiB RAM (per instance) with 30 GiB of Storage volume attached
|
|
||||||
|
|
||||||
These settings apply as well when using managed instances, such as AWS RDS or GCP CloudSQL or AWS OpenSearch.
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
## Minimum Sizing Requirements
|
|
||||||
|
|
||||||
We recommend you to allocate openmetadata-server with minimum of 2vCPUs and 6 GiB Memory.
|
|
||||||
|
|
||||||
For External Services that openmetadata depends on -
|
|
||||||
- For the database, minimum 2 vCPUs and 2 GiB RAM (per instance) with 30 GiB of Storage Volume Attached (dynamic expansion up to 100 GiB)
|
|
||||||
- For Elasticsearch, minimum 2 vCPUs and 2 GiB RAM (per instance) with 30 GiB of Storage volume attached
|
|
||||||
|
|
||||||
These settings apply as well when using managed instances, such as AWS RDS or GCP CloudSQL or AWS OpenSearch.
|
|
||||||
@ -80,8 +80,6 @@ Follow the instructions [here](https://docs.docker.com/compose/cli-command/#inst
|
|||||||
> Docker Compose version v2.2.3
|
> Docker Compose version v2.2.3
|
||||||
```
|
```
|
||||||
|
|
||||||
{% partial file="/v1.6/deployment/minimum-sizing-requirements.md" /%}
|
|
||||||
|
|
||||||
## Steps for Deploying OpenMetadata using Docker
|
## Steps for Deploying OpenMetadata using Docker
|
||||||
|
|
||||||
### 1. Create a directory for OpenMetadata
|
### 1. Create a directory for OpenMetadata
|
||||||
|
|||||||
@ -0,0 +1,60 @@
|
|||||||
|
---
|
||||||
|
title: Minimum Requirements
|
||||||
|
slug: /deployment/minimum-requirements
|
||||||
|
collate: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# Minimum Hardware Requirements
|
||||||
|
|
||||||
|
OpenMetadata requires either MySQL or PostgreSQL as Backend Database and ElasticSearch or OpenSearch as Search Engine.
|
||||||
|
|
||||||
|
Please refer to the [architecture section](/developers/architecture) for more details.
|
||||||
|
|
||||||
|
We recommend the following for the Production Grade OpenMetadata Installation -
|
||||||
|
|
||||||
|
## MySQL or PostgreSQL as Database
|
||||||
|
|
||||||
|
Our minimum specs recommendation for MySQL / PostgreSQL as database deployment is
|
||||||
|
- 4 vCPUs
|
||||||
|
- 16 GiB Memory
|
||||||
|
- 100 GiB Storage
|
||||||
|
|
||||||
|
These settings apply as well when using managed instances, such as AWS RDS or GCP CloudSQL or Azure Flexible Servers.
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
|
||||||
|
- MySQL version 8.0.0 or higher
|
||||||
|
- PostgreSQL version 12.0 or higher
|
||||||
|
|
||||||
|
## ElasticSearch or OpenSearch as Search Instance
|
||||||
|
|
||||||
|
Our minimum specs recommendation for ElasticSearch / OpenSearch deployment is
|
||||||
|
- 2 vCPUs
|
||||||
|
- 8 GiB Memory
|
||||||
|
- 100 GiB Storage (per node)
|
||||||
|
- Master / Worker Nodes with atleast 1 Master and 2 Worker Nodes
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
|
||||||
|
- ElasticSearch version 8.X till 8.11.4
|
||||||
|
- OpenSearch version 2.7
|
||||||
|
|
||||||
|
These settings apply as well when using managed instances, such as AWS OpenSearch Service or Elastic Cloud on GCP, AWS, Azure.
|
||||||
|
|
||||||
|
## Apache Airflow as Ingestion Instance
|
||||||
|
|
||||||
|
Our minimum specs recommendation for Apache Airflow is
|
||||||
|
- 4 vCPU
|
||||||
|
- 16 GiB Memory
|
||||||
|
- 100 GiB Storage for Airflow Dags and Logs
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
- Airflow version 2.9.1
|
||||||
|
|
||||||
|
Learn more about how to deploy and manage the ingestion workflows [here](/deployment/ingestion).
|
||||||
@ -20,6 +20,8 @@ site_menu:
|
|||||||
|
|
||||||
- category: Deployment
|
- category: Deployment
|
||||||
url: /deployment
|
url: /deployment
|
||||||
|
- category: Deployment / Minimum Requirements
|
||||||
|
url: /deployment/minimum-requirements
|
||||||
- category: Deployment / Bare Metal Deployment
|
- category: Deployment / Bare Metal Deployment
|
||||||
url: /deployment/bare-metal
|
url: /deployment/bare-metal
|
||||||
- category: Deployment / Bare Metal Deployment / Enable Security
|
- category: Deployment / Bare Metal Deployment / Enable Security
|
||||||
|
|||||||
@ -80,8 +80,6 @@ Follow the instructions [here](https://docs.docker.com/compose/cli-command/#inst
|
|||||||
> Docker Compose version v2.2.3
|
> Docker Compose version v2.2.3
|
||||||
```
|
```
|
||||||
|
|
||||||
{% partial file="/v1.7/deployment/minimum-sizing-requirements.md" /%}
|
|
||||||
|
|
||||||
## Steps for Deploying OpenMetadata using Docker
|
## Steps for Deploying OpenMetadata using Docker
|
||||||
|
|
||||||
### 1. Create a directory for OpenMetadata
|
### 1. Create a directory for OpenMetadata
|
||||||
|
|||||||
@ -0,0 +1,60 @@
|
|||||||
|
---
|
||||||
|
title: Minimum Requirements
|
||||||
|
slug: /deployment/minimum-requirements
|
||||||
|
collate: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# Minimum Hardware Requirements
|
||||||
|
|
||||||
|
OpenMetadata requires either MySQL or PostgreSQL as Backend Database and ElasticSearch or OpenSearch as Search Engine.
|
||||||
|
|
||||||
|
Please refer to the [architecture section](/developers/architecture) for more details.
|
||||||
|
|
||||||
|
We recommend the following for the Production Grade OpenMetadata Installation -
|
||||||
|
|
||||||
|
## MySQL or PostgreSQL as Database
|
||||||
|
|
||||||
|
Our minimum specs recommendation for MySQL / PostgreSQL as database deployment is
|
||||||
|
- 4 vCPUs
|
||||||
|
- 16 GiB Memory
|
||||||
|
- 100 GiB Storage
|
||||||
|
|
||||||
|
These settings apply as well when using managed instances, such as AWS RDS or GCP CloudSQL or Azure Flexible Servers.
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
|
||||||
|
- MySQL version 8.0.0 or higher
|
||||||
|
- PostgreSQL version 12.0 or higher
|
||||||
|
|
||||||
|
## ElasticSearch or OpenSearch as Search Instance
|
||||||
|
|
||||||
|
Our minimum specs recommendation for ElasticSearch / OpenSearch deployment is
|
||||||
|
- 2 vCPUs
|
||||||
|
- 8 GiB Memory
|
||||||
|
- 100 GiB Storage (per node)
|
||||||
|
- Master / Worker Nodes with atleast 1 Master and 2 Worker Nodes
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
|
||||||
|
- ElasticSearch version 8.X till 8.11.4
|
||||||
|
- OpenSearch version 2.7
|
||||||
|
|
||||||
|
These settings apply as well when using managed instances, such as AWS OpenSearch Service or Elastic Cloud on GCP, AWS, Azure.
|
||||||
|
|
||||||
|
## Apache Airflow as Ingestion Instance
|
||||||
|
|
||||||
|
Our minimum specs recommendation for Apache Airflow is
|
||||||
|
- 4 vCPU
|
||||||
|
- 16 GiB Memory
|
||||||
|
- 100 GiB Storage for Airflow Dags and Logs
|
||||||
|
|
||||||
|
### Software Requirements
|
||||||
|
|
||||||
|
OpenMetadata currently supports -
|
||||||
|
- Airflow version 2.9.1
|
||||||
|
|
||||||
|
Learn more about how to deploy and manage the ingestion workflows [here](/deployment/ingestion).
|
||||||
@ -20,6 +20,8 @@ site_menu:
|
|||||||
|
|
||||||
- category: Deployment
|
- category: Deployment
|
||||||
url: /deployment
|
url: /deployment
|
||||||
|
- category: Deployment / Minimum Requirements
|
||||||
|
url: /deployment/minimum-requirements
|
||||||
- category: Deployment / Bare Metal Deployment
|
- category: Deployment / Bare Metal Deployment
|
||||||
url: /deployment/bare-metal
|
url: /deployment/bare-metal
|
||||||
- category: Deployment / Bare Metal Deployment / Enable Security
|
- category: Deployment / Bare Metal Deployment / Enable Security
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user