Repository navigation
Commit 407ab9c
txmazing
feat(openbao): optional static-key auto-unseal and apiserver egress label
Two problems with the built-in OpenBAO app:
- #2787: the app has no auto-unseal. Every pod restart (node drain, image
bump, OOM) leaves the instance sealed until an operator types the Shamir
key shares into each replica.
- #2793: in HA mode the pods hang on startup because
service_registration "kubernetes" cannot reach kube-apiserver.
Cozystack's CiliumNetworkPolicy allow-to-apiserver only admits egress
from pods labelled policy.cozystack.io/allow-to-apiserver=true, and the
wrapper never set that label, so every tenant had to hand-craft a
network policy. Related: #2059, #2483.
Design:
- A new `seal` value with `type: shamir` (default) or `type: static`.
With `static` the chart appends OpenBAO's `seal "static"` stanza to the
server config and mounts the operator-owned Secret named in
`seal.secretName` through the upstream chart's `server.extraVolumes`
(mounted at /openbao/userconfig/<secret>/). The chart never generates,
stores or rotates the key; the operator creates the Secret (32 random
bytes, base64 text under key `key`) and names it. `previousSecretName`
/ `previousKeyId` allow the n-1 rotation the static seal supports.
The stanza is rendered in both the Raft (HA) and the standalone
configuration, since the static seal works with either storage.
- The template fails fast when `static` is chosen without `secretName`
or `keyId`, or when `previousSecretName` is set without
`previousKeyId`, so a misconfiguration surfaces at reconcile time
rather than as a sealed pod.
- `server.extraLabels` now always carries
policy.cozystack.io/allow-to-apiserver: "true". The upstream chart
renders it onto the StatefulSet pods, which is exactly what the
platform policy keys on.
The default stays `shamir`, so existing instances render the same HCL
as before apart from the new pod label. README, values.schema.json,
api/apps/v1alpha1/openbao/types.go and the openbao-rd
ApplicationDefinition are regenerated with `make generate`; a
helm-unittest suite covers the label, both seal renderings, rotation
and the three failure cases.
Upstream docs: https://cozystack.io/docs/v1.6/applications/openbao/
(parameter reference only; says nothing about unsealing or the
apiserver egress label)
Upstream docs: https://openbao.org/docs/configuration/seal/static/
(current_key_id/current_key/previous_key_id/previous_key, 32-byte key,
file:// prefix, n-1 rotation)
Upstream docs: https://openbao.org/docs/concepts/seal/#seal-migration
(switching an existing instance between Shamir and static needs
`unseal -migrate` and downtime; the chart does not do this)
Upstream docs: https://github.com/openbao/openbao-helm
(charts/openbao values server.extraVolumes and server.extraLabels;
mount path /openbao/userconfig/<name> in templates/_helpers.tpl)
Signed-off-by: txmazing <[email protected]>
Assisted-by: LLM1 parent 9e577a5 commit 407ab9c
7 files changed
Lines changed: 310 additions & 2 deletions
File tree
- api/apps/v1alpha1/openbao
- packages
- apps/openbao
- templates
- tests
- system/openbao-rd/cozyrds
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 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 | + | |
8 | 36 | | |
9 | 37 | | |
10 | 38 | | |
| |||
27 | 55 | | |
28 | 56 | | |
29 | 57 | | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
1 | 12 | | |
2 | 13 | | |
3 | 14 | | |
| |||
27 | 38 | | |
28 | 39 | | |
29 | 40 | | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
30 | 47 | | |
31 | 48 | | |
32 | 49 | | |
| |||
42 | 59 | | |
43 | 60 | | |
44 | 61 | | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
45 | 72 | | |
46 | 73 | | |
47 | 74 | | |
| |||
68 | 95 | | |
69 | 96 | | |
70 | 97 | | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
71 | 109 | | |
72 | 110 | | |
73 | 111 | | |
| |||
85 | 123 | | |
86 | 124 | | |
87 | 125 | | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
88 | 137 | | |
89 | 138 | | |
90 | 139 | | |
| |||
| 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 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 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 | + | |
134 | 175 | | |
135 | 176 | | |
136 | 177 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
0 commit comments