Skip to content

Commit

Permalink
doc(ingestion): add examples of running in docker and Kubernetes (dat…
Browse files Browse the repository at this point in the history
  • Loading branch information
anshbansal authored and maggiehays committed Aug 1, 2022
1 parent e8ce028 commit 1867672
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion metadata-ingestion/sink_docs/datahub.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down

0 comments on commit 1867672

Please sign in to comment.