serverless-beacon
aehrc/serverless-beacon/aws
Implementation of Beacon in a serverless (FaaS) manner, to enable cheaper and more versatile (e.g. over distributed datasets) queries
Serverless Beacon  !assets/logo-black.png Contents - Why serverless? - Introduction to sBeacon - Installation Option 1: Setting up the development environment on Amazon Linux Option 2: Using the docker image - Deployment Direct deployment Use as a module - Development - API Usage Example data Data ingestion API Query API - Securing the API - Troubleshooting Illegal instruction (core dumped) Provider produced inconsistent final plan Why serverless? Serverless means the service does not require any servers to be provisioned. The idea is to minimise running costs, as well as support arbitrary scalablility. It also means setup is very fast. Introduction to sBeacon sBeacon implements Beacon v2 protocol according to the ga4gh specification. sBeac
| Name | Type | Description | Default |
|---|---|---|---|
| beacon-default-granularity | string | Value for beacon default granularity | "boolean" |
| organisation-name | string | Name of the organisation providing the beacon. | "CSIRO" |
| beacon-id | string | Unique identifier of the beacon. Use reverse domain name notation. | "au.csiro.sbeacon" |
| beacon-alternative-url | string | Value for beacon alternative url | "https://bioinformatics.csiro.au/" |
| beacon-documentation-url | string | Value for beacon documentation url | "https://github.com/EGA-archive/beacon2- |
| beacon-org-welcome-url | string | Value for beacon organisation welcome url | "https://bioinformatics.csiro.au/" |
| region | string | Deployment region. | "us-east-1" |
| beacon-description | string | Value for beacon description | "Serverless Beacon (sBeacon)" |
| beacon-version | string | Value for beacon version | "v0.1.0" |
| beacon-org-description | string | Value for beacon organisation description | "CSIRO, Australia" |
| beacon-org-contact-url | string | Value for beacon organisation contact url | "https://bioinformatics.csiro.au/get-in- |
| common-tags | map(string) | A set of tags to attach to every created resource. | {} |
| beacon-environment | string | Value for beacon environment | "dev" |
| beacon-guest-username | string | Value for guest username (must be an email) | "guest@example.com" |
| organisation-id | string | Unique identifier of the organisation providing the beacon. | "CSIRO" |
| beacon-service-type-group | string | Value for beacon service type group | "au.csiro" |
| beacon-service-type-version | string | Value for beacon service type version | "1.0" |
| beacon-enable-auth | bool | Flag to enable API authentication | false |
| beacon-admin-username | string | Value for admin username (must be an email) | "admin@example.com" |
| beacon-name | string | Human readable name of the beacon. | "CSIRO Serverless Beacon" |
api_url — URL used to invoke the API.cognito_client_id — Cognito client Id for user registration and login.admin_login_command — Command to sign in an adminguest_login_command — Command to sign in a guestAzure landing zones Terraform module
Terraform supermodule for the Terraform platform engineering for Azure
Terraform module to deploy landing zone subscriptions (and much more) in Azure
Terraform Module to define a consistent naming convention by (namespace, stage,