Skip to content

Commit 96801f1

Browse files
committed
docs(development): tighten extra examples per review
- Drop the etcd example so the section stays valid regardless of the outcome of the per-cluster etcd proposal - Drop external-dns from the extra examples: it behaves like a regular app and its placement is tracked in a separate issue - Note that extra modules appear under Administration -> Modules - Remove the non-verbatim seaweedfs chart description quote Assisted-By: Claude Signed-off-by: Andrei Kvapil <[email protected]>
1 parent a01e62f commit 96801f1

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎content/en/docs/v1.5/development.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -243,28 +243,29 @@ Other examples of this pattern: `extra/ingress`, `extra/seaweedfs`, `extra/monit
243243
`extra` packages are **enabler modules**, not first-class services. A user never orders
244244
them as a final entity; instead they are switched on as **tenant options**, and once
245245
enabled they provide capabilities that the `apps` services build on — working under the
246-
hood. For that reason they are *not* shown in the application catalog and can only be
247-
installed as part of a tenant. Because an `extra` module is enabled at the tenant level,
246+
hood. For that reason they are *not* shown in the application catalog (they appear
247+
under **Administration → Modules** instead) and can only be installed as part of a
248+
tenant. Because an `extra` module is enabled at the tenant level,
248249
it is shared by the child (bottom) tenants nested in that tenant's namespace —
249250
provisioned once and reused beneath them (for example, a child tenant without its own
250251
`monitoring` sends its metrics to the parent tenant's monitoring stack instead of
251252
running a second copy).
252253
253254
The clearest example is object storage:
254255
255-
- `extra/seaweedfs` ("Managed SeaweedFS Service") deploys a SeaweedFS cluster and
256+
- `extra/seaweedfs` deploys a SeaweedFS cluster and
256257
registers `BucketClass` resources for the tenant.
257258
- `apps/bucket` ("S3 compatible storage") is what the user actually orders — it creates
258259
a `BucketClaim` against one of those `BucketClass`es.
259260
260261
So a tenant administrator *enables the SeaweedFS module once*, and from then on users
261262
can order S3 buckets as a first-class service. The user consumes a bucket; they never
262263
see, order, or manage SeaweedFS itself — it is an implementation detail of "S3 bucket".
263-
The same relationship holds for `extra/etcd` ("Storage for Kubernetes clusters"), which
264-
provides the datastore for `apps/kubernetes` managed clusters. Other `extra` modules
264+
Other `extra` modules
265265
supply tenant-wide infrastructure rather than orderable services: `extra/ingress`
266-
(NGINX Ingress Controller), `extra/gateway` (per-tenant Gateway API backed by Cilium),
267-
`extra/external-dns`, and `extra/monitoring`.
266+
(NGINX Ingress Controller), `extra/monitoring` (the tenant's monitoring stack), and
267+
`extra/gateway` (per-tenant Gateway API backed by Cilium; toggle-only — it has no
268+
dashboard presence and is enabled automatically for tenants with a derived apex domain).
268269
269270
Read more about [Tenant System](/docs/guides/concepts/#tenant-system) on the Core Concepts page.
270271

0 commit comments

Comments
 (0)