Merge pull request #22733 from nalind/system-check

Add `podman system check`
This commit is contained in:
openshift-merge-bot[bot]
2024-06-13 10:35:56 +00:00
committed by GitHub
36 changed files with 2378 additions and 4 deletions

View File

@ -0,0 +1,59 @@
% podman-system-check 1
## NAME
podman\-system\-check - Perform consistency checks on image and container storage
## SYNOPSIS
**podman system check** [*options*]
## DESCRIPTION
Perform consistency checks on image and container storage, reporting images and
containers which have identified issues.
## OPTIONS
#### **--force**, **-f**
When attempting to remove damaged images, also remove containers which depend
on those images. By default, damaged images which are being used by containers
are left alone.
Containers which depend on damaged images do so regardless of which engine
created them, but because podman only "knows" how to shut down containers that
it started, the effect on still-running containers which were started by other
engines is difficult to predict.
#### **--max**, **-m**=*duration*
When considering layers which are not used by any images or containers, assume
that any layers which are more than *duration* old are the results of canceled
attempts to pull images, and should be treated as though they are damaged.
#### **--quick**, **-q**
Skip checks which are known to be time-consuming. This will prevent some types
of errors from being detected.
#### **--repair**, **-r**
Remove any images which are determined to have been damaged in some way, unless
they are in use by containers. Use **--force** to remove containers which
depend on damaged images, and those damaged images, as well.
## EXAMPLE
A reasonably quick check:
```
podman system check --quick --repair --force
```
A more thorough check:
```
podman system check --repair --max=1h --force
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-system(1)](podman-system.1.md)**
## HISTORY
April 2024

View File

@ -13,6 +13,7 @@ The system command allows management of the podman systems
| Command | Man Page | Description |
| ------- | ------------------------------------------------------------ | ------------------------------------------------------------------------ |
| check | [podman-system-check(1)](podman-system-check.1.md) | Perform consistency checks on image and container storage.
| connection | [podman-system-connection(1)](podman-system-connection.1.md) | Manage the destination(s) for Podman service(s) |
| df | [podman-system-df(1)](podman-system-df.1.md) | Show podman disk usage. |
| events | [podman-events(1)](podman-events.1.md) | Monitor Podman events |