From 6bddb38895c7da0501e0d90a49323f835e1220b4 Mon Sep 17 00:00:00 2001
From: Doug Goldstein <doug.goldstein@rackspace.com>
Date: Fri, 21 Jun 2024 15:42:37 -0500
Subject: [PATCH] docs: add initial vision

Attempt to explain the vision of Understack at a high-level.
---
 docs/overrides/home.html |  2 +-
 docs/vision.md           | 33 +++++++++++++++++++++++++++++++++
 mkdocs.yml               |  1 +
 3 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 docs/vision.md

diff --git a/docs/overrides/home.html b/docs/overrides/home.html
index 6c0c83964..0e7bb20a2 100644
--- a/docs/overrides/home.html
+++ b/docs/overrides/home.html
@@ -284,7 +284,7 @@ <h2>What is UnderStack?</h2>
   <div class="wrapper">
     <div></div>
     <div style="font-size: 20px;">
-      <p>UnderStack is an opinionated installation of OpenStack and related services to
+      <p>UnderStack is an opinionated installation of OpenStack centered around Ironic and related services to
       be able to provision bare metal hardware to be consumable by
       <a href="https://github.com/rackerlabs/genestack" target="_blank">genestack</a> for the
       full OpenStack suite.</p>
diff --git a/docs/vision.md b/docs/vision.md
new file mode 100644
index 000000000..1124f4643
--- /dev/null
+++ b/docs/vision.md
@@ -0,0 +1,33 @@
+# Vision
+
+Understack aims to provide an opinoniated installation of OpenStack Ironic and related
+services to allow management of bare metal environments efficiently, rapidly, consistently and cost-effectively.
+
+## Components
+
+- Data Center Infrastructure Management
+- IP Address Management
+- Hardware Provisioning
+- Hardware Lifecycle
+- Hardware Monitoring
+
+The effort aims to be OpenStack centric with supporting services and systems. The aim
+for the deployment platform is to be centered on Kubernetes.
+
+## End User Experience
+
+The end user experience is expected to be an API first model centered around OpenStack
+APIs allowing users to use existing OpenStack based tooling. Servers will be available
+via Nova so that there can be defined flavors and the user gets a machine that fulfills
+their needs.
+
+## Operator Experience
+
+Operators like DC techs and network engineering will have immediate view into the system
+assets and if they are consumed or not consumed.
+
+## Scale
+
+The overall scale of one system is expected to be at a multiple data center with multiple
+fabrics in each data center. This is the differiator between other tools available
+today.
diff --git a/mkdocs.yml b/mkdocs.yml
index 48e12d616..6e41efc00 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -67,6 +67,7 @@ validation:
 nav:
   - Home: index.md
   - 'Getting Started':
+    - vision.md
     - 'Prerequisites':
       - kubernetes.md
       - openstack-helm.md