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.

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

Use Elasticsearch configuration file to avoid tricky envvar names #4992

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #4974 by @zackkrida

Description

See my comment on the issue clarifying the cause and long-term fixes for additional rationale of this change.

TL;DR: Docker compose broke the way environment variables are parsed, and no longer accepts those defined in es/env.docker. On the other hand, it appears that there is no way to pass allow-origin as an environment variable, as ES will not recognise the same option with an underscore, and provides no method to map hyphens. The configuration file is much more searchable against the docs anyway.

Testing Instructions

CI must pass (proving ES is accessible throughout the development stack). Also check out this branch and run ov j api/up to get ES running locally, and make an http request like ov http http://0.0.0.0:50292/_cluster/health. Also use a tool like Elasticvue to prove CORS is working for local development usage.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

…able names

It appears that there is no way to pass allow-origin as an environment variable, as ES will not recognise the same option with an underscore, and provides no method to map hyphens. The configuration file is much more searchable against the docs anyway.
@sarayourfriend sarayourfriend added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: mgmt Related to repo management and automations labels Sep 25, 2024
@sarayourfriend sarayourfriend requested a review from a team as a code owner September 25, 2024 19:44
@sarayourfriend sarayourfriend requested review from zackkrida and krysal and removed request for a team September 25, 2024 19:44
@openverse-bot openverse-bot added 🧱 stack: analytics Related to the analytics setup 🧱 stack: api Related to the Django API 🧱 stack: catalog Related to the catalog and Airflow DAGs labels Sep 25, 2024
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

The approach taken looks correct and I do think ultimately this is a better approach even if it was forced on us by docker compose.

One caveat to my review is that I am away from my computer and cannot run this locally. It does look right though, so feel free to use your discretion in merging.

@sarayourfriend
Copy link
Contributor Author

sarayourfriend commented Sep 25, 2024

I'll merge based on that review, my testing locally using the tests I shared in the PR description, and if CI passes, which includes running API tests and loading sample data, both of which use the local Elasticsearch cluster.

@AetherUnbound
Copy link
Contributor

I'm looking now as well, if you wanted a second set of eyes before merging.

@sarayourfriend sarayourfriend merged commit 5a3d387 into main Sep 25, 2024
90 checks passed
@sarayourfriend sarayourfriend deleted the fix/docker-es-env branch September 25, 2024 19:58
@sarayourfriend
Copy link
Contributor Author

Ah, sorry @AetherUnbound, your comment had not come through on the page! If you find any issues I am around to hotfix.

@AetherUnbound
Copy link
Contributor

No worries, changes look good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: analytics Related to the analytics setup 🧱 stack: api Related to the Django API 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧱 stack: mgmt Related to repo management and automations
Projects
Status: 🤝 Merged
Development

Successfully merging this pull request may close these issues.

Incorrect CORS variable definition in docker.env
4 participants