Kubernetes Deployment

OpenMetadata supports the Installation and Running of Application on kubernetes through Helm Charts.

openmetadata-helm-charts houses Kubernetes Helm charts for deploying OpenMetadata and its dependencies (Elasticsearch, MySQL and Airflow) on a Kubernetes cluster.

  • A Kubernetes cluster on any cloud
  • kubectl to manage Kubernetes resources
  • Helm to deploy resources based on Helm charts from the OpenMetadata repository

Note

OpenMetadata ONLY supports Helm 3.

This guide assumes your helm chart release names are openmetadata and openmetadata-dependencies and the kubernetes namespace used is default.

Assuming Kubernetes setup is done and your Kubernetes context points to a correct Kubernetes cluster, first we create kubernetes secrets that contains MySQL and Airflow passwords as secrets.

kubectl create secret generic mysql-secrets --from-literal=openmetadata-mysql-password=openmetadata_password
kubectl create secret generic airflow-secrets --from-literal=openmetadata-airflow-password=admin

The above commands sets the passwords as an example. Change to any password of your choice.

Next, install the OpenMetadata dependencies by adding the OpenMetadata Helm repository with the following command.

helm repo add open-metadata https://helm.open-metadata.org/

Run the command helm repo list to ensure the OpenMetadata repository was added.

NAME            URL                            
open-metadata   https://helm.open-metadata.org/

Assuming kubectl context points to the correct kubernetes cluster, first create the kubernetes secrets that contain airflow mysql password as secrets.

kubectl create secret generic airflow-mysql-secrets --from-literal=airflow-mysql-password=airflow_pass

Deploy the dependencies by running the following command:

helm install openmetadata-dependencies open-metadata/openmetadata-dependencies

Note

The above command uses configurations defined here. You can modify any configuration and deploy by passing your own values.yaml

helm install openmetadata-dependencies open-metadata/openmetadata-dependencies --values <path-to-values-file>

Run kubectl get pods to check whether all the pods for the dependencies are running. You should get a result similar to below.

NAME                                                       READY   STATUS     RESTARTS   AGE
elasticsearch-0                                            1/1     Running   0          4m26s
mysql-0                                                    1/1     Running   0          4m26s
openmetadata-dependencies-db-migrations-5984f795bc-t46wh   1/1     Running   0          4m26s
openmetadata-dependencies-scheduler-5b574858b6-75clt       1/1     Running   0          4m26s
openmetadata-dependencies-sync-users-654b7d58b5-2z5sf      1/1     Running   0          4m26s
openmetadata-dependencies-triggerer-8d498cc85-wjn69        1/1     Running   0          4m26s
openmetadata-dependencies-web-64bc79d7c6-7n6v2             1/1     Running   0          4m26s

Please note that the pods names above as openmetadata-dependencies-* are part of airflow deployments.

Helm Chart for OpenMetadata Dependencies uses the following helm charts:

If you want to customise helm values for the dependencies as per your cluster, you can follow the above links and update your custom helm values.yaml.

Airflow uses DAGs and Logs for persistence volumes with the Kubernetes Executor.

Make sure your kubernetes cluster storage provisioner has persistent volumes capability of ReadWriteMany Access Mode. Modify the Helm Values for airflow as per your requirement here.

This is not required if you are deploying on kubernetes cluster created by minkube or Docker Desktop. Check the storage provider compatibility here.

Next, deploy OpenMetadata by running the following command:

helm install openmetadata open-metadata/openmetadata

Again, this uses the values defined here. Use the --values flag to point to your own YAML configuration if needed.

Note

The values in values.yaml are preset to match with dependencies deployed using openmetadata-dependencies with release name "openmetadata-dependencies". If you deployed helm chart using different release name, make sure to update values.yaml accordingly before installing.

Run kubectl get pods --selector=app.kubernetes.io/name=openmetadata to check the status of pods running. You should get a result similar to the output below:

NAME                            READY   STATUS    RESTARTS   AGE
openmetadata-5c55f6759c-52dvq   1/1     Running   0          90s

To expose the OpenMetadata UI on a local Kubernetes instance, run this command:

kubectl port-forward <openmetadata-front end pod name> 8585:8585

Please follow our Enable Security Guide to configure security for your OpenMetadata installation.

Run the below command to view status of openmetadata helm chart deployed:

helm status openmetadata

For more information, visit helm command line reference here.

Run the below command to list openmetadata kubernetes pods deployed in a namespace:

kubectl get pods --namespace <NAMESPACE_NAME> -l='app.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=<RELEASE_NAME>'

For example, list pods deployed by helm release name ometa in the namespace ometa-dev:

kubectl get pods --namespace ometa-dev -l='app.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=ometa'

Next, view the logs of pod by running the below command,

kubectl logs <POD_NAME> --namespace <NAMESPACE_NAME>

For more information, visit the kubectl logs command line reference documentation here.

Use the below command to uninstall OpenMetadata Helm Charts completely.

helm uninstall openmetadata
helm uninstall openmetadata-dependencies

MySql and ElasticSearch OpenMetadata Dependencies as deployed as StatefulSets and have persistent volumes (pv) and persistent volume claims (pvc). These will need to be manually cleaned after helm uninstall. You can use kubectl delete CLI command for the same.

If you are running OpenMetadata in AWS, it is recommended to use Amazon RDS and Amazon OpenSearch Service.

We support

  • Amazon RDS (MySQL) engine version upto 8.0.29
  • Amazon OpenSearch (ElasticSearch) engine version upto 7.10 or Amazon OpenSearch engine version upto 1.3
  • Amazon RDS (PostgreSQL) engine version upto 14.2-R1

For Production Systems, we recommend Amazon RDS to be in Multiple Availibility Zones. For Amazon OpenSearch (or ElasticSearch) Service, we recommend Multiple Availibility Zones with minimum 3 Master Nodes.

Once you have the RDS and OpenSearch Services Setup, you can update the environment variables below for OpenMetadata kubernetes deployments to connect with Database and ElasticSearch.

# openmetadata-values.prod.yaml
...
global:
  elasticsearch:
    host: <AMAZON_OPENSEARCH_SERVICE_ENDPOINT_WITHOUT_HTTPS>
    port: 443
    scheme: https
    connectionTimeoutSecs: 5
    socketTimeoutSecs: 60
    batchSize: 10
    auth:
      enabled: false
      username: <AMAZON_OPENSEARCH_USERNAME>
      password:
        secretRef: elasticsearch-secrets
        secretKey: openmetadata-elasticsearch-password
  database:
    host: <AMAZON_RDS_ENDPOINT>
    port: 3306
    driverClass: com.mysql.cj.jdbc.Driver
    dbScheme: mysql
    dbUseSSL: true
    databaseName: <RDS_DATABASE_NAME>
    auth:
      username: <RDS_DATABASE_USERNAME>
      password:
        secretRef: mysql-secrets
        secretKey: openmetadata-mysql-password
...

Make sure to create RDS and OpenSearch credentials as Kubernetes Secrets mentioned here.

Still have questions?

You can take a look at our Q&A or reach out to us in Slack

Was this page helpful?

editSuggest edits