Feature/gen-193 (#31)

* feat: describe what's been done, and what is next * feat: add notes about mvp and timeline
koor-tech · Aug 15, 2023 · d96b3a2 · d96b3a2
1 parent 633b965
commit d96b3a2
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 36 deletions.
diff --git a/docs/company/marketing/branding.md b/docs/company/marketing/branding.md
@@ -59,11 +59,12 @@ Use primary and secondary as the base or main set of colors. Apply the accent co
 
 The palette was enhanced by [Colormind](http://colormind.io/bootstrap/#).
 
-```css
+```scss
 $primary: #19dda5; // "java" a.k.a. "Medium Aquamarine"
 $secondary: #119671; // "jungle green" a.k.a. "Paolo Veronese Green"
 $accent: #9e809a; // "mountbatten pink"
 $light: #f6f5f6; // "wild sand"
+$light-brighter: #f8f7f8; // "alabastar"
 $dark: #1d2628; // "shark" a.k.a. "Charleston Green"
 ```
 

diff --git a/docs/development/product-roadmap.md b/docs/development/product-roadmap.md
@@ -4,60 +4,76 @@ title: Product Roadmap
 
 # Product Roadmap
 
-## You are here
 
-The Koor Storage Distribution includes features that work on top of Rook and Ceph to enhance the experience of storage professionals. Today, the KSD functionality includes the following:
+**Last updated:** 14 August 2023
+
+## Past to Now
+
+Koor's primary product offering has been the Koor Storage Distribution (KSD). Strictly speaking, KSD is a fork of Rook with a handful of helpful scripts and documents added to the mix. More broadly, KSD includes a loosely organized set of features that enhance the experience of using Rook and Ceph for self-managed data storage. 
+
+### What we have called KSD
 
 * Koor Storage Distribution (KSD)
-  * Bundles latest stable release of Rook with additional tools from Koor
-  * A KSD license includes authorization to use everything in this list
+  * A fork of Rook that is kept at parity with the latest version.
 * Koor Operator
   * Installs KSD on any Kubernetes cluster, and sets up Rook Ceph storage
   * Uses Helm chart or CRDs to define storage
-  * Checks the status of storage
+  * Checks the status of storage, flagging the user of resources that are configured below minimum thresholds
 * Diagnostic scripts
-  * Gathers debugging information that is useful for troubleshooting issues in a Rook Ceph cluster
+  * Gathers debugging information from a running cluster for troubleshooting issues
 * Extended Ceph Exporter
   * Extends metrics exported from Promethius for improved utilization charts
+* Version service
+  * Checks for newer version of Ceph and Rook that could be adopted
+
+### No adoption so far
+
+The real problem with what we have offered so far is that have had zero adoption that we know about. Perhaps a few have used the Koor Operator without our knowledge. Maybe some have taken a look. Either KSD was not well understood or the benefits were not useful enough to be worth the trouble of adopting or even trying it.
+
+Our customers to date are those who sought help with issues using Rook and Ceph. We are able to resolve issues and recommend improvements, so that has worked out. We need a much larger customer base, and we need customers to use our products.
+
+
+## Next
+
+Our new product strategy is to offer a single, multi-faceted product. For now as a working title, let's call it the Koor Data Control Center (KDCC). That's what we are building and offering, even though we may try different names in our marketing and sales packaging.
+
+Simply put, the KDCC is everything you need to see what is happening with your data storage systems and to change the system as needed. It's a single-pane-of-glass view that provides a common user interfaces for many perspectives of data storage operation. It is also offers GUI-based controls for setting up data storage, for tuning a running system, and to assist with larger modifications, like upgrades, expansion, and migrations.
+
+The components and features of the KDCC include the following.
+
+### Koor Dashboard
+
+* A top-level view that shows critical system metrics and active alerts.
+* High-level operational charts with drill-downs to see the details of each subsystem.
+* Versions of Ceph, Rook, and installed extensions, with information about available updates.
+
+### Koor Controls
 
-### Releases
+* Control panels with editable fields for properties that can be modified.
+* Staging for changes that require restart.
+* Scrubbing schedules to ensure deep scrubbing happens frequently enough.
 
-* [Koor Operator v0.2.0](https://github.com/koor-tech/koor-operator/releases/tag/koor-operator-0.2.0)
-* [Extended Ceph Exporter v1.2.8](https://github.com/koor-tech/extended-ceph-exporter/releases/tag/extended-ceph-exporter-1.2.8)
-* [Koor gather info scripts](https://github.com/koor-tech/koor-gather-info)
+### Data Storage Set-up
 
+* Koor Operator and Helm chart for installing the Koor Storage Distribution.
+* A selection of templates to match common use cases.
+* Automated system upgrades.
+* SSO integration.
 
-## Work in progress
+### Troubleshooting Tools
 
-The Koor team is working on 2 new features for the Koor Operator
+* Diagnostic scripts to gather data to help pinpoint issues.
 
-* Version update notifications -- issues an alert when a newer version of Ceph is available
-* Automated upgrades -- if there is a newer version of Ceph, upgrades your cluster (waits for user to initiate)
 
+## MVP
 
-## Future
+We do not know what a minimum-viable product is. We have to keep adding features until rates of adoption start to soar. 
 
-We are always looking for more ways to make running Rook Ceph storage in Kubernetes easier. Here are a few of the ideas we are thinking about for 2023.
+Rather than worrying about predicting an MVP, let's focus on choosing the next best feature to add and making that as valuable as possible.
 
-* Koor Dashboard
-  * Rook Ceph cluster visualization
-  * See your data cluster configuration in a browser
-  * Click on each component to see configuration and operational characteristics
-* Storage System Builder
-  * Start from one of the basic templates that match common use cases
-  * Adjust configuration options through a GUI
-  * One-click cluster provisioning and adjustments
-  * Integrates with Koor Dashboard
-* Security Tools
-  * Set up SSO access to underlying Ceph cluster
-* Troubleshooting Tools
-  * Performance tuning support
 
+## Timeline
 
-## Future future
+We have to hurry. It is critical to put together a functioning alpha version of the KDCC by the end of August, which is about 15 calendar days away. The alpha does not have to do much other than serve as a good basis to continue adding features and functionality for the coming months.
 
-* Storage System Builder
-* Backup and recovery
-  * Select data to back up, select a storage target, and schedule
-* Troubleshooting Tools
-  * Gap analysis - search Rook and Ceph features to find mismatches, identify what may be missing
+Once the architecture has been reviewed, and we select an initial feature set and define development tasks in Linear. This needs to be our top priority.