Update stack deployment docs and other small fixes #2846

stefannica · 2024-07-11T17:09:22Z

Describe changes

This PR updates the stack deployment docs to include the GCP cloud provider and add more info around the AWS stack CLI deployments. It also includes the following minor fixes:

minor formatting improvements for the GCP stack deployment configuration
extend the custom HTTP timeout increase to also cover the "list service connector resources" endpoint
removed the Cloud Function from the GCP deployment manager template because this feature is only available in a handful of GCP regions. Replaced it with bash script commands that call the ZenML REST API directly with the JSON output extracted from the deployment

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 · 2024-07-11T17:09:28Z

Important

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

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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@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 · 2024-07-11T17:11:43Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 22.7%, saving 617.08 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/deploy_stack_gcp_2.png`	153.00 KB	125.22 KB	-18.2%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_3.png`	135.38 KB	107.61 KB	-20.5%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_intro.png`	350.58 KB	263.54 KB	-24.8%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_start.png`	21.89 KB	16.10 KB	-26.4%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_step_1.png`	363.49 KB	272.82 KB	-24.9%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_step_2.png`	359.66 KB	268.58 KB	-25.3%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_step_3.png`	345.99 KB	260.37 KB	-24.7%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cloudshell_step_4.png`	326.45 KB	252.76 KB	-22.6%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_dashboard_output.png`	109.87 KB	90.50 KB	-17.6%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_dm_progress.png`	152.83 KB	126.82 KB	-17.0%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp.png`	138.11 KB	110.19 KB	-20.2%	View diff
`docs/book/.gitbook/assets/deploy_stack_pending.png`	158.06 KB	122.41 KB	-22.6%	View diff
`docs/book/.gitbook/assets/deploy_stack_selection.png`	99.28 KB	80.59 KB	-18.8%	View diff

244 images did not require optimisation.

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

…m:zenml-io/zenml into feature/prd-482-gcp-stack-deployment-docs

github-actions · 2024-07-11T19:52:58Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 14%, saving 108.81 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/deploy_stack_aws_cf_progress.png`	90.36 KB	66.04 KB	-26.9%	View diff
`docs/book/.gitbook/assets/deploy_stack_aws_cli_output.png`	94.18 KB	83.06 KB	-11.8%	View diff
`docs/book/.gitbook/assets/deploy_stack_aws_cli.png`	133.90 KB	118.26 KB	-11.7%	View diff
`docs/book/.gitbook/assets/deploy_stack_aws_cloudformation_intro.png`	89.49 KB	75.47 KB	-15.7%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cli_output.png`	159.98 KB	140.38 KB	-12.2%	View diff
`docs/book/.gitbook/assets/deploy_stack_gcp_cli.png`	210.76 KB	186.66 KB	-11.4%	View diff

256 images did not require optimisation.

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

…m:zenml-io/zenml into feature/prd-482-gcp-stack-deployment-docs

htahir1

Excellent work @stefannica - @avishniakov i synced it to this gitbook space to read more easily. From my side , LGTM!

…p-stack-deployment-docs

socket-security · 2024-07-12T11:29:40Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher

🚮 Removed packages: pypi/functions-framework@3.8.0, pypi/functions-framework@3.8.0

View full report↗︎

avishniakov · 2024-07-12T12:33:09Z

@stefannica pls don't merge just yet - will push some minor things very soon

avishniakov · 2024-07-12T13:39:45Z

@stefannica , I'm done, if you want to merge it 🙂

Updated docs and other small fixes

f925e65

stefannica requested a review from avishniakov July 11, 2024 17:09

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Jul 11, 2024

Optimised images with calibre/image-actions

fbf6492

stefannica and others added 3 commits July 11, 2024 21:49

Added more docs and fixed minor CLI output inconsistencies

a12db4a

Merge branch 'feature/prd-482-gcp-stack-deployment-docs' of github.co…

d8b6993

…m:zenml-io/zenml into feature/prd-482-gcp-stack-deployment-docs

Optimised images with calibre/image-actions

6e2ae38

stefannica added 2 commits July 11, 2024 21:59

More minor CLI output adjustments

2ee1e01

Merge branch 'feature/prd-482-gcp-stack-deployment-docs' of github.co…

2f09a62

…m:zenml-io/zenml into feature/prd-482-gcp-stack-deployment-docs

htahir1 approved these changes Jul 12, 2024

View reviewed changes

avishniakov approved these changes Jul 12, 2024

View reviewed changes

Remove cloud function from GCP deployment template

a7a8c86

stefannica force-pushed the feature/prd-482-gcp-stack-deployment-docs branch from 803ce44 to a7a8c86 Compare July 12, 2024 11:17

Merge remote-tracking branch 'origin/develop' into feature/prd-482-gc…

108c181

…p-stack-deployment-docs

stefannica added 3 commits July 12, 2024 13:32

Remove region availability check

9b8ba91

Remove cloud function from GCP deployment manager template

3bc5eb2

Changed deployment error hint

f726b62

avishniakov added 3 commits July 12, 2024 14:58

improve docs

749ab37

formatting

028c4c5

formatting

3af6f3a

stefannica and others added 2 commits July 12, 2024 17:32

Improve the error message in case of deployment failures

d2bd3c2

lint

105153a

stefannica merged commit 9af4d6a into develop Jul 15, 2024
50 of 54 checks passed

stefannica deleted the feature/prd-482-gcp-stack-deployment-docs branch July 15, 2024 07:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update stack deployment docs and other small fixes #2846

Update stack deployment docs and other small fixes #2846

stefannica commented Jul 11, 2024 •

edited

Loading

coderabbitai bot commented Jul 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

htahir1 left a comment

socket-security bot commented Jul 12, 2024 •

edited

Loading

avishniakov commented Jul 12, 2024

avishniakov commented Jul 12, 2024

Update stack deployment docs and other small fixes #2846

Update stack deployment docs and other small fixes #2846

Conversation

stefannica commented Jul 11, 2024 • edited Loading

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Jul 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

htahir1 left a comment

Choose a reason for hiding this comment

socket-security bot commented Jul 12, 2024 • edited Loading

avishniakov commented Jul 12, 2024

avishniakov commented Jul 12, 2024

stefannica commented Jul 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

socket-security bot commented Jul 12, 2024 •

edited

Loading