Management Database Endpoints

Management Compile HS Database Endpoint

Endpoint: Management Compile Hyperscan Database

Method: GET

RESPONSES:
  • 200: Doesn’t matter it will always return a done status
  • 400: Unable to compile new hyperscan database

The Compile Hyperscan Database endpoint provides you with the ability to compile a new Hyperscan Database from the current SQLite3 database which holds all the Redirect Rules.

TODO: Make it work with Jobs

Management Get HS DB Version Endpoint

Endpoint: Management Get Hyperscan DB Version

Method: GET

RESPONSES:
  • 200: Returns the old_version and the current_version. If not versions are yet available then None

The Get Hyperscan DB Version endpoint provides with the ability to retrieve the previous and the current Hyperscan DB Version which are stored in the database. It will return None for both if there is still no entry about versions in the database.

Management Reload Management HS DB Endpoint

Endpoint: Management Reload Hyperscan Database

Method: GET

RESPONSES:
  • 200: The Hyperscan Database has been reloaded

This endpoint provides the management pod with the ability to reload it’s hyperscan database that it uses for testing purposes.

Management Reload Worker HS DB Endpoint

Endpoint: Management Database Reload Worker

Method: POST

RESPONSES:
  • 200: The specified worker has started updating
  • 400: Unable to update the specified worker. See errors

This endpoint provides the management pod with the ability to send an update request to one specific the worker pod. Before sending an update worker request to the worker the endpoint checks if the worker actually exists by making a health status request. If the health status request fails then the worker is considered unreachable and a 400 is returned. If the health status request succeeds then a second reload worker hs db request is send. If the reload worker hs db requests returns 200 then the worker has started updating itself.

Management Reload Workers HS DB Endpoint

Endpoint: Management Database Reload Workers

Method: GET

RESPONSES:
  • 200: All workers have been updated
  • 400: Unable to update some or all workers. Look at errors

This endpoint provides the management pod with the ability to send an update request to all of the worker pods that are currently running on the cluster.