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

Make Dockerfied development environment compatible with macOS #4401

Merged
merged 5 commits into from
May 30, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented May 29, 2024

Description

This PR makes the Docker-based setup for Openverse usable on macOS. It has some rather major differences from the Linux-compatible implementation in #4343.

This PR

  • drops user management entirely, running the container as the default user

    The original approach where user is being supplied to the container via --user is inherently incompatible with macOS because there is no docker group when running Docker containers on macOS either via Docker Compose or Orbstack.

  • changes the preserved volume to target /opt instead of from $HOME

    This is a consequence of removing user management. This works in fundamentally the same way except that the tools need to be configured via env vars to use paths under /opt.

  • removes redundant/autoinstalled packages, updates package explanations and fixes a typo in ov link command

Testing Instructions

Run the same testing instructions as #4343 using a Mac.

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 (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or 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.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels May 29, 2024
@dhruvkb dhruvkb marked this pull request as ready for review May 29, 2024 11:23
@dhruvkb dhruvkb requested a review from a team as a code owner May 29, 2024 11:23
@dhruvkb dhruvkb requested review from AetherUnbound, stacimc, krysal and obulat and removed request for a team, AetherUnbound and stacimc May 29, 2024 11:23
@sarayourfriend
Copy link
Collaborator

Merging this as is into the base branch, and then will push some additional fixes and simplifications. This is getting very close!

@sarayourfriend sarayourfriend merged commit 695bbd3 into add/openverse-dev-env-docker-image May 30, 2024
69 checks passed
@sarayourfriend sarayourfriend deleted the dockerfy_mac branch May 30, 2024 01:30
sarayourfriend added a commit that referenced this pull request May 30, 2024
* Dockerfy Openverse dev env

* Switch to Fedora for ARM support

* Fix group ID reading for macOS

* Apply suggestions from code review

Co-authored-by: Dhruv Bhanushali <[email protected]>

* Document new just recipes

* Make Dockerfied development environment compatible with macOS (#4401)

* Update packages and their explanations

* Use `/opt` as the preserved volume target

* Remove user management that's incompatible with macOS

* Add missing hyphen for default value

* Remove redundant packages and update comment

* Fix permissions (hopefully) and get aliases working again

* Fix shellcheck lint

* Tidy up

* Fix argument string conversion location

* Remove use of associative arrays to support macOS bash

* Unuse Perl

* Remove potentially problematic link utility

* Add g++ for renovate pre-commit node-gyp

* Remove unnecessary gcc; make running ov in parallel possible; fix whitespace

* Add pre-push hook and pass arguments to `ov hook`

* Fix pdm venv location

* Silence errors in docker volume when checking for volume

* Use &> to clobber all output

* Update ov

Co-authored-by: Dhruv Bhanushali <[email protected]>

---------

Co-authored-by: Dhruv Bhanushali <[email protected]>
Co-authored-by: Dhruv Bhanushali <[email protected]>
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: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants