[FOLIO-634] Update network/filesharing configuration to allow running against locally built modules from Okapi Created: 24/May/17  Updated: 31/Jan/19  Resolved: 26/Jan/19

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

Type: New Feature Priority: P2
Reporter: Wayne Schneider Assignee: Wayne Schneider
Resolution: Done Votes: 0
Labels: ci, platform-backlog, sprint52, sprint53, sprint54, sprint55
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-1548 SPIKE: a lighter-weight folio/testing... Closed
blocks STCLI-114 CLI support for local backend modules Closed
Relates
relates to STCLI-114 CLI support for local backend modules Closed
Sprint:
Development Team: Core: Platform

 Description   

A module running on the host needs to be able to connect to the Okapi hosted within the VM. The connection needs to be bidirectional. meaning Okapi needs to be able to make the calls outside of the VM, addressing the module running on the host machine.

The proposed forward port range is 8081-9000

Another solution (per Adam) to this problem is to cross the local machine/VM boundry by running a local instance of Okapi that talks to the Okapi running within the VM. This is not, however, the solution we are going to pursue here

This work should directly support STCLI-114 Closed .

Acceptance criteria:

  • port forwarding configuration for Vagrant that allows communication between a local module instance and Okapi


 Comments   
Comment by Wayne Schneider [ 26/Jan/19 ]

Embarrassingly, this turns out to be trivial. All you need to do is build and start up your module locally on an available port, post a module descriptor to the Okapi running in the guest VM, then post a deployment descriptor that points back to your module on the IP address 10.0.2.2. For example:

{
  "srvcId": "mod-tags-0.3.0-SNAPSHOT",
  "instId": "mod-tags-on-host",
  "url": "http://10.0.2.2:8081"
}

Then enable it for your tenant. That's it. I'll document in folio-ansible and close the issue.

Comment by Wayne Schneider [ 26/Jan/19 ]

Documentation updated in commit https://github.com/folio-org/folio-ansible/pull/172/commits/7d2137478ce92cec56ab33e35b89ea403548b6ee

Comment by David Crossley [ 31/Jan/19 ]

Congratulations – a nice discovery.

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