feat: allow to host dbt docs on cluster

[Ian2012]

Description

This PR allows hosting dbt docs locally and on k8s. It also stores the manifest.json state file and superset exposures in clickhouse enabling us to remove the volume for the state. Closes: #915

• Fixes an issue with the dbt state that makes it find false positives.
• Turn every rendered value into an env var.
• Removes the k8s volume for the dbt state in favor of storing metadata in ClickHouse.

Testing instructions

• Enable RUN_ASPECTS_DOCS in your config.yml.
• Run migrations with tutor dev do alembic -c "upgrade head"
• Build the aspects docker image: tutor images build aspects
• Run DBT.
• Run collect lineage command.
• Go to http://dbt.local.edly.io:7000 and verify the docs are working, lineage data is available and exposures are available.
• Rerun DBT and verify that no changes have been detected.

[openedx-webhooks]

Thanks for the pull request, @Ian2012!

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[itsjeyd]

Hey @bmtcril and @pomegranited, would you have time to give this PR a look?

[Ian2012]

There are a couple of issues with this refactor:

• The new entrypoint has hardcoded the dbt branch and repositories, we need to turn it into env variables and apply them to all deployments
• We don't have a solution to have both lineage data and dbt documentation together. We need to save this information to ClickHouse.

[bmtcril]

Seems a little closer, I can init now, but k8s complains about the format of the deployment:

Error from server (BadRequest): error when creating "/Users/brianmesick/Dev/oars-tutor/env": Deployment in version "v1" cannot be handled as a Deployment: strict decoding error: unknown field "spec.template.metadata.containers", unknown field "spec.template.metadata.volumes"
Error: Command failed with status 1: kubectl apply --kustomize /Users/brianmesick/Dev/oars-tutor/env --selector app.kubernetes.io/component notin (job,volume,namespace)

[bmtcril]

Looks like the code is in a good place! Can you document the new feature and setting, why people might want it, and why they should be careful about turning it on / what access controls people might want? A "how-to" in openedx-aspects is probably the best place for it.

[bmtcril]

Tested in k8s and local and is working well

[openedx-webhooks]

@Ian2012 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.