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.

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

[docs] best practices for upgrading zenml server #3087

Merged
merged 35 commits into from
Oct 17, 2024

Conversation

wjayesh
Copy link
Contributor

@wjayesh wjayesh commented Oct 16, 2024

Describe changes

I added a new section: how-to/manage-zenml-server with best practices around upgrading and using the zenml server.

  • a new guide on how to use ZenML server in production with all the information that we have personally from deploying and managing ZenML Pro.
  • a new guide on how to navigate upgrades of ZenML server with regards to user pipelines and artifacts
  • general best practices for upgrading zenml
  • removed the zenml deploy command and moved the migrations guide to this section
  • subsumed the existing upgrade zenml pages into this new section

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)

@github-actions github-actions bot added internal To filter out internal PRs and issues documentation Improvements or additions to documentation labels Oct 16, 2024
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 11.2%, saving 103.74 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/cloudrun_autoscaling.png 62.57 KB 55.29 KB -11.6% View diff
docs/book/.gitbook/assets/cloudrun_metrics.png 433.58 KB 410.04 KB -5.4% View diff
docs/book/.gitbook/assets/ecs_autoscaling.png 121.71 KB 109.33 KB -10.2% View diff
docs/book/.gitbook/assets/ecs_cpu_utilization.png 126.53 KB 110.88 KB -12.4% View diff
docs/book/.gitbook/assets/grafana_dashboard.png 178.11 KB 133.22 KB -25.2% View diff

321 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 10.9%, saving 32.85 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/aws-rds-backups.png 52.29 KB 47.88 KB -8.4% View diff
docs/book/.gitbook/assets/server_migration_1.png 132.60 KB 115.14 KB -13.2% View diff
docs/book/.gitbook/assets/server_migration_2.png 115.52 KB 104.53 KB -9.5% View diff

326 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 9.5%, saving 10.99 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/server_migration_2.png 115.24 KB 104.25 KB -9.5% View diff

328 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

@wjayesh wjayesh requested review from htahir1 and strickvl October 16, 2024 11:25
.gitbook.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Ok almost there! Can you sync to gitbook and give me a link please? id like to read the tabs and verify the images work!

@wjayesh
Copy link
Contributor Author

wjayesh commented Oct 17, 2024

@htahir1 this is the using-zenml-in-prod page deployed on my gitbook space https://zenml-io.gitbook.io/jayeshml/how-to/manage-your-zenml-server/using-zenml-server-in-prod

Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Approved minus the conflicts

@wjayesh wjayesh requested a review from strickvl October 17, 2024 12:29
wjayesh and others added 2 commits October 17, 2024 18:11
@wjayesh wjayesh requested a review from strickvl October 17, 2024 12:43
@wjayesh wjayesh merged commit 30d16a9 into develop Oct 17, 2024
11 checks passed
@wjayesh wjayesh deleted the docs/best-practices-upgrading-zenml-server branch October 17, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants