ZenML Server activation and user on-boarding

[stefannica]

Describe changes

This PR changes the way that ZenML server are being provisioned immediately after deployment to exclude the automated creation of the so called default user. A new server activation flow is introduced that works as follows:

• newly deployed ZenML servers will not have any user accounts configured by default anymore. The "default user" concept is removed. Users cannot log into the server until they've gone through the server activation flow (see below)
• after deployment, the ZenML server is in an inactive state, marked by a False value for the new active field in the server info object. When the dashboard is opened in this state, the user will be walked through the server activation flow, which consists of the following:
  • supplying a username for the initial admin account
  • supplying a password for the initial admin account
  • setting the server name
  • after all this information is collected, the dashboard calls the new /api/v1/activate endpoint that 1. activates the server (toggles active to True) 2. creates an initial admin user account with the given name/password 3. automatically logs in the user using the new account

The server activation feature only works with the new OSS dashboard. If users want to explicitly configure new ZenML server deployments to use the old dashboard, the legacy behavior of automatically activating the server and automatically creating the default admin user account will be automatically enabled (FYI @avishniakov ).

The legacy behavior can also be enabled by setting the ZENML_SERVER_AUTO_CREATE_DEFAULT_USER environment variable to True for those who need a ready-to-go ZenML server that is automatically pre-activated on deployment.

The following server deployments are unaffected by this and will continue to have a default user account created automatically on deployment:

• local client deployments connected directly to a database
• local ZenML servers deployed with zenml up
• test harness deployments
• deployments that are explicitly configured to use the old dashboard

Side changes

This includes some changes required to support server settings and user on-boarding:

• the identity table has been renamed to server_settings and now contains new server-wide settings attributes in addition to the previous id deployment identifier:
  • the new active attribute
  • analytics opt in
  • whether to display announcements in the dashboard
  • whether to display information about zenml updates in the dashboard
  • onboarding status - server global on-boarding metadata that can be set by the dashboard
• the user now has a new user_metadata attribute that can be used by the dashboard to store additional information

Backwards compatibility

Existing server deployments are already active and have at least one admin account already configured.

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)

[coderabbitai]

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.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[github-actions]

Quickstart template updates in examples/quickstart have been pushed.

[github-actions]

E2E template updates in examples/e2e have been pushed.

[github-actions]

NLP template updates in examples/e2e_nlp have been pushed.

[avishniakov]

Cool, that Server Settings are in the DB now 👍🏼
Left a few minor changes/questions.

[avishniakov]

LGTM, if CI pass 👍🏼