[FOLIO-1697] Spike: Gather list of items for additional module metadata Created: 14/Jan/19  Updated: 03/Jun/20  Resolved: 02/Sep/19

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: David Crossley Assignee: Unassigned
Resolution: Done Votes: 1
Labels: platform-backlog, sysops_mgt
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-1696 SPIKE: provide operational "metadata"... Closed
Sprint:
Development Team: Core: Platform

 Description   

The following initial set of potential items was gathered from the #sys-ops Slack channel around 2019-01-10, the SysOps SIG weekly meeting of 2019-01-11, and from some other people.

Please provide additional suggestion notes. Later we can collate and organise.



 Comments   
Comment by David Crossley [ 14/Jan/19 ]
  • 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.
Comment by David Crossley [ 15/Jan/19 ]

See comment from Jason Root in the parent issue, for some additional items.

Comment by David Crossley [ 16/Jan/19 ]

Regarding the RAMLs and Schemas, there are some notes in FOLIO-903 Open and FOLIO-1645 Open .

Generated at Thu Feb 08 23:15:14 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.