Skip to content

Commit f29b3fb

Browse files
authored
Merge pull request #42514 from sftim/20230812_tweak_pv_phase_docs
Tweak docs about PersistentVolume phase
2 parents 6abb091 + 05e8f72 commit f29b3fb

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

content/en/docs/concepts/storage/persistent-volumes.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -748,27 +748,34 @@ API reference has more details on this field.
748748

749749
### Phase
750750

751-
A volume will be in one of the following phases:
751+
A PersistentVolume will be in one of the following phases:
752752

753-
* Available -- a free resource that is not yet bound to a claim
754-
* Bound -- the volume is bound to a claim
755-
* Released -- the claim has been deleted, but the resource is not yet reclaimed by the cluster
756-
* Failed -- the volume has failed its automatic reclamation
753+
`Available`
754+
: a free resource that is not yet bound to a claim
757755

758-
The CLI will show the name of the PVC bound to the PV.
756+
`Bound`
757+
: the volume is bound to a claim
758+
759+
`Released`
760+
: the claim has been deleted, but the associated storage resource is not yet reclaimed by the cluster
761+
762+
`Failed`
763+
: the volume has failed its (automated) reclamation
764+
765+
You can see the name of the PVC bound to the PV using `kubectl describe persistentvolume <name>`.
759766

760767
#### Phase transition timestamp
761768

762769
{{< feature-state for_k8s_version="v1.28" state="alpha" >}}
763770

764-
Persistent volume status contains `lastPhaseTransitionTime` field which holds
765-
a timestamp of when the volume last transitioned its phase. For newly created
766-
volumes the phase is set to "Pending" and `lastPhaseTransitionTime` is set to
767-
current time.
771+
The `.status` field for a PersistentVolume can include an alpha `lastPhaseTransitionTime` field. This field records
772+
the timestamp of when the volume last transitioned its phase. For newly created
773+
volumes the phase is set to `Pending` and `lastPhaseTransitionTime` is set to
774+
the current time.
768775

769776
{{< note >}}
770777
You need to enable the `PersistentVolumeLastPhaseTransitionTime` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
771-
to see `lastPhaseTransitionTime` field.
778+
to use or see the `lastPhaseTransitionTime` field.
772779
{{< /note >}}
773780

774781
## PersistentVolumeClaims

0 commit comments

Comments
 (0)