Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 2.42 KB

README.md

File metadata and controls

71 lines (53 loc) · 2.42 KB
Raw

brXM Lucene Index Exporter Application

A standalone application that takes care of exporting lucene index from a running brXM cms instance, in a kubernetes cluster

This applicaiton pulls the lucene index from ${LIE_URL} (e.g. http://localhost:8080/cms/ws/indexexport) and saves it into path at ${LIE_LIVE_INDEX_DIR}. This path can be an NFS mount for example and can be mounted into brXM pods. That way, brXM pods can use this lucene index export to start faster

Run it locally in minikube:

(Tested minikube version: v1.5.2)

Install virtualbox https://www.virtualbox.org/wiki/Downloads

Install minikube https://github.com/kubernetes/minikube

brew cask install minikube

Start minikube with some additional resources

minikube --memory 8192 --cpus 2 start

Setup helm (tested with v3.0.0) (kubernetes package manager) https://github.com/helm/helm

brew install kubernetes-helm

Switch to kubernetes folder

cd kubernetes

Setup a postgresql db for brxm

./setup_db.sh

After db is up, create a brxm deployment (from kubernetes directory)

./deploy-brxm.sh

To be able to work with the docker daemon on your mac/linux host use the docker-env command in your shell

eval $(minikube docker-env)

Now that you have run the eval command above, build the brxm-lucene-index-exporter image: (you have to keep using the same shell!)

cd .. # switch to pom.xml directory
mvn clean compile jib:dockerBuild

Create either a cronjob (lie-cronjob.yaml), job (lie-job.yaml)

kubectl create -f kubernetes/lie-cronjob.yaml

Remarks:

  • Ideally you want to run the cronjob every 4 hours.
  • The app also backs up the exported indexes by date (YYYYmmdd format), and deletes backed-up indexes that are older than ${LIE_INDEX_RETENTION_DAYS}. These backups are necessary when you restore a db backup (You'd have to find a suitable export for that backup, you can't use an export of today for a backup taken 3 days ago).
  • The directory in which the usable index is stored is at ${LIE_LIVE_INDEX_DIR}. Backed-up indexes are at ${LIE_BACKUP_INDEX_DIR}. ${LIE_TEMP_INDEX_DIR} is used for a temporary place to keep an index that is being downloaded.