Skip to content

Commit 8352e23

Browse files
committed
docs: update ImagePolicy API documentation
Remove deprecated status field sections and update kubectl output example to match new printer columns format that displays Image, Tag, Ready, Status, and Age columns instead of the deprecated LatestImage column. Signed-off-by: cappyzawa <[email protected]>
1 parent ad10474 commit 8352e23

File tree

1 file changed

+4
-48
lines changed

1 file changed

+4
-48
lines changed

docs/spec/v1beta2/imagepolicies.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ kubectl apply -f imagepolicy.yaml
5252
2. Run `kubectl get imagepolicy` to see the ImagePolicy:
5353

5454
```console
55-
NAME LATESTIMAGE
56-
podinfo ghcr.io/stefanprodan/podinfo:5.1.4
55+
NAME IMAGE TAG READY STATUS AGE
56+
podinfo ghcr.io/stefanprodan/podinfo 5.1.4 True Latest image tag for 'ghcr.io/stefanprodan/podinfo' resolved to 5.1.4 5m
5757
```
5858

59-
3. Run `kubectl describe imagepolicy podinfo` to see the [Latest Image](#latest-image)
60-
and [Conditions](#conditions) in the ImagePolicy's Status:
59+
3. Run `kubectl describe imagepolicy podinfo` to see the [Latest Ref](#latest-ref)
60+
and [Conditions](#conditions) in the ImagePolicy's Status:
6161

6262
```console
6363
Status:
@@ -68,7 +68,6 @@ Status:
6868
Reason: Succeeded
6969
Status: True
7070
Type: Ready
71-
Latest Image: ghcr.io/stefanprodan/podinfo:5.1.4
7271
Latest Ref:
7372
Digest: sha256:2d9a00b3981628a533ff43352193b1838b0a4bf6b0033444286f563205e51a2c
7473
Image: ghcr.io/stefanprodan/podinfo
@@ -356,49 +355,6 @@ specific ImagePolicy, e.g.
356355

357356
## ImagePolicy Status
358357

359-
### Latest Image
360-
361-
**Warning:** This field is deprecated in favor of `.status.latestRef.image` and will be
362-
removed in a future release.
363-
364-
The ImagePolicy reports the latest select image from the ImageRepository tags in
365-
`.status.latestImage` for the resource.
366-
367-
Example:
368-
369-
```yaml
370-
---
371-
apiVersion: image.toolkit.fluxcd.io/v1beta2
372-
kind: ImagePolicy
373-
metadata:
374-
name: <policy-name>
375-
status:
376-
latestImage: ghcr.io/stefanprodan/podinfo:5.1.4
377-
```
378-
379-
### Observed Previous Image
380-
381-
**Warning:** This field is deprecated in favor of `.status.observedPreviousRef.image`
382-
and will be removed in a future release.
383-
384-
The ImagePolicy reports the previously observed latest image in
385-
`.status.observedPreviousImage` for the resource. This is used by the
386-
ImagePolicy to determine an upgrade path of an ImagePolicy update. This field
387-
is reset when the ImagePolicy fails due to some reason to be able to distinguish
388-
between a failure recovery and a genuine latest image upgrade.
389-
390-
Example:
391-
392-
```yaml
393-
apiVersion: image.toolkit.fluxcd.io/v1beta2
394-
kind: ImagePolicy
395-
metadata:
396-
name: <policy-name>
397-
status:
398-
latestImage: ghcr.io/stefanprodan/podinfo:6.2.1
399-
observedPreviousImage: ghcr.io/stefanprodan/podinfo:5.1.4
400-
```
401-
402358
### Latest Ref
403359

404360
The ImagePolicy reports the latest selected image from the ImageRepository tags in

0 commit comments

Comments
 (0)