Appearance
Tutorials
A tutorial is a lesson. It takes you by the hand through a series of steps to build something, so that you learn by doing. It is the right starting point when plexsphere is new to you and you do not yet know enough to ask a precise question.
Tutorials in this section make three promises:
- You will succeed. Every command is exact and every output is shown. If your screen matches the page, you are on track; if it does not, the page tells you so.
- You do not have to decide anything. A tutorial makes the choices for you. Options, trade-offs, and the reasoning behind them belong to the explanation quadrant — not here.
- You will end with a working mental model, not just a running process.
The learning path
Follow these in order. Each lesson assumes you finished the one before it.
- Set up your local plexsphere — the shortest path from
git cloneto a running plexsphere on a local kind cluster, with the CLI authenticated against the seeded IdP and driving the/v1API. Start here. - Set up the full local stack — the same cluster plus every production dependency, the golden-flow end-to-end run, and the troubleshooting matrix. Take this once lesson 1 works.
- Explore your first Domain — with the stack running, walk the seeded tenant end-to-end through the CLI against the
/v1API and learn how a Domain, its Projects, its identities, and its audit log fit together.
When to read this section
- plexsphere is new to you and you want a guided first hour.
- You are onboarding to the repository and want a known-good baseline before you start changing things.
When you instead have a specific job to do — invite an operator, rotate the signing key, register a node — you have outgrown the tutorials. Go to the how-to guides. When you need the exact shape of a surface, go to the reference. When you want to understand why the system is built this way, go to the architecture and bounded-context explanations.