From 14937a09c0f7396ed18340dee37d803b7ddd7145 Mon Sep 17 00:00:00 2001
From: Aseem Bansal <asmbansal2@gmail.com>
Date: Tue, 29 Mar 2022 19:35:29 +0530
Subject: [PATCH] doc(ingestion): add examples of running in docker and
 Kubernetes

---
 metadata-ingestion/sink_docs/datahub.md | 26 ++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/metadata-ingestion/sink_docs/datahub.md b/metadata-ingestion/sink_docs/datahub.md
index f783a8f541f8ae..77048b5e2e448c 100644
--- a/metadata-ingestion/sink_docs/datahub.md
+++ b/metadata-ingestion/sink_docs/datahub.md
@@ -17,7 +17,7 @@ is that any errors can immediately be reported.
 
 Check out the following recipe to get started with ingestion! See [below](#config-details) for full configuration options.
 
-For general pointers on writing and running a recipe, see our [main recipe guide](../README.md#recipes).
+For general pointers on writing and running a recipe, see our [main recipe guide](../README.md#recipes). This should point to the GMS server.
 
 ```yml
 source:
@@ -28,6 +28,30 @@ sink:
     server: "http://localhost:8080"
 ```
 
+If you are running the ingestion in a container in docker and your [GMS is also running in docker](../../docker/README.md) then you should use the internal docker hostname of the GMS pod. Usually it would look something like
+
+```yml
+source:
+  # source configs
+sink:
+  type: "datahub-rest"
+  config:
+    server: "http://datahub-gms:8080"
+```
+
+If GMS is running in a kubernetes pod [deployed through the helm charts](../../docs/deploy/kubernetes.md) and you are trying to connect to it from within the kubernetes cluster then you should use the Kubernetes service name of GMS. Usually it would look something like
+
+```yml
+source:
+  # source configs
+sink:
+  type: "datahub-rest"
+  config:
+    server: "http://datahub-datahub-gms.datahub.svc.cluster.local:8080"
+```
+
+If you are using [UI based ingestion](../../docs/ui-ingestion.md) then where GMS is deployed decides what hostname you should use.
+
 ### Config details
 
 Note that a `.` is used to denote nested fields in the YAML recipe.