60ff64c8ed
* Add changes for kubernetes deployment docs * Update Quickstart docker guide * fix: docker quickstart docs * Add troubleshooting guide for quickstart k8s * fix typo * upper case the placeholders * Add FAQs and update EKS deployment docs * fix: docs links * Update Deployment page * fix: update k8s gke docs * fix(chore): Notes as warning type * fix(chore): markdown link and typo * fix(refactor): Docker Deployment Docs * fix(refactor): Docker Deployment Docs * fix: upgrade k8s docs * fix(reviews): remove apache mod_proxy * fix(refactor): docker volumes docs section * fix(refactor): Code Review changes * Merge remote-tracking branch 'origin/main' into 12608 * Add troubleshoot docs for psql create extension pgcypto issue * fix: k8s docs with elasticsearch auth enabled * fix: Update the changes to v1.1.1 docs * fix: updated the docs for 1.1.1 * Add docker and kubernetes v1.1.1 changes in docs * fix: Docker Deployment Link * fix: more fixes --------- Co-authored-by: Akash-Jain <Akash.J@deuexsolutions.com>
3.1 KiB
| 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 requires 4 components
- OpenMetadata Server, pick the latest release from our (github releases)[https://github.com/open-metadata/OpenMetadata/releases]
- 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
- MySQL Version 8.0.0 or Greater
- Postgres Version 12.0 or Greater
- Search Engine (ElasticSearch, OpenSearch)
- We support ElasticSearch 7.16 to 7.17
- OpenSearch 1.3
- Workflow Orchestration Tools
OpenMetadata requires connectors to be scheduled to periodically fetch the metadata or you can use the OpenMetadata APIs to push the metadata as well
- OpenMetadata Ingestion Framework is flexible to run on any orchestrator. However we built an ability to deploy and manage connectors as pipelines from the UI. This requires the Airflow container we ship
- 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
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%}