Skip to content

docs: edge clusters in Architecture, Deployment Preparation, Install and Operations - #236

Merged
noctarius merged 3 commits into
mainfrom
docs/edge-clusters
Oct 11, 2026
Merged

noctarius merged 3 commits into
mainfrom
docs/edge-clusters

Conversation

@schmidt-scaled

@schmidt-scaled schmidt-scaled commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Edge clusters (one or two storage nodes at an edge site, managed by a central control plane on a hub through the operator's managed profile), documented inside the existing sections. There is no separate menu item and no separate requirements page. Each page covers only what is edge-specific and links the generic pages.

Section Page Placement
Architecture → Deployment Topologies docs/architecture/deployment-topologies/edge-clusters.md (new) after Disaggregated
Architecture → Concepts docs/architecture/concepts/linux-block-devices.md (changed) new subsection Partitions
Deployment Preparation docs/deployment-preparation/hardware-requirements.md (changed) "Edge clusters" boxes
Deployment Preparation docs/deployment-preparation/software-requirements.md (changed) "Edge clusters" box under Kubernetes Requirements
Kubernetes Storage → Install docs/kubernetes/installation/edge-clusters.md (new) after Connecting to an External Control Plane
Kubernetes Storage → Operations → Cluster docs/kubernetes/operations/cluster/edge-clusters.md (new) after Node Affinity

Diagram: docs/assets/images/architecture/edge-clusters.svg.

  • Linux block devices (general, applies to edge clusters): partitions are storage units; at most one partition per physical disk; equal sizes recommended; selected explicitly at storage node configuration by /dev/disk/by-partuuid/... or serial (sn configure --lblk --blk-names / --blk-serials), never automatically; a disk and its own partition cannot both be selected; the smallest partition is split into journal and data (--jm-percent, default 3); identity is the disk serial + -part- + PARTUUID; the operator discovery (enableLogicalBlockDevices) proposes whole disks only.
  • Hardware Requirements boxes: edge minimum 3 vCPUs and 3 GB RAM per storage node, devices and partitions, two independent links for two nodes, ports hub↔edge and WAN round-trip for the hold time.
  • Software Requirements box: hub (reachable Management API, controlplane.local.adminTokenSecretRef), credentials at the edge, control plane nodes for storage, two-node OpenShift (arbiter or fencing), node remediation.
  • Architecture, deployment and operations pages: as before (hub/edge model, HA for 1 vs 2 nodes, arbitration, managed-profile install, discovery and drafts for 1+0 and 1+1 with spec.cluster.twoNode, monitoring, failure tables, healing, upgrades, troubleshooting incl. GET /api/v2/clusters/{id}/arbitration).

No experimental or preview labels. The two-node parts carry a short note that they require two-node arbitration support in the control plane, the Simplyblock Operator, and the storage nodes (sbcli #1458/#1459, simplyblock-operator #712 and #716 on feature/two-node-ha, ultra #206, spdk #76).

Resolved: two-node 1+1 on two storage nodes with the twoNode declaration (operator #716); partitions as devices are documented.

TODO before merge (to confirm with engineering):

  • The rule "at most one partition per physical disk" is documented as a requirement. sbcli does not appear to enforce it at selection time; confirm whether a check is planned.
  • Whether adding a second storage node to an existing one-node 1+0 cluster is supported at all.
  • Hub exposure example uses kubectl expose service simplyblock-webappapi --type LoadBalancer; confirm the recommended production exposure (Route or Ingress with TLS).
  • Upgrade order "hub first": confirm the supported version skew between the hub control plane and edge operators.

Quality gate passes for all changed pages, and mkdocs build --strict reports only reference/api/index.md → openapi.json, which is pre-existing on main and generated in CI.

🤖 Generated with Claude Code

…ployment, operations)

One-node edge clusters managed from a central control plane through the
operator's managed profile; two-node edge clusters with hub arbitration
documented as a preview (sbcli #1458/#1459, operator #712, ultra #206,
spdk #76).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-edge-clusters

Architecture (deployment topologies), Deployment Preparation (edge
requirements), Kubernetes installation (deploying edge clusters) and
cluster operations each get an edge page that links the generic pages
instead of repeating them. No experimental or preview labels; two-node
content notes the arbitration support it needs. Two-node 1+1 on two nodes
via twoNode in the deployment document (operator #716).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@schmidt-scaled schmidt-scaled changed the title docs: Edge Clusters (architecture, deployment preparation, deployment, operations) docs: edge clusters in Architecture, Deployment Preparation, Install and Operations Oct 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-edge-clusters

…tware Requirements

- Linux Block Devices: partitions are storage units (at most one per disk,
  equal sizes recommended, explicit selection by by-partuuid or serial,
  journal split from the smallest partition, identity parent serial +
  -part- + PARTUUID); operator discovery proposes whole disks only.
- Edge Cluster Requirements page removed; edge deviations are boxes in
  Hardware Requirements (3 vCPU / 3 GB RAM minimum, devices, independent
  links for two nodes, hub/edge ports) and Software Requirements (hub,
  credentials, control plane nodes, two-node OpenShift, remediation).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-edge-clusters

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-edge-clusters

@noctarius
noctarius merged commit 5ee4396 into main Oct 11, 2026
7 checks passed
@noctarius
noctarius deleted the docs/edge-clusters branch October 11, 2026 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants