Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

HowTo topics for Kafka tiered storage #2162

Merged
merged 22 commits into from
Nov 6, 2023

Conversation

harshini-rangaswamy
Copy link
Contributor

@harshini-rangaswamy harshini-rangaswamy commented Sep 28, 2023

What changed, and why it matters

Added HowTo topics for Kafka tiered storage (instructions for Aiven Console):

  • Get started
  • Enabled tiered storage
  • Configure tiered storage for topics
  • Tiered storage overview from Aiven Console

@harshini-rangaswamy harshini-rangaswamy self-assigned this Sep 28, 2023
@harshini-rangaswamy harshini-rangaswamy added the Kafka Kafka-related label Sep 28, 2023
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Sep 28, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 69f2489
Status: ✅  Deploy successful!
Preview URL: https://de991e48.devportal.pages.dev
Branch Preview URL: https://harshini-kafka-tiered-storag-3es7.devportal.pages.dev

View logs

@harshini-rangaswamy harshini-rangaswamy marked this pull request as ready for review September 28, 2023 12:10
4. Select **True** to activate tiered storage for the topic.

.. note::
If you leave the value as **Default**, it implies that tiered storage is enabled for this topic.
Copy link
Member

Choose a reason for hiding this comment

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

I thought the default was not to use it, interesting.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just tried setting Remote storage enable to Default, and it does nothing. But this is going to be an obvious question from the user. Why have Default in the drop-down when it does nothing? Is there a way to remove it?
For now, I will remove this note.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah i think so. Default in the topic configs means "not set", meaning it's as if it was never touched by user. (Maybe it should be "Not set" instead of "Default" 🤔) In this case, as you need to explicitly enable remote storage per topic, the default is that it's not enabled. Does that make sense?

- If you are creating a new service:

a. On the **Create Apache Kafka® service** page, scroll down to the **Tiered storage** section.
b. To enable tiered storage, select the **Enable tiered storage** toggle.
Copy link
Member

Choose a reason for hiding this comment

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

Should we mention that the price can be seen in the overview section?


Aiven for Apache Kafka®'s tiered storage expands storage beyond local disks. It stores frequently accessed data on faster tiers and less active data on cost-effective, slower tiers, ensuring both performance and cost efficiency are optimized.

For an in-depth understanding of tiered storage, how it works, and its benefits, see `Tiered Storage in Aiven for Apache Kafka®`.
Copy link
Member

@roope-kar roope-kar Oct 2, 2023

Choose a reason for hiding this comment

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

Tiered storage* (i think?)

View of the current configurations for tiered storage:

- **Local Cache**: Shows the current cache configuration.
- **Default Local Retention Time (ms)**: Shows the current local data retention set in milliseconds.
Copy link
Member

Choose a reason for hiding this comment

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

Wondering if these should mention the actual setting name? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used the name the user would see on the "Tiered storage overview" page. Do you mean add this - kafka.log_local_retention_bytes and kafka.log_local_retention_ms?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, those are the actual settings names. I'm just thinking that if for example you use the CLI, you would use the real setting names so it could be reassuring that we are in fact talking about the exact same service level settings.

I think we should just use the real setting name in console as well to avoid confusion.

Copy link
Member

@roope-kar roope-kar left a comment

Choose a reason for hiding this comment

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

Very nice work, looks good! :) I did not tag all uses of local cache as i assume these will be removed in one batch.

I did not try the instructions yet in production but might be a good idea to do some click testing with people having console + dev docs open and see if they manage to do everything.

General question, do we need screenshots to help with steps?

@harshini-rangaswamy
Copy link
Contributor Author

Very nice work, looks good! :) I did not tag all uses of local cache as i assume these will be removed in one batch.

I did not try the instructions yet in production but might be a good idea to do some click testing with people having console + dev docs open and see if they manage to do everything.

General question, do we need screenshots to help with steps?

As a general practice, we avoid screenshots due to maintenance issues. If the screen changes, we need to update them in the docs. Hence, we try to be detailed in the steps.

Copy link
Member

@ivanyu ivanyu left a comment

Choose a reason for hiding this comment

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

Not a full review yet


Aiven for Apache Kafka®'s tiered storage expands storage beyond local disks. It stores frequently accessed data on faster tiers and less active data on cost-effective, slower tiers, ensuring both performance and cost efficiency are optimized.

For an in-depth understanding of tiered storage, how it works, and its benefits, see `Tiered Storage in Aiven for Apache Kafka®`.
Copy link
Member

Choose a reason for hiding this comment

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

I guess it's the name of a section? I can't find it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This content is related to the concept topics in the PR - #2142. I'm unable to create direct links at the moment, as they would lead to broken links and prevent me from merging the content into the main branch.

Co-authored-by: Ivan Yurchenko <ivanyu@aiven.io>
_toc.yml Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@jeqo jeqo left a comment

Choose a reason for hiding this comment

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

Adding suggestions to align with https://github.com/aiven/aiven-core/pull/40511 changes

docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
docs/products/kafka/howto/tiered-storage-overview.rst Outdated Show resolved Hide resolved
harshini-rangaswamy and others added 7 commits November 6, 2023 12:37
Co-authored-by: Jorge Esteban Quilcate Otoya <jorge.quilcate@aiven.io>
Co-authored-by: Jorge Esteban Quilcate Otoya <jorge.quilcate@aiven.io>
Co-authored-by: Jorge Esteban Quilcate Otoya <jorge.quilcate@aiven.io>
Co-authored-by: Jorge Esteban Quilcate Otoya <jorge.quilcate@aiven.io>
Copy link
Member

@ivanyu ivanyu left a comment

Choose a reason for hiding this comment

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

A couple of suggestions

@ivanyu ivanyu merged commit 4b01872 into main Nov 6, 2023
5 checks passed
@ivanyu ivanyu deleted the harshini-kafka-tiered-storage-console branch November 6, 2023 13:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Kafka Kafka-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants