Skip to content

Commit

Permalink
docs: add initial vision
Browse files Browse the repository at this point in the history
Attempt to explain the vision of Understack at a high-level.
  • Loading branch information
cardoe committed Jun 21, 2024
1 parent 127b46d commit 6bddb38
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
33 changes: 33 additions & 0 deletions docs/vision.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ validation:
nav:
- Home: index.md
- 'Getting Started':
- vision.md
- 'Prerequisites':
- kubernetes.md
- openstack-helm.md
Expand Down

0 comments on commit 6bddb38

Please sign in to comment.