Commit 62066fe
authored
docs: lineage-controller-webhook configuration guide (#513)
## Summary
- Adds
`content/en/docs/next/operations/configuration/lineage-controller-webhook.md`
(weight 40, sibling of the existing Components reference page).
- Documents the five user-facing knobs (`deployment.enabled`,
`deployment.replicas`, `nodeAffinity`, `tolerations`,
`localK8sAPIEndpoint.enabled`) and three worked Package CR overrides
covering the common non-default topologies: Deployment on a large
control plane, managed Kubernetes / Cozy-in-Cozy tenants, and dedicated
webhook nodes.
- Explains the chart's validation guard (`localK8sAPIEndpoint.enabled:
true` + `nodeAffinity: []` is rejected at render time) and adds a
`warning`-style callout for the case the guard cannot catch —
non-apiserver-bearing custom `nodeAffinity` with the local endpoint left
enabled, which silently produces crash-looping pods and tenant
CREATE/UPDATE outage with `failurePolicy: Fail`.
## Companion PR
Companion to cozystack/cozystack#2481, which exposes the underlying
knobs in the chart. The website page is targeted at `next/` since v1.3
docs aren't registered yet and these knobs ship in the next release.
## Test plan
- [ ] `make serve` — confirm the page renders, the cross-link to
`Components` resolves, and the alert callout displays correctly.
- [ ] Visually inspect the four code blocks; confirm Package CR
overrides are valid YAML.
- [ ] Verify the page appears in the `Configuration` sidebar between
`Components` (weight 30) and `White Labeling` (weight 50).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added a new Lineage Controller Webhook guide describing its behavior
and impact on resource labeling.
* Documents admission requirement (failurePolicy: Fail) and operational
implications.
* Provides deployment topology guidance (replicas, affinity,
anti-affinity, PDB, service distribution) and a Helm override example.
* Warns about a deprecated flag that can cause crashes/admission
outages.
* Includes verification commands and a dry-run validation flow.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 file changed
Lines changed: 110 additions & 0 deletions
Lines changed: 110 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
0 commit comments