Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Search engine documentation review #369

Merged
merged 3 commits into from
May 3, 2022
Merged

Search engine documentation review #369

merged 3 commits into from
May 3, 2022
+25 −20

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented May 2, 2022

Review the searchengine documentation introduced in #359:

  • rename the file to fix a typo
  • add links to the repositories
  • updates the ports for the engine and the client
  • add links to the playbooks
  • remove the unnecessary pg_hba.conf section as the configuration should be handled via the playbook (?)

sbesson added 2 commits May 2, 2022 13:47
@sbesson
Rename searchengine doc
c31c310
@sbesson
Improve searchengine docs with additional links and updated ports

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
ff88955
@sbesson sbesson requested a review from khaledk2 May 2, 2022 16:42
khaledk2
khaledk2 suggested changes May 2, 2022
View reviewed changes
Copy link
Contributor

@khaledk2 khaledk2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The next line should be modified
http://127.0.0.1:5577/api/v1/resources/
The script_name searchengineapi is set by gunicon for the searchengine, so it should be a part of the URL, so it needs to be like that:
http://127.0.0.1:5577/searchengineapi/api/v1/resources/

@sbesson
Copy link
Member Author

sbesson commented May 2, 2022

Thanks @khaledk2, looking at the pilot-idr0000 deployment, I have

[sbesson@pilot-idr0000-omeroreadwrite ~]$ curl  http://127.0.0.1:5577/api/v1/resources/
Omero search engine (API V1)[sbesson@pilot-idr0000-omeroreadwrite ~]$ 
[sbesson@pilot-idr0000-omeroreadwrite ~]$ curl  http://127.0.0.1:5577/searchengineapi/api/v1/resources/
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>404 Not Found</title>
<h1>Not Found</h1>
<p>The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.</p>
[sbesson@pilot-idr0000-omeroreadwrite ~]$

Is there a special configuration required to get the new endpoint?

@khaledk2
Copy link
Contributor

khaledk2 commented May 2, 2022

I think you have deployed it before the latest modifications which I have pushed.
https://github.com/IDR/deployment/pull/359#issuecomment-1112753968

You may be re-run the deployment ansible-playbook again or just pull the latest docker image for the search engine and run the container. The latest can be done using the following commands:
sudo docker pull openmicroscopy/omero-searchengine:latest
sudo docker stop searchengine
sudo docker run -d --name searchengine --rm -v /data/searchengine/searchengine/:/etc/searchengine/ --network=searchengine-net -p 5577:5577 openmicroscopy/omero-searchengine:latest run_app searchengineapi

@sbesson
Copy link
Member Author

sbesson commented May 3, 2022

Thanks, pulling the latest image and redeploying it fixes the endpoint and 82b144cupdates the documentation accordingly.

This highlights the issue associated with using mutable images for the deployment. I'll open a separate issue to discuss the container versioning/lifecycle.

@sbesson sbesson requested a review from khaledk2 May 3, 2022 10:49
@sbesson sbesson mentioned this pull request May 3, 2022
Closed
@khaledk2
Copy link
Contributor

khaledk2 commented May 3, 2022

It looks fine, thank you.

@sbesson sbesson merged commit 7738bf4 into IDR:master May 3, 2022
@sbesson sbesson deleted the search_docs branch June 30, 2022 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@khaledk2 khaledk2

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@sbesson @khaledk2