- command line params
- ENV variables
- RAM requirements (`-Xmx`)
- Storage/database requirements
- Healthcheck endpoint
- Listen port
- Link to GitHub repo
- Infrastructure dependencies (e.g. PostgreSQL, messaging etc)
- Default port when running standalone
- Default port when running in Docker
- Environment variable to change port
- Environment variables to configure database
- Other configuration options (e.g. Java parameters, though debatable if we want those set often)
- Log output (format, does it go to standard out, how to reconfigure)
- There are also broader topics like health monitoring, operational metrics (throughput by endpoint for example), log aggregation
- interface dependencies should also be documented (they should be able to be generated from the module descriptor template, of course).
- Are RAMLs and related Schemas provided? If so, then:
- default RAMLs directory "./ramls"
- default raml-util directory "./ramls/raml-util"
- directories to exclude when automatically searching for ramls and schemas. e.g. raml-util, ...
- Interface names and versions, and which *.raml provides them.
- Location of ModuleDescriptor template
- Repository description.
- Repository short name.
|