Add configuration to run against local APIs #11551
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Size Change: +166 B (+0.02%) Total Size: 1.02 MB
ℹ️ View Unchanged
|
This was referenced Jan 31, 2025
I've taken to running |
|
Also excellent branch name |
rcantin-w
reviewed
Feb 3, 2025
rcantin-w
reviewed
Feb 3, 2025
|
I can get quite far in the config but it fails here, happy to discuss on a call 
|
This probably means the servers folder isn't created as part of the nginx install, that makes sense as I think I see it being created over here where i've "borrowed" some of these scripts from. |
kenoir
force-pushed
the
rk/everything-everywhere-all-at-once-sausage-fingers
branch
from
20b8674 to
59b9414
Compare
kenoir
force-pushed
the
rk/everything-everywhere-all-at-once-sausage-fingers
branch
from
59b9414 to
81f9756
Compare
rcantin-w
approved these changes
Feb 3, 2025
There was a problem hiding this comment.
For what we discussed it works well locally for me; I can access https://www-dev.wellcomecollection.org/search and get results for content only (not running the catalogue api). The identity icon does appear as I run them both, although I can't sign in, which I believe we said was expected. The links to it also appear to be the correct ones.
Exciting stuff, thank you! (Slack thread for legacy, and I've asked Gareth and David to also have a look!)
kenoir
deleted the
rk/everything-everywhere-all-at-once-sausage-fingers
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
Resolves wellcomecollection/platform#5892
This change adds a script that creates a local nginx configuration to proxy requests to locally running APIs using consistent domain names and with SSL.
When configured
https://www-dev.wellcomecollection.organdhttps://api-dev.wellcomecollection.orgare made available locally, served over https using development certificates added to the system root store. Requests are routed to distinct ports and paths so that the Concepts, Content, Catalogue Search & Catalogue Items APIs when run locally can be accessed from the locally running copy of the content app.This work borrows heavily from https://github.com/guardian/dev-nginx
Note
Requests, Account and Identity APIs have not been included yet as these require more complicated configuration. This change remove the ability to use content & identity locally as it is little used (I think), unnecessarily complex and doesn't play nicely with the nginx configuration.
This change depends on downstream changes to the following projects:
How to test
Running the Catalogue API locally:
sbt "project search" "~reStart": Starts the Search APIsbt "project items" "~reStart": Starts the Items API./conceptsrunyarn && yarn dev: Starts the Concepts APIRunning the Content API locally:
Check out https://github.com/wellcomecollection/content-api
In the
./apifolder run:yarn && yarn devRun
yarn config-local-apisand follow the instructionsRun the APIs you wish to test locally, observe that requests are routed to those APIs.
How can we measure success?
Development that crosses the API boundary is easier to do!
Have we considered potential risks?
This should only impact local development.