[FOLIO-1696] SPIKE: provide operational "metadata" for each module Created: 14/Jan/19  Updated: 11/Aug/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: 0
Labels: platform-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: File module_metadata.md    
Issue links:
Relates
relates to FOLIO-1729 Use container memory limits to manage... Closed
relates to FOLIO-1697 Spike: Gather list of items for addit... Closed
relates to FOLIO-1698 determine additional module metadata ... Closed
relates to FOLIO-2003 platform-core backend modules metadata Closed
relates to FOLIO-2008 Publish a minimal README at Docker Hu... Closed
Sprint: CP: ready for planning
Story Points: 8
Development Team: Core: Platform

 Description   

Various tools and systems operations procedures do require additional information about each module.

For example, for back-end modules: is a database needed; RAM requirements (`-Xmx`); module listen port; healthcheck endpoint; database connection etc.

There would be a standard set of default values, and each module would document its differences.

The metadata would be efficiently managed at each module. In a machine-readable format, preferably witin the Module Descriptor.

Some of the information would also be used as the "Overview" when the image is pushed to Docker Hub.



 Comments   
Comment by David Crossley [ 14/Jan/19 ]

Bear in mind that some installations will be running the set of modules independently of Okapi orchestrating them.

Comment by jroot [ 14/Jan/19 ]

I have documented some of the metadata needed by certain modules back in the Q2 release, here under the section Workload Notes.:

https://folio-org.atlassian.net/wiki/pages/viewpage.action?pageId=2097418

I have a running document I will be amending to for the Q4 release.

Comment by jroot [ 17/Jan/19 ]

I have uploaded the running document I have been maintaining/using to keep track of what modules need when they start up.

Comment by jroot [ 22/Apr/19 ]

I have updated my metadata doc here to reflect Q1 module needs to the best of my knowledge: https://github.com/folio-org/folio-install/blob/kube-rancher/alternative-install/kubernetes-rancher/TAMU/module_metadata.md

Comment by David Crossley [ 25/Apr/19 ]

There is also a list of items in the related FOLIO-1697 Closed

Comment by David Crossley [ 19/Jun/19 ]

The FOLIO-2003 Closed added some basic metadata to every "core" backend ModuleDescriptor.

The FOLIO-2008 Closed added a Jenkins job to gather that along with some other metadata, and publish to Docker Hub upon each merge to master or release.

See example for a core module mod-inventory

See example for a non-core module mod-orders (currently lacking their ModuleDescriptor metadata, so is basic).

Comment by David Crossley [ 02/Sep/19 ]

Superseded by FOLIO-2185 Closed .

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