Documentation

Where to start.

The conceptual documentation is published here: how the platform is built, what each module does, what is enforced where, and how a deployment is designed. Operational reference — API, CLI, installation and release notes — is listed at the foot of this page.

Talk to an architect Architecture overview
By what you are doingConcepts firstReference below
Organised by task
Not by product structure. Find the path that matches what you are actually doing.
Concepts are public
How it works, what is enforced and how a deployment is designed are all published.
Nothing is hand-waved
Where reference material does not exist yet, this page says so rather than implying it.
An architect on the call
What a document cannot answer, a conversation can. There is no ticket queue in front of it.
Find your path

Five things people arrive here to do.

Each path is a reading order, not a list. Start at the left and work across.

EvaluatingDeciding whether the platform fits before anyone commits.
Designing a deploymentDrawing the boundary, choosing the model and agreeing what is enforced.
Understanding a moduleWhat each module does, and what it depends on.
Operating itRunning the estate day to day once it is live.
Building on itIntegrating a technology, publishing a service or joining the federation.
Operational reference

Not published here yet.

Rather than link to pages that do not exist, this is what belongs here and what each one needs to contain.

For implementers
To be supplied
[Installation and prerequisites]
Supported hypervisors and versions, sizing, network and storage prerequisites, and the order of installation
To be supplied
[Configuration reference]
Every configurable parameter, its default, its effect and whether it can be changed after deployment
To be supplied
[Integration guides]
Per technology — CloudStack, OpenStack, VMware, Kubernetes, bare metal — what the platform expects and how it connects
For developers and operators
To be supplied
[API reference]
Authentication, endpoints, payloads, error codes and rate limits — generated from the API itself, not written by hand
To be supplied
[CLI and automation]
Commands, flags and worked examples for the operations teams automate first
To be supplied
[Release notes and versioning]
What changed, what breaks, what is deprecated, and the support window for each release

If you need any of this before it is published, ask — an operator running a deployment is not left waiting on a documentation release.

Getting help

There is no ticket queue in front of an architect.

Oasis Stack is deployed, not downloaded. Every operator running it has a direct route to the people who build it — which is also why the reference material above has not been the bottleneck it would be for a self-serve product.

Talk to us
Evaluating
Ask for an architect on the first call. Bring your estate and your regulator.
Deploying
Your deployment team works alongside ours through assess, design, build and operate.
Running
Amin watches the estate; escalation paths are agreed in the design phase, not improvised.
Open. Modular. Intelligent. Limitless.

Ask the question a document cannot answer.

A conversation with an architect about your estate, your constraints and what a deployment would actually involve.

Talk to an architect Architecture overview