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

Avoid emulation for ov development environment #5256

Merged
merged 8 commits into from
Dec 11, 2024
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Dec 7, 2024

Fixes

Fixes #4934 by @dhruvkb
Addresses #4944 by @d3jawu

Problem

I was trying to use the ov environment more proactively in anticipation of the upcoming WordCamp. During this I noticed that ov was considerably slower than it should've been when running under emulation on macOS. This PR aims to fix that.

Description

This PR allows us to go back to running ov in the architecture native to the host machine instead of emulating for linux/amd64. This change significantly improves performance.

For example, it would take many minutes for linting to set up and run earlier, which now only takes a few seconds. This makes commits and pushes so much more frictionless.

To do this,

  • we replaced the vale Python package with a simpler download script that automatically downloads architecture specific binaries from GH releases. With this change, we can also drop the entire Python project we had scaffolded inside .vale/ for one dependency.
  • we made k6 optional in the Dockerfile. It will automatically be installed when the architecture is supported and will be skipped otherwise. If we find ourselves needing it more, we can switch to a method similar to Vale above and get it from GH releases.

Testing Instructions

  1. Check out the PR.
  2. If you were using ov before, clean it up:
    • ov clean
    • ov init
  3. Check that workflows continue to work normally, for example linting:
    ov just lint

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.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Dec 7, 2024
@dhruvkb dhruvkb force-pushed the dev_env_no_emulation branch from 79b389b to 4dca301 Compare December 7, 2024 07:58
@dhruvkb dhruvkb marked this pull request as ready for review December 7, 2024 15:41
@dhruvkb dhruvkb requested a review from a team as a code owner December 7, 2024 15:41
@dhruvkb dhruvkb requested review from krysal and obulat and removed request for a team December 7, 2024 15:41
@dhruvkb
Copy link
Member Author

dhruvkb commented Dec 11, 2024

I tested this on my Linux machine and while it was extremely slow, which was more likely a fault of my machine than this PR, it completed successfully. If someone has a faster, newer or more capable Linux machine, please test this out!

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.

I tried running this PR in WSL, and it worked. Linting is pretty slow, but this is not a problem of this PR.

I ran into a permission problem for PDM venv folder when running ov init for the first time:

INFO: python.use_venv is on, creating a virtualenv for this project...

[PermissionError]: [Errno 13] Permission denied: '/opt/pdm/venvs'

But when I re-ran ov init, everything went smoothly.

@dhruvkb dhruvkb merged commit 7679d55 into main Dec 11, 2024
54 checks passed
@dhruvkb dhruvkb deleted the dev_env_no_emulation branch December 11, 2024 07:08
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: improvement Improvement to an existing user-facing 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.

Use k6 release assets to build ov images
2 participants