Add bucketfs overview to documentation (#69)

--------- Co-authored-by: Torsten Kilias <[email protected]>
exasol · Jul 31, 2023 · 01cfb9e · 01cfb9e
1 parent 8f9b5a5
commit 01cfb9e
Show file tree

Hide file tree

Showing 6 changed files with 126 additions and 105 deletions.
diff --git a/doc/_static/bucketfs.png b/doc/_static/bucketfs.png
diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
@@ -1,6 +1,6 @@
 # 📝 Changes
 
-* [0.9.0](changes_0.9.0.md)
+* [unreleased](unreleased.md)
 * [0.8.0](changes_0.8.0.md)
 * [0.7.0](changes_0.7.0.md)
 * [0.6.0](changes_0.6.0.md)
@@ -10,12 +10,11 @@
 * [0.2.0](changes_0.2.0.md)
 * [0.1.0](changes_0.1.0.md)
 
-<!--- This MyST Parser Sphinx directive is necessary to keep Sphinx happy. We need list here all release letters again, because release droid and other scripts assume Markdown --->
 ```{toctree}
 ---
 hidden:
 ---
-changes_0.9.0
+unreleased
 changes_0.8.0
 changes_0.7.0
 changes_0.6.0

diff --git a/doc/changes/changes_0.9.0.md b/doc/changes/changes_0.9.0.md
diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md
@@ -0,0 +1,10 @@
+# Unreleased
+
+## Documentation
+- Added overview of bucketfs system
+
+## Dependencies
+- [#60](https://github.com/exasol/bucketfs-python/issues/60): Updated typeguard to 4.0.0
+
+## Internal
+- Updated lockfile
diff --git a/doc/user_guide/user_guide.rst b/doc/user_guide/user_guide.rst
@@ -1,6 +1,24 @@
 👤 User Guide
 ==============
 
+Bucketfs
+--------
+Depending on the database configuration, the bucketfs setup can range from straight forward to fairly complex.
+This is due to the fact that:
+
+* Each database can have one or more BucketFS services
+* Each BucketFS service is available on all worker cluster of a database
+* Each BucketFS service runs on all data nodes of a database
+* Each BucketFS service can have one or more Buckets
+* Each Bucket can hold one or more files
+
+The overview bellow tries to illustrate this in a more tangible manner.
+For more details on bucketfs, please also have a look in the `bucketfs section`_ of the `database documentation`_.
+
+.. image:: ../_static/bucketfs.png
+  :alt: BucketFS Overview
+
+
 Quickstart
 ----------
 
@@ -18,3 +36,5 @@ Follow Up
     advanced
     upload_github_release_to_bucket
 
+.. _bucketfs section: https://docs.exasol.com/db/latest/database_concepts/bucketfs/bucketfs.htm
+.. _database documentation: https://docs.exasol.com/db/latest/home.htm