Skip to main content

Minimal SQuaRE API wrapper for QA metrics

Project description

[![Build Status](https://travis-ci.org/lsst-sqre/sqre-apikit.svg?branch=master)](https://travis-ci.org/lsst-sqre/sqre-apikit)

# sqre-uservice-metricdeviation

LSST DM SQuaRE microservice wrapper for QA metrics; more
generally, a minimal viable example for how to use the `apikit`
interfaces to create a SQuaRE-compliant microservice.

## Usage

Create a Flask app (preferably using :class:`apikit.APIFlask`). If you
have used `APIFlask`, it will already have a metadata route (but if you
are using Kubernetes ingress, you will want to specify the additional
route behind api.lsst.codes (or wherever) as one of the arguments to
route.

Hook your app up with whatever authenticator to Github it needs (if
any), and whatever secrets the authenticator requires.

If you're planning on hosting in a container via Kubernetes, create a
service and a deployment for it (look in `kubernetes`), and then if you
are standing up the front end too, set up an ingress with TLS
certificate and key. If one already exists (e.g. `api.lsst.codes`) you
just need to add a path to the existing ingress.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sqre-uservice-metricdeviation, version 0.0.5
Filename, size & hash File type Python version Upload date
sqre_uservice_metricdeviation-0.0.5-py2.py3-none-any.whl (6.4 kB) View hashes Wheel py2.py3
sqre-uservice-metricdeviation-0.0.5.tar.gz (4.8 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page