Merge pull request #250 from navidys/readme_update

README.md update
containers · Jun 8, 2024 · ed735a8 · ed735a8
2 parents 993b3cf + b0d0a44
commit ed735a8
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 37 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -33,24 +33,24 @@ jobs:
           make lint
           make gofmt
 
-  tests_podmanv4:
-    runs-on: ubuntu-latest
-    container:
-      image: quay.io/containers/podman:v4
-      volumes:
-        - container_volume:/var/lib/containers
-      options: "--device /dev/fuse:rw --security-opt label=disable --security-opt seccomp=unconfined --privileged"
-    steps:
-      - uses: actions/setup-go@v3
-        with:
-          go-version: '1.21.4'
-      - uses: actions/checkout@v3
-      - run: |
-          yum -y install make gcc glib2-devel glibc-devel glibc-static device-mapper-devel
-          export GOBIN=$(pwd)/bin/
-          export CGO_ENABLED=1
-          make .install.ginkgo
-          make test
+#  tests_podmanv4:
+#    runs-on: ubuntu-latest
+#    container:
+#      image: quay.io/containers/podman:v4
+#      volumes:
+#        - container_volume:/var/lib/containers
+#      options: "--device /dev/fuse:rw --security-opt label=disable --security-opt seccomp=unconfined --privileged"
+#    steps:
+#      - uses: actions/setup-go@v3
+#        with:
+#          go-version: '1.21.4'
+#      - uses: actions/checkout@v3
+#      - run: |
+#          yum -y install make gcc glib2-devel glibc-devel glibc-static device-mapper-devel
+#          export GOBIN=$(pwd)/bin/
+#          export CGO_ENABLED=1
+#          make .install.ginkgo
+#          make test
 
   tests_podmanv5:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -69,24 +69,24 @@ jobs:
           make lint
           make gofmt
 
-  tests_podmanv4:
-    runs-on: ubuntu-latest
-    container:
-      image: quay.io/containers/podman:v4
-      volumes:
-        - container_volume:/var/lib/containers
-      options: "--device /dev/fuse:rw --security-opt label=disable --security-opt seccomp=unconfined --privileged"
-    steps:
-      - uses: actions/setup-go@v3
-        with:
-          go-version: '1.21.4'
-      - uses: actions/checkout@v3
-      - run: |
-          yum -y install make gcc glib2-devel glibc-devel glibc-static device-mapper-devel
-          export GOBIN=$(pwd)/bin/
-          export CGO_ENABLED=1
-          make .install.ginkgo
-          make test
+#  tests_podmanv4:
+#    runs-on: ubuntu-latest
+#    container:
+#      image: quay.io/containers/podman:v4
+#      volumes:
+#        - container_volume:/var/lib/containers
+#      options: "--device /dev/fuse:rw --security-opt label=disable --security-opt seccomp=unconfined --privileged"
+#    steps:
+#      - uses: actions/setup-go@v3
+#        with:
+#          go-version: '1.21.4'
+#      - uses: actions/checkout@v3
+#      - run: |
+#          yum -y install make gcc glib2-devel glibc-devel glibc-static device-mapper-devel
+#          export GOBIN=$(pwd)/bin/
+#          export CGO_ENABLED=1
+#          make .install.ginkgo
+#          make test
 
   tests_podmanv5:
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -5,15 +5,23 @@
 [![Go Report](https://img.shields.io/badge/go%20report-A%2B-brightgreen.svg)](https://goreportcard.com/report/github.com/containers/prometheus-podman-exporter)
 ![Go](https://github.com/containers/prometheus-podman-exporter/workflows/Go/badge.svg)
 
-Prometheus exporter for podman v4 and v5 environment exposing containers, pods, images, volumes and networks information.
+Prometheus exporter for podman environment exposing containers, pods, images, volumes and networks information.
 
 prometheus-podman-exporter uses the podman (libpod) library to fetch the statistics and therefore no need to enable podman.socket service unless using the container image.
 
+- [**Compatibility matrix**](#compatibility-matrix-with-podman)
 - [**Installation**](#installation)
 - [**Usage and Options**](#usage-and-options)
 - [**Collectors**](#collectors)
 - [**License**](#license)
 
+## Compatibility matrix
+
+| Exporter  | Podman |
+| --------- | ------ |
+| >= 1.11.y | v5.x.y |
+| <= 1.10.x | v4.x.y |
+
 ## Installation
 
 Building from source, using container image or installing packaged versions are detailed in [install guide](install.md).