<!-- 
RSS generated by JIRA (1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d) at Thu Feb 08 23:15:14 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary add field=key&field=summary to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>FOLIO Jira</title>
    <link>https://folio-org.atlassian.net</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>1001.0.0-SNAPSHOT</version>
        <build-number>100246</build-number>
        <build-date>07-02-2024</build-date>
    </build-info>

<item>
            <title>[FOLIO-1696] SPIKE: provide operational &quot;metadata&quot; for each module</title>
                <link>https://folio-org.atlassian.net/browse/FOLIO-1696</link>
                <project id="10290" key="FOLIO">FOLIO</project>
                    <description>&lt;p&gt;Various tools and systems operations procedures do require additional information about each module.&lt;/p&gt;

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

&lt;p&gt;There would be a standard set of default values, and each module would document its differences.&lt;/p&gt;

&lt;p&gt;The metadata would be efficiently managed at each module. In a machine-readable format, preferably witin the Module Descriptor.&lt;/p&gt;

&lt;p&gt;Some of the information would also be used as the &quot;Overview&quot; when the image is pushed to Docker Hub.&lt;/p&gt;</description>
                <environment></environment>
        <key id="80990">FOLIO-1696</key>
            <summary>SPIKE: provide operational &quot;metadata&quot; for each module</summary>
                <type id="10003" iconUrl="https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium">Task</type>
                                            <priority id="10002" iconUrl="https://dev.folio.org/assets/jira-priority/jira-p3.svg">P3</priority>
                        <status id="6" iconUrl="https://folio-org.atlassian.net/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="green"/>
                                    <resolution id="10003">Done</resolution>
                                                        <assignee accountid="-1">Unassigned</assignee>
                                                                <reporter accountid="61cd0ca0bce5e00069e98be7">David Crossley</reporter>
                                    <labels>
                            <label>platform-backlog</label>
                    </labels>
                <created>Mon, 14 Jan 2019 07:03:41 +0000</created>
                <updated>Tue, 11 Aug 2020 16:18:59 +0000</updated>
                            <resolved>Mon, 2 Sep 2019 07:29:40 +0000</resolved>
                                                                        <due></due>
                            <votes>0</votes>
                                    <watches>8</watches>
                                                                <comments>
                                                            <comment id="194286" author="61cd0ca0bce5e00069e98be7" created="Mon, 14 Jan 2019 07:24:13 +0000"  >&lt;p&gt;Bear in mind that some installations will be running the set of modules independently of Okapi orchestrating them.&lt;/p&gt;</comment>
                                                            <comment id="194288" author="6291011f9c617b006a6f8d98" created="Mon, 14 Jan 2019 14:51:39 +0000"  >&lt;p&gt;I have documented some of the metadata needed by certain modules back in the Q2 release, here under the section &lt;ins&gt;&lt;b&gt;Workload Notes.&lt;/b&gt;&lt;/ins&gt;:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://folio-org.atlassian.net/wiki/pages/viewpage.action?pageId=2097418&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://folio-org.atlassian.net/wiki/pages/viewpage.action?pageId=2097418&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;I have a running document I will be amending to for the Q4 release.&lt;/p&gt;</comment>
                                                            <comment id="194291" author="6291011f9c617b006a6f8d98" created="Thu, 17 Jan 2019 17:39:06 +0000"  >&lt;p&gt;I have uploaded the running document I have been maintaining/using to keep track of what modules need when they start up.&lt;/p&gt;</comment>
                                                            <comment id="194292" author="6291011f9c617b006a6f8d98" created="Mon, 22 Apr 2019 14:02:17 +0000"  >&lt;p&gt;I have updated my metadata doc here to reflect Q1 module needs to the best of my knowledge: &lt;a href=&quot;https://github.com/folio-org/folio-install/blob/kube-rancher/alternative-install/kubernetes-rancher/TAMU/module_metadata.md&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;https://github.com/folio-org/folio-install/blob/kube-rancher/alternative-install/kubernetes-rancher/TAMU/module_metadata.md&lt;/a&gt;&lt;/p&gt;</comment>
                                                            <comment id="194294" author="61cd0ca0bce5e00069e98be7" created="Thu, 25 Apr 2019 12:52:27 +0000"  >&lt;p&gt;There is also a list of items in the related 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-1697&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-1697&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Spike: Gather list of items for additional module metadata&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-1697
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
&lt;/p&gt;</comment>
                                                            <comment id="194297" author="61cd0ca0bce5e00069e98be7" created="Wed, 19 Jun 2019 04:15:07 +0000"  >&lt;p&gt;The 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2003&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2003&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;platform-core backend modules metadata &quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-2003
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
 added some basic metadata to every &quot;core&quot; backend ModuleDescriptor.&lt;/p&gt;

&lt;p&gt;The 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2008&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2008&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;Publish a minimal README at Docker Hub for each back-end module&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-2008
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
 added a Jenkins job to gather that along with some other metadata, and publish to Docker Hub upon each merge to master or release.&lt;/p&gt;

&lt;p&gt;See example for a core module &lt;a href=&quot;https://hub.docker.com/r/folioorg/mod-inventory/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-inventory&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;See example for a non-core module &lt;a href=&quot;https://hub.docker.com/r/folioorg/mod-orders/&quot; class=&quot;external-link&quot; rel=&quot;nofollow noreferrer&quot;&gt;mod-orders&lt;/a&gt; (currently lacking their ModuleDescriptor metadata, so is basic).&lt;/p&gt;</comment>
                                                            <comment id="194303" author="61cd0ca0bce5e00069e98be7" created="Mon, 2 Sep 2019 07:29:40 +0000"  >&lt;p&gt;Superseded by 
    &lt;span class=&quot;jira-issue-macro resolved&quot; data-jira-key=&quot;FOLIO-2185&quot; &gt;
                &lt;a href=&quot;https://folio-org.atlassian.net/browse/FOLIO-2185&quot; class=&quot;jira-issue-macro-key issue-link&quot;  title=&quot;SPIKE: how to maintain resource deployment descriptors in the module repository?&quot; &gt;
            &lt;img class=&quot;icon&quot; src=&quot;https://folio-org.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10318?size=medium&quot; /&gt;
            FOLIO-2185
        &lt;/a&gt;
                                                    &lt;span class=&quot;aui-lozenge aui-lozenge-subtle aui-lozenge-success jira-macro-single-issue-export-pdf&quot;&gt;Closed&lt;/span&gt;
            &lt;/span&gt;
.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10003">
                    <name>Relates</name>
                                            <outwardlinks description="relates to">
                                        <issuelink>
            <issuekey id="81114">FOLIO-1729</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80989">FOLIO-1697</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="80991">FOLIO-1698</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81227">FOLIO-2003</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="81237">FOLIO-2008</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                    </issuelinks>
                <attachments>
                            <attachment id="64121" name="module_metadata.md" size="6441" author="6291011f9c617b006a6f8d98" created="Thu, 17 Jan 2019 17:38:21 +0000"/>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10000" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarycf">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10057" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
                        <customfieldname>Development Team</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10144"><![CDATA[Core: Platform]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10019" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>0|hzx3og:v</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10020" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="994">CP: ready for planning</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10044" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>8.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10024" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>[CHART] Date of First Response</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Mon, 14 Jan 2019 14:51:39 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10025" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>[CHART] Time in Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>