Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Adds docs on K8s scheduled ingestion #5984

Merged
merged 2 commits into from
Sep 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ module.exports = {
"metadata-ingestion/schedule_docs/intro",
"metadata-ingestion/schedule_docs/cron",
"metadata-ingestion/schedule_docs/airflow",
"metadata-ingestion/schedule_docs/kubernetes",
],
},
// {
Expand Down
47 changes: 47 additions & 0 deletions metadata-ingestion/schedule_docs/kubernetes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Using Kubernetes

If you have deployed DataHub using our official [helm charts](https://github.com/acryldata/datahub-helm) you can use the
datahub ingestion cron subchart to schedule ingestions.

Here is an example of what that configuration would look like in your **values.yaml**:

```yaml
datahub-ingestion-cron:
enabled: true
crons:
mysql:
schedule: "0 * * * *" # Every hour
recipe:
configmapName: recipe-config
fileName: mysql_recipe.yml
```

This assumes the pre-existence of a Kubernetes ConfigMap which holds all recipes being scheduled in the same namespace as
where the cron jobs will be running.

An example could be:
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: recipe-config
data:
mysql_recipe.yml: |-
source:
type: mysql
config:
# Coordinates
host_port: <MYSQL HOST>:3306
database: dbname

# Credentials
username: root
password: example

sink:
type: datahub-rest
config:
server: http://<GMS_HOST>:8080
```

For more information, please see the [documentation](https://github.com/acryldata/datahub-helm/tree/master/charts/datahub/subcharts/datahub-ingestion-cron) of this sub-chart.