[FOLIO-1994] consolidate Okapi docker containers and update documentation Created: 02/May/19  Updated: 03/Jun/20  Resolved: 03/Jun/19

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Jakub Skoczen Assignee: Ian Hardy
Resolution: Done Votes: 0
Labels: platform-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-2117 Kubernetes integration (Q2, container... Closed
blocks UXPROD-1823 Kubernetes integration (Q3, Okapi fea... Draft
Relates
relates to FOLIO-1995 use Okapi docker container instead of... Closed
Sprint: CP: sprint 64
Story Points: 3
Development Team: Core: Platform

 Description   

The currently published Okapi container is limited and has little documentation. The container should be extended (or consolidated) to support options similar to:

https://github.com/folio-org/folio-install/tree/kube-rancher/alternative-install/kubernetes-rancher/TAMU/okapi

but has to be able to replace the deb package we use on the ref envs: FOLIO-1995 Closed



 Comments   
Comment by Ian Hardy [ 09/May/19 ]

Just adding a few notes, the existing container uses docker-run.sh as the entrypoint which allows for passing options https://github.com/fabric8io-images/run-java-sh/blob/master/fish-pepper/run-java-sh/readme.md#running-a-java-application

Example:

docker run -e JAVA_OPTIONS="-Dloglevel=TRACE" folioorg/okapi dev
Comment by Ian Hardy [ 03/Jun/19 ]

The okapi container seems sufficiently flexible so far, java options and arguments can be passed to okapi following the conventions documented here: https://dev.folio.org/guides/best-practices-dockerfiles/. Complete documentation on the entry point is available in the folio-tools repository. More information on the entry point script is available here.

Configuration file can be added as necessary at runtime as volumes e.g.

 
docker run -e JAVA_OPTIONS="-Dlog4j.configuration=file:///etc/log4j.properties" -v `pwd`/log4j.properties:/etc/log4j.properties folioci/okapi dev

Multi-step processes like initializing the okapi database can be done by running the container twice with appropriate arguments for each step.

Comment by Jakub Skoczen [ 03/Jun/19 ]

Create an follow up item for the readme under okapi-core/

Comment by jroot [ 14/Feb/20 ]

Is there any way to get this documentation generated in Dockerhub, for running the Okapi container?

Generated at Thu Feb 08 23:17:25 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.