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.

Sign up for GitHub

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

Jump to bottom

Add option to add base URL for zenml server (with support for cloud) #2464

Merged
merged 17 commits into from
Mar 4, 2024
Merged

Add option to add base URL for zenml server (with support for cloud) #2464

merged 17 commits into from
Mar 4, 2024

Conversation

wjayesh
Copy link
Contributor

@wjayesh wjayesh commented Feb 23, 2024

Describe changes

I implemented changes to allow

  • people to set base URLs for their ZenML server
  • for ZenML Cloud tenants to set the same along with an option to add organization ID and tenant ID to it to construct a full cloud URL.

This is exposed through the /info endpoint of the server. The use case is to allow ZenML to use the URL to construct addresses for stuff like pipeline runs and other info on the server.

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 coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 23, 2024 •
edited
Loading

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.

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-tests for this file.
  • 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Feb 23, 2024
@github-actions GitHub Actions
Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

@AlexejPenner
Copy link
Contributor

I think for the future we will also need the org id separately, I would not make it part of the base url.

Base url should be: https://cloud.zenml.io/
then the tenant should also have its organization_id available to it to construct a full url

I believe the tenant_id is already there

@wjayesh
Copy link
Contributor Author

wjayesh commented Feb 27, 2024

@AlexejPenner I made the base url, org and tenant ID available as separate variables. These variables are set in the environment through the terraform script in this PR: https://github.com/zenml-io/zenml-cloud-infra/pull/16

stefannica
stefannica requested changes Feb 27, 2024
View reviewed changes
src/zenml/zen_stores/sql_zen_store.py Outdated Show resolved Hide resolved
src/zenml/zen_stores/sql_zen_store.py Outdated Show resolved Hide resolved
stefannica
stefannica approved these changes Feb 27, 2024
View reviewed changes
Copy link
Contributor

@stefannica stefannica left a comment

Choose a reason for hiding this comment

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

This looks good now, but if you want to go the extra mile and model the cloud_organization_id setting as a generic metadata dictionary instead, it would be even better.

stefannica
stefannica requested changes Feb 29, 2024
View reviewed changes
src/zenml/config/server_config.py Outdated Show resolved Hide resolved
@wjayesh wjayesh requested a review from stefannica March 1, 2024 08:39
@AlexejPenner AlexejPenner mentioned this pull request Mar 1, 2024
Merged
9 tasks
@wjayesh wjayesh merged commit 683e943 into develop Mar 4, 2024
54 of 55 checks passed
@wjayesh wjayesh deleted the feature/add-server-url-to-info branch March 4, 2024 10:55
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
@wjayesh @actions-user
@schustmi @adtygan
Add option to add base URL for zenml server (with support for cloud) (z…
a2a52e8 
…enml-io#2464)

* add base url as helm input and create env var

* add server url as part of zenml info endpoint

* Auto-update of Starter template

* make org and tenant id available separately

* add base url and org id to server config

* add base url and org id to server model in base zen store

* add base URL to helm template for env vars

* make cloud org ID opauqe and part of server metadata

* make metadata a Dict type object

* if metadata is str, convert to dict

* fix linter issue

* make empty dict as default metadata value

* Add server metadata to analytics

---------

Co-authored-by: GitHub Actions <[email protected]>
Co-authored-by: Michael Schuster <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@schustmi schustmi schustmi left review comments

@stefannica stefannica stefannica approved these changes

@AlexejPenner AlexejPenner Awaiting requested review from AlexejPenner

Assignees
No one assigned
Labels
enhancement New feature or request internal To filter out internal PRs and issues run-slow-ci
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@wjayesh @AlexejPenner @stefannica @schustmi @actions-user