Support New Dashboard release #2635

avishniakov · 2024-04-24T10:13:50Z

Describe changes

ZenML can run with new dashboard by default!
Switch to old is still supported either with Server Config (env ZEN_SERVER_USE_LEGACY_DASHBOARD) or with --legacy flag of zenml up.

Rework dashboard install script to pull 2 artifacts for legacy and new dashboards (currently hard fixed to v0.17.0-rc1, we will switch to latest after testing)
Add --legacy flag to zenml up to run the old dashboard
Add use_legacy_dashboard server config option, defaulted to False => new dashboard is default one
Extended CSP to support the What's New feature of the new dashboard
Added ZEN_SERVER_USE_LEGACY_DASHBOARD env
Update URL building logic of dashboard utils
Updated deployment config to support dashboard switches
Update Server API to support also new dashboard file structure

Docs update will follow separately

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

Summary by CodeRabbit

New Features
- Added support for launching the legacy ZenML dashboard via a new --legacy option.
- Introduced configuration options to toggle between the legacy and new dashboard versions.
Enhancements
- Updated the installation script to handle different releases of the ZenML Dashboard dynamically.
- Enhanced server deployment configurations to support environment-specific dashboard settings.
Documentation
- Updated internal documentation to reflect changes in dashboard management and deployment strategies.

…lease

coderabbitai · 2024-04-24T10:14:16Z

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The updates across various files introduce support for a legacy version of the ZenML Dashboard, enabling users to choose between the new and legacy versions. These changes involve adding configuration parameters, environment variables, and conditional logic to facilitate backward compatibility and user flexibility in selecting the dashboard version.

Changes

File Path	Change Summary
`scripts/install-dashboard.sh`	Updated to handle different releases of the ZenML Dashboard, including fetching and installing specified versions.
`src/zenml/cli/server.py` `src/zenml/config/server_config.py` `src/zenml/constants.py` `src/zenml/models/v2/misc/server_models.py`	Added support for a `--legacy` option and configuration parameters to toggle the legacy dashboard.
`src/zenml/utils/dashboard_utils.py`	Enhanced URL handling logic to support legacy dashboard based on configuration.
`src/zenml/zen_server/.../docker_zen_server.py` `src/zenml/zen_server/.../local_zen_server.py` `src/zenml/zen_server/zen_server_api.py` `src/zenml/zen_stores/base_zen_store.py`	Handling of environment variables and serving logic for legacy dashboard across different server deployment and store configurations.

Poem

🐇💻✨
In the fields of code, where the data streams flow,
The rabbits tweaked dashboards, with old and new glow.
Legacy and latest, side by side they sit,
A toggle, a switch, for whichever you fit.
Hop through the changes, with ease and fun,
For with every update, new victories are won! 🎉🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

avishniakov · 2024-04-24T10:14:30Z

@coderabbitai review

coderabbitai

Actionable comments posted: 7

scripts/install-dashboard.sh

…lease

* Add dashboard v2 source context (#2642) * use legacy url for stacks and stack components * Add dashboard v2 source context (#2642) * use legacy url for stacks and stack components * remove leaked change --------- Co-authored-by: Michael Schuster <[email protected]>

…s://github.com/zenml-io/zenml into feature/OSSK-526-support-oss-dashboard-release

…lease

…s://github.com/zenml-io/zenml into feature/OSSK-526-support-oss-dashboard-release

avishniakov · 2024-04-29T12:44:36Z

@coderabbitai review

coderabbitai

Actionable comments posted: 2

Out of diff range and nitpick comments (4)

scripts/install-dashboard.sh (4)

8-8: Ensure consistency in variable naming for clarity.

Consider renaming LEGACY_INSTALL_DIR to INSTALL_DIR_LEGACY to maintain consistency with INSTALL_DIR.

5-11: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [10-18]

Improve user guidance in error messages.

Consider providing more specific guidance on how to install missing tools or disable checksum verification in the error messages.

32-33: Clarify the error message for better user understanding.

Consider specifying which exact directory entries need to be removed from the .gitignore file in the error message.

105-105: Enhance error messaging for checksum verification failure.

Consider providing suggestions on what to do next or how to troubleshoot when the checksum verification fails.

scripts/install-dashboard.sh

strickvl

LGTM

avishniakov · 2024-04-29T15:30:34Z

Not waiting for MacOS tests, since they will fail, as expected - fix is happening on another branch.

avishniakov added 7 commits April 22, 2024 17:16

support 2 dashboards

5da3996

properly pass legacy setting around

8ec7413

build proper url for new dashboard

7ca0f7a

install dashboard aware of 2 versions

44f8f47

put explicit placeholder

22b435f

update other URL to match new dashboard

7864493

rework catch_all to new structure

068e2b5

github-actions bot added the internal To filter out internal PRs and issues label Apr 24, 2024

Merge branch 'develop' into feature/OSSK-526-support-oss-dashboard-re…

b12db04

…lease

github-actions bot added the enhancement New feature or request label Apr 24, 2024

coderabbitai bot reviewed Apr 24, 2024

View reviewed changes

avishniakov and others added 13 commits April 24, 2024 12:48

allow https://avatar.vercel.sh in CSP

438c74e

coderabbitai suggestions

910ec0c

Merge branch 'develop' into feature/OSSK-526-support-oss-dashboard-re…

2239317

…lease

auto create default user for legacy

2f5cf5e

multi-archive install script

23129fc

add csp for What's New

4d45bdd

Merge branch 'feature/OSSK-526-support-oss-dashboard-release' of http…

dc59bce

…s://github.com/zenml-io/zenml into feature/OSSK-526-support-oss-dashboard-release

check that legacy dashboard is not ignored

753c793

Merge branch 'develop' into feature/OSSK-526-support-oss-dashboard-re…

6801669

…lease

lint

989f478

darglint

fcd375d

Merge branch 'feature/OSSK-526-support-oss-dashboard-release' of http…

2134c54

…s://github.com/zenml-io/zenml into feature/OSSK-526-support-oss-dashboard-release

avishniakov added the run-slow-ci label Apr 29, 2024

coderabbitai bot reviewed Apr 29, 2024

View reviewed changes

scripts/install-dashboard.sh Show resolved Hide resolved

scripts/install-dashboard.sh Show resolved Hide resolved

fix dashboard pre-release for now

88e6ef0

fix torch<2.3.0 in tests

0e8a437

avishniakov changed the title ~~[WIP] Support New Dashboard release~~ Support New Dashboard release Apr 29, 2024

avishniakov requested review from strickvl and safoinme April 29, 2024 15:23

strickvl approved these changes Apr 29, 2024

View reviewed changes

avishniakov merged commit 5ec22e4 into develop Apr 29, 2024

avishniakov deleted the feature/OSSK-526-support-oss-dashboard-release branch April 29, 2024 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support New Dashboard release #2635

Support New Dashboard release #2635

Uh oh!

avishniakov commented Apr 24, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 24, 2024 •

edited

Loading

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

avishniakov commented Apr 24, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

avishniakov commented Apr 29, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

strickvl left a comment

Uh oh!

avishniakov commented Apr 29, 2024

Uh oh!

Uh oh!

Support New Dashboard release #2635

Support New Dashboard release #2635

Uh oh!

Conversation

avishniakov commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Auto Review Skipped

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

avishniakov commented Apr 24, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

avishniakov commented Apr 29, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

strickvl left a comment

Choose a reason for hiding this comment

Uh oh!

avishniakov commented Apr 29, 2024

Uh oh!

Uh oh!

avishniakov commented Apr 24, 2024 •

edited

Loading

coderabbitai bot commented Apr 24, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)