EIS

eRSD Ingest Service.

Information on this page is likely out of date as of 2021-11-17.

Members of the HLN team will update this page after parallel production.

Overview

Take a eRSD payload, do the things.

Links and Resources

• GitHub Repository for HLN engineers/operators

• Mirrored GitHub Repository for AIMS read-only tag pulls

Environment Variables

Required

EIS can support any Mongo 3.6 compatible document store platform, such as AWS DocumentDB, Azure Cosmos DB API for MongoDB, and plain-ol MongoDB itself.

• DOCUMENT_STORE_PLATFORM enum(string)

  • Indicates the document store database driver/feature flags to use.

  • Defaults to mongodb; aws-documentdb for AWS DocumentDB

• DOCUMENT_STORE_CONNECTION_URI string

  • Provide a valid hostname, port, and namespace for a MongoDB connection string.

  • Defaults to localhost:27017/rckms

For the DOCUMENT_STORE_CONNECTION_URI value, please exclude any protocol prefixes (e.g. mongodb://), and where possible, do not provide a mongodb+srv:// connection string.

• DOCUMENT_STORE_TLS_ALLOW_INVALID_CERTIFICATES boolean

  • If true, document store database driver will allow invalid TLS/SSL certificates.

  • Defaults to false

• DOCUMENT_STORE_TLS_ALLOW_INVALID_HOSTNAME boolean

  • If true, document store database driver will allow certificate hostname mismatches.

  • Defaults to false

It is imperative that the DOCUMENT_STORE_ALLOW_* variables defined above are set to false in production, as the alternative would be non-compliant with the AIMS platform security requirements.

Recommended

• DEBUG string

  • Enables path based matching of debug statements to stdout. See debugon NPM for details.

  • A value of HLNDebug:* will enable all debug statements. Disabled by default.

• PORT number

  • Sets the port to bind this Node service to.

  • Defaults to 8080.

This service supports Sentry for automatic error capture and reporting. It does not currently support Sentry APM.

• SENTRY_DSN string

  • Enables Sentry, sets reporting endpoint.

  • Defaults to an empty string. An empty string will disable Sentry reporting.

• SENTRY_ENVIRONMENT string

  • Sets the environment parameter in Sentry reports, which is useful for context.

  • Defaults to an empty string.

• SENTRY_RELEASE string

  • Sets the release parameter in Sentry reports, which is useful for context.

  • Defaults to an empty string.

Optional

This service does not have any optional environment variables.

Resource Allocation & Availability

Recommended minimum quantity of pods per environment

Environment	Quantity
HLN Canary (staging)	1
HLN Training (training)	N/A
AIMS Sandbox (aims-sandbox)	1
AIMS Onboarding (aims-onboarding)	1
AIMS Production Readiness Review (aims-prr)	TBD
AIMS Production (aims-production)	TBD

Recommended minimum resource allocation per pod

CPU	CPU Intensive?	RAM	Storage	Preemptible?
500m	false	0.75Gi	N/A	true

• "CPU Intensive" indicates that this microservice is best served on a higher-class of compute resource, specifically intended for CPU intensive workloads. We recommend utilizing Kubernetes NodeAffinity requests to support this interaction.

• "Preemptible" indicates if a service can support operation atop lower-cost, ephemeral compute resources offered by a cloud platform (e.g. preemptible instances on GCP, spot instances on AWS). We recommend utilizing Kubernetes node taints to support this interaction.

Technology Stack

Container

• Javascript (Node 14 LTS)

  • Supports Ecmascript 2016 and later (ES6+) transpilation via Babel.

Requests

Probes: Liveness

GET localhost:${PORT}/_k8s-health-check

Refer to the Kubernetes Documentation for more information on probes.

204 Pod is ready to receive traffic.

{}

500 Pod is not ready to receive traffic.

Probes: Readiness

GET localhost:${PORT}/_k8s-health-check

Refer to the Kubernetes Documentation for more information on probes.

204 Pod is ready to receive traffic.

{}

500 Pod is not ready to receive traffic.

Point-of-Contact / Code Owners

Name	Email
Charlie Maxwell	[email protected]