Metadata-Version: 2.0
Name: sqre-uservice-productstatus
Version: 0.0.1
Summary: Minimal SQuaRE API wrapper for keeper.lsst.codes product status
Home-page: https://github.com/lsst-sqre/sqre-uservice-productstatus
Author: Adam Thornton
Author-email: athornton@lsst.org
License: MIT
Keywords: lsst
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: sqre-apikit (==0.0.10)

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

# sqre-uservice-productstatus

LSST DM SQuaRE microservice wrapper for determining whether products
listed at keeper.lsst.codes are responding to their published endpoint.

## 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.


