-
Notifications
You must be signed in to change notification settings - Fork 6
Add high level concepts doc for Spaces #1094
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
cbuto
wants to merge
1
commit into
main
Choose a base branch
from
concepts
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| --- | ||
| title: Spaces Concepts | ||
| sidebar_position: 0 | ||
| description: High-level overview of Spaces architecture, system components, and | ||
| control plane components | ||
| --- | ||
|
|
||
| This document provides a high-level overview of Upbound Spaces: its | ||
| architecture, system components, and how control planes and their components | ||
| work. | ||
|
|
||
| ## Spaces architecture | ||
|
|
||
| The basic Spaces workflow follows the pattern below: | ||
|
|
||
| ![Spaces workflow][spaces-workflow] | ||
|
|
||
| ## Spaces system components | ||
|
|
||
| Spaces is built from several system-level components that work together: | ||
|
|
||
| ### Spaces-router | ||
|
|
||
| Entry point for all Spaces endpoints. The router handles the following: | ||
|
|
||
| - Spaces API | ||
| - Spaces Apollo | ||
| - Control plane API servers | ||
|
|
||
| It reconciles control planes and dynamically builds routes to each control plane | ||
| API server. | ||
|
|
||
| ### Spaces-controller | ||
|
|
||
| Reconciles Space-level resources, serves webhooks, and works with | ||
| mxp-controller to provision control planes. | ||
|
|
||
| ### Spaces-api | ||
|
|
||
| API for managing groups, control planes, shared secrets, and shared telemetry | ||
| objects. It is accessed only through Spaces-router. | ||
|
|
||
| ### Spaces-apollo | ||
|
|
||
| Hosts the Query API and connects to the Postgres database that is populated by | ||
| apollo-syncer pods in each control plane. | ||
|
|
||
| ## Control planes and components | ||
|
|
||
| Each control plane runs in an isolated environment with a consistent set of components. | ||
|
|
||
| ### Namespaces | ||
|
|
||
| Each control plane gets a namespace with the pattern: `mxp-uuid-system`. | ||
|
|
||
| Namespaces are labeled with: | ||
|
|
||
| - `internal.spaces.upbound.io/controlplane-name` | ||
| - `internal.spaces.upbound.io/controlplane-namespace` | ||
|
|
||
| ### Finding which cluster a control plane is in | ||
|
|
||
| ```bash | ||
| # Search across all namespaces for a specific control plane | ||
| kubectl get namespaces -l internal.spaces.upbound.io/controlplane-name=<ctp-name> | ||
|
|
||
| # Get more details about the namespace | ||
| kubectl describe namespace <namespace-name> | ||
|
|
||
| # See what's running in that control plane's namespace | ||
| kubectl get pods -n <namespace-name> | ||
| ``` | ||
|
|
||
| ### Control plane runtime | ||
|
|
||
| Each control plane runs inside the Space cluster. Its main components are: | ||
|
|
||
| - **API server** — Often run in a single pod. | ||
| - **Etcd** — Data store for the control plane API server. It holds all user | ||
| Crossplane resources. | ||
| - **CoreDNS** — Handles DNS resolution inside the control plane. | ||
|
|
||
| ### mxp-controller | ||
|
|
||
| Controller and webhook that runs per control plane. It: | ||
|
|
||
| - Handles control plane provisioning (installs Crossplane, kube-state-metrics, | ||
| and related components) | ||
| - Manages resources inside the control plane API server (such as Crossplane) | ||
| - Serves webhooks | ||
|
|
||
| ### kube-state-metrics | ||
|
|
||
| Captures metrics around Managed Resource (MR) usage for billing. It counts | ||
| resource usage so usage can be metered and billed appropriately. | ||
|
|
||
| ### vector | ||
|
|
||
| Used with kube-state-metrics to send MR usage data to bucket storage for | ||
| billing. | ||
|
|
||
| ### apollo-syncer | ||
|
|
||
| Syncs control plane state into Postgres, which backs the Query API. It | ||
| bridges Kubernetes storage (etcd) and the query system (Query API / | ||
| Postgres). | ||
|
|
||
| ### External Secrets Operator (Spaces) | ||
|
|
||
| Uses the upstream External Secrets Operator to power the SharedSecrets | ||
| feature in Spaces. | ||
|
|
||
| [spaces-workflow]: /img/up-basic-flow.png | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll need to update this