/
How to Include a New Module in Snapshot Environment Builds

How to Include a New Module in Snapshot Environment Builds

This guide outlines the developer-facing steps required to prepare and request inclusion of a new FOLIO module—backend or frontend—in snapshot reference environment builds.

Prerequisites

A new module has been established and meets the following criteria: Create a new FOLIO module and do initial setup.

Verification and Preparation

Please be familiar with the following procedures and requirements:

Steps to Include a New Module

1. Jira Ticket: Helm Chart Creation (backend Only)

  • Navigate to the Rancher Jira project.

  • Create a new Jira ticket requesting the creation of a Helm chart for a new module in the folio-helm-v2 repository.

  • Specify the repository link of the newly developed application.

  • Explicitly provide in the ticket mandatory environment variables and integration requirements (DB, Kafka, S3, OpenSearch, OKAPI, System User).

  • Inform the Kitfox team via the Rancher support Slack channel.

  • Share the Jira ticket link and give a brief module description.

2. Jira Ticket: Snapshot Inclusion Request

  • Prepare the Jira ticket to guide the process, and request that the new backend module be enabled for the snapshot reference environments.

  • If there are special requirements, then provide a link to that section of the module README.

  • Overall, follow this instruction: How to raise a DevOps Jira ticket

3. Eureka-Specific Module Registration (optional)

Perform this step only if your module Eureka-specific

  • Navigate to the Rancher Jira project.

  • Create a new Jira ticket requesting the inclusion of your module in eureka-platform.json.

  • In case UI-module, request to add module to eureka-tpl/stripes.config.js

Further Information

If the module is not OKAPI-specific, it should reside in one of the applications. If a module is introduced along a new application, follow this instruction: How to Include a New Eureka Application in Snapshot Environment Builds.

Support

Contact the Kitfox team directly via Slack for immediate assistance or raise issues through the Jira ticketing system.