[FOLIO-2003] platform-core backend modules metadata Created: 06/May/19  Updated: 03/Jun/20  Resolved: 29/May/19

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

Type: Task Priority: P3
Reporter: Jakub Skoczen Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devops, platform-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
is blocked by FOLIO-2016 Update Okapi version to 2.29+ for ser... Closed
is blocked by OKAPI-732 add a new section for specifying key/... Closed
Relates
relates to FOLIO-673 Additional information section in eac... In Progress
relates to FOLIO-1698 determine additional module metadata ... Closed
relates to FOLIO-2008 Publish a minimal README at Docker Hu... Closed
relates to FOLIO-1696 SPIKE: provide operational "metadata"... Closed
Sprint: CP: sprint 64
Story Points: 3
Development Team: Core: Platform

 Description   

Add two module metadata items, minimum container memory (containerMemory) and whether DB is needed (databaseConnection) to the MDs of core modules. (Defined in FOLIO-1698 Closed .)

Point in to the ModuleDescriptor from the README for other information (e.g dependencies) and/or other tools that can display the information (e.g stripes-cli)

Link from README to its DockerHub entry, which will soon have descriptions generated from that part of the MD and gathered from other sources.



 Comments   
Comment by jroot [ 07/May/19 ]

While I don’t object to adding tags in the MD for metadata, I feel like the premise behind providing metadata is lost if that’s all that is done. A sys admin needs to know these things in advance, before deploying or orchestrating out a system. This metadata needs to be easily and readily available - preferably in Dockerhub as is common for other containers.

Comment by David Crossley [ 08/May/19 ]

That would be one of the outcomes FOLIO-1696 Closed .

Here exploring some possible ways to manage the metadata.

The exploration continues at FOLIO-1696 Closed and FOLIO-1698 Closed .

Comment by Jakub Skoczen [ 09/May/19 ]

David Crossley will create an issues for publishing README generated based on the info from MD metadata section and Dockerfiles on DockerHub

(Yes. Now see FOLIO-2008 Closed .)

Comment by David Crossley [ 29/May/19 ]

This is now added for all platform-core backend modules.

The minimum container memory (containerMemory) is that used in folio-ansible/group_vars for the reference environments.

Added basic documentation at https://dev.folio.org/guides/module-descriptor/

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