mod-oa

Copyright (C) 2021 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Bounded Context Deailing with Open Access Publishing

Additional information

Code of Conduct

Refer to the Wiki FOLIO Code of Conduct.

Deployment

A sample k8s resource definition for service and deployment can be found the scripts directory Or you can get the latest module descriptor from the project OKAPI - [For example - v1.0.0-SNAPSHOT65](curl http://folio-registry.aws.indexdata.com/_/proxy/modules/mod-oa-1.0.0-SNAPSHOT.65)

This module requires the following env parameters

• OKAPI_SERVICE_PORT - port number for okapi
• OKAPI_SERVICE_HOST - Host [namespace.hostname if running in a different namespace to okapi]

The following properties are understood and documented in the Module Descriptor

• DB_DATABASE
• DB_HOST
• DB_USERNAME
• DB_PASWORD
• DB_MAXPOOLSIZE
• DB_PORT
• EVENTS_PUBLISHER_BOOTSTRAP_SERVERS
• EVENTS_CONSUMER_BOOTSTRAP_SERVERS
• EVENTS_PUBLISHER_ZK_CONNECT
• EVENTS_CONSUMER_ZK_CONNECT

Environment variables

This is a NON-EXHAUSTIVE list of environment variables which tweak behaviour in this module

| Variable | Description | Options | Default | |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|-------------------------------| | | ENDPOINTS_INCLUDE_STACK_TRACE | Allows the HTTP response 500 to contain stacktrace from the exception thrown. Default return will be a generic message and a timestamp. |

• true
• false

| false |

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org

Issue tracker

See project MODOA at the FOLIO issue tracker.

Download and configuration

The built artifacts for this module are available. See configuration for repository access, and the Docker image.

Notes on github actions for grails: https://guides.grails.org/grails-on-github-actions/guide/index.html, https://dev.to/erichelgeson/grails-ci-with-github-actions-25ff