Commit be69d4a
authored
docs(tenants): finish isolated-field removal and document opt-in policy labels (#481)
## What
Three-file update that closes out the `isolated` field removal in the v1
docs and documents the new opt-in network-policy label mechanism that
replaced it.
Changed files:
- `content/en/docs/v1/getting-started/create-tenant.md` — drop the
outdated Dashboard-tab bullet about the `isolated` checkbox, drop
`isolated: true` from the kubectl YAML example, and add an info callout
after the tabs block pointing at the upgrade notes and listing both
labels inline so readers of either tab see the same guidance.
- `content/en/docs/v1/operations/upgrades/_index.md` — expand the
pre-existing "Tenant `isolated` flag removed" stub with a target/label
table, a complete `Deployment` example that includes
`spec.selector.matchLabels`, and a short prose explanation that the
Cilium `allow-to-apiserver` policy matches via the `kube-apiserver`
entity rather than by hard-coded Service IP.
- `content/en/docs/v1/guides/tenants/_index.md` — add a new "Network
Isolation Between Tenants" section so operators landing directly on the
Tenant System guide learn about the mandatory isolation model and the
opt-in labels without having to read the upgrade notes.
- `content/en/docs/v1/operations/stretched/seaweedfs-multidc.md` —
remove the stale `isolated: true` from the two v1 Tenant YAML examples
and add a short note pointing at the upgrade guide so a reader comparing
with an older version of the doc understands why the field disappeared.
## Why
Two recurring pain points from the community chat:
1. Users still see `isolated` in examples (`create-tenant.md`,
`seaweedfs-multidc.md`) even though the field was deleted from the
`tenant` chart in Cozystack v1.0. Copy-pasting the old YAML leaves a
silently-ignored field in their manifests; in the worst case it breaks
validation on stricter admission setups.
2. With isolation now always on, the next question every time is *how do
I let my operator reach `kube-apiserver` from inside a tenant
namespace*. The answer is the two Cilium-policy-gated pod labels shipped
by the tenant chart (`policy.cozystack.io/allow-to-apiserver` and
`policy.cozystack.io/allow-to-etcd`), but they are documented nowhere
outside the chart source — users ended up discovering the labels by
reading `packages/apps/tenant/templates/networkpolicy.yaml` in the
upstream repo.
This PR documents both the removal and the replacement in the three
places a user is likely to land: the getting-started flow, the Tenant
System guide, and the v0→v1 upgrade notes.
## Verification
- `hugo` builds cleanly; all three affected pages render with the new
sections.
- Label names verified against
`packages/apps/tenant/templates/networkpolicy.yaml` in upstream
`cozystack/cozystack`:
- `policy.cozystack.io/allow-to-apiserver` → consumed by
`CiliumNetworkPolicy` `allow-to-apiserver` (egress to `kube-apiserver`
entity on port 6443).
- `policy.cozystack.io/allow-to-etcd` → consumed by
`CiliumClusterwideNetworkPolicy` `<tenant>-ingress-etcd`.
- The `kube-apiserver` Cilium entity claim is verified against Cilium's
[entity
documentation](https://docs.cilium.io/en/stable/security/policy/language/#entities-based).
- Hugo auto-generates `#tenant-isolated-flag-removed` from the heading
`Tenant \`isolated\` flag removed` (backticks are stripped, spaces
become hyphens); the three cross-file `{{% ref %}}` links resolve
correctly in the built site.
- `grep -rn "isolated:\s*\(true\|false\)" content/en/docs/v1/` after the
change only finds the intentional mention in `upgrades/_index.md`
describing the historical `isolated: false` behaviour — no stale YAML
examples remain.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated tenant configuration documentation to reflect removal of the
`isolated` field
* Added details on automatic Cilium-enforced network isolation for all
tenants
* Documented pod label requirements for accessing kube-apiserver and
etcd
* Added upgrade guidance for the `isolated` flag removal with migration
examples
<!-- end of auto-generated comment: release notes by coderabbit.ai -->4 files changed
Lines changed: 84 additions & 9 deletions
File tree
- content/en/docs/v1
- getting-started
- guides/tenants
- operations
- stretched
- upgrades
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | 74 | | |
78 | 75 | | |
79 | 76 | | |
| |||
106 | 103 | | |
107 | 104 | | |
108 | 105 | | |
109 | | - | |
110 | 106 | | |
111 | 107 | | |
112 | 108 | | |
| |||
124 | 120 | | |
125 | 121 | | |
126 | 122 | | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
127 | 135 | | |
128 | 136 | | |
129 | 137 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
58 | 78 | | |
59 | 79 | | |
60 | 80 | | |
| |||
Lines changed: 5 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
26 | 31 | | |
27 | 32 | | |
28 | 33 | | |
| |||
33 | 38 | | |
34 | 39 | | |
35 | 40 | | |
36 | | - | |
37 | 41 | | |
38 | 42 | | |
39 | 43 | | |
| |||
77 | 81 | | |
78 | 82 | | |
79 | 83 | | |
80 | | - | |
81 | 84 | | |
82 | 85 | | |
83 | 86 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
139 | | - | |
140 | | - | |
141 | | - | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
142 | 186 | | |
143 | 187 | | |
144 | 188 | | |
| |||
0 commit comments