Create Eureka environment from branch

Purpose

The development team needs to create an Eureka-based environment with modules from a specific branch.

This job provisions a complete Eureka environment with all necessary infrastructure components, applications, and optional features.

Create Eureka environment

Steps:

1. Log in to Jenkins Dashboard

2. Navigate to the job: createNamespaceFromBranch

3. Click the Build with Parameters button on the left side

4. Configure the following parameters:

Core Parameters

• development - for Dev cluster
• testing - for Testing cluster
• performance - for Perf cluster |
| SC_NATIVE | Optional | Set false to use Java-based SC image (default: true, Eureka only) |
| TYPE | Required | Action type: full (complete setup), terraform (infrastructure only), or update (update existing) |

Environment Features

Integration Parameters

Post-Deployment

5. Click Build button

6. Wait for completion

Important Notes

• IMPORTANT: Delete your environment if it exists before creating! Even if the job failed previously, you must delete the namespace before recreating

• For protected clusters (folio-testing, folio-etesting) or DATASET environments, kitfox approval is required

• Namespace validation is performed for all clusters except folio-tmp

• Parameter visibility is dynamic based on PLATFORM selection:

  • Eureka platform hides OKAPI_VERSION

  • Okapi platform hides APPLICATION_SET, APPLICATIONS, and SC_NATIVE

• Consortium secure tenant parameters are conditionally visible based on CONSORTIA and HAS_SECURE_TENANT settings

Job Workflow

The job executes different workflows based on the PLATFORM parameter:

For EUREKA Platform:

1. Calls folioNamespaceCreateEureka with namespace parameters

2. Configures Eureka-specific settings (Kong, Keycloak, Applications)

3. Sets up consortium with Eureka extensions if enabled

4. Optionally runs Cypress sanity check against Kong endpoint

For OKAPI Platform:

1. Calls folioNamespaceCreate with namespace parameters

2. Configures Okapi-specific settings

3. Sets up consortium with standard extensions if enabled

4. Optionally runs Cypress sanity check against Okapi endpoint

Folio Extensions Added:

Based on enabled features, the following extensions are automatically added:

• consortia-eureka or consortia (based on platform)

• linked-data (if LINKED_DATA=true)

• marc-migrations (if MARC_MIGRATIONS=true)

• rtac-cache (if RTAC_CACHE=true)

• edge-locate (if EDGE_LOCATE=true)

Sanity Check Configuration

If RUN_SANITY_CHECK is enabled, Cypress tests run with:

• Eureka: Tests against Kong endpoint with fse+sanity tags from master branch

• Okapi: Tests against Okapi endpoint with fse+sanity tags from okapi branch

• Workers: 4 parallel workers

• Timeout: 60 minutes

• Tenant: diku with admin credentials

Example Use Cases

Standard Eureka Environment

• PLATFORM: EUREKA

• CLUSTER: edev

• FOLIO_BRANCH: snapshot

• CONSORTIA: true

• BUILD_UI: true

• TYPE: full

Testing Environment with RTAC Cache

• PLATFORM: EUREKA

• CLUSTER: etesting

• RTAC_CACHE: true

• LINKED_DATA: true

• RUN_SANITY_CHECK: true

• TYPE: full

Update Existing Environment

• TYPE: update

• Other parameters remain the same as original creation