Add more detailed docs for ZenML Pro #3065
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
internal
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 20.9%, saving 762.76 KB.
319 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
strickvl
requested changes
Oct 14, 2024
|
|
||
| ## Create a Tenant in your organization | ||
|
|
||
| A tenant is a crucial part of your Organization and holds all of your pipelines, experiments and models, among other things. You need to have a tenant to fully utilize the benefits that ZenML Pro brings. The following is how you can create a tenant yourself: |
There was a problem hiding this comment.
Maybe it's worth adding that people can think of a tenant as a single VM / deployment of the ZenML server?
| - Give your tenant a name and click on the "Create Tenant" button | ||
|  | ||
|
|
||
| The tenant will be created in some time and added to your organization. In the meantime, you can already get started with setting up your environment for the onboarding experience. |
There was a problem hiding this comment.
Suggested change
| The tenant will be created in some time and added to your organization. In the meantime, you can already get started with setting up your environment for the onboarding experience. | |
| The tenant will then be created and added to your organization. In the meantime, you can already get started with setting up your environment for the onboarding experience. |
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 30.4%, saving 58.13 KB.
332 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 40.4%, saving 307.15 KB.
359 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
wjayesh
commented
Oct 18, 2024
| You can also create a tenant through the Cloud API by navigating to https://cloudapi.zenml.io/ and using the `POST /organizations` endpoint to create a tenant. | ||
| {% endhint %} | ||
|
|
||
| ## Organizing your tenants |
There was a problem hiding this comment.
really like this section
strickvl
reviewed
Oct 18, 2024
| read [this guide](../getting-started/deploying-zenml/README.md). | ||
| {% endhint %} | ||
|
|
||
| A ZenML OSS deployment (AKA a tenant) consists of the following moving pieces: |
There was a problem hiding this comment.
Suggested change
| A ZenML OSS deployment (AKA a tenant) consists of the following moving pieces: | |
| A ZenML OSS deployment consists of the following moving pieces: |
you make the distinction a few lines down
| ZenML OSS is free with Apache 2.0 license. Learn how to deploy it [here](./deploying-zenml/README.md). | ||
|
|
||
| {% hint style="info" %} | ||
| To learn more about the core concepts for ZenML OSS, go [here](../getting-started/core-concepts.md) |
There was a problem hiding this comment.
Suggested change
| To learn more about the core concepts for ZenML OSS, go [here](../getting-started/core-concepts.md) | |
| To learn more about the core concepts for ZenML OSS, go [here](../getting-started/core-concepts.md). |
| ## ZenML Pro (SaaS or Self-hosted) | ||
|
|
||
| {% hint style="info" %} | ||
| If you're interested in assessing ZenML Pro SaaSs, you can create |
There was a problem hiding this comment.
Suggested change
| If you're interested in assessing ZenML Pro SaaSs, you can create | |
| If you're interested in assessing ZenML Pro SaaS, you can create |
|
|
||
| ## Other operations involving organizations | ||
|
|
||
| There are a lot of other operations involving Organizations that you can perform directly through the API. You can find more information about the API by visiting https://cloudapi.zenml.io/. |
There was a problem hiding this comment.
Suggested change
| There are a lot of other operations involving Organizations that you can perform directly through the API. You can find more information about the API by visiting https://cloudapi.zenml.io/. | |
| There are a lot of other operations involving Organizations that you can perform directly through the API. You can find more information about the API by visiting [https://cloudapi.zenml.io/](https://cloudapi.zenml.io/). |
Comment on lines
23
to
35
| ## Deployment scenarios: SaaS vs Self-hosted | ||
|
|
||
| ZenML Pro enables you to [create and run templates](../../how-to/trigger-pipelines/README.md#run-templates). | ||
| This way, you can use the dashboard or our Client/REST API to run a pipeline with updated configuration | ||
| which allows you to iterate quickly with minimal friction. | ||
| One of the most straightforward paths to start with a deployed ZenML server is | ||
| to use [the SaaS version of ZenML Pro](https://zenml.io/pro). The ZenML Pro offering eliminates the need | ||
| for you to dedicate time and resources to deploy and manage a ZenML server, | ||
| allowing you to focus primarily on your MLOps workflows. | ||
|
|
||
| ### Triggers, CI/CD, Reports and more | ||
| However, ZenML Pro can also be deployed fully self-hosted. Please [book a demo](https://www.zenml.io/book-your-demo) | ||
| to learn more. | ||
|
|
||
| Additionally, ZenML Pro users get exclusive access to an array of | ||
| cloud-specific features, such as triggers, integrating with your code | ||
| repository CI/CD system, generating usage reports and more. | ||
| Click [here](../system-architectures.md) to understand about the various deployment scenarios with ZenML Pro. | ||
|
|
||
| Learn more about ZenML Pro on the [ZenML Website](https://zenml.io/pro). | ||
| <table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:purple;"><strong>Tenants</strong></mark></td><td>Tenants in ZenML Pro</td><td></td><td></td><td><a href="./tenants.md">tenants.md</a></td></tr><tr><td><mark style="color:purple;"><strong>Organizations</strong></mark></td><td>Organizations in ZenML Pro</td><td></td><td></td><td><a href="./organization.md">organization.md</a></td></tr><tr><td><mark style="color:purple;"><strong>Teams</strong></mark></td><td>Teams in ZenML Pro</td><td></td><td></td><td><a href="./teams.md">teams.md</a></td></tr><tr><td><mark style="color:purple;"><strong>Roles</strong></mark></td><td>Roles in ZenML Pro</td><td></td><td></td><td><a href="./roles.md">roles.md</a></td></tr></tbody></table> |
There was a problem hiding this comment.
Feels like there is too much redirection here. The table should stay I guess, but then the paragraph itself seems to send you in lots of directions.
|
|
||
| ## Using your tenant | ||
|
|
||
| As said already, a tenant is a supercharged ZenML server that you can use to run your pipelines, carry out experiments and perform all the other actions you expect out of your ZenML server. |
There was a problem hiding this comment.
Suggested change
| As said already, a tenant is a supercharged ZenML server that you can use to run your pipelines, carry out experiments and perform all the other actions you expect out of your ZenML server. | |
| As previously mentioned, a tenant is a supercharged ZenML server that you can use to run your pipelines, carry out experiments and perform all the other actions you expect out of your ZenML server. |
|
|
||
| ZenML Pro offers a powerful API that allows you to interact with your ZenML resources. Whether you're using the [SaaS version](https://cloud.zenml.io) or a self-hosted ZenML Pro instance, you can leverage this API to manage tenants, organizations, users, roles, and more. | ||
|
|
||
| Note, the SaaS version of ZenML Pro API is hosted [here](https://cloudapi.zenml.io) |
There was a problem hiding this comment.
Suggested change
| Note, the SaaS version of ZenML Pro API is hosted [here](https://cloudapi.zenml.io) | |
| The SaaS version of ZenML Pro API is hosted [here](https://cloudapi.zenml.io). |
|  | ||
|
|
||
| In this scenario, all services, data, and secrets are deployed on the customer | ||
| cloud. This is the opposite of Scenario 1, and is meant for customers who |
There was a problem hiding this comment.
We haven't mentioned scenarios in the document yet, so it feels a bit out of place...
| </details> | ||
|
|
||
| Are you interested in ZenML Pro? [Sign up](https://cloud.zenml.io/?utm\_source=docs\&utm\_medium=referral\_link\&utm\_campaign=cloud\_promotion\&utm\_content=signup\_link) | ||
| and get access to Scenario 1. with a free 14 day trial now! |
There was a problem hiding this comment.
same here with the scenario....
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 38.2%, saving 688.78 KB.
354 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
…into docs/zenml-pro-user-mgmt
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 32.7%, saving 158.30 KB.
361 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 43.6%, saving 135.29 KB.
362 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
strickvl
reviewed
Oct 18, 2024
strickvl
reviewed
Oct 18, 2024
|
|
||
| There are a lot of other operations involving Organizations that you can perform directly through the API. You can find more information about the API by visiting [https://cloudapi.zenml.io/](https://cloudapi.zenml.io/). | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
|
@strickvl addressed all comments |
strickvl
approved these changes
Oct 20, 2024
|
good to go from my side too |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe changes
I added some docs for ZenML Pro concepts like organizations, tenants, roles and the hierarchy of these concepts.
Pre-requisites
Please ensure you have done the following:
developand the open PR is targetingdevelop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes