yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-24 09:50:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.1.0/deployment/index.md

3.6 KiB
Raw Blame History

title slug
Deployment /deployment

Deploy OpenMetadata in Production

{%note%} Are you looking to do POC? It won't get easier than following our Quickstart guide! {%/note%}

OpenMetadata Deployment Architecture

{% image src="/images/v1.1.0/deployment/architecture.png" alt="architecture" /%}

OpenMetadata requirements

As shown in the deployment architecture above, OpenMetadata requires following 3 and an optional Airflow instance

  1. OpenMetadata Server, pick the latest release from our (github releases)[https://github.com/open-metadata/OpenMetadata/releases]
  2. OpenMetadata Server stores the metadata in a relational database. We support MySQL or Postgres. Any Cloud provider such as AWS or GCP's provided MySQL/Postgres services will work as well
    1. MySQL Version 8.0.0 or Greater
    2. Postgres Version 12.0 or Greater
  3. Search Engine (ElasticSearch, OpenSearch)
    1. We support ElasticSearch 7.16 to 7.17
    2. OpenSearch 1.3
  4. Metadata Connector's Scheduler (optional) OpenMetadata requires connectors to be scheduled to periodically fetch the metadata or you can use the OpenMetadata APIs to push the metadata as well.
    1. OpenMetadata Ingestion Framework is flexible to run on any orchestrator. However we built an ability to deploy and manage connectors as pipelines from the OpenMetadata UI. This requires the Airflow container we ship. If you have an existing Airflow you can also install the REST APIs we developed for it by following the steps here
    2. If your team prefers to run on any other orchestrator such as prefect, dagster or even github workflows. Please refer to our recent webinar on How Ingestion Framework works or refer to docs here for an example

The Dependencies must be deployed before installing OpenMetadata Application. With Docker and Kubernetes deployment, we package these together as part of quickstart.

{% note noteType="Warning" %} For production deployment, we recommend you to bring up MySQL/Postgres, Elastic/OpenSearch, Scheduler (like airflow) as an external service and do not rely on quickstart packages. {% /note %}

Deployment Options

We support following deployment options

{%inlineCalloutContainer%} {%inlineCallout color="violet-70" icon="celebration" bold="Deploy on Docker" href="/quick-start/local-deployment"%} Deploy OpenMetadata with Docker {%/inlineCallout%} {%inlineCallout color="violet-70" icon="storage" bold="Deploy on Bare Metal" href="/deployment/bare-metal"%} Deploy OpenMetadata directly using the binaries. {%/inlineCallout%} {%inlineCallout color="violet-70" icon="fit_screen" bold="Deploy on Kubernetes" href="/deployment/kubernetes"%} Deploy and scale with Kubernetes {%/inlineCallout%} {%/inlineCalloutContainer%}

Security

Secure your OpenMetadata deployment

{%inlineCalloutContainer%} {%inlineCallout color="violet-70" icon="add_moderator" bold="Enable Security" href="/deployment/security"%} Enable Security for your OpenMetadata deployment {%/inlineCallout%} {%/inlineCalloutContainer%}

Upgrade

Learn how to move from version to version:

{%inlineCalloutContainer%} {%inlineCallout color="violet-70" icon="10k" bold="Upgrade OpenMetadata" href="/deployment/upgrade/"%} Upgrade your OpenMetadata deployment {%/inlineCallout%} {%/inlineCalloutContainer%}