From 0bf62da23dfff6c71a8404633ef40bd70554c2d5 Mon Sep 17 00:00:00 2001 From: Shannon Bradshaw Date: Mon, 22 Nov 2021 17:55:06 +0000 Subject: [PATCH] GitBook: [#29] Clean up Run in Kubernetes docs. --- docs/install/run-in-kubernetes.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/install/run-in-kubernetes.md b/docs/install/run-in-kubernetes.md index 4dce8414885..4f7fb559dec 100644 --- a/docs/install/run-in-kubernetes.md +++ b/docs/install/run-in-kubernetes.md @@ -2,37 +2,42 @@ description: This guide will help you run OpenMetadata using Helm Charts --- -# Open Metadata Helm Charts +# Run in Kubernetes [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/open-metadata)](https://artifacthub.io/packages/search?repo=open-metadata) ## Introduction -[openmetadata-helm-charts](https://github.com/open-metadata/openmetadata-helm-charts) houses Kubernetes [Helm](https://helm.sh) charts for deploying Open Metadata and it's dependencies (Elastic Search and MySQL) on a Kubernetes Cluster. +[openmetadata-helm-charts](https://github.com/open-metadata/openmetadata-helm-charts) houses Kubernetes [Helm](https://helm.sh) charts for deploying OpenMetadata and its dependencies (Elasticsearch and MySQL) on a Kubernetes cluster. ## Prerequisites -- [Kubernetes Cluster](https://kubernetes.io) - Set up a kubernetes cluster on any cloud -- [Kubectl](https://kubernetes.io/docs/tasks/tools/) to manage Kubernetes Resources -- [Helm](https://helm.sh) to deploy resources based on Helm Charts from this repository. Note, we only support Helm 3 +* A [Kubernetes cluster](https://kubernetes.io) on any cloud +* [kubectl](https://kubernetes.io/docs/tasks/tools/) to manage Kubernetes resources +* [Helm](https://helm.sh) to deploy resources based on Helm charts from the OpenMetadata repository + +{% hint style="info" %} +Note, OpenMetadata only supports Helm 3 +{% endhint %} ## Quickstart -Assuming Kubernetes setup is done and your kubernetes context is points to a correct kubernetes cluster, first we install Open Metadata dependencies. +Assuming Kubernetes setup is done and your Kubernetes context points to a correct Kubernetes cluster, first we install OpenMetadata dependencies. -Add openmetadata helm repo by running the following - +Add the OpenMetadata Helm repository by running the following command. ``` helm repo add open-metadata https://helm.open-metadata.org/ ``` -Run the command `helm repo list` to list the addition of openmetadata helm repo - + +Run the command `helm repo list` to ensure the OpenMetadata repository was added. ``` NAME URL open-metadata https://helm.open-metadata.org/ ``` -Deploy the dependencies by running +Deploy the dependencies by running the following command. ``` helm install openmetadata-dependencies open-metadata/openmetadata-dependencies @@ -54,7 +59,7 @@ elasticsearch-0 1/1 Running 0 3m56s mysql-0 1/1 Running 0 3m56s ``` -Next, deploy the openmetadata by running the following +Next, deploy OpenMetadata by running the following command. ``` helm install openmetadata open-metadata/openmetadata @@ -62,7 +67,7 @@ helm install openmetadata open-metadata/openmetadata Values in [values.yaml](https://raw.githubusercontent.com/open-metadata/openmetadata-helm-charts/main/charts/openmetadata/values.yaml) are preset to match with dependencies deployed using [openmetadata-dependencies](https://github.com/open-metadata/openmetadata-helm-charts/tree/main/charts/deps) 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` command to check the statuses of pods running you should get a result similar to below. +Run `kubectl get pods` to check the status of pods running. You should get a result similar to the output below. ``` NAME READY STATUS RESTARTS AGE @@ -72,9 +77,9 @@ openmetadata-5566f4d8b9-544gb 1/1 Running 0 98s ``` {% hint style="info" %} -To expose the Openmetadata UI on local kubernetes instance, run the below command - +To expose the OpenMetadata UI on a local Kubernetes instance, run this command. ``` kubectl port-forward 8585:8585 ``` -{% endhint %} \ No newline at end of file +{% endhint %}