Skip to content

Commit 3cd8d1a

Browse files
erikgbtenstad
andauthored
Update docs after code review
Co-authored-by: Amund Tenstad <[email protected]> Signed-off-by: Erik Godding Boye <[email protected]>
1 parent 90c3721 commit 3cd8d1a

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

api/v1/kustomization_types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ type KustomizationSpec struct {
101101

102102
// DeletionPolicy can be used to control garbage collection when this
103103
// Kustomization is deleted. Valid values are ('MirrorPrune', 'Delete',
104-
// 'Orphan'). 'MirrorPrune' mirrors the Prune field (false = 'Ophan',
105-
// true = 'Delete'). Defaults to 'MirrorPrune'.
104+
// 'Orphan'). 'MirrorPrune' mirrors the Prune field (orphan if false,
105+
// delete if true). Defaults to 'MirrorPrune'.
106106
// +kubebuilder:validation:Enum=MirrorPrune;Delete;Orphan
107107
// +optional
108108
DeletionPolicy string `json:"deletionPolicy,omitempty"`

docs/spec/v1/kustomizations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,16 +171,16 @@ to garbage collect, see [`.status.inventory`](#inventory).
171171

172172
### Deletion policy
173173

174-
`.spec.deletionPolicy` is an optional field that is allowing control over
174+
`.spec.deletionPolicy` is an optional field that allows control over
175175
garbage collection when a Kustomization object is deleted. The default behavior
176-
is to mirror the value of [`.spec.prune`](#prune).
176+
is to mirror the configuration of [`.spec.prune`](#prune).
177177

178178
Valid values:
179179

180180
- `MirrorPrune` (default) - The managed resources will be deleted if `prune` is
181181
`true` and orphaned if `false`.
182182
- `Delete` - Ensure the managed resources are deleted before the Kustomization
183-
is finalized.
183+
is deleted.
184184
- `Orphan` - Leave the managed resources when the Kustomization is deleted.
185185

186186
For special cases when the managed resources are removed by other means (e.g.

0 commit comments

Comments
 (0)