dp-import-api

module
v1.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 21, 2021 License: MIT

README

DP Import API

Getting started
MongoDB
  • Run brew install mongodb
  • Run brew services start mongodb
kafka
  • Run brew install java
  • Run brew install kafka
  • Run brew services start zookeeper
  • Run brew services start kafka

Scripts for updating and debugging Kafka can be found here(dp-data-tools)

Configuration
Environment variable Default Description
BIND_ADDR :21800 The host and port to bind to
KAFKA_ADDR localhost:9092 A list of kafka brokers
KAFKA_MAX_BYTES 200000 The max message size for kafka producer
DATABAKER_IMPORT_TOPIC data-bake-job-available The topic to place messages to data-baker
INPUT_FILE_AVAILABLE_TOPIC input-file-available The topic to place V4 files
HOST "http://localhost:21800" The host name used to build URLs
MONGODB_IMPORTS_ADDR "localhost:27017" Address of MongoDB
MONGODB_IMPORTS_DATABASE "imports" The mongodb database to store imports
MONGODB_IMPORTS_COLLECTION "imports" The mongodb collection to store imports
DATASET_API_URL "http://localhost:22000" The URL for the DatasetAPI
DATASET_API_AUTH_TOKEN "FD0108EA-825D-411C-9B1D-41EF7727F465" The Auth Token for the DatasetAPI
RECIPE_API_URL "http://localhost:22300" The URL for the RecipeAPI
ZEBEDEE_URL "http://localhost:8082" The URL Zebedee
SERVICE_AUTH_TOKEN "0C30662F-6CF6-43B0-A96A-954772267FF5" The token used to identify this service when authenticating
HEALTHCHECK_INTERVAL 30s The time between calling healthcheck endpoints for check subsystems
HEALTHCHECK_CRITICAL_TIMEOUT 90s The time taken for the health changes from warning state to critical due to subsystem check failures
DEFAULT_MAXIMUM_LIMIT 1000 Default maximum limit for pagination
DEFAULT_LIMIT 20 Default limit for pagination
DEFAULT_OFFSET 0 Default offset for pagination
Contributing

See CONTRIBUTING for details.

License

Copyright © 2016-2021, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL