Skip to content

Commit af9faf9

Browse files
authored
Update the migration doc to cover static entries (#435)
Signed-off-by: Keegan Witt <[email protected]>
1 parent 2094b33 commit af9faf9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

migration/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Next deploy the new SPIRE Controller Manager.
5151
5252
## Delete the Kubernetes Workload Registrar CRD (CRD mode only)
5353

54-
The CRD mode requires an additonal step of removing the SpiffeId CRD. SPIRE Controller Manager uses a different CRD, so this one needs to be removed and resources cleaned up.
54+
The CRD mode requires an additional step of removing the SpiffeId CRD. SPIRE Controller Manager uses a different CRD, so this one needs to be removed and resources cleaned up.
5555

5656
1. Manually remove the finalizers with the below script. SPIRE Controller Manager will automatically clean up entries, so the finalizers can safely be removed.
5757

@@ -228,11 +228,11 @@ For each [ClusterSPIFFEID][1] you want to auto populate DNS names for, set the `
228228

229229
### Can SPIRE Controller Manager be deployed in a different Pod from SPIRE Server?
230230

231-
This is not supported with SPIRE Controller Manager, they must be in the same Pod. If you require them to be in seperate Pods, please open a [new issue](https://github.com/spiffe/spire-controller-manager/issues/new) with your use case.
231+
This is not supported with SPIRE Controller Manager, they must be in the same Pod. If you require them to be in separate Pods, please open a [new issue](https://github.com/spiffe/spire-controller-manager/issues/new) with your use case.
232232

233233
### Can I manually create entries like I could with the CRD Kubernetes Workload Registrar?
234234

235-
This is not currently supported, SPIRE Controller Manager will automatically garbage collect any manually created entries. If you need suppport for manually created entries, please update [#76](https://github.com/spiffe/spire-controller-manager/issues/76) with your use case.
235+
Yes, but it requires the use of a separate CRD ([ClusterStaticEntry][2]).
236236

237237
### How do i see SPIRE Controller Manager logs?
238238

@@ -245,7 +245,7 @@ $ kubectl logs spire-server-0 -n spire -c spire-controller-manager
245245
2022-12-13T00:41:21.844Z INFO webhook-manager Webhook configuration patched with CABundle
246246
```
247247

248-
### I'm using CRD mode Kubernetes Workload Registrar and it gets stuck deleting the SpiffeId CRD. What do I do?
248+
### I'm using CRD mode Kubernetes Workload Registrar, and it gets stuck deleting the SpiffeId CRD. What do I do?
249249

250250
This can happen if the Kubernetes Workload Registrar is deleted before all the SpiffeId custom resources are removed. To get around this, manually remove the finalizers with the below script and try deleting the CRD again.
251251

@@ -261,10 +261,11 @@ done
261261

262262
### Why can't Kubernetes Workload Registrar entries be reused with SPIRE Controller Manager?
263263

264-
SPIRE Controller Manager uses a different scheme for parenting SPIFFE IDs. Though it is technically possible to modify all the entries, its a lot easier to just allow SPIRE Controller Manager to automatically replace the entries.
264+
SPIRE Controller Manager uses a different scheme for parenting SPIFFE IDs. Though it is technically possible to modify all the entries, it's a lot easier to just allow SPIRE Controller Manager to automatically replace the entries.
265265

266-
### What happens if a Pod is deployed while I'm in the middle of this cutover?
266+
### What happens if a Pod is deployed while I'm in the middle of this cut-over?
267267

268268
SPIRE Controller Manager will reconcile the state of the system when it starts up. Any new Pods deployed after Kubernetes Workload Registrar is deleted and before SPIRE Controller Manager is up will have entries created when SPIRE Controller Manager is up.
269269

270270
[1]: docs/clusterspiffeid-crd.md
271+
[2]: docs/clusterstaticentry-crd.md

0 commit comments

Comments
 (0)