Skip to content

Commit

Permalink
byoc data store
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik-dorota committed Feb 3, 2025
1 parent bf55b7f commit 9b54df8
Show file tree
Hide file tree
Showing 10 changed files with 138 additions and 5 deletions.
34 changes: 29 additions & 5 deletions docs/platform/concepts/byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ to work properly (supporting HA signaling to the Aiven management node and RPM d
from Aiven repositories).
:::

Object storage in your AWS cloud account is where service's
[backups](/docs/platform/concepts/byoc#byoc-service-backups) and
[cold data](/docs/platform/howto/byoc/store-data#byoc-tiered-storage) are stored using
two S3 buckets.

</TabItem>
<TabItem value="2" label="AWS public">

Expand All @@ -154,6 +159,12 @@ through the public internet: the Aiven control plane connects to the nodes
using the public address, and the Aiven management plane can access the service VMs
directly. To restrict access to your service, you can use the
[IP filter](/docs/platform/howto/restrict-access).

Object storage in your AWS cloud account is where service's
[backups](/docs/platform/concepts/byoc#byoc-service-backups) and
[cold data](/docs/platform/howto/byoc/store-data#byoc-tiered-storage) are stored using
two S3 buckets.

</TabItem>
<TabItem value="3" label="Google Cloud private">

Expand Down Expand Up @@ -183,6 +194,11 @@ to work properly (supporting HA signaling to the Aiven management node and RPM d
from Aiven repositories).
:::

Object storage in your Google Cloud organization is
where service's [backups](/docs/platform/concepts/byoc#byoc-service-backups) and
[cold data](/docs/platform/howto/byoc/store-data#byoc-tiered-storage) are stored using
Google **Cloud Storage** buckets.

</TabItem>
<TabItem value="4" label="Google Cloud public">

Expand All @@ -196,6 +212,12 @@ through the public internet: the Aiven control plane connects to the nodes
using the public address, and the Aiven management plane can access the service VMs
directly. To restrict access to your service, you can use the
[IP filter](/docs/platform/howto/restrict-access).

Object storage in your Google Cloud organization is
where service's [backups](/docs/platform/concepts/byoc#byoc-service-backups) and
[cold data](/docs/platform/howto/byoc/store-data#byoc-tiered-storage) are stored using
Google **Cloud Storage** buckets.

</TabItem>
</Tabs>

Expand All @@ -208,10 +230,12 @@ All Aiven communication is encrypted.
Depending on the BYOC service, Aiven takes
[regular service backups](/docs/platform/concepts/service_backups) to enable forking, point
in time recovery (PITR), and disaster recovery.
These backups by default do not reside in your cloud. If there is a
requirement to have all backups in your own cloud account, it's still possible.
To accomplish this, Aiven needs read-write permissions to access the object storage on
your cloud account.

BYOC-hosted services have user-owned backups stored in object storage in your AWS
account or your Google Cloud organization. Backups reside in:

- S3 buckets for AWS BYOC environments
- Cloud Storage buckets for Google Cloud BYOC environments

:::important

Expand All @@ -232,4 +256,4 @@ Aiven deployment model.
- [Bring your own cloud networking and security](/docs/platform/howto/byoc/networking-security)
- [Enable bring your own cloud (BYOC)](/docs/platform/howto/byoc/enable-byoc)
- [Create a custom cloud in Aiven](/docs/platform/howto/byoc/create-cloud/create-custom-cloud)
- [Manage services hosted in custom clouds](/docs/platform/howto/byoc/manage-byoc-service)
- [Store BYOC data in your own cloud account](/docs/platform/howto/byoc/store-data)
6 changes: 6 additions & 0 deletions docs/platform/concepts/service_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,3 +334,9 @@ backups, see

For more information on Aiven for ClickHouse backups, see
[Backup and restore](/docs/products/clickhouse/concepts/disaster-recovery).

## BYOC service backups

Learn about
[backups for services hosted in custom clouds](/docs/platform/concepts/byoc#byoc-service-backups)
or [bring your own cloud (BYOC)](/docs/platform/concepts/byoc) environments.
14 changes: 14 additions & 0 deletions docs/platform/howto/byoc/create-cloud/create-aws-custom-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,20 @@ In the **Create custom cloud** wizard:
cannot change the BYOC VPC CIDR block after your custom
cloud is created.

- Remote storage (BYOC-hosted)

By default, the following data is stored in the BYOC object storage in your own
cloud account:

- [Cold data](/docs/platform/howto/byoc/store-data)
- [Service backups](/docs/platform/concepts/byoc#byoc-service-backups)

:::note
- Data is stored in your BYOC object storage using one S3 bucket per custom cloud.
- Permissions for S3 bucket management will be included in the Terraform
infrastructure template to be generated upon completing this step.
:::

Click **Generate template**.

Your IaC Terraform template gets generated based on your inputs. You can
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,21 @@ In the **Create custom cloud** wizard:
cannot change the BYOC VPC CIDR block after your custom
cloud is created.

- Remote storage (BYOC-hosted)

By default, the following data is stored in the BYOC object storage in your own
cloud account:

- [Cold data](/docs/platform/howto/byoc/store-data)
- [Service backups](/docs/platform/concepts/byoc#byoc-service-backups)

:::note
- Data is stored in your BYOC object storage using one Cloud Storage bucket per
custom cloud.
- Permissions for Cloud Storage bucket management will be included in the Terraform
infrastructure template to be generated upon completing this step.
:::

Click **Generate template**.

Your infrastructure Terraform template gets generated based on your inputs. You can
Expand Down
73 changes: 73 additions & 0 deletions docs/platform/howto/byoc/store-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: Store BYOC data in your own cloud account
sidebar_label: BYOC tiered storage
keywords: [bring your own cloud, byoc, custom cloud, BYOC cloud, object storage, tiered storage, bucket]
---

import ConsoleLabel from "@site/src/components/non-swizzled/ConsoleIcons";

BYOC environments use the tiered storage capability for data allocation. Cold data in your
custom cloud is stored in your AWS cloud account or your Google Cloud organization.

## BYOC tiered storage

:::important
[BYOC](/docs/platform/concepts/byoc) tiered storage is only supported for
[Aiven for Apache Kafka](/docs/products/kafka/howto/kafka-tiered-storage-get-started) and
[Aiven for ClickHouse](/docs/products/clickhouse/concepts/clickhouse-tiered-storage).
:::

To store data, [BYOC](/docs/platform/concepts/byoc) environments use tiered storage, a
data allocation mechanism for improved efficiency and cost optimization of data management.
When enabled, tiered storage allows moving data automatically between hot storage (for
frequently accessed, critical, and often updated data) and cold storage (for rarely
accessed, static, or archived data).

Cold data of BYOC-hosted services is stored in object storage in your AWS cloud
account or your Google Cloud organization. One bucket is created per custom cloud.

:::note

- Tiered storage enabled on non-BYOC services is owned by Aiven and as such doesn't allow
to store cold data in your own cloud account.
- Non-BYOC services with Aiven-owned tiered storage cannot be migrated to BYOC.

:::

To use tiered storage in an BYOC-hosted service, tiered storage needs to be enabled both
[in your custom cloud](/docs/platform/howto/byoc/store-data#enable-tiered-storage-in-a-custom-cloud)
and
[in the BYOC-hosted service](/docs/platform/howto/byoc/store-data#enable-tiered-storage-on-a-service).

## Enable tiered storage in a custom cloud

- **New custom clouds**: Tiered storage is enabled by default in all new custom
clouds so you can proceed to
[enabling tiered storage on a service](/docs/platform/howto/byoc/store-data#enable-tiered-storage-on-a-service).
- **Existing custom clouds with no tiered storage support**:
[Contact the Aiven support team](mailto:support@aiven.io) to request enabling tiered
storage in your custom cloud.

## Enable tiered storage on a service

### Prerequisites

- At least one [custom cloud](/docs/platform/howto/byoc/create-cloud/create-custom-cloud)
- At least one [Aiven-manged service](/docs/platform/howto/create_new_service), either
Aiven for Apache Kafka® or Aiven for ClickHouse®, hosted in an custom cloud

:::note
If your Aiven-managed service is not hosted in a custom cloud, you can
[migrate it](/docs/platform/howto/byoc/manage-byoc-service#migrate-an-existing-service-to-a-custom-cloud).
:::

### Activate tiered storage

- [Enable for Aiven for Apache Kafka](/docs/products/kafka/howto/enable-kafka-tiered-storage)
- [Enable for Aiven for Clickhouse](/docs/products/clickhouse/howto/enable-tiered-storage)

## Related pages

- [Bring your own cloud networking and security](/docs/platform/howto/byoc/networking-security)
- [View the status of a custom cloud](/docs/platform/howto/byoc/view-custom-cloud-status)
- [Manage services hosted in custom clouds](/docs/platform/howto/byoc/manage-byoc-service)
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ const sidebars: SidebarsConfig = {
'platform/howto/byoc/assign-project-custom-cloud',
'platform/howto/byoc/add-customer-info-custom-cloud',
'platform/howto/byoc/tag-custom-cloud-resources',
'platform/howto/byoc/store-data',
'platform/howto/byoc/rename-custom-cloud',
'platform/howto/byoc/download-infrastructure-template',
'platform/howto/byoc/delete-custom-cloud',
Expand Down
Binary file modified static/images/content/figma/byoc-aws-private.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/content/figma/byoc-aws-public.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/content/figma/byoc-gcp-private.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/content/figma/byoc-gcp-public.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9b54df8

Please sign in to comment.