mirror of
https://github.com/PaesslerAG/docker-multi-platform-probe.git
synced 2026-02-20 22:15:40 +00:00
Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9ab86d9e89 | ||
|
|
923b65c1e4 | ||
|
|
77016209c1 | ||
| e64f6724ab | |||
| 46fc633d88 | |||
| 573c54f5e2 | |||
| 8abf3edfcd | |||
| 16a7bea45c | |||
|
|
baa179a41c | ||
|
|
91a2187ec1 | ||
|
|
b54bc94716 | ||
|
|
44749872c3 | ||
|
|
b04fc33694 | ||
|
|
198cc27854 | ||
|
|
94519a402f | ||
|
|
546ee7af5e | ||
|
|
dfdc14a586 | ||
|
|
8bb3d9b08b | ||
|
|
19ee055f91 | ||
|
|
07882452e1 | ||
|
|
8a15bb8d94 | ||
|
|
cb62a9faa3 | ||
|
|
08ee7e1398 | ||
|
|
29af404991 | ||
|
|
fd79b23057 | ||
|
|
3b09d94284 | ||
|
|
5bcfae9b91 |
85
.github/workflows/docker-build.yml
vendored
Normal file
85
.github/workflows/docker-build.yml
vendored
Normal file
@@ -0,0 +1,85 @@
|
||||
# See https://docs.github.com/en/actions/publishing-packages/publishing-docker-images
|
||||
|
||||
name: Build and push # to docker registries
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- "main"
|
||||
tags:
|
||||
- "*"
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
env:
|
||||
IMAGE_NAME: prtgprobe/multi-platform-probe
|
||||
|
||||
jobs:
|
||||
docker_build:
|
||||
name: Build and push
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
packages: write
|
||||
contents: read
|
||||
attestations: write
|
||||
id-token: write
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
variant:
|
||||
- name: systemec_piraeus
|
||||
registry: "piraeus.systemec.nl"
|
||||
steps:
|
||||
- name: Set image for Docker
|
||||
id: set-image
|
||||
run: |
|
||||
if [ "${{ matrix.variant.name }}" == "systemec_piraeus" ]; then
|
||||
echo "IMAGE_TO_USE=${IMAGE_NAME}" >> $GITHUB_ENV
|
||||
else
|
||||
echo "Failing to resolve."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Check out the repository
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
with:
|
||||
platforms: |
|
||||
- linux/amd64
|
||||
- linux/arm64
|
||||
- linux/arm/v7
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to Systemec Piraeus
|
||||
if: matrix.variant.name == 'systemec_piraeus'
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PUSH_TOKEN }}
|
||||
registry: ${{ matrix.variant.registry }}
|
||||
|
||||
- name: Extract metadata (tags, labels) for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ matrix.variant.registry }}/${{ env.IMAGE_TO_USE }}
|
||||
tags: |
|
||||
type=ref,event=branch
|
||||
type=ref,event=tag
|
||||
type=sha,format=short,prefix=
|
||||
|
||||
- name: Build and push Docker image
|
||||
id: push
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
||||
6
.github/workflows/dockerhub.yml
vendored
6
.github/workflows/dockerhub.yml
vendored
@@ -3,8 +3,8 @@
|
||||
name: Push to Docker Hub
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
# release:
|
||||
# types: [published]
|
||||
|
||||
env:
|
||||
IMAGE_NAME: paessler/multi-platform-probe
|
||||
@@ -56,6 +56,6 @@ jobs:
|
||||
- name: Generate artifact attestation
|
||||
uses: actions/attest-build-provenance@v1
|
||||
with:
|
||||
subject-name: ${{ env.IMAGE_NAME }}
|
||||
subject-name: docker.io/${{ env.IMAGE_NAME }}
|
||||
subject-digest: ${{ steps.push.outputs.digest }}
|
||||
push-to-registry: true
|
||||
|
||||
6
.github/workflows/github.yml
vendored
6
.github/workflows/github.yml
vendored
@@ -3,9 +3,9 @@
|
||||
name: Push to GitHub
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
tags: ["*"]
|
||||
# push:
|
||||
# branches: ["main"]
|
||||
# tags: ["*"]
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
|
||||
21
Dockerfile
21
Dockerfile
@@ -1,10 +1,11 @@
|
||||
FROM debian:11-slim
|
||||
FROM debian:13-slim
|
||||
|
||||
LABEL org.opencontainers.image.authors="info@paessler.com"
|
||||
LABEL org.opencontainers.image.vendor="Paessler GmbH"
|
||||
LABEL org.opencontainers.image.licenses="MIT"
|
||||
|
||||
ARG DEBIAN_FRONTEND=noninteractive
|
||||
ARG DEBIAN_FB_RELEASE=bookworm
|
||||
|
||||
# enforce image to be up to date
|
||||
RUN \
|
||||
@@ -21,7 +22,7 @@ RUN \
|
||||
# - libcap2-bin (for setcap command)
|
||||
#
|
||||
RUN \
|
||||
apt-get update \
|
||||
apt-get update && apt-get full-upgrade \
|
||||
&& apt-get -y install --no-install-recommends --no-install-suggests \
|
||||
ca-certificates \
|
||||
python3-minimal \
|
||||
@@ -29,13 +30,15 @@ RUN \
|
||||
libcap2-bin \
|
||||
&& apt-get clean
|
||||
|
||||
# add paessler's official package repository
|
||||
# Add Paessler's official package repository with current release specifications.
|
||||
# If the current release is not present on Paessler's servers fallback to defined fallback release.
|
||||
RUN \
|
||||
apt-get update \
|
||||
apt-get -qq update \
|
||||
&& apt-get -y install --no-install-recommends --no-install-suggests \
|
||||
curl \
|
||||
&& curl --fail --silent https://packages.paessler.com/keys/paessler.asc > /usr/share/keyrings/paessler-archive-keyring.asc \
|
||||
&& curl --fail --silent https://packages.paessler.com/docs/apt-sources/$(. /etc/os-release && echo $VERSION_CODENAME).sources > /etc/apt/sources.list.d/paessler.sources \
|
||||
&& curl --fail https://packages.paessler.com/keys/paessler.asc > /usr/share/keyrings/paessler-archive-keyring.asc \
|
||||
&& curl --fail https://packages.paessler.com/docs/apt-sources/$(. /etc/os-release && $VERSION_CODENAME).sources \
|
||||
|| curl --fail https://packages.paessler.com/docs/apt-sources/${DEBIAN_FB_RELEASE}.sources > /etc/apt/sources.list.d/paessler.sources \
|
||||
&& apt-get -y remove --purge curl \
|
||||
&& apt-get clean
|
||||
|
||||
@@ -44,10 +47,11 @@ RUN \
|
||||
apt-get update \
|
||||
&& apt-get -y install --no-install-recommends --no-install-suggests \
|
||||
prtgmpprobe \
|
||||
&& apt-get autoremove -y \
|
||||
&& apt-get clean
|
||||
|
||||
# add entrypoint script
|
||||
COPY --chown=root:root --chmod=0555 run-prtgmpprobe.sh /run-prtgmpprobe.sh
|
||||
COPY --chown=root:root --chmod=0555 run-prtgmpprobe.sh /entrypoint.sh
|
||||
|
||||
# specify volumes:
|
||||
# - /config : configuration directory for the prtgmpprobe, put your config.yml here.
|
||||
@@ -57,4 +61,5 @@ VOLUME [ "/config", "/opt/paessler/share/scripts" ]
|
||||
# set WORKDIR to a sane default
|
||||
WORKDIR /
|
||||
|
||||
ENTRYPOINT [ "/run-prtgmpprobe.sh", "service-run" ]
|
||||
ENTRYPOINT [ "/entrypoint.sh" ]
|
||||
CMD [ "service-run" ]
|
||||
|
||||
28
README.md
28
README.md
@@ -17,7 +17,7 @@ We recommend that you always update to the latest version of PRTG via the Auto-U
|
||||
Requires a [NATS server](#install-and-configure-a-nats-server) connection configured in PRTG.
|
||||
|
||||
[prtg-96]: https://www.paessler.com/prtg/history/stable#24.2.96.1315
|
||||
[manual]: https://paessler.canto.global/direct/document/qvou34dmut1uh0gg6mqee3ip2k/K-e9xGiEiT58XzlH3s_Nf-B3lVk/original?content-type=application%2Fpdf&name=Multi-Platform+Probe+Manual.pdf
|
||||
[manual]: https://manuals.paessler.com/multiplatformprobemanual.pdf
|
||||
|
||||
## How to use the multi-platform probe container
|
||||
|
||||
@@ -37,7 +37,7 @@ Paessler GmbH provides the **NATS Server for Paessler PRTG** Windows installer t
|
||||
* Configures the NATS server.
|
||||
* Installs and starts the NATS server service in the background.
|
||||
|
||||
For the installer and step-by-step instructions on how to set up a NATS server on Windows, see section **Step 1: Install a NATS server** in the [Multi-Platform Probe for PRTG (PDF)][manual] manual.
|
||||
For the installer and step-by-step instructions on how to set up a NATS server on Windows, see section **Step 1: Install a NATS server** in the [Multi-Platform Probe for PRTG][manual] manual.
|
||||
|
||||
ℹ️ If you want to deploy your NATS server on a non-Windows system, see the NATS documentation on their website.
|
||||
|
||||
@@ -46,7 +46,7 @@ For the installer and step-by-step instructions on how to set up a NATS server o
|
||||
Once you set up your NATS server, you must configure PRTG to accept connections to the NATS server.
|
||||
This is done from the PRTG web interface via **Setup** | **Cores & Probes** | **[Multi-Platform Probe Connection Settings][prtg-manual:cores]**.
|
||||
|
||||
For step-by-step instructions on how to configure PRTG, see section **Step 2: Configure connection in PRTG** in the [Multi-Platform Probe for PRTG (PDF)][manual] manual.
|
||||
For step-by-step instructions on how to configure PRTG, see section **Step 2: Configure connection in PRTG** in the [Multi-Platform Probe for PRTG][manual] manual.
|
||||
|
||||
[prtg-manual:cores]: https://www.paessler.com/manuals/prtg/core_and_probes#multi_platform_probe_connection
|
||||
|
||||
@@ -66,21 +66,35 @@ nats:
|
||||
```
|
||||
|
||||
You must put the configuration file into the `/config/config.yml` volume of the docker container.
|
||||
For all available configuration options, see [config.full-example.yml](./config/config.full-example.yml).
|
||||
|
||||
ℹ️ The container also used the `/config` volume to store the [multi-platform probe's GID][GID] and therefore cannot be set as read-only (`:ro`) unless you specify the GID as an environment variable.
|
||||
ℹ️ If necessary you can put your custom [CA certificate][TLS] into `/config/certs` and specify it in the `/config/config.yml` as well:
|
||||
|
||||
```yaml
|
||||
access_key: YOUR_PROBE_ACCESS_KEY
|
||||
nats:
|
||||
url: tls://localhost:23561
|
||||
authentication:
|
||||
user: USER
|
||||
password: PASSWORD
|
||||
server_ca: /config/certs/ca.crt
|
||||
```
|
||||
|
||||
ℹ️ The container also used the `/config` volume to store the [multi-platform probe's GID][GID] and therefore cannot be set as read-only (`:ro`) unless you specify the [multi-platform probe's GID][GID] as an environment variable.
|
||||
|
||||
You can also use the `/opt/paessler/share/scripts` volume for the scripts of the [Script v2][prtgmanual:scriptv2] sensor.
|
||||
|
||||
[prtgmanual:scriptv2]: https://www.paessler.com/manuals/prtg/script_v2_sensor
|
||||
[TLS]: https://kb.paessler.com/en/topic/91877-how-can-i-create-a-tls-certificate
|
||||
[GID]: https://www.paessler.com/manuals/prtg/prtg_administration_tool_on_remote_probe_systems#:~:text=GID
|
||||
|
||||
```sh
|
||||
docker run -it \
|
||||
--network bridge \
|
||||
-v ./scripts:/opt/paessler/share/scripts:ro \
|
||||
-v ./config:/config \
|
||||
-v $(pwd)/scripts:/opt/paessler/share/scripts:ro \
|
||||
-v $(pwd)/config:/config \
|
||||
--cap-add NET_ADMIN \
|
||||
--cap-add NET_RAW
|
||||
--cap-add NET_RAW \
|
||||
paessler/multi-platform-probe:latest
|
||||
```
|
||||
|
||||
|
||||
@@ -13,12 +13,12 @@ _passthrough=0
|
||||
for _arg in "$@"
|
||||
do
|
||||
case "$_arg" in
|
||||
--help|example-config)
|
||||
-h|--help|example-config|-V|--version)
|
||||
_passthrough=1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
if [ ! $_passthrough -eq 0 ] ; then
|
||||
if [ $_passthrough -ne 0 ] ; then
|
||||
exec gosu paessler_mpprobe:paessler_mpprobe \
|
||||
${PRTGMPPROBE__BINARY} \
|
||||
"$@"
|
||||
@@ -42,19 +42,29 @@ done
|
||||
|
||||
# Handling Env vars
|
||||
|
||||
# Get/Generate a probe id from PRTGMPPROBE__ID_FILE or from PRTGMPPROBE__ID
|
||||
if [ -z "${PRTGMPPROBE__ID-}" ] ; then
|
||||
if [ ! -f "${PRTGMPPROBE__ID_FILE}" ] ; then
|
||||
cat /proc/sys/kernel/random/uuid > ${PRTGMPPROBE__ID_FILE} || (
|
||||
error "Unable to write to ${PRTGMPPROBE__ID_FILE}. Please either set PRTGMPPROBE__ID in the container environment or make sure the location ${PRTGMPPROBE__ID_FILE} is writable."
|
||||
echo >&2 " "
|
||||
echo >&2 "Example:"
|
||||
echo >&2 "PRTGMPPROBE__ID=$(cat /proc/sys/kernel/random/uuid)"
|
||||
exit 1
|
||||
)
|
||||
if [ ! -f "${PRTGMPPROBE__CONFIG_FILE}" ] ; then
|
||||
error "Configuration file ${PRTGMPPROBE__CONFIG_FILE} does not exist. Please create one."
|
||||
echo >&2 " "
|
||||
echo >&2 "Example:"
|
||||
${PRTGMPPROBE__BINARY} example-config >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Get/Generate a probe id from PRTGMPPROBE__ID_FILE or from PRTGMPPROBE__ID if not set in PRTGMPPROBE__CONFIG_FILE
|
||||
if ! grep -q "^id:" "${PRTGMPPROBE__CONFIG_FILE}" ; then
|
||||
if [ -z "${PRTGMPPROBE__ID-}" ] ; then
|
||||
if [ ! -f "${PRTGMPPROBE__ID_FILE}" ] ; then
|
||||
cat /proc/sys/kernel/random/uuid > ${PRTGMPPROBE__ID_FILE} || (
|
||||
error "Unable to write to ${PRTGMPPROBE__ID_FILE}. Please either set PRTGMPPROBE__ID in the container environment, 'id:' in the ${PRTGMPPROBE__CONFIG_FILE} or make sure the location ${PRTGMPPROBE__ID_FILE} is writable."
|
||||
echo >&2 " "
|
||||
echo >&2 "Example:"
|
||||
echo >&2 "PRTGMPPROBE__ID=$(cat /proc/sys/kernel/random/uuid)"
|
||||
exit 1
|
||||
)
|
||||
fi
|
||||
PRTGMPPROBE__ID=$(cat ${PRTGMPPROBE__ID_FILE})
|
||||
export PRTGMPPROBE__ID
|
||||
fi
|
||||
PRTGMPPROBE__ID=$(cat ${PRTGMPPROBE__ID_FILE})
|
||||
export PRTGMPPROBE__ID
|
||||
fi
|
||||
|
||||
export PRTGMPPROBE__NAME=${PRTGMPPROBE__NAME:-"multi-platform-probe@$(hostname)"}
|
||||
@@ -70,14 +80,6 @@ export PRTGMPPROBE__LOGGING__CONSOLE__WITHOUT_TIME=${PRTGMPPROBE__LOGGING__CONSO
|
||||
export PRTGMPPROBE__LOGGING__JOURNALD__LEVEL=${PRTGMPPROBE__LOGGING__JOURNALD__FIELD_PREFIX:-"off"}
|
||||
export PRTGMPPROBE__LOGGING__JOURNALD__FIELD_PREFIX=${PRTGMPPROBE__LOGGING__JOURNALD__FIELD_PREFIX:-"PRTGMPPROBE"}
|
||||
|
||||
if [ ! -f "${PRTGMPPROBE__CONFIG_FILE}" ] ; then
|
||||
error "Configuration file ${PRTGMPPROBE__CONFIG_FILE} does not exist. Please create one."
|
||||
echo >&2 " "
|
||||
echo >&2 "Example:"
|
||||
${PRTGMPPROBE__BINARY} example-config >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
env | grep PRTGMPPROBE__ >&2
|
||||
|
||||
# add capabilities for icmp to the probe executable
|
||||
|
||||
Reference in New Issue
Block a user