Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2 KB

README.md

File metadata and controls

37 lines (28 loc) · 2 KB

Helx-Apps

Helx-Apps is used by HeLxPlatform to dynamically ingest various application combinations during deployments. The branches specify deployment contexts and should not be deleted. Presently, these branches and their contexts created within the app-registry file also correspond with the settings of Appstore during deployment. See djangoSettings in the appstore chart.

App-Specs

This repo generally exists to collect "app" spec files in the Compose format. However, to faciliate robust usage of the Kubernetes environments these applications are destined, slight deviations to the compose spec were necessary.

See the Google doc "App" Definition Proposal for more information.

Overview

Spec files are created in an app specific directory under app-specs.

Each app should be represented via the Compose file format version 3 containing the service image, ports etc.

Please specify memory resources in Megabytes "M" for consistency across specs.

Each app should also provide a minimum resource constraint in the form of a reservation along with a maximum in the form of a limit. If you are not sure what to set the defaults are currently:

version: '3'
...
deploy:
  resources:
    limits:
      cpus: '8'
      memory: 64000M
    reservations:
      cpus: '1'
      memory: 1000M 

Most apps will want access to a core and gig of memory while the limit is something that many Kubernetes environments can support for an individual application.