Skip to main content

Minimal SQuaRE API wrapper for ci.lsst.codes build status

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-status

LSST DM SQuaRE microservice wrapper for `status.lsst.codes`; 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.

Source Distribution

sqre-uservice-buildstatus-0.0.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

sqre_uservice_buildstatus-0.0.1-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sqre-uservice-buildstatus-0.0.1.tar.gz.

File metadata

File hashes

Hashes for sqre-uservice-buildstatus-0.0.1.tar.gz
Algorithm Hash digest
SHA256 5a6b0edcedf5c887df3336071a2b6aa5f79f2c738484f2a0db5d3bc514a35f66
MD5 e9ba36cbf8d5fc9a682ce5ccaf6141fe
BLAKE2b-256 af90af1d38382107cb6c49a7138f8532e7cd913af83fd17876bd36264e94340e

See more details on using hashes here.

File details

Details for the file sqre_uservice_buildstatus-0.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sqre_uservice_buildstatus-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 720c7ee665638a86a609c0eaa6613c6bb90bf0c94d4d4dbfcbae0099abc9a4b9
MD5 c1c0a2dd01d58ce1508d3d70e28d050c
BLAKE2b-256 0c354c3ff2b9ecb54eccb873c1258f21cf86ac3a9b29f44638883c1320d5f4dc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page