Eureka - How to ...

#

Page

Heading

Sub-heading

Sub-Sub-heading

Assigned

Ticket#

Sprint

Notes

#

Page

Heading

Sub-heading

Sub-Sub-heading

Assigned

Ticket#

Sprint

Notes

 

Install FOLIO

 

 

 

 

 

 

 

 

 

Types of installations and deployments

 

 

 

 

 

 

 

Single-server deployment

Eureka

EUREKA-321

Eureka Sprint 202

changed by Natalia on Oct 2, 2024

IT-201 (from 30th Sept), Oleksii Kuzminov will come back with information about estimation period

 

 

 

Kubernetes deployment

Kitfox

RANCHER-1695

Kitfox Sprint 202

IT-201 (from 30th Sept), will estimate earlier.

 

 

Prerequisites

 

 

 

 

 

 

 

 

Memory

PTF

PERF-990

 

Plans to have some Eureka tests in mid November and could provide some results.

 

 

 

Infrastructure

 

 

 

 

 

 

 

 

PostgreSQL

Keep as is

 

 

 

 

 

 

 

OpenSearch or Elasticsearch

Keep as is

 

 

 

 

 

 

 

Kafka

Keep as is

 

 

 

 

 

 

 

Optional: MinIO or Amazon S3

Keep as is

 

 

 

 

 

 

 

Kong

FSE

FOLIO-4055

IT-203

IT-203 (September 23rd), will look after 23rd September.

 

 

 

 

Sidecars

FSE

FOLIO-4055

IT-203

 

 

 

 

 

Keycloak

FSE

FOLIO-4055

IT-203

 

 

Hostnames Configuration

 

Eureka

EUREKA-324

Eureka Sprint 202

changed by Natalia on Oct 2, 2024

 

 

Overview

 

 

 

 

 

 

 

DNS Configuration

 

 

 

 

 

 

 

 

Required DNS records

 

 

 

 

 

 

 

Examples

 

 

 

 

 

 

TLS/SSL Certificates

 

 

 

 

 

 

 

Obtaining certificates

 

 

 

 

 

 

 

Configuring certificates

 

 

 

 

 

 

Common Issues

 

Kitfox/FSE

FOLIO-4058
RANCHER-1724

3 SP

 

Kitfox Sprint 201

 

 

 

 

Troubleshooting hostname resolution

 

 

 

 

 

 

 

Debugging TLS/SSL certificate problems

 

 

 

 

 

Single Server Fresh Install

 

Eureka

EUREKA-326

Eureka Sprint 202

changed by Natalia on Oct 2, 2024

https://github.com/folio-org/eureka-platform-bootstrap

 

 

Overview

 

 

 

 

 

 

 

System Requirements

 

 

 

 

 

 

 

Memory and CPU

 

 

 

 

 

 

 

Disk Space

 

 

 

 

 

 

Installation Steps

 

 

 

 

 

 

 

 

Preparing the environment

 

 

 

 

 

 

 

Installing dependencies

 

 

 

 

 

 

 

Setting up the database

 

 

 

 

 

 

 

Deploying FOLIO modules

 

 

 

 

 

 

Post-Installation Tasks

 

 

 

 

 

 

 

Verifying installation

 

 

 

 

 

 

 

Configuring FOLIO

 

 

 

 

 

 

 

Setting up administrative users

 

 

 

 

 

Single Server Install with Containers

Eureka

EUREKA-339

 

 

 

 

Overview

 

 

 

 

 

 

 

System Requirements

 

 

 

 

 

 

 

Hardware and software prerequisites

 

 

 

 

 

 

Installation Steps

 

 

 

 

 

 

 

 

Setting up Docker

 

 

 

 

 

 

 

Configuring Docker Compose

 

 

 

 

 

 

 

Deploying FOLIO containers

 

 

 

 

 

 

Post-Installation Tasks

 

 

 

 

 

 

 

Verifying the deployment

 

 

 

 

 

 

 

Managing containers

 

 

 

 

 

 

 

Troubleshooting common issues

 

 

 

 

 

Kubernetes Example Deployment

 

Kitfox

RANCHER-1722

5 SP

Kitfox Sprint 201

 

 

 

Overview

 

 

 

 

 

 

 

Setting Up the Environment

 

 

 

 

 

 

 

Kubernetes prerequisites

 

 

 

 

 

 

 

Cluster setup

 

 

 

 

 

 

Deploying FOLIO on Kubernetes

 

 

 

 

 

 

 

Preparing manifests

 

 

 

 

 

 

 

Deploying modules

 

 

 

 

 

 

Post-Deployment Tasks

 

 

 

 

 

 

 

Monitoring and logging

 

 

 

 

 

 

 

Scaling and updates

 

 

 

 

 

 

Troubleshooting and Common Issues

 

 

 

 

 

 

 

Debugging deployment errors

 

 

 

 

 

 

 

Resolving resource limitations

 

 

 

 

 

Customizing FOLIO

 

 

Kitfox

RANCHER-1723

Kitfox Sprint 202

 

 

 

Overview

 

 

 

 

 

 

 

Configuration Changes

 

 

 

 

 

 

 

System settings

 

 

 

 

 

 

 

Module configurations

 

 

 

 

 

 

Custom Module Development

 

 

 

 

 

 

 

Developing custom modules

 

 

 

 

 

 

 

Integrating with FOLIO

 

 

 

 

 

 

Theme and UI Customization

 

 

 

 

 

 

 

Changing themes

 

 

 

 

 

 

 

Modifying the user interface

 

 

 

 

 

 

Advanced Customizations

 

 

 

 

 

 

 

Middleware customization

 

 

 

 

 

 

 

Extending APIs

 

 

 

 

 

Migration to Eureka

 

 

Eureka

EUREKA-327

Eureka Sprint 202

changed by Natalia on Oct 2, 2024