OpenMetadata
Search…
Run in Kubernetes
This guide will help you run OpenMetadata using Helm Charts

Introduction

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

Prerequisites

  • 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

Quickstart

Assuming Kubernetes setup is done and your Kubernetes context points to a correct Kubernetes cluster, first we install OpenMetadata dependencies.
Add the OpenMetadata Helm repository by running the following command.
1
helm repo add open-metadata https://helm.open-metadata.org/
Copied!
Run the command helm repo list to ensure the OpenMetadata repository was added.
1
NAME URL
2
open-metadata https://helm.open-metadata.org/
Copied!
Deploy the dependencies by running the following command.
1
helm install openmetadata-dependencies open-metadata/openmetadata-dependencies
Copied!
Note - The above command uses configurations defined here. You can modify any configuration and deploy by passing your own values.yaml
1
helm install openmetadata-dependencies open-metadata/openmetadata-dependencies --values <<path-to-values-file>>
Copied!
Run kubectl get pods to check whether all the pods for the dependencies are running. You should get a result similar to below.
1
NAME READY STATUS RESTARTS AGE
2
elasticsearch-0 1/1 Running 0 3m56s
3
mysql-0 1/1 Running 0 3m56s
Copied!
Next, deploy OpenMetadata by running the following command.
1
helm install openmetadata open-metadata/openmetadata
Copied!
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 to check the status of pods running. You should get a result similar to the output below.
1
NAME READY STATUS RESTARTS AGE
2
elasticsearch-0 1/1 Running 0 5m34s
3
mysql-0 1/1 Running 0 5m34s
4
openmetadata-5566f4d8b9-544gb 1/1 Running 0 98s
Copied!
To expose the OpenMetadata UI on a local Kubernetes instance, run this command.
1
kubectl port-forward <openmetadata-front end pod name> 8585:8585
Copied!
Last modified 10d ago