Eureka Developer Guide

Introduction

• Overview

  • Platform Description

  • Overview of Okapi vs Eureka

  • Transition Rationale

• Guide Purpose and Audience

Core Concepts

• Architecture Overview

  • Introduction to the Architecture

  • Types of Installations and Deployments

  • Core Components

    • Kong Basics

    • Kong Gateway (Slide 5)

    • Keycloak Basics

    • Keycloak for Identity and Access Management (Slide 6)

    • Sidecars

    • Management Components

  • Platform Management (Slide 12)

  • Platform Runtime (Slide 13)

• Interaction Between Components/Data Flow

  • Authorization and Authentication

    • Authentication

    • Authorization

    • Authorization Flows

  • API Gateway

• Applications and Application Manager

  • Application Overview (Slide 11)

  • Module Management and Discovery (Slide 7)

  • Installation of Applications (Slide 9)

• Tenants and Realms

  • Tenants and Realms Management (Slide 8)

  • mgr-tenants

• Consortia and Consortia Manager

  • Consortia Manager Document Index

  • Setting up Your Consortia Environment

  • Consortia Manager Settings

  • Enhanced Consortia Support

Getting Started

• Setting Up Your Local Development Environment

  • System Requirements and Installation for Local Development

  • Using the CLI for Local Deployment

  • Installing Tools and Libraries

  • Configuring Your Local Development Environment

• System Requirements and Installation

  • Single Servers

  • Kubernetes Deployment

• Remote Debugging via Telepresence

  • Telepresence on Rancher

Module Development

• Eureka vs Okapi Development Comparison Table

• Sidecars - Module Interaction Patterns

  • Overview

  • folio-module-sidecar

  • M2M Proxy and AuthZ Filter (Slide 10)

• Kong

  • Official Kong Documentation

  • Plugins in Use

Permissions and Security

• Understanding the Permissions Model

  • Okapi Permission Rules to Successfully Migrate to Capabilities and Capability Sets

  • Sub-permission Conversion

  • Permissions naming conventions

• Setting Up and Configuring Keycloak

  • mod-roles-keycloak

  • Refresh Token Rotation Configuration on Eureka

  • SSO Configuration

Best Practices

• System Users

  • System Users (Slide 11)

  • mgr-tenant-entitlements

  • mod-users-keycloak

• Cross Tenant Communication

  • Use Single x-okapi-token Header

• Replace Self-invocation with Particular Module Invocation for vert.x Modules

• vert.x Base Module Headers (For vert.x based modules all headers from incoming request should exist in newly created request)  

Migration from Okapi to Eureka

• Procedure

  • Changes and Migration Algorithms

• Compatibility Issues, Validation and Testing

  • Pitfalls and Validation

  • Testing

• Modifications for Stripes

  • UI QA Environments

  • Configuration

Integration Testing

• Testing Procedures

Deployment

• Deployment Options

  • Provisioning a Eureka Environment

  • Kubernetes

• Steps for Deployment

  • Local Deployment

  • Single Server Deployment

  • mgr-tenant-entitlements

• Application Manager and Application Descriptors Deployment

  • Manager Services

  • Adding Applications into Eureka

    • Application Definition (Slide 5)

• Provisioning

  • Putting It All Together

  • Adding Applications to Eureka

    • Register an Application (Slide 7)

    • Register Discovery Information (Slide 8)

  • Adding Tenants to Eureka

    • Create a Tenant (Slide 9)

  • Making Applications Available to Tenants

    • Create Entitlement (Slide 10)

  • Adding Users to Tenants

Appendix

• Glossary of Terms

• FAQs

• Community and Support