How to Include a New Eureka Application in Snapshot Environment Builds

This guide provides detailed instructions for including a newly developed Eureka application into the snapshot environment builds of the FOLIO platform. Follow the steps below carefully to ensure your application is successfully integrated into the snapshot builds and available in the user interface.

Prerequisites

• The application GitHub repository has been created, is accessible, and the permission has been granted to the Kitfox team(Admin Access level please).

• All application modules have been added to the platform-complete snapshot repo branch.

• All application backend modules have corresponding Helm charts.

• All checks and validation for interface(s) dependencies were done: https://dev.folio.org/folio-api-dependencies/, if any of modules in app-platform-complete REQUIRES the interface(s) of the new Eureka application that you’re working on, that mean either additional changes are required inside moduleDescriptor(s) of that\those module(s): REQUIRES → OPTIONAL or creating an additional brand new Eureka application i.e. moving out that\those module(s) from the app-platform-complete to avoid this kind of issues\errors:

Open

Verification and Preparation

• If new modules are introduced along with the application, please follow these steps: How to Include a New Module in Snapshot Environment Builds.

• If the new modules are not yet added to the platform-complete snapshot branch, create a test branch based on the snapshot branch approach (in case the modules are not supposed to be installed on demand).

• To create a new application, please follow the standard procedures outlined here: Application Creation and Maintenance Documentation

• Determine the appropriate place for your application based on the application dependency, Application Composition Plan and its current state.

Steps to Include a Eureka Application

1. Create a Jira Ticket

• Navigate to the Rancher Jira project.

• Create a new Jira ticket requesting the inclusion of your application in the snapshot builds.

• Specify the repository link of the newly developed application.

• If the application is meant to be added to environments on demand (like app-marc-migrations), please explicitly provide this information in the ticket.

• If the application modules are not yet propagated to the platform-complete snapshot branch, provide the link to the test branch based on the snapshot in the ticket.

2. Grant Access to the Kitfox Team

Make sure the Kitfox team has the necessary permissions to access and commit to your application's repository.

3. Notify the Kitfox Team

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

• Share the Jira ticket link and give a brief description of your application.

Further Information

• If during the execution of the Jira ticket, the application modules were not propagated to the platfom-complete snapshot branch yet, please inform the Kitfox team via Rancher support Slack channel when this occures.

• Your application should be listed here: FOLIO Eureka Applications.

• For detailed guidelines on ongoing application maintenance and best practices, refer to Application Management and Releases.

Support

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