Skip to content

[apps] Update the backup and restore documentation for managed apps - #1137

Closed
Nick Volynkin (NickVolynkin) wants to merge 2 commits into
mainfrom
update-backup-restore-reference
Closed

[apps] Update the backup and restore documentation for managed apps#1137
Nick Volynkin (NickVolynkin) wants to merge 2 commits into
mainfrom
update-backup-restore-reference

Conversation

@NickVolynkin

@NickVolynkin Nick Volynkin (NickVolynkin) commented Jul 1, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Resolved in #1141

@NickVolynkin
[apps] Give examples of new resources in managed app README's
4719c82 
- Change wording for `resources` and `resourcesPreset` variables.
- Explain and give exampls of other object-type variables,
  if their child fields are not annotated.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
[apps] Update the backup and restore documentation for managed apps
e82b656 
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 1, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

This update revises documentation and schema descriptions across multiple application charts to clarify the usage of resources and resourcesPreset parameters. It enhances README files, YAML comments, and JSON schema descriptions, adds explicit examples and reference tables for resource presets, and corrects minor formatting and typographical issues. No functional code is changed.

Changes

Files/Paths Change Summary
*/README.md Expanded documentation for resources and resourcesPreset; added parameter examples, preset tables, and clarified usage.
*/values.yaml Updated parameter comments for resources and resourcesPreset for clarity and explicitness.
*/values.schema.json Refined property descriptions for resources and resourcesPreset, improving clarity and listing allowed values.
packages/apps/postgres/README.md
packages/apps/mysql/README.md
packages/apps/vpn/README.md
packages/apps/ferretdb/README.md
packages/apps/kafka/README.md
packages/apps/clickhouse/README.md
packages/apps/redis/README.md
packages/apps/nats/README.md
packages/apps/rabbitmq/README.md
packages/apps/http-cache/README.md
packages/apps/tcp-balancer/README.md
packages/apps/kubernetes/README.md		 Added or reorganized sections for resource configuration examples and preset reference tables; improved formatting and fixed typos.
packages/apps/*/values.schema.json Updated descriptions for resource-related properties; no schema structure or type changes.
packages/apps/*/values.yaml Clarified and expanded inline documentation for resource configuration parameters.

Sequence Diagram(s)

Skipped: Changes are documentation and schema description updates only, with no impact on control flow or feature logic.

Possibly related PRs

Suggested reviewers

  • lllamnyp
  • kvaps
  • klinch0

Poem

🐇
With carrots and care I write today,
To clarify resources in every way.
Presets and examples, all neat and precise,
YAML and schema, with sugar and spice.
Now every chart’s a garden bright—
Configured just right, from morning to night!
🍃

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b3a2bc8 and e82b656.

📒 Files selected for processing (36)
  • packages/apps/clickhouse/README.md (2 hunks)
  • packages/apps/clickhouse/values.schema.json (1 hunks)
  • packages/apps/clickhouse/values.yaml (1 hunks)
  • packages/apps/ferretdb/README.md (2 hunks)
  • packages/apps/ferretdb/values.schema.json (4 hunks)
  • packages/apps/ferretdb/values.yaml (4 hunks)
  • packages/apps/http-cache/README.md (2 hunks)
  • packages/apps/http-cache/values.schema.json (2 hunks)
  • packages/apps/http-cache/values.yaml (1 hunks)
  • packages/apps/kafka/README.md (1 hunks)
  • packages/apps/kafka/values.schema.json (2 hunks)
  • packages/apps/kafka/values.yaml (1 hunks)
  • packages/apps/kubernetes/README.md (1 hunks)
  • packages/apps/kubernetes/values.schema.json (4 hunks)
  • packages/apps/kubernetes/values.yaml (2 hunks)
  • packages/apps/mysql/README.md (3 hunks)
  • packages/apps/mysql/values.schema.json (2 hunks)
  • packages/apps/mysql/values.yaml (2 hunks)
  • packages/apps/nats/README.md (1 hunks)
  • packages/apps/nats/values.schema.json (1 hunks)
  • packages/apps/nats/values.yaml (1 hunks)
  • packages/apps/postgres/README.md (3 hunks)
  • packages/apps/postgres/values.schema.json (1 hunks)
  • packages/apps/postgres/values.yaml (1 hunks)
  • packages/apps/rabbitmq/README.md (1 hunks)
  • packages/apps/rabbitmq/values.schema.json (1 hunks)
  • packages/apps/rabbitmq/values.yaml (1 hunks)
  • packages/apps/redis/README.md (1 hunks)
  • packages/apps/redis/values.schema.json (1 hunks)
  • packages/apps/redis/values.yaml (1 hunks)
  • packages/apps/tcp-balancer/README.md (1 hunks)
  • packages/apps/tcp-balancer/values.schema.json (1 hunks)
  • packages/apps/tcp-balancer/values.yaml (1 hunks)
  • packages/apps/vpn/README.md (2 hunks)
  • packages/apps/vpn/values.schema.json (2 hunks)
  • packages/apps/vpn/values.yaml (3 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jul 1, 2025
@NickVolynkin
[docs] Update managed apps reference
94cc15e 
Mirroring changes from cozystack/cozystack#1137

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin Nick Volynkin (NickVolynkin) mentioned this pull request Jul 1, 2025
Merged
Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jul 1, 2025
@NickVolynkin
[docs] Update managed apps reference
5392748 
Mirroring changes from cozystack/cozystack#1137

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
Nick Volynkin (NickVolynkin) marked this pull request as ready for review July 2, 2025 09:56
@NickVolynkin
Nick Volynkin (NickVolynkin) marked this pull request as draft July 2, 2025 09:56
@NickVolynkin

Nick Volynkin (NickVolynkin) commented Jul 2, 2025

Copy link
Copy Markdown
Contributor Author

#1141

Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jul 3, 2025
@NickVolynkin
[docs] Update managed apps reference
2657e11 
Updating changes from cozystack/cozystack#1137

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin Nick Volynkin (NickVolynkin) mentioned this pull request Jul 3, 2025
Merged
Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jul 3, 2025
@NickVolynkin
[docs] Update managed apps reference
6f0706e 
Updating changes from

- cozystack/cozystack#1131
- cozystack/cozystack#1137

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Nick Volynkin (NickVolynkin) added a commit to cozystack/website that referenced this pull request Jul 3, 2025
@NickVolynkin
[docs] Update managed apps reference
cada010 
Updating changes from

- cozystack/cozystack#1131
- cozystack/cozystack#1137

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kvaps Andrei Kvapil (kvaps) Awaiting requested review from kvaps kvaps is a code owner
@lllamnyp Timofei Larkin (lllamnyp) Awaiting requested review from lllamnyp lllamnyp is a code owner
@klinch0 klinch0 Awaiting requested review from klinch0
@IvanHunters IvanHunters Awaiting requested review from IvanHunters IvanHunters will be requested when the pull request is marked ready for review IvanHunters is a code owner
@myasnikovdaniil myasnikovdaniil Awaiting requested review from myasnikovdaniil myasnikovdaniil will be requested when the pull request is marked ready for review myasnikovdaniil is a code owner
@lexfrei Aleksei Sviridkin (lexfrei) Awaiting requested review from lexfrei lexfrei will be requested when the pull request is marked ready for review lexfrei is a code owner
@scooby87 scooby87 Awaiting requested review from scooby87 scooby87 will be requested when the pull request is marked ready for review scooby87 is a code owner

Assignees

@NickVolynkin Nick Volynkin (NickVolynkin)

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@NickVolynkin