docs: add features and use cases

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
koor-tech · Jul 7, 2023 · 67736bf · 67736bf
1 parent 9c30a3b
commit 67736bf
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 1 deletion.
diff --git a/docs/knowledge/koor/benefits.md b/docs/knowledge/koor/benefits.md
@@ -0,0 +1,33 @@
+---
+title: "Benefits"
+---
+
+## Storage wherever Kubernetes can run
+
+Wheter you are on bare metal, using Rancher, OpenShift or other Kubernetes-based platformns, you can run Koor Storage Distribution on it. For do-it-yourself enthusiasts, if you have Rook already running, you are ready for Koor Storage Distribution.
+
+Being able to run it "anywhere" enables you to easily test your whole environment easily.
+
+## One API for your Storage across Platforms
+
+You just use the Kubernetes API to create, edit and manage your storage cluster as needed.
+
+Monitoring metrics are exposed via standard Prometheus endpoints to integrate into your existing Prometheus stack.
+Additionally Koor Storage Distribution can deploy alerting rules of Ceph automatically for your cluster.
+
+## Stable Storage for Containers and Virtual Machines
+
+Built upon the rock solid [Ceph storage project](https://ceph.io/) which has been around since 2012.
+Used by many OpenStack installations to power many on-premise clouds to run virtual machines and many other workloads.
+
+Ceph is ready for Kubernetes thanks to the Rook, the base to the Koor Storage Distribution, and Ceph CSI projects.
+
+## On-Premise Block, Filesystem or Object Storage for your Kubernetes Platform
+
+With Koor Storage Distribution, we make it painless to run it. Just put Kubernetes on your servers and install Koor Storage Distribution.
+
+Easily enable the storage types that you need. Need just one, two or all three? No problem!
+
+* Block storage - Rados Block Devices (RBD), optiomal performance for applications that should be run on a typical filesystem (ext4, XFS).
+* Filesystem storage - CephFS, faster than NFS in most scenarios with file locking and more built-in.
+* Object storage - Rados Gateway (RGW), exposes an S3-compatible API for simple plugability to replace other S3-based storage.
diff --git a/docs/knowledge/koor/features.md b/docs/knowledge/koor/features.md
@@ -0,0 +1,47 @@
+---
+title: "Features"
+---
+
+## Automated Configuration of Dashboard SSO
+
+Koor adds automatic configuration of the Ceph dashboard's SSO (Single Sign On) to make it quick and easy to access the Ceph dashboard safely.
+
+You just need to add some lines of YAML to your existing `CephCluster`/`KoorStorageCluster` object:
+
+```yaml
+apiVersion: ceph.rook.io/v1
+kind: CephCluster
+metadata:
+  name: rook-ceph
+  namespace: rook-ceph # namespace:cluster
+spec:
+# [...]
+  dashboard:
+    enabled: true
+    ssl: true
+    sso:
+      enabled: true
+      # Your Identity provider of choice (e.g., Keycloak)
+      baseUrl: "https://ceph-dash.example.com"
+      #entityID: "<idp_entity_id>"
+      idpMetadataUrl: "https://keycloak.example.com/auth/realms/myrealm/protocol/saml/descriptor"
+      idpAttributes:
+        username: "username"
+      users:
+        - username: USERNAME
+          roles:
+            - administrator
+        # [...]
+```
+
+The operator takes care of configuring the Ceph dashboard and you should be redirected to your SSO provider for login.
+
+![Ceph Dashboard Overview](ceph-mgr-dashboard-sso-overview.jpg)
+
+## General Updates and Features for Community
+
+### Updated Grafana Dashboards for better Visualizing Cluster Metrics
+
+We have worked together with the community to update the Ceph dashboards to make it easier for everyone to keep an eye on their Ceph clusters.
+
+![Updated Grafana Ceph Cluster Dashboard](grafana_new_dashboard.png)
diff --git a/docs/knowledge/koor/features/ceph-mgr-dashboard-sso-overview.jpg b/docs/knowledge/koor/features/ceph-mgr-dashboard-sso-overview.jpg
diff --git a/docs/knowledge/koor/features/grafana_new_dashboard.png b/docs/knowledge/koor/features/grafana_new_dashboard.png
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -318,4 +318,3 @@
   cursor: default;
   opacity: .3;
 }
-