folio-org/eureka-platform-bootstrap
Developer toolsこのページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る
Provides docker-based minimal eureka platform
概要
Compose-centered local FOLIO Eureka app-platform-minimal environment definition and bootstrap repository. - Docker with Compose v2.24+ (allocate 12GB+ memory; the bootstrap warns below that) - Python 3.10+ - Java 17+ - Maven - jq - curl ./start.sh is the single entrypoint. It: - checks required tools - asks at most a couple of questions (actualize module versions; on Apple Silicon, build ARM images) - creates or updates local env files (docker/.env.local, docker/.env.local.credentials) - starts core, then mgr-components, then the bundled app-platform-minimal services by name - registers the bundled application descriptor and discovery metadata - creates tenant diku and the default admin user folio/folio - finishes with a short smoke check (api-gateway reachable, tenant token, diku exists, capabilities reachable) start.sh stays thin; the logic lives in focused libraries: The bundled application metadata lives in descriptors/app-platform-minimal/{descriptor,discovery}.json.
README
以下は原文 README の抜粋です。原文を見る。
eureka-platform-bootstrap
Compose-centered local FOLIO Eureka app-platform-minimal environment definition
and bootstrap repository.
Requirements
- Docker with Compose v2.24+ (allocate 12GB+ memory; the bootstrap warns below that)
- Python 3.10+
- Java 17+
- Maven
jqcurl
Quick start
./start.sh
./start.sh is the single entrypoint. It:
- checks required tools
- asks at most a couple of questions (actualize module versions; on Apple Silicon, build ARM images)
- creates or updates local env files (
docker/.env.local,docker/.env.local.credentials) - starts
core, thenmgr-components, then the bundledapp-platform-minimalservices by name - registers the bundled application descriptor and discovery metadata
- creates tenant
dikuand the default admin userfolio/folio - finishes with a short smoke check (api-gateway reachable, tenant token,
dikuexists, capabilities reachable)
Options
./start.sh --actualize [--pre-release] # refresh module versions first (SNAPSHOT with --pre-release)
./start.sh --native-sidecar # native folio-module-sidecar image (built if missing)
./start.sh --rebuild-native-sidecar # force a fresh native sidecar build
./start.sh --apisix # use APISIX as the API gateway instead of Kong
./start.sh --yes # non-interactive (assume defaults / yes)
./start.sh --debug # stream all helper output
How it is organized
start.sh stays thin; the logic lives in focused libraries:
| File | Responsibility |
|---|---|
start.sh |
argument parsing, prompts, tool checks, run the flow |
misc/bootstrap-engine.sh |
phase orchestration (run_bootstrap_flow) and local setup |
misc/lib/folio-common.sh |
logging, config loading, output helpers, dependency checks |
misc/lib/folio-api.sh |
tokens, descriptor/discovery registration, entitlement, smoke check |
misc/lib/docker-health.sh |
container health and HTTP route readiness waits |
The bundled application metadata lives in
descriptors/app-platform-minimal/{descriptor,discovery}.json. Extending the
local runtime with more modules is a code change to the descriptor and matching
Compose module/sidecar services, not a ./start.sh runtime option.
Native Docker access
./start.sh and ./stop.sh are the supported runtime lifecycle. Operators who
need low-level Docker access can work directly from docker/ with native
docker compose commands and their own environment configuration.
Stop and reset
./stop.sh # prompts: remove containers (default yes), clear volumes (default no)
./stop.sh --yes # non-interactive: remove containers, keep volumes
Keycloak topology
Keycloak runs as a single node by default. To scale the cluster, uncomment the
keycloak-sN services in docker/docker-compose.keycloak.yml and the matching
推奨ツール
別のキーワードを試すか、フィルタを外してください。
インストール
npx skillfish add folio-org/eureka-platform-bootstrap