[FOLIO-3881] Add edge-courses to snapshot hosted environments Created: 28/Aug/23  Updated: 09/Nov/23  Resolved: 09/Nov/23

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

Type: Task Priority: TBD
Reporter: Radhakrishnan Gopalakrishnan Assignee: David Crossley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-3923 edge-courses not responding on folio-... Closed
Sprint: DevOps Sprint 160
Development Team: FOLIO DevOps
RCA Group: TBD

 Description   

There is a new edge-inn-reach (https://github.com/folio-org/edge-courses) module that we'd like added to the hosted environments for testing and demo purposes.



 Comments   
Comment by Radhakrishnan Gopalakrishnan [ 18/Sep/23 ]

Any updates ??

Comment by David Crossley [ 19/Sep/23 ]

I did commence investigation.

Regarding https://dev.folio.org/guides/install-backend-module/#avoid-typical-mistakes
It has Port 8081 in Dockerfile and ModuleDescriptor and Jenkinsfile, but has 8080 in application.yml

Comment by David Crossley [ 11/Oct/23 ]

As far as i know, it is not a requirement to await the end of the approval process before adding to the reference environments. It is required before it gets added to a flower release.

I see that you are fixing the port numbers problem as part of that pull-request edge-courses/pull/2

Also i see that there is still a discrepancy in the Jenkinsfile.

It cannot be added to the refenvs until that those dispcrepancies are fixed.

Please do not leave it until the last minute. Our DevOps team is very under-staffed, so you cannot expect prompt action.

Comment by Radhakrishnan Gopalakrishnan [ 12/Oct/23 ]

Jenkins issue resolved. I was waiting for the dependent modules to be released. edge-common-spring. It was released just yesterday.

Apologies for the delay. 

Comment by David Crossley [ 17/Oct/23 ]

Today i did a test build via Jenkins folio-snapshot-test. All seems good in its module docker logs regarding the module startup.

The configuration is now merged, so it will be in today's "folio-snapshot-2".

When you get a chance to verify (see some wiki notes), then i will close this ticket.

Comment by David Crossley [ 06/Nov/23 ]

Radhakrishnan Gopalakrishnan – You did not verify as requested. Now someone is having trouble using the edge-courses module (see FOLIO-3923 Closed ).

When we configured it, i needed to guess the path and chose "/courses". Is that correct?

Comment by Radhakrishnan Gopalakrishnan [ 06/Nov/23 ]

The resulting ticket is a result me trying to verify it. I have been asking within the teams that have done this before to see if I was doing anything wrong. Didn't realize that a ticket was created as a result of that. Yes, /courses is correct. 

Comment by Steve Ellis [ 06/Nov/23 ]

David Crossleysorry for the additional ticket that got created. I had reached out to Wayne Schneider didn't notice this existing ticket where you are asking about verification, which is what I was providing. I believe the module is currently responding bad gateway 502 when routes within the module are requested. The module is clearly alive since its logs show that it is started, but requests aren't reaching it.

Comment by Wayne Schneider [ 08/Nov/23 ]

The issue appears to be that the application is listening on port 8080, but the Docker container is configured to export port 8081. I suspect that David assumed in response to his comment above that the developer would update the application.yml file to the more conventional (for FOLIO) listening port of 8081, but instead it looks like the Dockerfile was updated to expose 8080 instead. After updating the build playbook to use the correct port for the container, it is now available as expected on https://folio-snaposhot-test.dev.folio.org:8000/courses. The next folio-snapshot and folio-snapshot-2 builds should work.

In addition, the institutional user was lacking some required permissions. I have updated the build playbook to include course-reserves-storage.courses.collection.get, course-reserves-storage.departments.collection.get, and course-reserves-storage.courselistings.collection.get to support the /courses/courses, /courses/departments, and /courses/instructors endpoints. Please update the README accordingly.

Also, I note that the API definition file contains the endpoint /courses/courselistings/{instanceId}/reserves, but the instanceId referred to is actually a course listing identifier, not an inventory instance identifier. A minor point but might be nice to change that to avoid confusion in the future.

Comment by Radhakrishnan Gopalakrishnan [ 09/Nov/23 ]

Thanks Wayne Schneider . I will get the API definition fixed.

Comment by Wayne Schneider [ 09/Nov/23 ]

Please confirm that this is working as you expect so we can close this ticket. Thanks!

Comment by Radhakrishnan Gopalakrishnan [ 09/Nov/23 ]

Verified using https://folio-snapshot-2.dev.folio.org:8000/courses/courses

It works

 

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