mirror of
https://github.com/mag37/dockcheck.git
synced 2026-02-14 23:38:15 +01:00
feat: sync with dockcheck v0.7.1 upstream features
- Added advanced notification system with notify_v2.sh wrapper - Implemented async processing with xargs support (-x option) - Added comprehensive configuration system (default.config) - Enhanced command line options: -F, -I, -M, -u, -x - Added snooze functionality for notifications - Improved dependency management with auto-downloads - Added helper functions: releasenotes(), list_options(), progress_bar() - Updated README to match dockcheck style and documentation - Fixed label references to use sudo-kraken.podcheck namespace - Enhanced logo styling with rounded corners and cropped display - Maintained podman-specific functionality for compose and systemd units Brings podcheck to feature parity with dockcheck v0.7.1 while preserving podman ecosystem compatibility including Quadlet support.
This commit is contained in:
sudo-kraken
parent
fee18898b5
commit
6f1d63b47c
2 changed files with 197 additions and 100 deletions
277
README.md
277
README.md
|
|
@ -1,19 +1,39 @@
|
|||
<p align="center">
|
||||
<img src="extras/podcheck.png" width="160" title="Podcheck">
|
||||
<img src="extras/podcheck.png" width="250" title="podcheck" style="background-color: white; padding: 1px; border-radius: 15px; margin-bottom: 10px; object-fit: cover; object-position: center top; height: 210px;">
|
||||
</p>
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/bash-4.3-green?style=flat-square&logo=gnubash" alt="bash">
|
||||
<a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLv3-red?style=flat-square" alt="GPLv3"></a>
|
||||
<img src="https://img.shields.io/github/v/tag/sudo-kraken/podcheck?style=flat-square&label=release" alt="release">
|
||||
<a href="https://www.buymeacoffee.com/jharrison94"><img src="https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee" alt="Buy Me A Coffee">
|
||||
<br>
|
||||
<a href="https://www.buymeacoffee.com/jharrison94"><img src="https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee" alt="Buy Me A Coffee"></a>
|
||||
</p>
|
||||
|
||||
<h3 align="center">CLI tool to automate Podman image updates. <br>Selective updates, optional notifications, and image pruning when done.</h3>
|
||||
<h2 align="center">Now with simple notification integrations!</h2>
|
||||
<h4 align="center">Features include excluding specific containers, custom container labels, auto-prune when done, and more.</h4>
|
||||
<h2 align="center">CLI tool to automate podman image updates or notifying when updates are available.</h2>
|
||||
<h3 align="center">selective updates, exclude containers, custom labels, notification plugins, prune when done etc.</h3>
|
||||
|
||||
<h4 align="center">For Docker - see the original <a href="https://github.com/mag37/dockcheck">mag37/dockcheck</a>!</h4>
|
||||
|
||||
___
|
||||
## :bell: Changelog
|
||||
## Changelog
|
||||
|
||||
- **v0.7.1**:
|
||||
- Added support for multiple notifications using the same template
|
||||
- Added support for notification output format
|
||||
- Added support for file output
|
||||
- Added optional configuration variables per channel to (replace `<channel>` with any channel name):
|
||||
- `<channel>_TEMPLATE` : Specify a template
|
||||
- `<channel>_SKIPSNOOZE` : Skip snooze
|
||||
- `<channel>_CONTAINERSONLY` : Only notify for podman container related updates
|
||||
- `<channel>_ALLOWEMPTY` : Always send notifications, even when empty
|
||||
- `<channel>_OUTPUT` : Define output format
|
||||
- Added advanced configuration system with `default.config`
|
||||
- Added new command line options: `-F`, `-I`, `-M`, `-u`, `-x`
|
||||
- Added async processing support with xargs
|
||||
- Enhanced notification system with `notify_v2.sh` wrapper
|
||||
- Added snooze functionality to prevent duplicate notifications
|
||||
- Improved dependency management with automatic downloads
|
||||
- Added helper functions: `releasenotes()`, `list_options()`, `progress_bar()`
|
||||
- **v0.6.0**:
|
||||
- **Grafana & Prometheus Integration:**
|
||||
- Added a detailed Prometheus metrics exporter that now reports not only the number of containers with updates, no-updates, and errors, but also the total number of containers checked, the duration of the update check, and the epoch timestamp of the last check.
|
||||
|
|
@ -26,42 +46,35 @@ ___
|
|||
- **Miscellaneous Improvements:**
|
||||
- Enhanced dependency installer to support both package manager and static binary installations for `jq` and `regctl`.
|
||||
- General code refactoring across the project for better readability and maintainability.
|
||||
- **v0.5.7**: Rewrite of dependency downloads, now jq can be installed with package manager or static binary.
|
||||
- **v0.5.6**: Directly checking for systemd units matching container names.
|
||||
- Improved Quadlet detection by checking for systemd units named after the container.
|
||||
- Ensures better compatibility with Quadlet-managed containers.
|
||||
- **v0.5.5**: Switched to podman compose command.
|
||||
- Adjusted the script to use podman compose instead of podman-compose.
|
||||
- Removed unnecessary messages.
|
||||
- **v0.5.4**: Improved Quadlet detection by matching container IDs with systemd units.
|
||||
- The script now searches systemd unit files for references to the container ID.
|
||||
- Provides reliable detection of Quadlet-managed containers.
|
||||
- **v0.5.0**: Initial release of Podcheck, inspired by [Dockcheck](https://github.com/mag37/dockcheck).
|
||||
- Supports updating containers managed by Podman Compose and Quadlet.
|
||||
- Includes options for automatic updates, notifications, and more.
|
||||
___
|
||||
|
||||
## :mag_right: `podcheck.sh`
|
||||
## `podcheck.sh`
|
||||
```
|
||||
$ ./podcheck.sh -h
|
||||
Syntax: podcheck.sh [OPTION] [part of name to filter]
|
||||
Example: podcheck.sh -y -d 10 -e nextcloud,heimdall
|
||||
Syntax: podcheck.sh [OPTION] [comma separated names to include]
|
||||
Example: podcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall
|
||||
|
||||
Options:
|
||||
-a|y Automatic updates, without interaction.
|
||||
-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age.
|
||||
-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory.
|
||||
-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
|
||||
-e X Exclude containers, separated by comma.
|
||||
-f Force pod restart after update.
|
||||
-f Force stop+start stack after update. Caution: restarts once for every updated container within stack.
|
||||
-F Only compose up the specific container, not the whole compose stack (useful for master-compose structure).
|
||||
-h Print this Help.
|
||||
-i Inform - send a preconfigured notification.
|
||||
-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list).
|
||||
-l Only update if label is set. See readme.
|
||||
-m Monochrome mode, no printf color codes.
|
||||
-n No updates; only checking availability.
|
||||
-p Auto-prune dangling images after update.
|
||||
-r Allow updating images for podman run; won't update the container.
|
||||
-s Include stopped containers in the check.
|
||||
-t Set a timeout (in seconds) per container for registry checkups, 10 is default.
|
||||
-m Monochrome mode, no printf colour codes and hides progress bar.
|
||||
-M Prints custom releasenote urls as markdown (requires template support).
|
||||
-n No updates, only checking availability.
|
||||
-p Auto-Prune dangling images after update.
|
||||
-r Allow checking for updates/updating images for podman run containers. Won't update the container.
|
||||
-s Include stopped containers in the check. (Logic: podman ps -a).
|
||||
-t N Set a timeout (in seconds) per container for registry checkups, 10 is default.
|
||||
-u Allow automatic self updates - caution as this will pull new code and autorun it.
|
||||
-v Prints current version.
|
||||
-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested.
|
||||
```
|
||||
|
||||
### Basic example:
|
||||
|
|
@ -84,43 +97,97 @@ After the updates are complete, you'll be prompted if you'd like to prune dangli
|
|||
|
||||
___
|
||||
|
||||
## :nut_and_bolt: Dependencies
|
||||
- Podman: Ensure you have Podman installed and properly configured.
|
||||
- Podman Compose: For containers managed with podman compose, make sure it's installed.
|
||||
- Note: podman compose is included in recent versions of Podman.
|
||||
- Quadlet: If you're using systemd units to manage your containers, ensure they are correctly set up.
|
||||
## Dependencies
|
||||
- Running podman (duh) and compose, either standalone or plugin.
|
||||
- Bash shell or compatible shell of at least v4.3
|
||||
- POSIX `xargs`, usually default but can be installed with the `findutils` package - to enable async.
|
||||
- [jq](https://github.com/jqlang/jq)
|
||||
- User will be prompted to install with package manager or download static binary.
|
||||
- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
|
||||
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
|
||||
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
|
||||
- regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
|
||||
- [jq](https://github.com/jqlang/jq): Used for parsing JSON output from podman inspect. User will be prompted to install.
|
||||
- timeout: Optional but recommended for setting timeouts on registry checks.
|
||||
|
||||
## :tent: Install Instructions
|
||||
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
|
||||
## Install Instructions
|
||||
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
|
||||
For OSX/macOS preferably use `/usr/local/bin`.
|
||||
```sh
|
||||
# Using curl:
|
||||
# basic example with curl:
|
||||
curl -L https://raw.githubusercontent.com/sudo-kraken/podcheck/main/podcheck.sh -o ~/.local/bin/podcheck.sh
|
||||
chmod +x ~/.local/bin/podcheck.sh
|
||||
|
||||
# Or using wget:
|
||||
# or oneliner with wget:
|
||||
wget -O ~/.local/bin/podcheck.sh "https://raw.githubusercontent.com/sudo-kraken/podcheck/main/podcheck.sh" && chmod +x ~/.local/bin/podcheck.sh
|
||||
|
||||
# OSX or macOS version with curl:
|
||||
curl -L https://raw.githubusercontent.com/sudo-kraken/podcheck/main/podcheck.sh -o /usr/local/bin/podcheck.sh && chmod +x /usr/local/bin/podcheck.sh
|
||||
```
|
||||
Then call the script anywhere with `podcheck.sh`.
|
||||
Add your preferred notify.sh template to the same directory—this will not be touched by the script's self-update function.
|
||||
Then call the script anywhere with just `podcheck.sh`.
|
||||
Add preferred `notify.sh`-template to the same directory - this will not be touched by the scripts self-update function.
|
||||
|
||||
## :loudspeaker: Notifications
|
||||
Trigger with the `-i` flag.
|
||||
Run it scheduled with `-ni` to only get notified when there's updates available!
|
||||
## Configuration
|
||||
To modify settings and have them persist through updates - copy the `default.config` to `podcheck.config` alongside the script or in `~/.config/`.
|
||||
|
||||
Use a `notify_X.sh` template file from the **notify_templates** directory, copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore)
|
||||
**Current templates:**
|
||||
Alternatively create an alias where specific flags and values are set.
|
||||
Example `alias pc=podcheck.sh -p -x 10 -t 3`.
|
||||
|
||||
## Notifications
|
||||
Triggered with the `-i` flag. Will send a list of containers with updates available and a notification when `podcheck.sh` itself has an update.
|
||||
`notify_templates/notify_v2.sh` is the default notification wrapper, if `notify.sh` is present and configured, it will override.
|
||||
|
||||
Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications:
|
||||
`0 10 * * * /home/user123/.local/bin/podcheck.sh -nix 10 -e excluded_container1`
|
||||
|
||||
#### Installation and configuration:
|
||||
Set up a directory structure as below.
|
||||
You only need the `notify_templates/notify_v2.sh` file and any notification templates you wish to enable, but there is no harm in having all of them present.
|
||||
```
|
||||
.
|
||||
├── notify_templates/
|
||||
│ ├── notify_DSM.sh
|
||||
│ ├── notify_apprise.sh
|
||||
│ ├── notify_discord.sh
|
||||
│ ├── notify_generic.sh
|
||||
│ ├── notify_gotify.sh
|
||||
│ ├── notify_matrix.sh
|
||||
│ ├── notify_ntfy-sh.sh
|
||||
│ ├── notify_pushbullet.sh
|
||||
│ ├── notify_pushover.sh
|
||||
│ ├── notify_smtp.sh
|
||||
│ ├── notify_telegram.sh
|
||||
│ └── notify_v2.sh
|
||||
├── podcheck.config
|
||||
├── podcheck.sh
|
||||
└── urls.list # optional
|
||||
```
|
||||
- Uncomment and set the `NOTIFY_CHANNELS=""` environment variable in `podcheck.config` to a space separated string of your desired notification channels to enable.
|
||||
- Uncomment and set the environment variables related to the enabled notification channels. Eg. `GOTIFY_DOMAIN=""` + `GOTIFY_TOKEN=""`.
|
||||
|
||||
It's recommended to only do configuration with variables within `podcheck.config` and not modify `notify_templates/notify_X.sh` directly. If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `podcheck.sh` (where they're also ignored by git).
|
||||
|
||||
Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `podcheck.sh` root directory.
|
||||
|
||||
#### Snooze feature:
|
||||
Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame.
|
||||
|
||||
**Example:** *Podcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.*
|
||||
**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration.
|
||||
|
||||
**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour.
|
||||
|
||||
To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `podcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts.
|
||||
Snooze is split into three categories; container updates, `podcheck.sh` self updates and notification template updates.
|
||||
|
||||
If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items.
|
||||
|
||||
The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues.
|
||||
|
||||
#### Current notify templates:
|
||||
- Synology [DSM](https://www.synology.com/en-global/dsm)
|
||||
- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
|
||||
- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
|
||||
- both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
|
||||
- Read the [QuickStart](extras/apprise_quickstart.md)
|
||||
- [ntfy.sh](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
||||
- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
||||
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
|
||||
- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
|
||||
- [Telegram](https://telegram.org/) - Telegram chat API.
|
||||
|
|
@ -128,45 +195,76 @@ Use a `notify_X.sh` template file from the **notify_templates** directory, copy
|
|||
- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
|
||||
- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks.
|
||||
|
||||
Further additions are welcome - suggestions or PR!
|
||||
<sub><sup>Initiated and first contributed by [mag37](https://github.com/mag37) as [eck](https://github.com/mag37/eck).</sup></sub>
|
||||
Further additions are welcome - suggestions or PRs!
|
||||
<sub><sup>Initiated and first contributed by [mag37](https://github.com/mag37).</sup></sub>
|
||||
|
||||
### :date: Release notes addon to Notifications
|
||||
There's a function to use a lookup file to add release note URLs to the notification message.
|
||||
#### Notification channel configuration:
|
||||
All required environment variables for each notification channel are provided in the default.config file as comments and must be uncommented and modified for your requirements.
|
||||
For advanced users, additional functionality is available via custom configurations and environment variables.
|
||||
Use cases - all configured in `podcheck.config`:
|
||||
(replace `<channel>` with the upper case name of the of the channel as listed in `NOTIFY_CHANNELS` variable, eg `TELEGRAM_SKIPSNOOZE`)
|
||||
- To bypass the snooze feature, even when enabled, add the variable `<channel>_SKIPSNOOZE` and set it to `true`.
|
||||
- To configure the channel to only send container update notifications, add the variable `<channel>_CONTAINERSONLY` and set it to `true`.
|
||||
- To send notifications even when there are no updates available, add the variable `<channel>_ALLOWEMPTY` and set it to `true`.
|
||||
- To use another notification output format, add the variable `<channel>_OUTPUT` and set it to `csv`, `json`, or `text`. If unset or set to an invalid value, defaults to `text`.
|
||||
- To send multiple notifications using the same notification template:
|
||||
- Strings in the `NOTIFY_CHANNELS` list are now treated as unique names and do not necessarily refer to the notification template that will be called, though they do by default.
|
||||
- Add another notification channel to `NOTIFY_CHANNELS` in `podcheck.config`. The name can contain upper and lower case letters, numbers and underscores, but can't start with a number.
|
||||
- Add the variable `<channel>_TEMPLATE` to `podcheck.config` where `<channel>` is the name of the channel added above and set the value to an available notification template script (`discord`, `apprise`, `gotify`, etc.)
|
||||
- Add all other environment variables required for the chosen template to function with `<channel>` in upper case as the prefix rather than the template name.
|
||||
- For example, if `<channel>` is `mynotification` and the template configured is `discord`, you would need to set `MYNOTIFICATION_WEBHOOK_URL`.
|
||||
|
||||
Copy the notify_templates/urls.list file to the script directory—it will be used automatically if it's there. Modify it as necessary; the names of interest in the left column need to match your container names.
|
||||
### Release notes addon
|
||||
There's a function to use a lookup-file to add release note URL's to the notification message.
|
||||
|
||||
Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there.
|
||||
Modify it as necessary, the names of interest in the left column needs to match your container names.
|
||||
To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config.
|
||||
For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**)
|
||||
|
||||
The output of the notification will look something like this:
|
||||
```
|
||||
Containers on hostname with updates available:
|
||||
joplin-db -> https://github.com/laurent22/joplin/releases
|
||||
it-tools -> https://github.com/CorentinTh/it-tools/releases
|
||||
apprise-api -> https://github.com/linuxserver/docker-apprise-api/releases
|
||||
homer -> https://github.com/bastienwirtz/homer/releases
|
||||
nginx -> https://github.com/docker-library/official-images/blob/master/library/nginx
|
||||
...
|
||||
```
|
||||
The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
|
||||
|
||||
## :chart_with_upwards_trend: Prometheus and node_exporter
|
||||
Dockcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely.
|
||||
## Asyncronous update checks with **xargs**; `-x N` option. (default=1)
|
||||
Pass `-x N` where N is number of subprocesses allowed, experiment in your environment to find a suitable max!
|
||||
|
||||
Change the default value by editing the `MaxAsync=N` variable in `podcheck.sh`. To disable the subprocess function set `MaxAsync=0`.
|
||||
|
||||
## Extra plugins and tools:
|
||||
|
||||
### Using podcheck.sh with systemd units (Quadlet)
|
||||
Podcheck automatically detects containers managed by systemd units and will restart them appropriately using `systemctl restart`.
|
||||
|
||||
### Prometheus and node_exporter
|
||||
Podcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely.
|
||||
This is done with the `-c` option, like this:
|
||||
```
|
||||
dockcheck.sh -c /path/to/exporter/directory
|
||||
podcheck.sh -c /path/to/exporter/directory
|
||||
```
|
||||
See the [README_prom.md](./addons/prometheus/README.md) for more detailed information on how to set it up!
|
||||
|
||||
See the [README.md](./addons/prometheus/README.md) for more detailed information on how to set it up!
|
||||
<sub><sup>Contributed by [tdralle](https://github.com/tdralle).</sup></sub>
|
||||
|
||||
## :bookmark: Labels
|
||||
|
||||
Optionally, you can add labels to your containers to control how Podcheck handles them. Currently, these are the usable labels:
|
||||
|
||||
```yaml
|
||||
labels:
|
||||
sudo-kraken.podcheck.restart-stack: true
|
||||
sudo-kraken.podcheck.update: true
|
||||
## Labels
|
||||
Optionally add labels to compose-files. Currently these are the usable labels:
|
||||
```
|
||||
- `sudo-kraken.podcheck.restart-stack`: true works instead of the `-f` option, forcing a restart of the entire pod or compose stack when an update is applied. Caution: This will restart the entire stack for every updated container within it.
|
||||
- `sudo-kraken.podcheck.update`: true will, when used with the `-l` option, only update containers with this label and skip the rest. It will still list all available updates.
|
||||
labels:
|
||||
sudo-kraken.podcheck.update: true
|
||||
sudo-kraken.podcheck.only-specific-container: true
|
||||
sudo-kraken.podcheck.restart-stack: true
|
||||
```
|
||||
- `sudo-kraken.podcheck.update: true` will when used with the `-l` option only update containers with this label and skip the rest. Will still list updates as usual.
|
||||
- `sudo-kraken.podcheck.only-specific-container: true` works instead of the `-F` option, specifying the updated container when doing compose up, like `podman compose up -d homer`.
|
||||
- `sudo-kraken.podcheck.restart-stack: true` works instead of the `-f` option, forcing stop+restart on the whole compose-stack (Caution: Will restart on every updated container within stack).
|
||||
|
||||
## :roller_coaster: Workaround for non **amd64** / **arm64**
|
||||
## Workaround for non **amd64** / **arm64**
|
||||
`regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
|
||||
Run regctl in a container wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
|
||||
|
||||
|
|
@ -177,48 +275,47 @@ opts=""
|
|||
case "\$*" in
|
||||
"registry login"*) opts="-t";;
|
||||
esac
|
||||
docker container run \$opts -i --rm --net host \\
|
||||
podman container run \$opts -i --rm --net host \\
|
||||
-u "\$(id -u):\$(id -g)" -e HOME -v \$HOME:\$HOME \\
|
||||
-v /etc/docker/certs.d:/etc/docker/certs.d:ro \\
|
||||
ghcr.io/regclient/regctl:latest "\$@"
|
||||
EOF
|
||||
chmod 755 regctl
|
||||
```
|
||||
Test it with `./regctl --help` and then either add the file to the same path as *eck.sh* or in your path (eg. `~/.local/bin/regctl`).
|
||||
Test it with `./regctl --help` and then either add the file to the same path as *podcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
|
||||
|
||||
## :guardsman: Function to auth with docker hub before running
|
||||
## Function to auth with docker hub before running
|
||||
**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
|
||||
```sh
|
||||
function dchk {
|
||||
function pchk {
|
||||
cat ~/pwd.txt | podman login --username YourUser --password-stdin docker.io
|
||||
~/podcheck.sh "$@"
|
||||
}
|
||||
```
|
||||
|
||||
## :hammer: Known issues
|
||||
## `-r flag` disclaimer and warning
|
||||
**Wont auto-update the containers, only their images. (compose is recommended)**
|
||||
`podman run` dont support using new images just by restarting a container.
|
||||
Containers need to be manually stopped, removed and created again to run on the new image.
|
||||
Using the `-r` option together with eg. `-i` and `-n` to just check for updates and send notifications and not update is safe though!
|
||||
|
||||
## Known issues
|
||||
- No detailed error feedback (just skip + list what's skipped).
|
||||
- Not respecting `--profile` options when re-creating the container.
|
||||
- Not working well with containers created by **Portainer**.
|
||||
- **Watchtower** might cause issues due to retagging images when checking for updates (and thereby pulling new images).
|
||||
|
||||
## :warning: `-r flag` disclaimer and warning
|
||||
**Wont auto-update the containers, only their images. (compose is recommended)**
|
||||
`podman run` does not support using new images just by restarting a container.
|
||||
Containers need to be manually stopped, removed and created again to run on the new image.
|
||||
|
||||
## :wrench: Debugging
|
||||
If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
|
||||
## Debugging
|
||||
If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
|
||||
Another option is to run the main script with debugging in a subshell `bash -x podcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x podcheck.sh nginx`.
|
||||
|
||||
## :scroll: License
|
||||
## License
|
||||
podcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
|
||||
|
||||
___
|
||||
|
||||
### :floppy_disk: The Story Behind Podcheck
|
||||
### The Story Behind Podcheck
|
||||
Podcheck was created to bring the convenience of automated container updates to the Podman ecosystem. As a user of [Dockcheck](https://github.com/mag37/dockcheck) for Docker, the need for a similar tool for Podman became apparent. Podcheck aims to provide the same ease of use and automation, tailored for Podman users.
|
||||
|
||||
## :star2: Acknowledgments
|
||||
## Acknowledgments
|
||||
Podcheck is inspired by the original [Dockcheck](https://github.com/mag37/dockcheck) script. Without Dockcheck, there wouldn't have been a Podcheck. Many thanks to mag37 and all the contributors to Dockcheck for their work and inspiration.
|
||||
___
|
||||
Please feel free to contribute, open issues, or submit pull requests to improve Podcheck!
|
||||
|
||||
|
|
|
|||
20
podcheck.sh
20
podcheck.sh
|
|
@ -68,19 +68,19 @@ Help() {
|
|||
echo "-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
|
||||
echo "-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
|
||||
echo "-e X Exclude containers, separated by comma."
|
||||
echo "-f Force pod restart after update."
|
||||
echo "-f Force stop+start stack after update. Caution: restarts once for every updated container within stack."
|
||||
echo "-F Only compose up the specific container, not the whole compose stack (useful for master-compose structure)."
|
||||
echo "-h Print this Help."
|
||||
echo "-i Inform - send a preconfigured notification."
|
||||
echo "-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list)."
|
||||
echo "-l Only update if label is set. See readme."
|
||||
echo "-m Monochrome mode, no printf color codes and hides progress bar."
|
||||
echo "-m Monochrome mode, no printf colour codes and hides progress bar."
|
||||
echo "-M Prints custom releasenote urls as markdown (requires template support)."
|
||||
echo "-n No updates; only checking availability."
|
||||
echo "-n No updates; only checking availability without interaction."
|
||||
echo "-p Auto-prune dangling images after update."
|
||||
echo "-r Allow updating images for podman run; won't update the container."
|
||||
echo "-s Include stopped containers in the check."
|
||||
echo "-t N Set a timeout (in seconds) per container for registry checkups, 10 is default."
|
||||
echo "-r Allow checking for updates/updating images for podman run containers. Won't update the container."
|
||||
echo "-s Include stopped containers in the check. (Logic: podman ps -a)."
|
||||
echo "-t Set a timeout (in seconds) per container for registry checkups, 10 is default."
|
||||
echo "-u Allow automatic self updates - caution as this will pull new code and autorun it."
|
||||
echo "-v Prints current version."
|
||||
echo "-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested."
|
||||
|
|
@ -663,7 +663,7 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||
ContImage=$(podman inspect "$i" --format='{{.Config.Image}}')
|
||||
ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
||||
[[ "$ContPath" == "null" ]] && ContPath=""
|
||||
ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
||||
ContUpdateLabel=$($jqbin -r '."sudo-kraken.podcheck.update"' <<< "$ContLabels")
|
||||
[[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
|
||||
# Checking if Label Only -option is set, and if container got the label
|
||||
[[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } }
|
||||
|
|
@ -698,11 +698,11 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||
[[ "$ContName" == "null" ]] && ContName=""
|
||||
ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
|
||||
[[ "$ContEnv" == "null" ]] && ContEnv=""
|
||||
ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
||||
ContUpdateLabel=$($jqbin -r '."sudo-kraken.podcheck.update"' <<< "$ContLabels")
|
||||
[[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
|
||||
ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
|
||||
ContRestartStack=$($jqbin -r '."sudo-kraken.podcheck.restart-stack"' <<< "$ContLabels")
|
||||
[[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
|
||||
ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
|
||||
ContOnlySpecific=$($jqbin -r '."sudo-kraken.podcheck.only-specific-container"' <<< "$ContLabels")
|
||||
[[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
|
||||
|
||||
printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue