Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.69 KB

s3-compatible.md

File metadata and controls

60 lines (42 loc) · 2.69 KB
description cover coverY
Offload out-of-retention messages to any S3-Compatible Object Storage
../../.gitbook/assets/Amazon S3 + Memphis.jpg
0

S3-Compatible Object Storage

Please pay attention that Memphis.dev is no longer supported officially by the Superstream team (formerly Memphis.dev ) and was released to the public.

{% hint style="info" %} To learn more about the architecture behind storage tiering, please head here. {% endhint %}

Introduction

The common pattern of message brokers is to delete messages after passing the defined retention policy, like time/size/number of messages.
Memphis offers a 2nd storage tier for longer, possibly infinite retention of stored messages.
Each message that expels from the station will be automatically migrated to a 2nd storage tier.

S3-compatible storage providers offer cost-efficient object storage and can act as a 2nd tier storage option for ingested messages. Examples of S3-compatible object storage providers are AWS S3, Backblaze B2, Digital Ocean Spaces, or self-hosted like Minio.

Getting Started

Step 1: Establishing the connection

Configuring the connection does not necessarily means that the storage tiering is enabled across all the stations or by default. The actual usage will occur on step 2, per station, and upon configuration.

Step 2: Obtain the needed information

{% tabs %} {% tab title="AWS S3" %}

  1. Create an IAM user with programmatic access and write permission to a specific bucket.
    Copy and document both the Access key and the Secret access key
  2. Create a new S3 bucket. It can be in any region and block all traffic.
    As long as the IAM user has permission to write to it.
  3. In the S3 integration modal, insert the following:
    • Memphis: Secret access key -> IAM: Secret access key
    • Memphis: Access Key ID -> IAM: Access Key ID
    • Memphis: Region -> S3: Bucket's region
    • Memphis: Bucket name -> S3: Bucket name
  4. Connect {% endtab %} {% endtabs %}

Step 3: Activate

Each station can be managed and use the second storage tier independently.

How to read migrated data

Currently, to enable migration of JSON, protobuf, and Avro into a flat format in case Schemaverse is activated, data is being formatted into Hex format.

{% hint style="info" %} To learn more about the architecture behind storage tiering, please head here. {% endhint %}