[FOLIO-508] Associate and Include ModuleDescriptor with module Created: 21/Mar/17  Updated: 12/Nov/18  Resolved: 24/May/17

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

Type: Umbrella Priority: P3
Reporter: John Malconian Assignee: John Malconian
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-513 Consider to package/expose ModuleDesc... Open
relates to FOLIO-487 use ModuleDescriptors provided in the... Closed
Sprint:

 Description   

Although Module Descriptors are maintained alongside a module's source in GitHub, they are currently not included with the distribution of the module - whether that module is distributed as a Docker image or in the module's code as an endpoint, for example. It is, therefore, necessary to retrieve the Module Descriptor separately from the project's source repository, "maintain" it alongside your module distribution method, and hope that it is compatible with the current distribution of the module you are using. Utilize this issue to explore various approaches that can be taken.



 Comments   
Comment by John Malconian [ 21/Mar/17 ]

There are a few different approaches that can be taken. Specific examples include the following:

  • Simply "package" the Module descriptor with the module distribution. If creating Debian or RPM module packages or even just a tar archive, include the ModuleDescriptor as a file in the package. If creating Docker images for the module it's possible to include LABELs in the module's Dockerfile to describe the ModuleDescriptor and use Docker's 'inspect' capability to retrieve the ModuleDescriptor for that particular image.
  • Include the remote location such as a URL of a module's ModuleDescriptor in the module's Deployment descriptor. It's been pointed out that a remote repository would likely need to be able to maintain multiple versions of the ModuleDescriptor. Git/GitHub is, therefore, not ideal as a canonical repository of ModuleDescriptors. Adam has suggested that Okapi itself could be utilized as a repository for module metadata and ModuleDescriptors since it already contains the parsing and validating facilities. The caveat is that they need to be identified by a unique ID - probably with some combination of module name and version.
Comment by John Malconian [ 24/May/17 ]

It's been concluded that the maintaining the module descriptor in the projects git repository and fetching it from there is the best way to maintain these at this time.

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