Skip to content

Commit

Permalink
docs: Add title for core components
Browse files Browse the repository at this point in the history
  • Loading branch information
jeqo committed Oct 14, 2024
1 parent daec916 commit 7a96610
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
25 changes: 14 additions & 11 deletions config.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
=================
RemoteStorageManagerConfig
Core components
=================
-----------------
RemoteStorageManagerConfig
-----------------
``chunk.size``
Segment files are chunked into smaller parts to allow for faster processing (e.g. encryption, compression) and for range-fetching. It is recommended to benchmark this value, starting with 4MiB.

Expand Down Expand Up @@ -91,9 +94,9 @@ RemoteStorageManagerConfig
* Importance: low


=================
-----------------
SegmentManifestCacheConfig
=================
-----------------
Under ``fetch.manifest.cache.``

``retention.ms``
Expand Down Expand Up @@ -129,9 +132,9 @@ Under ``fetch.manifest.cache.``
* Importance: low


=================
-----------------
SegmentIndexesCacheConfig
=================
-----------------
Under ``fetch.indexes.cache.``

``retention.ms``
Expand Down Expand Up @@ -167,9 +170,9 @@ Under ``fetch.indexes.cache.``
* Importance: low


=================
-----------------
ChunkManagerFactoryConfig
=================
-----------------
``fetch.chunk.cache.class``
Chunk cache implementation. There are 2 implementations included: io.aiven.kafka.tieredstorage.fetch.cache.MemoryChunkCache and io.aiven.kafka.tieredstorage.fetch.cache.DiskChunkCache

Expand All @@ -179,9 +182,9 @@ ChunkManagerFactoryConfig
* Importance: medium


=================
-----------------
MemoryChunkCacheConfig
=================
-----------------
Under ``fetch.chunk.cache.``

``size``
Expand Down Expand Up @@ -224,9 +227,9 @@ Under ``fetch.chunk.cache.``
* Importance: low


=================
-----------------
DiskChunkCacheConfig
=================
-----------------
Under ``fetch.chunk.cache.``

``path``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,30 +39,32 @@
**/
public class ConfigDocs {
public static void main(final String[] args) {
printSectionTitle("RemoteStorageManagerConfig");
printSectionTitle("Core components");

printSubsectionTitle("RemoteStorageManagerConfig");
final var rsmConfigDef = RemoteStorageManagerConfig.configDef();
System.out.println(rsmConfigDef.toEnrichedRst());

printSectionTitle("SegmentManifestCacheConfig");
printSubsectionTitle("SegmentManifestCacheConfig");
System.out.println("Under ``" + SEGMENT_MANIFEST_CACHE_PREFIX + "``\n");
final var segmentManifestCacheDef = MemorySegmentManifestCache.configDef();
System.out.println(segmentManifestCacheDef.toEnrichedRst());

printSectionTitle("SegmentIndexesCacheConfig");
printSubsectionTitle("SegmentIndexesCacheConfig");
System.out.println("Under ``" + FETCH_INDEXES_CACHE_PREFIX + "``\n");
final var segmentIndexesCacheDef = MemorySegmentIndexesCache.configDef();
System.out.println(segmentIndexesCacheDef.toEnrichedRst());

printSectionTitle("ChunkManagerFactoryConfig");
printSubsectionTitle("ChunkManagerFactoryConfig");
final var chunkCacheFactoryDef = ChunkManagerFactoryConfig.configDef();
System.out.println(chunkCacheFactoryDef.toEnrichedRst());

printSectionTitle("MemoryChunkCacheConfig");
printSubsectionTitle("MemoryChunkCacheConfig");
System.out.println("Under ``" + FETCH_CHUNK_CACHE_PREFIX + "``\n");
final var memChunkCacheDef = ChunkCacheConfig.configDef(new ConfigDef());
System.out.println(memChunkCacheDef.toEnrichedRst());

printSectionTitle("DiskChunkCacheConfig");
printSubsectionTitle("DiskChunkCacheConfig");
System.out.println("Under ``" + FETCH_CHUNK_CACHE_PREFIX + "``\n");
final var diskChunkCacheDef = DiskChunkCacheConfig.configDef();
System.out.println(diskChunkCacheDef.toEnrichedRst());
Expand Down

0 comments on commit 7a96610

Please sign in to comment.