diff --git a/docs/install/run-in-kubernetes.md b/docs/install/run-in-kubernetes.md index 4f7fb559dec..fd7b090bddf 100644 --- a/docs/install/run-in-kubernetes.md +++ b/docs/install/run-in-kubernetes.md @@ -83,3 +83,37 @@ To expose the OpenMetadata UI on a local Kubernetes instance, run this command. kubectl port-forward 8585:8585 ``` {% endhint %} + +## Troubleshooting +### View helm chart deployment status + +Run the below command to view status of openmetadata helm chart deployed - + +``` +helm status openmetadata +``` + +For more information, visit helm command line reference [here](https://helm.sh/docs/helm/helm_status/). + +### View openmetadata kubernetes pod logs + +Run the below command to list openmetadata kubernetes pods deployed in a namespace - + +``` +kubectl get pods --namespace -l='app.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=' +``` + +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 --namespace +``` + +For more information, visit the kubectl logs command line reference documentation [here](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-running-pod/). + diff --git a/docs/install/run-openmetadata.md b/docs/install/run-openmetadata.md index d5d2eea34a2..adb44ce6fc8 100644 --- a/docs/install/run-openmetadata.md +++ b/docs/install/run-openmetadata.md @@ -193,6 +193,22 @@ You should see a page similar to the following as the landing page for the OpenM ### Troubleshooting +#### Viewing docker container logs + +You can view the logs generated by openmetadata containers with the below command - + +``` +docker-compose logs +``` + +or + +``` +docker logs +``` + +For further reference, visit command line documentation for [docker-compose logs](https://docs.docker.com/compose/reference/logs/) and [docker logs](https://docs.docker.com/engine/reference/commandline/logs/) + #### Could not find a version that satisfied the requirement ```