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

Start the catalog service as part of ov just init #5300

Merged
merged 1 commit into from
Dec 25, 2024
Merged

Conversation

AetherUnbound
Copy link
Collaborator

Fixes

This fixes an issue I identified while trying to run ov just init - see the Make WordPress Slack

Description

This PR modifies the ov just init script to start the catalog stack at the very beginning, so that it's ready and initialized for the just catalog/cli commands that come later in the load_sample_data.sh script.

Testing Instructions

On main

Run ov just init and observe that it fails:

just dc exec -u airflow  "$@"
env COMPOSE_PROFILES="api,ingestion_server,frontend,catalog" docker compose -f docker-compose.yml "$@"
service "scheduler" is not running
error: Recipe `dc` failed on line 266 with exit code 1
error: Recipe `exec` failed on line 339 with exit code 1
error: Recipe `cli` failed on line 89 with exit code 1
error: Recipe `init` failed on line 64 with exit code 1
error: Recipe `init` failed on line 304 with exit code 1

On this branch

ov just init should run successfully without intervention

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.
  • 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.

@AetherUnbound AetherUnbound requested a review from a team as a code owner December 25, 2024 00:55
@AetherUnbound AetherUnbound added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Dec 25, 2024
@AetherUnbound AetherUnbound requested review from obulat and dhruvkb and removed request for a team December 25, 2024 00:55
@openverse-bot openverse-bot added the 🧱 stack: api Related to the Django API label Dec 25, 2024
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Nice, thank you, @AetherUnbound !

@obulat obulat merged commit 347878a into main Dec 25, 2024
81 checks passed
@obulat obulat deleted the fix/airflow-init branch December 25, 2024 05:26
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Late to the review, but it'd be nice to take down the additional services after the init step so that they're not taking up system resources when the user is concerned with the API.

@AetherUnbound
Copy link
Collaborator Author

Late to the review, but it'd be nice to take down the additional services after the init step so that they're not taking up system resources when the user is concerned with the API.

That's fair, but the best way to accomplish this (I think) would be taking down the whole stack, then just spinning the API back up again. Otherwise we'd have to explicitly list the services to shut down in the ov just down command, which would be cause for drift if that changes at all. Sometimes development requires ov just init for setting up and working on other parts of the stack as well. Perhaps it's okay to leave it as-is, rather than add more time on the init process to tear down then restart just the API bits? Especially given that Airflow isn't too resource intensive when idle. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API 🧱 stack: mgmt Related to repo management and automations
Projects
Status: 🤝 Merged
Development

Successfully merging this pull request may close these issues.

4 participants