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

update: service backups #112

Merged
merged 3 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 30 additions & 48 deletions docs/platform/concepts/service_backups.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,50 @@
---
title: Backups at Aiven
title: Service backups
---

import AutoDelete from "@site/static/includes/auto-delete-poweredoff.md";
import Database from "@site/static/images/icons/db-backup.svg";
import EditBackUpSchedule from "@site/static/includes/edit-backup-schedule.md"

On top of general rules for handling service backups in Aiven, there are service-specific backup details, such as backup frequency and retention period per service. Backup policies for service power-off/on and service deletion are common for all the services, similarly as the backup access policy.
Most services have automatic time-based backups that are encrypted and securely stored.

## About backups at Aiven
**Backed-up services:** All Aiven services, except for Apache Kafka® and M3
Aggregator/Coordinator.

All Aiven services, except for Apache Kafka® and M3
Aggregator/Coordinator, have time-based backups that are encrypted and
securely stored. Backups at Aiven are stored in the object storage of
the cloud region where the service is first created (for example, S3 for
AWS or GCS for GCP). See the location of your service's
backups in [Aiven Console](https://console.aiven.io/) > your service's
homepage > **Backups**.
**Backup location:** Backups are stored in the object storage of the cloud region
where the service is first created, for example, S3 for AWS or GCS for GCP.

The backup retention times vary based on the service and the selected
service plan.
## Display service backups

Aiven takes service backups for managing purposes. These backups are
compressed and encrypted by the Aiven management platform and, as such,
are not available for download for any service type.
1. In the Aiven Console, open the service of your choice.
1. Click <Database className="icon"/> **Backups**.

:::note
If you change a cloud provider or an availability zone for your service,
Backups are encrypted and not available for download.

If you change a service's cloud provider or an availability zone,
its backups are not migrated from their original location.
:::

## Service power-off/on backup policy

Whenever a service is powered on from a powered-off state, the latest available
backup is restored.
backup is automatically restored.

:::note
<AutoDelete/>

See [Power a service on/off](/docs/platform/concepts/service-power-cycle).
:::

## Service backup deletion policy

For services that have been deleted for over 41 days, all the backups
are automatically deleted and, hence, no longer available.
A service's backups are automatically deleted 41 days after the service's deletion date.

## Access to backups

The Aiven platform takes care of all maintenance operations required for
running complex software at scale, allowing you to focus on using your
services. The open-source tools used for service backups can be
leveraged in your own infrastructure.

Since service backups are encrypted and stored in the object storage,
accessing them is not possible. If you do need to backup your service,
use the standard tooling for this service.

Recommended backup tools per service are as follows:
Backups are encrypted and not available for download, but you can create your own
backups with the appropriate tooling:

- [PostgreSQL®](https://www.postgresql.org/docs/14/app-pgdump.html):
`pgdump`
Expand All @@ -67,16 +58,12 @@ Recommended backup tools per service are as follows:
`elasticdump`

:::note
The listed backup tools are recommendations and are not intended
These tools are recommendations and are not intended
to create a snapshot of your Aiven service but to provide access to the
data.
:::

## Backup profile per service

Depending on the service plan, each service provides different backups
with different retention periods. See the hourly and daily backups
with the number of days of retention provided in the table.
## Backup retention profile per service

<table>
<thead>
Expand Down Expand Up @@ -221,7 +208,7 @@ are constantly archived to the cloud object storage. In case of node
failure,

- For a business or premium plan, Aiven can reconstruct the latest
state from a replica
state from a replica.
- For a startup plan, Aiven can reconstruct the latest state from the
latest base backup and replay the latest WAL segments on top of
that.
Expand All @@ -230,11 +217,9 @@ You can supplement this with a remote read-only replica service, which
you can run in a different cloud region or with another cloud provider
and promote to master if needed.

To shift the backup schedule to a new time, you can modify the backup
time configuration option in **Advanced configuration** in [Aiven
Console](https://console.aiven.io/) (the service's **Service settings**
page). If a recent backup has been taken, it may take another backup
cycle before the new backup time takes effect.
#### Edit the backup schedule

<EditBackUpSchedule/>

For more information, refer to:

Expand All @@ -250,14 +235,11 @@ with the open source [myhoard](https://github.com/aiven/myhoard)
software. Myhoard uses [Percona XtraBackup](https://www.percona.com/)
internally for taking full (or incremental) snapshots for MySQL.

To shift the backup schedule to a new time, you can modify the backup
time configuration option in **Advanced configuration** in [Aiven
Console](https://console.aiven.io/) (the service's **Service settings**
page). If a recent backup has been taken, it may take another backup
cycle before the new backup time takes effect.
#### Edit the backup schedule

<EditBackUpSchedule/>

For more information, refer to [MySQL
Backups](/docs/products/mysql/concepts/mysql-backups).
For more information, refer to [MySQL Backups](/docs/products/mysql/concepts/mysql-backups).

### Aiven for OpenSearch®

Expand Down
38 changes: 17 additions & 21 deletions docs/products/clickhouse/concepts/features-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,18 @@
title: Aiven for ClickHouse® features overview
---

Aiven for ClickHouse® is designed for developers to try out ClickHouse
quickly and easily and develop analytics apps. Discover Aiven for
ClickHouse's key features and attributes which let you focus on turning
business data into actionable insights while Aiven takes care of
managing ClickHouse.
Aiven for ClickHouse® is designed for developers to develop analytics apps.

Discover Aiven for ClickHouse's key features and attributes which let you focus
on turning business data into actionable insights.

## About the core functionality

Aiven for ClickHouse is a fully managed distributed columnar database
which is built on the open source ClickHouse solution. It is a fast
highly-scalable fault-tolerant database designed for online analytical
which is built on the open source ClickHouse solution. ClickHouse is a
highly scalable fault-tolerant database designed for online analytical
processing (OLAP) and data warehousing. Aiven for ClickHouse enables you
to execute complex SQL queries on large datasets quickly and effectively
to execute complex SQL queries on large datasets effectively
to process large amounts of data in real time. On top of that, it
supports built-in data integrations for Aiven for Kafka® and Aiven for
PostgreSQL®.
Expand All @@ -29,9 +28,7 @@ your shoulders.

**Pre-configured settings:** The managed ClickHouse service is
pre-configured with a rational set of parameters and settings
appropriate for the plan you have selected. You can easily launch
production-ready ClickHouse clusters in minutes in a cloud of your
choice.
appropriate for the plan you have selected.

## Easy management

Expand Down Expand Up @@ -62,7 +59,7 @@ choice.
times that do not affect productivity.
- **Backups and disaster recovery:** Aiven for ClickHouse has
automatic backups taken every 24 hours. The retention period depends
on your plan tier. Check out the details on [Plan
on your plan tier. See the details on [Plan
comparison](https://aiven.io/pricing?product=clickhouse&tab=plan-comparison).

## Intelligent observability
Expand All @@ -83,26 +80,25 @@ choice.

## Security and compliance

- **Single tenancy:** Your service runs on dedicated instances, thus
offering true data isolation that contributes to the optimal
- **Single tenancy:** Your service runs on dedicated instances.
This offers true data isolation that contributes to the optimal
protection and an increased security.
- **Network isolation:** Aiven platform supports VPC peering as a
mechanism for connecting directly to your ClickHouse service via
private IP, thus providing a more secure network setup. The platform
private IP. This provides a more secure network setup. The platform
also supports PrivateLink connectivity.
- **Regulatory compliance:** ClickHouse runs on Aiven platform that is
ISO 27001:2013, SOC2, GDPR, HIPAA, and PCI/DSS compliant.

Role based Access Control (RBAC) To learn what kind of granular access
is possible in Aiven for ClickHouse, check out
[RBAC with Zookeeper](/docs/products/clickhouse/concepts/service-architecture#zookeeper).

- **Role based Access Control (RBAC)**. To learn what kind of granular access
is possible in Aiven for ClickHouse, see
[RBAC with Zookeeper](/docs/products/clickhouse/concepts/service-architecture#zookeeper).

- **Zero lock-in:** Aiven for ClickHouse offers compatibility with
open source software (OSS), which protects you from software and
vendor lock-in. You can easily migrate between clouds and regions.
vendor lock-in. You can migrate between clouds and regions.

Check out more details on security and compliance in Aiven for
See more details on security and compliance in Aiven for
ClickHouse in
[Secure a managed ClickHouse® service](/docs/products/clickhouse/howto/secure-service).

Expand Down
2 changes: 2 additions & 0 deletions static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@
/platform/concepts/list-billing https://aiven.io/docs/platform/concepts/hourly-billing-model
/platform/howto/list-billing-groups https://aiven.io/docs/platform/concepts/billing-groups
/platform/howto/list-byoc https://aiven.io/docs/platform/concepts/byoc
/products/postgresql/reference/list-of-advanced-params https://aiven.io/docs/products/postgresql/reference/advanced-params
/products/mysql/reference/list-of-advanced-params https://aiven.io/docs/products/mysql/reference/advanced-params
8 changes: 8 additions & 0 deletions static/includes/edit-backup-schedule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
To shift the backup schedule to a new time:

1. Open your service.
1. Click **Service settings** page.
1. In **Advanced configuration**, click **Configure**, and use the `backup_hour` and `backup_minute`.

If a backup was recently made, it can take another backup cycle before the new backup
time takes effect.