8000 [Control Center] Add database backups section by sosa-vaadin · Pull Request #4337 · vaadin/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Control Center] Add database backups section #4337

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

Merged
merged 16 commits into from
May 27, 2025

Conversation

sosa-vaadin
Copy link
Contributor

Document the process of making database backups, scheduling automatic backups, and recovery from a backup in Control Center.

Fixes https://github.com/vaadin/control-center/issues/892

Copy link
github-actions bot commented May 26, 2025

AI Language Review

The documentation in the "Backups" file is comprehensive and well-structured. However, there are a few areas where minor improvements or clarifications could enhance readability and consistency:

  1. In the "Creating a Backup" section, replace "done" with "nothing in itself" for accuracy in the sentence: "Enabling backups does nothing by itself."

  2. In "Volume Snapshots," consider rephrasing "needed for volume snapshot backups" to "required for volume snapshot backups" to maintain consistency with requirements language.

  3. In "Automatic Backups," the phrasing "The options let you schedule backups so they happen" can be improved for readability. Consider: "You can schedule backups to occur automatically."

These are minor suggestions aimed at improving overall clarity. The document is already quite detailed and well-organized.


The backup configuration using a cloud object store depends on which cloud object store is used.
https://cloudnative-pg.io/documentation/1.25/appendixes/object_stores/[CouldNativePG's official documentation] lists common object stores and how to configure them.
We provide example configurations for AWS S3 and other S3 compatible object stores, Microsoft Azure Blob Storage and Google Cloud Storage.
Copy link
Contributor
@MatthewVaadin MatthewVaadin May 26, 2025

Choose a reason for hiding this comment

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

Then the sentence needs rewording to make that obvious. Perhaps like this:

Suggested change
We provide example configurations for AWS S3 and other S3 compatible object stores, Microsoft Azure Blob Storage and Google Cloud Storage.
Example configurations are provided below for Microsoft Azure Blob Storage, Google Cloud Storage, Amazon Web Services (AWS) S3, and other S3 compatible object stores.

- https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#configure-a-connection-string-for-an-azure-storage-account[Connection String]
- Storage account name and https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage[Storage account access key]
- Storage account name and https://docs.microsoft.com/en-us/azure/storage/blobs/sas-service-create[Storage account SAS Token]
- Storage account name and https://azure.github.io/azure-workload-identity/docs/introduction.html[Azure AD Workload Identity] properly configured.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Storage account name and https://azure.github.io/azure-workload-identity/docs/introduction.html[Azure AD Workload Identity] properly configured.
- Storage account name and a properly configured https://azure.github.io/azure-workload-identity/docs/introduction.html[Azure AD Workload Identity].


= Backups

Control Center manages databases using https://cloudnative-pg.io[CloudNativePG], an open-source Kubernetes operator to manage PostgreSQL workloads on any supported Kubernetes cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

I you have to guess, we should remove it or re-word it.

@MatthewVaadin
Copy link
Contributor

Add the following lines to the .github/styles/config/vocabularies/Docs/accept.txt file:

Linode
[tT]ablespace(s)?

Copy link
Contributor
@MatthewVaadin MatthewVaadin left a comment

Choose a reason for hiding this comment

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

Comprehensive, yet concise documentation. Nice job.

@MatthewVaadin MatthewVaadin merged commit 0e25c78 into latest May 27, 2025
3 of 5 checks passed
@MatthewVaadin MatthewVaadin deleted the control-center/892/database-backups branch May 27, 2025 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0