From cad7b6cfea0ff916641916ba8d6afe201bccdae0 Mon Sep 17 00:00:00 2001 From: Akash Jain <15995028+akash-jain-10@users.noreply.github.com> Date: Mon, 17 Mar 2025 17:23:04 +0000 Subject: [PATCH] docs: Add Docs for Minimum Requirements (#19967) * feat: Add Docs for Minimum Hardware Requirements * fix: Add s/w specifications and airflow specifications --- .../deployment/minimum-sizing-requirements.md | 9 --- .../deployment/minimum-sizing-requirements.md | 9 --- .../content/v1.6.x/deployment/docker/index.md | 2 - .../v1.6.x/deployment/minimum-requirements.md | 60 +++++++++++++++++++ openmetadata-docs/content/v1.6.x/menu.md | 2 + .../deployment/docker/index.md | 2 - .../deployment/minimum-requirements.md | 60 +++++++++++++++++++ .../content/v1.7.x-SNAPSHOT/menu.md | 2 + 8 files changed, 124 insertions(+), 22 deletions(-) delete mode 100644 openmetadata-docs/content/partials/v1.6/deployment/minimum-sizing-requirements.md delete mode 100644 openmetadata-docs/content/partials/v1.7/deployment/minimum-sizing-requirements.md create mode 100644 openmetadata-docs/content/v1.6.x/deployment/minimum-requirements.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/minimum-requirements.md diff --git a/openmetadata-docs/content/partials/v1.6/deployment/minimum-sizing-requirements.md b/openmetadata-docs/content/partials/v1.6/deployment/minimum-sizing-requirements.md deleted file mode 100644 index 462fb492904..00000000000 --- a/openmetadata-docs/content/partials/v1.6/deployment/minimum-sizing-requirements.md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/openmetadata-docs/content/partials/v1.7/deployment/minimum-sizing-requirements.md b/openmetadata-docs/content/partials/v1.7/deployment/minimum-sizing-requirements.md deleted file mode 100644 index 462fb492904..00000000000 --- a/openmetadata-docs/content/partials/v1.7/deployment/minimum-sizing-requirements.md +++ /dev/null @@ -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. \ No newline at end of file diff --git a/openmetadata-docs/content/v1.6.x/deployment/docker/index.md b/openmetadata-docs/content/v1.6.x/deployment/docker/index.md index 2a39f7ab9ba..60f60e33f47 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/docker/index.md +++ b/openmetadata-docs/content/v1.6.x/deployment/docker/index.md @@ -80,8 +80,6 @@ Follow the instructions [here](https://docs.docker.com/compose/cli-command/#inst > Docker Compose version v2.2.3 ``` -{% partial file="/v1.6/deployment/minimum-sizing-requirements.md" /%} - ## Steps for Deploying OpenMetadata using Docker ### 1. Create a directory for OpenMetadata diff --git a/openmetadata-docs/content/v1.6.x/deployment/minimum-requirements.md b/openmetadata-docs/content/v1.6.x/deployment/minimum-requirements.md new file mode 100644 index 00000000000..cbb2e897db3 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/deployment/minimum-requirements.md @@ -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). diff --git a/openmetadata-docs/content/v1.6.x/menu.md b/openmetadata-docs/content/v1.6.x/menu.md index 9614af013be..9d4784c8622 100644 --- a/openmetadata-docs/content/v1.6.x/menu.md +++ b/openmetadata-docs/content/v1.6.x/menu.md @@ -20,6 +20,8 @@ site_menu: - category: Deployment url: /deployment + - category: Deployment / Minimum Requirements + url: /deployment/minimum-requirements - category: Deployment / Bare Metal Deployment url: /deployment/bare-metal - category: Deployment / Bare Metal Deployment / Enable Security diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/docker/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/docker/index.md index 1d73f43d3cf..4c9606cc9a2 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/docker/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/docker/index.md @@ -80,8 +80,6 @@ Follow the instructions [here](https://docs.docker.com/compose/cli-command/#inst > Docker Compose version v2.2.3 ``` -{% partial file="/v1.7/deployment/minimum-sizing-requirements.md" /%} - ## Steps for Deploying OpenMetadata using Docker ### 1. Create a directory for OpenMetadata diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/minimum-requirements.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/minimum-requirements.md new file mode 100644 index 00000000000..cbb2e897db3 --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/deployment/minimum-requirements.md @@ -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). diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md index d75b4be1d18..95dcbb26c89 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md @@ -20,6 +20,8 @@ site_menu: - category: Deployment url: /deployment + - category: Deployment / Minimum Requirements + url: /deployment/minimum-requirements - category: Deployment / Bare Metal Deployment url: /deployment/bare-metal - category: Deployment / Bare Metal Deployment / Enable Security