Skip to content

mesmacosta/google-datacatalog-postgresql-connector-anthos

Repository files navigation

PostgreSQL Connector Service

This depends on the environment: bank-of-anthos.

The PostgreSQL connector plugs in the bank-of-anthos enrivonment.

The connector pulls metadata from the accounts database and pushes in Google Data Catalog. This can be used in any GKE and Kubernetes environment to also connect with other PostgreSQL databases, by setting the environment variables with the correct values.

Implemented in Python with Flask using the google-datacatalog-postgresql-connector.

Architecture Diagram

Disclaimer: This is not an officially supported Google product.

Table of Contents


Endpoints

Endpoint Type Auth? Description
/sync POST 🔒 Synchronize PostgreSQL metadata into Google Data Catalog.
/ready GET Readiness probe endpoint.
/version GET Returns the contents of $VERSION

Environment Variables

  • VERSION

    • a version string for the service
  • PORT

    • the port for the webserver
  • LOG_LEVEL

  • ConfigMap environment-config:

    • LOCAL_ROUTING_NUM
      • the routing number for our bank
    • PUB_KEY_PATH
      • the path to the JWT signer's public key, mounted as a secret
  • ConfigMap accounts-db-config:

    • POSTGRES_DB
      • name of accounts-db database
    • POSTGRES_USER
      • user of accounts-db database
    • POSTGRES_PASSWORD
      • pasword of accounts-db database

Kubernetes Resources

Development Instructions

Deployment Instructions

Automated Sync

You can automate the sync execution by adding a cron job to the architecture:

Architecture Cron Diagram

Cron Deployment Instructions

About

Anthos foundation to run the google-datacatalog-postgresql-connector.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published