How to recreate Eureka Rancher environment

How to recreate Eureka Rancher environment

How to recreate Eureka Rancher environment with default parameters


Purpose

If you need to delete and recreate your Eureka Rancher environment, use this aggregated pipeline. It's useful for refreshing an environment with the latest configurations or recovering from issues.

Target pipeline: recreateTeamNamespace


What the Pipeline Does

This pipeline performs two sequential operations:

  1. Delete existing environment - Removes the current namespace and all its resources

  2. Create new environment - Provisions a fresh environment with the same name, links, and configurations


Parameters

Parameter

Required/Optional

Description

Default/Value

Parameter

Required/Optional

Description

Default/Value

PLATFORM

Required

Platform type - Must be set to EUREKA

EUREKA

CLUSTER

Required

Select target cluster (e.g., folio-edev, folio-etesting)

  •  

NAMESPACE

Required

Your team's namespace name (e.g., eureka, folijet, spitfire)

  •  

CONFIG_TYPE

Required

Deployment configuration: • development - for Dev clusters • testing - for Testing clusters • performance - for Perf clusters

development

SC_NATIVE

Optional

Use native sidecar image (set false for Java-based SC)

true

CONSORTIA_EXTRA

Optional

Include 2nd consortium setup

false


Pre-configured Environment Settings

The pipeline creates environments with the following fixed configurations (not configurable via parameters):

Core Configuration

  • FOLIO Branch: snapshot

  • Okapi Version: latest

  • Application Set: Complete

  • UI Build: Enabled

  • Sanity Check: Enabled (runs automatically after creation)

Feature Flags

  • LOAD_REFERENCE: ✓ Enabled

  • LOAD_SAMPLE: ✓ Enabled

  • CONSORTIA: ✓ Enabled

  • LINKED_DATA: ✓ Enabled

  • SPLIT_FILES: ✓ Enabled

  • HAS_SECURE_TENANT: ✓ Enabled (on University tenant)

  • RW_SPLIT: ✗ Disabled

  • GREENMAIL: ✗ Disabled

  • MOCK_SERVER: ✗ Disabled

  • RTR: ✗ Disabled

  • ECS_CCL: ✗ Disabled

  • DATASET: ✗ Disabled

Infrastructure

  • PostgreSQL: Built-in (version 16.8)

  • Kafka: Built-in

  • OpenSearch: AWS

  • S3: Built-in (Minio)


Steps to Perform

  1. Navigate to the recreateTeamNamespace job

  2. Click Build with Parameters

  3. Fill in the required parameters:

    • Set PLATFORM to EUREKA

    • Select your CLUSTER (e.g., folio-edev)

    • Enter your NAMESPACE name

    • Set CONFIG_TYPE (typically development)

    • Optionally adjust SC_NATIVE and CONSORTIA_EXTRA

  4. Click Build button

  5. Wait for completion (~1 hour)


Important Notes

  • Automated Scheduling: The pipeline runs automatically every day at 8 PM UTC for the eureka namespace in folio-edev cluster

  • Concurrent Builds: Disabled to prevent conflicts - only one recreation can run at a time

  • Secure Tenant: Automatically configured on the University consortium tenant

  • Sanity Check: Cypress tests run automatically after environment creation to verify the setup

  • Build Retention: Last 30 builds are kept


Triggered Jobs

This pipeline orchestrates two other jobs:

  1. deleteNamespace - Removes the existing namespace

  2. createNamespaceFromBranch - Creates the new namespace with all configurations

Both jobs run sequentially and must complete successfully for the recreation to succeed.


Expected Duration

  • Total Time: Approximately 1 hour

    • Delete phase: ~5-10 minutes

    • Create phase: ~45-50 minutes

    • Sanity check: ~5-10 minutes


Troubleshooting

  • If the job fails during deletion, verify the namespace exists and you have permissions

  • If the job fails during creation, check the logs of the createNamespaceFromBranch sub-job

  • If sanity checks fail, the environment is created but may have issues - review Cypress test results

  • For scheduled runs, the job only recreates the eureka namespace in folio-edev cluster


Example Configuration

Standard team environment recreation:

  • PLATFORM: EUREKA

  • CLUSTER: folio-edev

  • NAMESPACE: folijet

  • CONFIG_TYPE: development

  • SC_NATIVE: true

  • CONSORTIA_EXTRA: false