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

feat: add bind and compose mount settings for superset #988

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Nov 15, 2024

Description

Adds IMAGES_BUILD_MOUNTS and COMPOSE_MOUNTS support for development on Superset within Aspects.

Preliminary step to work on openedx/openedx-aspects#299

Testing instructions

  1. Install this plugin's branch to your tutor virtualenv.
  2. Clone the Superset repo to your local environment: git clone https://github.com/apache/superset.git
  3. Add a mount for where you cloned superset, e.g. tutor dev mounts add /dev/superset
  4. Check that the mount shows up in the list, e.g tutor dev mounts list should have:
    - name: /dev/superset
      build_mounts:
      - image: aspects-superset
        context: superset
      compose_mounts:
      - service: superset
        container_path: /app
    
  5. Rebuild your superset image: tutor dev images build aspects-superset
  6. Stop superset and run a shell to check that your superset repo is mounted under /app.

to allow development on Superset within Aspects.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 15, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @bmtcril. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Contributor

@Ian2012 Ian2012 left a comment

Choose a reason for hiding this comment

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

LGTM, keep in mind that our Dockerfile depends heavily on the already built image of Superset so, changes to requirements or changes of this kind may not be well supported.

Another approach is to updated our Dockerfile to re-use/extend the upstream Dockerfile, however for general Aspects operations will only slow down builds.

@Ian2012 Ian2012 merged commit 4a00325 into main Nov 18, 2024
9 checks passed
@Ian2012 Ian2012 deleted the jill/mount-superset branch November 18, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants