Skip to content

Commit

Permalink
feat: update docs to look more like an integrated product
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Carter <[email protected]>
  • Loading branch information
cloudnull committed Mar 7, 2024
1 parent 70e6e24 commit 582e967
Show file tree
Hide file tree
Showing 5 changed files with 223 additions and 163 deletions.
1 change: 1 addition & 0 deletions docs/assets/images/rackspace_logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 33 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,45 @@
---
hide:
- navigation
- toc
---

# Welcome to the Genestack Documentation

![Genestack Logo Mono](assets/images/genestack-logo.png#only-dark){ align=left }
![Genestack Logo Mono](assets/images/genestack-logo-mono.png#only-light){ align=left }
<div class="grid cards" markdown>
- :material-abacus:{ .lg .middle } __Genestack__

---

Where Kubernetes and OpenStack tango in the cloud. Imagine a waltz between systems that deploy
what you need. Operators play the score, managing the complexity with a flick of their digital batons. They
unify the chaos, making scaling and management a piece of cake. Think of it like a conductor effortlessly
guiding a cacophony into a symphony.

!!! info "The etymology of our Stack"
- :material-alpha:{ .lg .middle } __dʒen.ə.stæk__

Genestack - dʒen.ə.stæk
---

1. The genesis of cloud
2. Open-Infrastructure Simplified
3. Your new favorite OpenStack ecosystem
1. The genesis of Open-Infrastructure
2. Cloud Simplified
3. Your new favorite ecosystem
</div>

Genestack — where Kubernetes and OpenStack tango in the cloud. Imagine a waltz between systems that deploy
what you need. Operators play the score, managing the complexity with a flick of their digital batons. They
unify the chaos, making scaling and management a piece of cake. Think of it like a conductor effortlessly
guiding a cacophony into a symphony.
---

![Genestack Logo](assets/images/genestack-logo.png){ align=left }

## What is Genestack?

Genestack is a complete operations and deployment ecosystem for Kubernetes and OpenStack. The purpose is of
this project is to allow hobbyists, operators, and cloud service providers the ability to build, scale, and
leverage Open-Infrastructure in new and exciting ways.

Genestack’s inner workings are a blend dark magic — crafted with [Kustomize](https://kustomize.io) and
[Helm](https://helm.sh). It’s like cooking with cloud. Want to spice things up? Tweak the
`kustomization.yaml` files or add those extra 'toppings' using Helm's style overrides. However, the
platform is ready to go with batteries included.

Genestack is making use of some homegrown solutions, community operators, and OpenStack-Helm. Everything
in Genestack comes together to form cloud in a new and exciting way; all built with opensource solutions
to manage cloud infrastructure in the way you need it.
28 changes: 15 additions & 13 deletions docs/openstack-overview.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
# Building the cloud

From this point forward we're building our OpenStack cloud. The following commands will leverage `helm` as the package manager and `kustomize` as our configuration management backend.

## Deployment choices

When you're building the cloud, you have a couple of deployment choices, the most fundamental of which is `base` or `aio`.

* `base` creates a production-ready environment that ensures an HA system is deployed across the hardware available in your cloud.
* `aio` creates a minimal cloud environment which is suitable for test, which may have low resources.

The following examples all assume the use of a production environment, however, if you change `base` to `aio`, the deployment footprint will be changed for a given service.
![Genestack Logo](assets/images/genestack-logo.png){ align=right }

## The DNA of our services

![Genestack Logo Mono](assets/images/genestack-logo.png#only-dark){ align=left }
![Genestack Logo Mono](assets/images/genestack-logo-mono.png#only-light){ align=left }
The DNA of the OpenStack services has been built to scale, and be managed in a pseudo light-outs environment. We're aiming to empower operators to do more, simply and easily. The high level tenets we started our project from are simple and were written with intention. We're building Genestack not to show off how complex our platform is or how smart our engineers are, we're building systems to show how simple cloud deployment, operations, and maintenance can be.

### Core Tenets
## Core Tenets
* All services make use of our core infrastructure which is all managed by operators.
* Rollback and versioning is present and a normal feature of our operations.
* Backups, rollbacks, and package management all built into our applications delivery.
* Databases, users, and grants are all run against a cluster which is setup for OpenStack to use a single right, and read from many.
* The primary node is part of application service discovery and will be automatically promoted / demoted within the cluster as needed.
* Queues, permissions, vhosts, and users are all backed by a cluster with automatic failover. All of the queues deployed in the environment are done with Quorum queues, giving us a best of bread queing platform which gracefully recovers from faults while maintaining performance.
* Horizontal scaling groups have been applied to all of our services. This means we'll be able to auto scale API applications up and down based on the needs of the environment.

## Deployment choices

When you're building the cloud, you have a couple of deployment choices, the most fundamental of which is `base` or `aio`.

* `base` creates a production-ready environment that ensures an HA system is deployed across the hardware available in your cloud.
* `aio` creates a minimal cloud environment which is suitable for test, which may have low resources.

The following examples all assume the use of a production environment, however, if you change `base` to `aio`, the deployment footprint will be changed for a given service.

!!! info

From this point forward we're building our OpenStack cloud. The following commands will leverage `helm` as the package manager and `kustomize` as our configuration management backend.
12 changes: 12 additions & 0 deletions docs/overrides/stylesheets/adr.css
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,15 @@
.md-grid {
max-width: 95%;
}

.md-nav__item--active>.md-nav__link {
color: #c90000;
font-weight: bold;
}

[data-md-color-accent=red] {
--md-accent-fg-color: #eb0000;
--md-accent-fg-color--transparent: #ff19471a;
--md-accent-bg-color: #fff;
--md-accent-bg-color--light: #ffffffb3
}
Loading

0 comments on commit 582e967

Please sign in to comment.