chore(deps): lock file maintenance (#574)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.chglog/CHANGELOG.tpl.md

@@ -1,27 +0,0 @@
-# Changelog
-
-{{ range .Versions -}}
-## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }})
-
-{{ range .CommitGroups -}}
-### {{ .Title }}
-
-{{ $subjects := list }}
-{{ range .Commits -}}
-{{ if not (has .Subject $subjects) -}}
-- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
-{{ $subjects = append $subjects .Subject -}}
-{{ end }}
-{{- end }}
-{{- end -}}
-
-{{- if .NoteGroups -}}
-{{ range .NoteGroups -}}
-### {{ .Title }}
-
-{{ range .Notes }}
-{{ .Body }}
-{{ end }}
-{{ end -}}
-{{ end -}}
-{{ end -}}

.chglog/config.yml

@@ -1,25 +0,0 @@
-style: github
-template: CHANGELOG.tpl.md
-info:
-  title: CHANGELOG
-  repository_url: https://github.com/thegeeklab/prometheus-pve-sd
-options:
-  commit_groups:
-    title_maps:
-      feat: Features
-      fix: Bug Fixes
-      perf: Performance Improvements
-      refactor: Code Refactoring
-      chore: Others
-      test: Testing
-      ci: CI Pipeline
-      docs: Documentation
-  header:
-    pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
-    pattern_maps:
-      - Type
-      - Scope
-      - Subject
-  notes:
-    keywords:
-      - BREAKING CHANGE

.dictionary

@@ -5,3 +5,20 @@ xoxys
 Proxmox
 VE
 TBD
+PVE
+SELinux
+CLI
+JSON
+toc
+Codecov
+IPv4
+IPv6
+Alertmanager
+VM
+VMID
+Telegraf
+QEMU
+cloud-init
+Prometheus
+Kubernetes
+namespace

.drone.jsonnet

@@ -1,493 +0,0 @@
-local PythonVersion(pyversion='3.6') = {
-  name: 'python' + std.strReplace(pyversion, '.', '') + '-pytest',
-  image: 'python:' + pyversion,
-  environment: {
-    PY_COLORS: 1,
-  },
-  commands: [
-    'pip install poetry poetry-dynamic-versioning -qq',
-    'poetry config experimental.new-installer false',
-    'poetry install',
-    'poetry version',
-    'poetry run prometheus-pve-sd --help',
-  ],
-  depends_on: [
-    'fetch',
-  ],
-};
-
-local PipelineLint = {
-  kind: 'pipeline',
-  name: 'lint',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  steps: [
-    {
-      name: 'yapf',
-      image: 'python:3.9',
-      environment: {
-        PY_COLORS: 1,
-      },
-      commands: [
-        'git fetch -tq',
-        'pip install poetry poetry-dynamic-versioning -qq',
-        'poetry config experimental.new-installer false',
-        'poetry install',
-        'poetry run yapf -dr ./prometheuspvesd',
-      ],
-    },
-    {
-      name: 'flake8',
-      image: 'python:3.9',
-      environment: {
-        PY_COLORS: 1,
-      },
-      commands: [
-        'git fetch -tq',
-        'pip install poetry poetry-dynamic-versioning -qq',
-        'poetry config experimental.new-installer false',
-        'poetry install',
-        'poetry run flake8 ./prometheuspvesd',
-      ],
-    },
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineTest = {
-  kind: 'pipeline',
-  name: 'test',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  steps: [
-    {
-      name: 'fetch',
-      image: 'python:3.9',
-      commands: [
-        'git fetch -tq',
-      ],
-    },
-    PythonVersion(pyversion='3.6'),
-    PythonVersion(pyversion='3.7'),
-    PythonVersion(pyversion='3.8'),
-    PythonVersion(pyversion='3.9'),
-  ],
-  depends_on: [
-    'lint',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineSecurity = {
-  kind: 'pipeline',
-  name: 'security',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  steps: [
-    {
-      name: 'bandit',
-      image: 'python:3.9',
-      environment: {
-        PY_COLORS: 1,
-      },
-      commands: [
-        'git fetch -tq',
-        'pip install poetry poetry-dynamic-versioning -qq',
-        'poetry config experimental.new-installer false',
-        'poetry install',
-        'poetry run bandit -r ./prometheuspvesd -x ./prometheuspvesd/test',
-      ],
-    },
-  ],
-  depends_on: [
-    'test',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineBuildPackage = {
-  kind: 'pipeline',
-  name: 'build-package',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  steps: [
-    {
-      name: 'build',
-      image: 'python:3.9',
-      commands: [
-        'git fetch -tq',
-        'pip install poetry poetry-dynamic-versioning -qq',
-        'poetry build',
-      ],
-    },
-    {
-      name: 'checksum',
-      image: 'alpine',
-      commands: [
-        'cd dist/ && sha256sum * > ../sha256sum.txt',
-      ],
-    },
-    {
-      name: 'changelog-generate',
-      image: 'thegeeklab/git-chglog',
-      commands: [
-        'git fetch -tq',
-        'git-chglog --no-color --no-emoji -o CHANGELOG.md ${DRONE_TAG:---next-tag unreleased unreleased}',
-      ],
-    },
-    {
-      name: 'changelog-format',
-      image: 'thegeeklab/alpine-tools',
-      commands: [
-        'prettier CHANGELOG.md',
-        'prettier -w CHANGELOG.md',
-      ],
-    },
-    {
-      name: 'publish-github',
-      image: 'plugins/github-release',
-      settings: {
-        overwrite: true,
-        api_key: { from_secret: 'github_token' },
-        files: ['dist/*', 'sha256sum.txt'],
-        title: '${DRONE_TAG}',
-        note: 'CHANGELOG.md',
-      },
-      when: {
-        ref: ['refs/tags/**'],
-      },
-    },
-    {
-      name: 'publish-pypi',
-      image: 'python:3.9',
-      commands: [
-        'git fetch -tq',
-        'pip install poetry poetry-dynamic-versioning -qq',
-        'poetry publish -n',
-      ],
-      environment: {
-        POETRY_HTTP_BASIC_PYPI_USERNAME: { from_secret: 'pypi_username' },
-        POETRY_HTTP_BASIC_PYPI_PASSWORD: { from_secret: 'pypi_password' },
-      },
-      when: {
-        ref: ['refs/tags/**'],
-      },
-    },
-  ],
-  depends_on: [
-    'security',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineBuildContainer(arch='amd64') = {
-  local build = if arch == 'arm' then [{
-    name: 'build',
-    image: 'python:3.9-alpine',
-    commands: [
-      'apk add -Uq --no-cache build-base libressl-dev libffi-dev musl-dev python3-dev git cargo',
-      'git fetch -tq',
-      'pip install poetry poetry-dynamic-versioning -qq',
-      'poetry build',
-    ],
-    environment: {
-      CARGO_NET_GIT_FETCH_WITH_CLI: true,
-    },
-  }] else [{
-    name: 'build',
-    image: 'python:3.9',
-    commands: [
-      'git fetch -tq',
-      'pip install poetry poetry-dynamic-versioning -qq',
-      'poetry build',
-    ],
-  }],
-
-  kind: 'pipeline',
-  name: 'build-container-' + arch,
-  platform: {
-    os: 'linux',
-    arch: arch,
-  },
-  steps: build + [
-    {
-      name: 'dryrun',
-      image: 'thegeeklab/drone-docker:19',
-      settings: {
-        dry_run: true,
-        dockerfile: 'docker/Dockerfile.' + arch,
-        repo: 'thegeeklab/${DRONE_REPO_NAME}',
-        username: { from_secret: 'docker_username' },
-        password: { from_secret: 'docker_password' },
-      },
-      depends_on: ['build'],
-      when: {
-        ref: ['refs/pull/**'],
-      },
-    },
-    {
-      name: 'publish-dockerhub',
-      image: 'thegeeklab/drone-docker:19',
-      settings: {
-        auto_tag: true,
-        auto_tag_suffix: arch,
-        dockerfile: 'docker/Dockerfile.' + arch,
-        repo: 'thegeeklab/${DRONE_REPO_NAME}',
-        username: { from_secret: 'docker_username' },
-        password: { from_secret: 'docker_password' },
-      },
-      when: {
-        ref: ['refs/heads/main', 'refs/tags/**'],
-      },
-      depends_on: ['dryrun'],
-    },
-    {
-      name: 'publish-quay',
-      image: 'thegeeklab/drone-docker:19',
-      settings: {
-        auto_tag: true,
-        auto_tag_suffix: arch,
-        dockerfile: 'docker/Dockerfile.' + arch,
-        registry: 'quay.io',
-        repo: 'quay.io/thegeeklab/${DRONE_REPO_NAME}',
-        username: { from_secret: 'quay_username' },
-        password: { from_secret: 'quay_password' },
-      },
-      when: {
-        ref: ['refs/heads/main', 'refs/tags/**'],
-      },
-      depends_on: ['dryrun'],
-    },
-  ],
-  depends_on: [
-    'security',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineDocs = {
-  kind: 'pipeline',
-  name: 'docs',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  concurrency: {
-    limit: 1,
-  },
-  steps: [
-    {
-      name: 'assets',
-      image: 'thegeeklab/alpine-tools',
-      commands: [
-        'make doc',
-      ],
-    },
-    {
-      name: 'markdownlint',
-      image: 'thegeeklab/markdownlint-cli',
-      commands: [
-        "markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md'",
-      ],
-    },
-    {
-      name: 'spellcheck',
-      image: 'node:lts-alpine',
-      commands: [
-        'npm install -g spellchecker-cli',
-        "spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions",
-      ],
-      environment: {
-        FORCE_COLOR: true,
-        NPM_CONFIG_LOGLEVEL: 'error',
-      },
-    },
-    // {
-    //   name: 'testbuild',
-    //   image: 'thegeeklab/hugo:0.83.1',
-    //   commands: [
-    //     'hugo -s docs/ -b http://localhost/',
-    //   ],
-    // },
-    // {
-    //   name: 'link-validation',
-    //   image: 'thegeeklab/link-validator',
-    //   commands: [
-    //     'link-validator -ro',
-    //   ],
-    //   environment: {
-    //     LINK_VALIDATOR_BASE_DIR: 'docs/public',
-    //   },
-    // },
-    // {
-    //   name: 'build',
-    //   image: 'thegeeklab/hugo:0.83.1',
-    //   commands: [
-    //     'hugo -s docs/',
-    //   ],
-    // },
-    // {
-    //   name: 'beautify',
-    //   image: 'node:lts-alpine',
-    //   commands: [
-    //     'npm install -g js-beautify',
-    //     "html-beautify -r -f 'docs/public/**/*.html'",
-    //   ],
-    //   environment: {
-    //     FORCE_COLOR: true,
-    //     NPM_CONFIG_LOGLEVEL: 'error',
-    //   },
-    // },
-    // {
-    //   name: 'publish',
-    //   image: 'plugins/s3-sync',
-    //   settings: {
-    //     access_key: { from_secret: 's3_access_key' },
-    //     bucket: 'geekdocs',
-    //     delete: true,
-    //     endpoint: 'https://sp.rknet.org',
-    //     path_style: true,
-    //     secret_key: { from_secret: 's3_secret_access_key' },
-    //     source: 'docs/public/',
-    //     strip_prefix: 'docs/public/',
-    //     target: '/${DRONE_REPO_NAME}',
-    //   },
-    //   when: {
-    //     ref: ['refs/heads/main', 'refs/tags/**'],
-    //   },
-    // },
-  ],
-  depends_on: [
-    'build-package',
-    'build-container-amd64',
-    'build-container-arm64',
-    'build-container-arm',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
-  },
-};
-
-local PipelineNotifications = {
-  kind: 'pipeline',
-  name: 'notifications',
-  platform: {
-    os: 'linux',
-    arch: 'amd64',
-  },
-  steps: [
-    {
-      image: 'plugins/manifest',
-      name: 'manifest-dockerhub',
-      settings: {
-        ignore_missing: true,
-        auto_tag: true,
-        username: { from_secret: 'docker_username' },
-        password: { from_secret: 'docker_password' },
-        spec: 'docker/manifest.tmpl',
-      },
-      when: {
-        status: ['success'],
-      },
-    },
-    {
-      image: 'plugins/manifest',
-      name: 'manifest-quay',
-      settings: {
-        ignore_missing: true,
-        auto_tag: true,
-        username: { from_secret: 'quay_username' },
-        password: { from_secret: 'quay_password' },
-        spec: 'docker/manifest-quay.tmpl',
-      },
-      when: {
-        status: ['success'],
-      },
-    },
-    {
-      name: 'pushrm-dockerhub',
-      pull: 'always',
-      image: 'chko/docker-pushrm:1',
-      environment: {
-        DOCKER_PASS: {
-          from_secret: 'docker_password',
-        },
-        DOCKER_USER: {
-          from_secret: 'docker_username',
-        },
-        PUSHRM_FILE: 'README.md',
-        PUSHRM_SHORT: 'Prometheus Service Discovery for Proxmox VE',
-        PUSHRM_TARGET: 'thegeeklab/${DRONE_REPO_NAME}',
-      },
-      when: {
-        status: ['success'],
-      },
-    },
-    {
-      name: 'pushrm-quay',
-      pull: 'always',
-      image: 'chko/docker-pushrm:1',
-      environment: {
-        APIKEY__QUAY_IO: {
-          from_secret: 'quay_token',
-        },
-        PUSHRM_FILE: 'README.md',
-        PUSHRM_TARGET: 'quay.io/thegeeklab/${DRONE_REPO_NAME}',
-      },
-      when: {
-        status: ['success'],
-      },
-    },
-    {
-      name: 'matrix',
-      image: 'plugins/matrix',
-      settings: {
-        homeserver: { from_secret: 'matrix_homeserver' },
-        roomid: { from_secret: 'matrix_roomid' },
-        template: 'Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}',
-        username: { from_secret: 'matrix_username' },
-        password: { from_secret: 'matrix_password' },
-      },
-      when: {
-        status: ['success', 'failure'],
-      },
-    },
-  ],
-  depends_on: [
-    'docs',
-  ],
-  trigger: {
-    ref: ['refs/heads/main', 'refs/tags/**'],
-    status: ['success', 'failure'],
-  },
-};
-
-[
-  PipelineLint,
-  PipelineTest,
-  PipelineSecurity,
-  PipelineBuildPackage,
-  PipelineBuildContainer(arch='amd64'),
-  PipelineBuildContainer(arch='arm64'),
-  PipelineBuildContainer(arch='arm'),
-  PipelineDocs,
-  PipelineNotifications,
-]

.drone.yml

@@ -1,590 +0,0 @@
----
-kind: pipeline
-name: lint
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: yapf
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry run yapf -dr ./prometheuspvesd
-  environment:
-    PY_COLORS: 1
-
-- name: flake8
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry run flake8 ./prometheuspvesd
-  environment:
-    PY_COLORS: 1
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
----
-kind: pipeline
-name: test
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: fetch
-  image: python:3.9
-  commands:
-  - git fetch -tq
-
-- name: python36-pytest
-  image: python:3.6
-  commands:
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry version
-  - poetry run prometheus-pve-sd --help
-  environment:
-    PY_COLORS: 1
-  depends_on:
-  - fetch
-
-- name: python37-pytest
-  image: python:3.7
-  commands:
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry version
-  - poetry run prometheus-pve-sd --help
-  environment:
-    PY_COLORS: 1
-  depends_on:
-  - fetch
-
-- name: python38-pytest
-  image: python:3.8
-  commands:
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry version
-  - poetry run prometheus-pve-sd --help
-  environment:
-    PY_COLORS: 1
-  depends_on:
-  - fetch
-
-- name: python39-pytest
-  image: python:3.9
-  commands:
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry version
-  - poetry run prometheus-pve-sd --help
-  environment:
-    PY_COLORS: 1
-  depends_on:
-  - fetch
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- lint
-
----
-kind: pipeline
-name: security
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: bandit
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry config experimental.new-installer false
-  - poetry install
-  - poetry run bandit -r ./prometheuspvesd -x ./prometheuspvesd/test
-  environment:
-    PY_COLORS: 1
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- test
-
----
-kind: pipeline
-name: build-package
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: build
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry build
-
-- name: checksum
-  image: alpine
-  commands:
-  - cd dist/ && sha256sum * > ../sha256sum.txt
-
-- name: changelog-generate
-  image: thegeeklab/git-chglog
-  commands:
-  - git fetch -tq
-  - git-chglog --no-color --no-emoji -o CHANGELOG.md ${DRONE_TAG:---next-tag unreleased unreleased}
-
-- name: changelog-format
-  image: thegeeklab/alpine-tools
-  commands:
-  - prettier CHANGELOG.md
-  - prettier -w CHANGELOG.md
-
-- name: publish-github
-  image: plugins/github-release
-  settings:
-    api_key:
-      from_secret: github_token
-    files:
-    - dist/*
-    - sha256sum.txt
-    note: CHANGELOG.md
-    overwrite: true
-    title: ${DRONE_TAG}
-  when:
-    ref:
-    - refs/tags/**
-
-- name: publish-pypi
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry publish -n
-  environment:
-    POETRY_HTTP_BASIC_PYPI_PASSWORD:
-      from_secret: pypi_password
-    POETRY_HTTP_BASIC_PYPI_USERNAME:
-      from_secret: pypi_username
-  when:
-    ref:
-    - refs/tags/**
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- security
-
----
-kind: pipeline
-name: build-container-amd64
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: build
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry build
-
-- name: dryrun
-  image: thegeeklab/drone-docker:19
-  settings:
-    dockerfile: docker/Dockerfile.amd64
-    dry_run: true
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/pull/**
-  depends_on:
-  - build
-
-- name: publish-dockerhub
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: amd64
-    dockerfile: docker/Dockerfile.amd64
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-- name: publish-quay
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: amd64
-    dockerfile: docker/Dockerfile.amd64
-    password:
-      from_secret: quay_password
-    registry: quay.io
-    repo: quay.io/thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: quay_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- security
-
----
-kind: pipeline
-name: build-container-arm64
-
-platform:
-  os: linux
-  arch: arm64
-
-steps:
-- name: build
-  image: python:3.9
-  commands:
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry build
-
-- name: dryrun
-  image: thegeeklab/drone-docker:19
-  settings:
-    dockerfile: docker/Dockerfile.arm64
-    dry_run: true
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/pull/**
-  depends_on:
-  - build
-
-- name: publish-dockerhub
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: arm64
-    dockerfile: docker/Dockerfile.arm64
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-- name: publish-quay
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: arm64
-    dockerfile: docker/Dockerfile.arm64
-    password:
-      from_secret: quay_password
-    registry: quay.io
-    repo: quay.io/thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: quay_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- security
-
----
-kind: pipeline
-name: build-container-arm
-
-platform:
-  os: linux
-  arch: arm
-
-steps:
-- name: build
-  image: python:3.9-alpine
-  commands:
-  - apk add -Uq --no-cache build-base libressl-dev libffi-dev musl-dev python3-dev git cargo
-  - git fetch -tq
-  - pip install poetry poetry-dynamic-versioning -qq
-  - poetry build
-  environment:
-    CARGO_NET_GIT_FETCH_WITH_CLI: true
-
-- name: dryrun
-  image: thegeeklab/drone-docker:19
-  settings:
-    dockerfile: docker/Dockerfile.arm
-    dry_run: true
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/pull/**
-  depends_on:
-  - build
-
-- name: publish-dockerhub
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: arm
-    dockerfile: docker/Dockerfile.arm
-    password:
-      from_secret: docker_password
-    repo: thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: docker_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-- name: publish-quay
-  image: thegeeklab/drone-docker:19
-  settings:
-    auto_tag: true
-    auto_tag_suffix: arm
-    dockerfile: docker/Dockerfile.arm
-    password:
-      from_secret: quay_password
-    registry: quay.io
-    repo: quay.io/thegeeklab/${DRONE_REPO_NAME}
-    username:
-      from_secret: quay_username
-  when:
-    ref:
-    - refs/heads/main
-    - refs/tags/**
-  depends_on:
-  - dryrun
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- security
-
----
-kind: pipeline
-name: docs
-
-platform:
-  os: linux
-  arch: amd64
-
-concurrency:
-  limit: 1
-
-steps:
-- name: assets
-  image: thegeeklab/alpine-tools
-  commands:
-  - make doc
-
-- name: markdownlint
-  image: thegeeklab/markdownlint-cli
-  commands:
-  - markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md'
-
-- name: spellcheck
-  image: node:lts-alpine
-  commands:
-  - npm install -g spellchecker-cli
-  - spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions
-  environment:
-    FORCE_COLOR: true
-    NPM_CONFIG_LOGLEVEL: error
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  - refs/pull/**
-
-depends_on:
-- build-package
-- build-container-amd64
-- build-container-arm64
-- build-container-arm
-
----
-kind: pipeline
-name: notifications
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-- name: manifest-dockerhub
-  image: plugins/manifest
-  settings:
-    auto_tag: true
-    ignore_missing: true
-    password:
-      from_secret: docker_password
-    spec: docker/manifest.tmpl
-    username:
-      from_secret: docker_username
-  when:
-    status:
-    - success
-
-- name: manifest-quay
-  image: plugins/manifest
-  settings:
-    auto_tag: true
-    ignore_missing: true
-    password:
-      from_secret: quay_password
-    spec: docker/manifest-quay.tmpl
-    username:
-      from_secret: quay_username
-  when:
-    status:
-    - success
-
-- name: pushrm-dockerhub
-  pull: always
-  image: chko/docker-pushrm:1
-  environment:
-    DOCKER_PASS:
-      from_secret: docker_password
-    DOCKER_USER:
-      from_secret: docker_username
-    PUSHRM_FILE: README.md
-    PUSHRM_SHORT: Prometheus Service Discovery for Proxmox VE
-    PUSHRM_TARGET: thegeeklab/${DRONE_REPO_NAME}
-  when:
-    status:
-    - success
-
-- name: pushrm-quay
-  pull: always
-  image: chko/docker-pushrm:1
-  environment:
-    APIKEY__QUAY_IO:
-      from_secret: quay_token
-    PUSHRM_FILE: README.md
-    PUSHRM_TARGET: quay.io/thegeeklab/${DRONE_REPO_NAME}
-  when:
-    status:
-    - success
-
-- name: matrix
-  image: plugins/matrix
-  settings:
-    homeserver:
-      from_secret: matrix_homeserver
-    password:
-      from_secret: matrix_password
-    roomid:
-      from_secret: matrix_roomid
-    template: "Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}"
-    username:
-      from_secret: matrix_username
-  when:
-    status:
-    - success
-    - failure
-
-trigger:
-  ref:
-  - refs/heads/main
-  - refs/tags/**
-  status:
-  - success
-  - failure
-
-depends_on:
-- docs
-
----
-kind: signature
-hmac: b6ecc59cd94c224bbd990f1d6be90ec6c28e8faf121b37c56f47fa9befb77ad8
-
-...

.github/settings.yml

@@ -1,6 +1,7 @@
 repository:
   name: prometheus-pve-sd
   description: Prometheus Service Discovery for Proxmox VE
+  homepage: https://prometheus-pve-sd.geekdocs.de
   topics: prometheus, proxmox, metrics, sd, python
 
   private: false
@@ -51,6 +52,11 @@ branches:
       required_status_checks:
         strict: false
         contexts:
-          - continuous-integration/drone/pr
-      enforce_admins: null
+          - ci/woodpecker/pr/lint
+          - ci/woodpecker/pr/test
+          - ci/woodpecker/pr/build-package
+          - ci/woodpecker/pr/build-container
+          - ci/woodpecker/pr/docs
+      enforce_admins: false
+      required_linear_history: true
       restrictions: null

.gitignore

@@ -106,6 +106,8 @@ pip-wheel-metadata
 docs/themes/
 docs/public/
 resources/_gen/
+.hugo_build.lock
 
 # Misc
 CHANGELOG.md
+.ruff_cache

.gitsv/config.yml

@@ -0,0 +1,47 @@
+---
+version: "1.1"
+
+versioning:
+  update-major: []
+  update-minor: [feat]
+  update-patch: [fix, perf, refactor, chore, test, ci, docs]
+
+tag:
+  pattern: "v%d.%d.%d"
+
+release-notes:
+  sections:
+    - name: Features
+      commit-types: [feat]
+      section-type: commits
+    - name: Bug Fixes
+      commit-types: [fix]
+      section-type: commits
+    - name: Performance Improvements
+      commit-types: [perf]
+      section-type: commits
+    - name: Code Refactoring
+      commit-types: [refactor]
+      section-type: commits
+    - name: Others
+      commit-types: [chore]
+      section-type: commits
+    - name: Testing
+      commit-types: [test]
+      section-type: commits
+    - name: CI Pipeline
+      commit-types: [ci]
+      section-type: commits
+    - name: Documentation
+      commit-types: [docs]
+      section-type: commits
+    - name: Breaking Changes
+      section-type: breaking-changes
+
+commit-message:
+  footer:
+    issue:
+      key: issue
+      add-value-prefix: "#"
+  issue:
+    regex: "#?[0-9]+"

.lycheeignore

@@ -0,0 +1 @@
+https://hub.docker.com/r/thegeeklab/*

.prettierignore

@@ -1,2 +1,2 @@
-.drone.yml
 *.tpl.md
+LICENSE

.woodpecker/build-container.yml

@@ -0,0 +1,73 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: build
+    image: docker.io/library/python:3.12
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry build
+
+  - name: dryrun
+    image: quay.io/thegeeklab/wp-docker-buildx:4
+    settings:
+      containerfile: Containerfile.multiarch
+      dry_run: true
+      platforms:
+        - linux/amd64
+        - linux/arm64
+      provenance: false
+      repo: ${CI_REPO}
+    when:
+      - event: [pull_request]
+
+  - name: publish-dockerhub
+    image: quay.io/thegeeklab/wp-docker-buildx:4
+    group: container
+    settings:
+      auto_tag: true
+      containerfile: Containerfile.multiarch
+      password:
+        from_secret: docker_password
+      platforms:
+        - linux/amd64
+        - linux/arm64
+      provenance: false
+      repo: ${CI_REPO}
+      username:
+        from_secret: docker_username
+    when:
+      - event: [tag]
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+
+  - name: publish-quay
+    image: quay.io/thegeeklab/wp-docker-buildx:4
+    group: container
+    settings:
+      auto_tag: true
+      containerfile: Containerfile.multiarch
+      password:
+        from_secret: quay_password
+      platforms:
+        - linux/amd64
+        - linux/arm64
+      provenance: false
+      registry: quay.io
+      repo: quay.io/${CI_REPO}
+      username:
+        from_secret: quay_username
+    when:
+      - event: [tag]
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+
+depends_on:
+  - lint
+  - test

.woodpecker/build-package.yml

@@ -0,0 +1,56 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: build
+    image: docker.io/library/python:3.12
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry build
+
+  - name: checksum
+    image: quay.io/thegeeklab/alpine-tools
+    commands:
+      - cd dist/ && sha256sum * > ../sha256sum.txt
+
+  - name: changelog
+    image: quay.io/thegeeklab/git-sv
+    commands:
+      - git sv current-version
+      - git sv release-notes -t ${CI_COMMIT_TAG:-next} -o CHANGELOG.md
+      - cat CHANGELOG.md
+
+  - name: publish-github
+    image: docker.io/plugins/github-release
+    settings:
+      api_key:
+        from_secret: github_token
+      files:
+        - dist/*
+        - sha256sum.txt
+      note: CHANGELOG.md
+      overwrite: true
+      title: ${CI_COMMIT_TAG}
+    when:
+      - event: [tag]
+
+  - name: publish-pypi
+    image: docker.io/library/python:3.12
+    secrets:
+      - source: pypi_password
+        target: POETRY_HTTP_BASIC_PYPI_PASSWORD
+      - source: pypi_username
+        target: POETRY_HTTP_BASIC_PYPI_USERNAME
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry publish -n
+    when:
+      - event: [tag]
+
+depends_on:
+  - lint
+  - test

.woodpecker/docs.yml

@@ -0,0 +1,100 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: assets
+    image: quay.io/thegeeklab/alpine-tools
+    commands:
+      - make doc
+
+  - name: markdownlint
+    image: quay.io/thegeeklab/markdownlint-cli
+    group: test
+    commands:
+      - markdownlint 'README.md' 'CONTRIBUTING.md'
+
+  - name: spellcheck
+    image: quay.io/thegeeklab/alpine-tools
+    group: test
+    commands:
+      - spellchecker --files 'docs/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls
+    environment:
+      FORCE_COLOR: "true"
+
+  - name: link-validation
+    image: docker.io/lycheeverse/lychee
+    group: test
+    commands:
+      - lychee --no-progress --format detailed docs/content README.md
+
+  - name: build
+    image: quay.io/thegeeklab/hugo:0.125.7
+    commands:
+      - hugo --panicOnWarning -s docs/
+
+  - name: beautify
+    image: quay.io/thegeeklab/alpine-tools
+    commands:
+      - html-beautify -r -f 'docs/public/**/*.html'
+    environment:
+      FORCE_COLOR: "true"
+
+  - name: publish
+    image: quay.io/thegeeklab/wp-s3-action
+    settings:
+      access_key:
+        from_secret: s3_access_key
+      bucket: geekdocs
+      delete: true
+      endpoint:
+        from_secret: s3_endpoint
+      path_style: true
+      secret_key:
+        from_secret: s3_secret_access_key
+      source: docs/public/
+      strip_prefix: docs/public/
+      target: /${CI_REPO_NAME}
+    when:
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+        status: [success, failure]
+
+  - name: pushrm-dockerhub
+    image: docker.io/chko/docker-pushrm:1
+    secrets:
+      - source: docker_password
+        target: DOCKER_PASS
+      - source: docker_username
+        target: DOCKER_USER
+    environment:
+      PUSHRM_FILE: README.md
+      PUSHRM_SHORT: Prometheus Service Discovery for Proxmox VE
+      PUSHRM_TARGET: ${CI_REPO}
+    when:
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+        status: [success]
+
+  - name: pushrm-quay
+    image: docker.io/chko/docker-pushrm:1
+    secrets:
+      - source: quay_token
+        target: APIKEY__QUAY_IO
+    environment:
+      PUSHRM_FILE: README.md
+      PUSHRM_TARGET: quay.io/${CI_REPO}
+    when:
+      - event: [push, manual]
+        branch:
+          - ${CI_REPO_DEFAULT_BRANCH}
+        status: [success]
+
+depends_on:
+  - build-package
+  - build-container

.woodpecker/lint.yml

@@ -0,0 +1,25 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+steps:
+  - name: check-format
+    image: docker.io/library/python:3.12
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry install
+      - poetry run ruff format --check --diff ./${CI_REPO_NAME//-/}
+    environment:
+      PY_COLORS: "1"
+
+  - name: check-coding
+    image: docker.io/library/python:3.12
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry install
+      - poetry run ruff check ./${CI_REPO_NAME//-/}
+    environment:
+      PY_COLORS: "1"

.woodpecker/notify.yml

@@ -0,0 +1,26 @@
+---
+when:
+  - event: [tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+runs_on: [success, failure]
+
+steps:
+  - name: matrix
+    image: quay.io/thegeeklab/wp-matrix
+    settings:
+      homeserver:
+        from_secret: matrix_homeserver
+      password:
+        from_secret: matrix_password
+      roomid:
+        from_secret: matrix_roomid
+      username:
+        from_secret: matrix_username
+    when:
+      - status: [success, failure]
+
+depends_on:
+  - docs

.woodpecker/test.yml

@@ -0,0 +1,39 @@
+---
+when:
+  - event: [pull_request, tag]
+  - event: [push, manual]
+    branch:
+      - ${CI_REPO_DEFAULT_BRANCH}
+
+variables:
+  - &pytest_base
+    group: pytest
+    commands:
+      - pip install poetry poetry-dynamic-versioning -qq
+      - poetry install
+      - poetry run pytest --cov-append
+      - poetry version
+      - poetry run ${CI_REPO_NAME} --help
+    environment:
+      PY_COLORS: "1"
+
+steps:
+  - name: python-312
+    image: docker.io/library/python:3.12
+    <<: *pytest_base
+
+  - name: python-311
+    image: docker.io/library/python:3.11
+    <<: *pytest_base
+
+  - name: python-310
+    image: docker.io/library/python:3.10
+    <<: *pytest_base
+
+  - name: python-39
+    image: docker.io/library/python:3.9
+    <<: *pytest_base
+
+  - name: python-38
+    image: docker.io/library/python:3.8
+    <<: *pytest_base

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 ## Security
 
 If you think you have found a **security issue**, please do not mention it in this repository.
-Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential.
+Instead, send an email to `security@thegeeklab.de` with as many details as possible so it can be handled confidential.
 
 ## Bug Reports and Feature Requests
 

Containerfile.multiarch

@@ -1,4 +1,4 @@
-FROM amd64/python:3.9-alpine@sha256:d2dfb8f0a8b3ab3e2899bba05e53c2b16bc1b8c1fca83637266edb8d1a57dc86
+FROM python:3.12-alpine@sha256:5365725a6cd59b72a927628fdda9965103e3dc671676c89ef3ed8b8b0e22e812
 
 LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>"
 LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>"
@@ -8,10 +8,11 @@ LABEL org.opencontainers.image.source="https://github.com/thegeeklab/prometheus-
 LABEL org.opencontainers.image.documentation="https://github.com/thegeeklab/prometheus-pve-sd/"
 
 ENV PY_COLORS=1
+ENV TZ=UTC
 
 ADD dist/prometheus_pve_sd-*.whl /
 
-RUN apk update && \
+RUN apk --update add --virtual .build-deps build-base libffi-dev openssl-dev && \
     pip install --upgrade --no-cache-dir pip && \
     pip install --no-cache-dir $(find / -name "prometheus_pve_sd-*.whl") && \
     rm -f prometheus_pve_sd-*.whl && \

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Robert Kaussow <mail@thegeeklab.de>
+Copyright (c) 2022 Robert Kaussow <mail@thegeeklab.de>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,5 +1,5 @@
 # renovate: datasource=github-releases depName=thegeeklab/hugo-geekdoc
-THEME_VERSION := v0.13.5
+THEME_VERSION := v0.45.0
 THEME := hugo-geekdoc
 BASEDIR := docs
 THEMEDIR := $(BASEDIR)/themes
@@ -17,4 +17,4 @@ doc-assets:
 
 .PHONY: clean
 clean:
-	rm -rf $(THEMEDIR) && \
+	rm -rf $(THEMEDIR)

README.md

@@ -2,7 +2,7 @@
 
 Prometheus Service Discovery for Proxmox VE
 
-[![Build Status](https://img.shields.io/drone/build/thegeeklab/prometheus-pve-sd?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/prometheus-pve-sd)
+[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/prometheus-pve-sd/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/prometheus-pve-sd)
 [![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/prometheus-pve-sd)
 [![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/prometheus-pve-sd)
 [![Python Version](https://img.shields.io/pypi/pyversions/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
@@ -12,11 +12,13 @@ Prometheus Service Discovery for Proxmox VE
 [![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/prometheus-pve-sd)
 [![License: MIT](https://img.shields.io/github/license/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/blob/main/LICENSE)
 
-TBD
+This project provides a simple custom service discovery for [Prometheus](https://prometheus.io/). It is using the [Proxmox VE](https://www.proxmox.com/de/proxmox-ve) (PVE) API to fetch Hosts and it's meta information to generate a Prometheus compatible [file based](https://prometheus.io/docs/guides/file-sd/) service discovery. Releases are available as Python Packages on [GitHub](https://github.com/thegeeklab/prometheus-pve-sd/releases) or [PyPI](https://pypi.org/project/prometheus-pve-sd/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/thegeeklab/prometheus-pve-sd).
+
+You can find the full documentation at [https://prometheus-pve-sd.geekdocs.de](https://prometheus-pve-sd.geekdocs.de).
 
 ## Contributors
 
-Special thanks goes to all [contributors](https://github.com/thegeeklab/prometheus-pve-sd/graphs/contributors). If you would like to contribute,
+Special thanks to all [contributors](https://github.com/thegeeklab/prometheus-pve-sd/graphs/contributors). If you would like to contribute,
 please see the [instructions](https://github.com/thegeeklab/prometheus-pve-sd/blob/main/CONTRIBUTING.md).
 
 ## License

docker/Dockerfile.arm

@@ -1,23 +0,0 @@
-FROM arm32v7/python:3.9-alpine@sha256:183252dde15e315fbe570a5355be839251aa4878b20163c767dd5238de3c988e
-
-LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>"
-LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>"
-LABEL org.opencontainers.image.title="prometheus-pve-sd"
-LABEL org.opencontainers.image.url="https://github.com/thegeeklab/prometheus-pve-sd/"
-LABEL org.opencontainers.image.source="https://github.com/thegeeklab/prometheus-pve-sd/"
-LABEL org.opencontainers.image.documentation="https://github.com/thegeeklab/prometheus-pve-sd/"
-
-ENV PY_COLORS=1
-
-ADD dist/prometheus_pve_sd-*.whl /
-
-RUN apk update && \
-    pip install --upgrade --no-cache-dir pip && \
-    pip install --no-cache-dir $(find / -name "prometheus_pve_sd-*.whl") && \
-    rm -f prometheus_pve_sd-*.whl && \
-    rm -rf /var/cache/apk/* && \
-    rm -rf /root/.cache/
-
-USER root
-CMD []
-ENTRYPOINT ["/usr/local/bin/prometheus-pve-sd"]

docker/Dockerfile.arm64

@@ -1,23 +0,0 @@
-FROM arm64v8/python:3.9-alpine@sha256:2dd55073bf996f367008a7fad490add0343b5c151b708dcf52c133f70ab171a9
-
-LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>"
-LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>"
-LABEL org.opencontainers.image.title="prometheus-pve-sd"
-LABEL org.opencontainers.image.url="https://github.com/thegeeklab/prometheus-pve-sd/"
-LABEL org.opencontainers.image.source="https://github.com/thegeeklab/prometheus-pve-sd/"
-LABEL org.opencontainers.image.documentation="https://github.com/thegeeklab/prometheus-pve-sd/"
-
-ENV PY_COLORS=1
-
-ADD dist/prometheus_pve_sd-*.whl /
-
-RUN apk update && \
-    pip install --upgrade --no-cache-dir pip && \
-    pip install --no-cache-dir $(find / -name "prometheus_pve_sd-*.whl") && \
-    rm -f prometheus_pve_sd-*.whl && \
-    rm -rf /var/cache/apk/* && \
-    rm -rf /root/.cache/
-
-USER root
-CMD []
-ENTRYPOINT ["/usr/local/bin/prometheus-pve-sd"]

docker/manifest-quay.tmpl

@@ -1,24 +0,0 @@
-image: quay.io/thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
-{{#if build.tags}}
-tags:
-{{#each build.tags}}
-  - {{this}}
-{{/each}}
-{{/if}}
-manifests:
-  - image: quay.io/thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}amd64
-    platform:
-      architecture: amd64
-      os: linux
-
-  - image: quay.io/thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm64
-    platform:
-      architecture: arm64
-      os: linux
-      variant: v8
-
-  - image: quay.io/thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm
-    platform:
-      architecture: arm
-      os: linux
-      variant: v7

docker/manifest.tmpl

@@ -1,24 +0,0 @@
-image: thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
-{{#if build.tags}}
-tags:
-{{#each build.tags}}
-  - {{this}}
-{{/each}}
-{{/if}}
-manifests:
-  - image: thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}amd64
-    platform:
-      architecture: amd64
-      os: linux
-
-  - image: thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm64
-    platform:
-      architecture: arm64
-      os: linux
-      variant: v8
-
-  - image: thegeeklab/prometheus-pve-sd:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm
-    platform:
-      architecture: arm
-      os: linux
-      variant: v7

docs/config.yaml

@@ -0,0 +1,37 @@
+---
+baseURL: https://prometheus-pve-sd.geekdocs.de/
+title: prometheus-pve-sd
+theme: hugo-geekdoc
+pygmentsUseClasses: true
+pygmentsCodeFences: true
+
+# Geekdoc configuration
+disablePathToLower: true
+enableGitInfo: true
+
+# Needed for mermaid/katex shortcodes
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+  tableOfContents:
+    startLevel: 1
+
+params:
+  description: >
+    prometheus-pve-sd is a simple custom service discovery for Prometheus. It is using the Proxmox VE API
+    to fetch Hosts and it's meta information to generate a Prometheus compatible file based service discovery.
+  images:
+    - "socialmedia2.png"
+
+  geekdocMenuBundle: true
+  geekdocToC: 3
+
+  geekdocRepo: https://github.com/thegeeklab/prometheus-pve-sd
+  geekdocEditPath: edit/main/docs
+
+  geekdocDateFormat: "Jan 2, 2006"
+  geekdocSearch: true
+
+  geekdocLegalNotice: https://thegeeklab.de/legal-notice/#contact-information
+  geekdocPrivacyPolicy: https://thegeeklab.de/legal-notice/#privacy-policy

docs/content/_index.md

@@ -0,0 +1,15 @@
+---
+title: Documentation
+---
+
+[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/prometheus-pve-sd/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/prometheus-pve-sd)
+[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/prometheus-pve-sd)
+[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/prometheus-pve-sd)
+[![Python Version](https://img.shields.io/pypi/pyversions/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
+[![PyPI Status](https://img.shields.io/pypi/status/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
+[![PyPI Release](https://img.shields.io/pypi/v/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
+[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/graphs/contributors)
+[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/prometheus-pve-sd)
+[![License: MIT](https://img.shields.io/github/license/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/blob/main/LICENSE)
+
+This project provides a simple custom service discovery for [Prometheus](https://prometheus.io/). It is using the [Proxmox VE](https://www.proxmox.com/de/proxmox-ve) (PVE) API to fetch Hosts and it's meta information to generate a Prometheus compatible [file based](https://prometheus.io/docs/guides/file-sd/) service discovery. Releases are available as Python Packages on [GitHub](https://github.com/thegeeklab/prometheus-pve-sd/releases) or [PyPI](https://pypi.org/project/prometheus-pve-sd/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/thegeeklab/prometheus-pve-sd).

docs/content/configuration/_index.md

@@ -0,0 +1,11 @@
+---
+title: Configuration
+---
+
+Changes can be made on different locations which will be processed in the following order (last wins):
+
+- default configuration (build-in)
+- global configuration file (path depends on your operating system)
+- user-defined configuration file
+- environment variables
+- CLI options

docs/content/configuration/cli.md

@@ -0,0 +1,29 @@
+---
+title: CLI options
+---
+
+You can get all available CLI options by running `prometheus-pve-sd --help`:
+
+```Shell
+$ prometheus-pve-sd --help
+usage: prometheus-pve-sd [-h] [-c CONFIG_FILE] [-o OUTPUT_FILE] [-m OUTPUT_FILE_MODE] [-d LOOP_DELAY] [--no-service] [-f LOG_FORMAT] [-v] [-q] [--version]
+
+Prometheus Service Discovery for Proxmox VE
+
+options:
+  -h, --help            show this help message and exit
+  -c CONFIG_FILE, --config CONFIG_FILE
+                        location of configuration file
+  -o OUTPUT_FILE, --output OUTPUT_FILE
+                        output file
+  -m OUTPUT_FILE_MODE, --mode OUTPUT_FILE_MODE
+                        output file mode
+  -d LOOP_DELAY, --loop-delay LOOP_DELAY
+                        delay between discovery runs
+  --no-service          run discovery only once
+  -f LOG_FORMAT, --log-format LOG_FORMAT
+                        used log format
+  -v                    increase log level
+  -q                    decrease log level
+  --version             show program's version number and exit
+```

docs/content/configuration/defaults.md

@@ -0,0 +1,64 @@
+---
+title: Default settings
+---
+
+```Shell
+---
+logging:
+    # Supported log levels: debug|info|warning|error|critical
+    level: warning
+    # Supported log formats: console|json|simple
+    format: console
+
+metrics:
+    enabled: true
+    address: "127.0.0.1"
+    port: 8000
+
+output_file:
+output_file_mode: "0640"
+
+loop_delay: 300
+# Run pve sd in a loop and discover hosts every n seconds (as defined in loop_delay).
+# Can be disabled to run disovery only once.
+service: true
+
+exclude_state: []
+
+# Needs to be a list of strings.
+exclude_vmid: []
+include_vmid: []
+
+# Can be used to exclude vms by tags (proxmox 6+) - needs to be a list of strings.
+# If `include_tags` and `exclude_tags` are set at the same time, the `exclude_tags` option takes precedence.
+# If `include_tags` is set, and your VM don't have any tags set, they will not show up!
+exclude_tags: []
+include_tags: []
+
+# Set either password or token_name and token_value
+pve:
+    server:
+    user:
+    password:
+    token_name:
+    token_value:
+    auth_timeout: 5
+    verify_ssl: true
+
+# Example with password
+# pve:
+#     server: proxmox.example.com
+#     user: root
+#     password: secure
+#     auth_timeout: 5
+#     verify_ssl: true
+
+# Example with API token
+# pve:
+#     server: proxmox.example.com
+#     user: root
+#     token_name: pve_sd
+#     token_value: 01234567-89ab-cdef-0123-456789abcdef
+#     auth_timeout: 5
+#     verify_ssl: true
+```

docs/content/configuration/env.md

@@ -0,0 +1,43 @@
+---
+title: Environment Variables
+---
+
+```Shell
+PROMETHEUS_PVE_SD_CONFIG_FILE=
+
+# supported log levels: debug|info|warning|error|critical
+PROMETHEUS_PVE_SD_LOG_LEVEL=warning
+# supported log formats: console|json|simple
+PROMETHEUS_PVE_SD_LOG_FORMAT=console
+
+PROMETHEUS_PVE_SD_METRICS_ENABLED=true
+PROMETHEUS_PVE_SD_METRICS_ADDRESS=127.0.01
+PROMETHEUS_PVE_SD_METRICS_PORT=8000
+
+PROMETHEUS_PVE_SD_OUTPUT_FILE=
+PROMETHEUS_PVE_SD_OUTPUT_FILE_MODE=0640
+
+PROMETHEUS_PVE_SD_LOOP_DELAY=300
+
+# Run PVE SD in a loop and discover hosts every n seconds (as defined in PROMETHEUS_PVE_SD_LOOP_DELAY).
+# Can be disabled to run disovery only once.
+PROMETHEUS_PVE_SD_SERVICE=true
+
+PROMETHEUS_PVE_SD_EXCLUDE_STATE=
+
+# comma-separated list
+PROMETHEUS_PVE_SD_EXCLUDE_VMID=
+PROMETHEUS_PVE_SD_INCLUDE_VMID=
+
+# comma-separated list
+PROMETHEUS_PVE_SD_EXCLUDE_TAGS=
+PROMETHEUS_PVE_SD_INCLUDE_TAGS=
+
+PROMETHEUS_PVE_SD_PVE_SERVER=
+PROMETHEUS_PVE_SD_PVE_USER=
+PROMETHEUS_PVE_SD_PVE_PASSWORD=
+PROMETHEUS_PVE_SD_PVE_TOKEN_NAME=
+PROMETHEUS_PVE_SD_PVE_TOKEN_VALUE=
+PROMETHEUS_PVE_SD_PVE_AUTH_TIMEOUT=5
+PROMETHEUS_PVE_SD_PVE_VERIFY_SSL=true
+```

docs/content/setup/_index.md

@@ -0,0 +1,3 @@
+---
+title: Setup
+---

docs/content/setup/docker.md

@@ -0,0 +1,23 @@
+---
+title: Using docker
+---
+
+```Shell
+docker run \
+    -e PROMETHEUS_PVE_SD_LOG_LEVEL=info \
+    -e PROMETHEUS_PVE_SD_LOG_FORMAT=console \
+    -e PROMETHEUS_PVE_SD_OUTPUT_FILE=/out/pve.json \
+    -e PROMETHEUS_PVE_SD_SERVICE=false \
+    -e PROMETHEUS_PVE_SD_PVE_SERVER=pve.example.com \
+    -e PROMETHEUS_PVE_SD_PVE_USER=root \
+    -e PROMETHEUS_PVE_SD_PVE_PASSWORD=secure \
+    -e PY_COLORS=1 \
+    -v $(pwd):/out \
+    thegeeklab/prometheus-pve-sd
+```
+
+{{< hint type=note >}}
+Keep in mind, that you have to pass SELinux labels (:Z or :z) to your mount option if you are working on SELinux enabled systems.
+{{< /hint >}}
+
+After configuring and starting the service, Prometheus need to be [configured](/usage/getting-started/#prometheus-configuration) to use the external service discovery.

docs/content/setup/pip.md

@@ -0,0 +1,22 @@
+---
+title: Using pip
+---
+
+```Shell
+# From PyPI as unprivileged user
+$ pip install prometheus-pve-sd --user
+
+# .. or as root
+$ sudo pip install prometheus-pve-sd
+
+# From Wheel file
+$ pip install https://github.com/thegeeklab/prometheus-pve-sd/releases/download/v0.1.0/prometheus_pve_sd-0.1.0-py3-none-any.whl
+```
+
+Start the service:
+
+```Shell
+prometheus-pve-sd -vv --loop-delay 900 -o /etc/prometheus/pve.json
+```
+
+After configuring and starting the service, Prometheus need to be [configured](/usage/getting-started/#prometheus-configuration) to use the external service discovery.

docs/content/setup/prometheus-operator.md

@@ -0,0 +1,80 @@
+---
+title: Using Prometheus Operator
+---
+
+{{< toc >}}
+
+As an alternative to local files service discovery Prometheus also support discoveries form HTTP endpoints. In a Kubernetes setup, with the Prometheus operator, it makes more sense to use this [HTTP SD](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) instead of mounting the output file of the `prometheus-pve-sd` to the container.
+
+The `prometheus-pve-sd` module doesn't have a dedicated HTTP endpoint, therefore you need to use a web server sidecar, that hosts the static file. The following deployment configuration can serve as a starting point for most setups, and just requires some minor adjustments, depending on your Kubernetes setup.
+
+## Kubernetes configuration
+
+Deployment configuration:
+
+```YAML
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  creationTimestamp: null
+  labels:
+    app: proxmox-service-discovery
+  name: proxmox-service-discovery
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: proxmox-service-discovery
+  strategy: {}
+  template:
+    metadata:
+      creationTimestamp: null
+      labels:
+        app: proxmox-service-discovery
+    spec:
+      containers:
+      - image: nginx
+        name: webserver
+        resources: {}
+        ports:
+        - containerPort: 80
+          protocol: TCP
+          name: http
+        volumeMounts:
+        - name: pve-sd-output
+          mountPath: /usr/share/nginx/html
+      - image: thegeeklab/prometheus-pve-sd
+        name: prometheus-pve-sd
+        resources: {}
+        env:
+        - name: PROMETHEUS_PVE_SD_OUTPUT_FILE
+          value: /tmp/pve/proxmox.json
+        # Add more configurations here, or use a configMap or secret to inject the remaining configs
+        volumeMounts:
+        - name: pve-sd-output
+          mountPath: /tmp/pve/
+      volumes:
+        - name: pve-sd-output
+          emptyDir: {}
+status: {}
+```
+
+Additionally you will need a service, that exposes the HTTP endpoint within Kubernetes so Prometheus can scrape it.
+
+Service configuration:
+
+```YAML
+apiVersion: v1
+kind: Service
+metadata:
+  name: pve-sd-service
+spec:
+  selector:
+    app: proxmox-service-discovery
+  ports:
+    - protocol: TCP
+      port: 80
+      targetPort: 80
+```
+
+After configuring and starting the service, Prometheus need to be [configured](/usage/getting-started/#prometheus-configuration) to use the external service discovery.

docs/content/usage/_index.md

@@ -0,0 +1,3 @@
+---
+title: Usage
+---

docs/content/usage/advanced.md

@@ -0,0 +1,54 @@
+---
+title: Getting Started
+---
+
+{{< toc >}}
+
+## Prometheus relabeling
+
+### Use IP address labels
+
+Instead of `__meta_pve_name`, it is also possible to configure Prometheus to use the address provided by `__meta_pve_ipv4` or `__meta_pve_ipv4` for connections:
+
+```YAML
+relabel_configs:
+- replacement: ${1}:9273
+  source_labels:
+  - __meta_pve_ipv4
+  target_label: __address__
+```
+
+### Convert tags to custom labels
+
+Tags of a node exposed by the `__meta_pve_tags` might be useful to build more complex configurations in Prometheus. As an example, an `alert` tag can be extracted to dine alerting routes based on the tag value.
+
+**Example:**
+
+Extract `group` and `alert` from a list of tags like this: `__meta_pve_tags="alert_team-1,group_cluster-1,node_node-1"`
+
+```YAML
+
+relabel_configs:
+- source_labels:
+  - __meta_pve_tags
+  regex: ".*group_([\w\-_]*)"
+  target_label: "group"
+  replacement: "${1}"
+- source_labels:
+  - __meta_pve_tags
+  regex: ".*alert_([\w\-_]*)"
+  target_label: "alert"
+  replacement: "${1}"
+```
+
+Use the extracted `alert` label to set an Alertmanager route:
+
+```YAML
+routes:
+- receiver: "empty"
+  matchers:
+  - alert = muted
+- receiver: "team-1"
+  matchers:
+  - alert = team-1
+```

docs/content/usage/getting-started.md

@@ -0,0 +1,83 @@
+---
+title: Getting Started
+---
+
+{{< toc >}}
+
+## Available Labels
+
+The following list of meta labels can be used to relabel your scrape results:
+
+`__meta_pve_ipv4`
+: Discovered IPv4 address or `False` if not found. To discover the IP address either QEMU guest agent or a cloud-init configuration is required.
+
+`__meta_pve_ipv6`
+: Discovered IPv6 address or `False` if not found. To discover the IP address either QEMU guest agent or a cloud-init configuration is required.
+
+`__meta_pve_name`
+: Name of the node.
+
+`__meta_pve_type`
+: Node type, either `qemu` or `lxc`.
+
+`__meta_pve_vmid`
+: VMID of the node.
+
+`__meta_pve_cpu`
+: Current CPU load of the node.
+
+`__meta_pve_cores`
+: Assigned CPU cores for the node.
+
+`__meta_pve_memory`
+: Assigned RAM for the node.
+
+`__meta_pve_status`
+: Current state of the node.
+
+`__meta_pve_tags`
+: A comma-separated list of tags, as set on the node. The label is not getting exported if no tags were found. (Requires PVE 6+)
+
+`__meta_pve_groups`
+: Groups discovered from the `Notes` field of the node. Need to be a valid JSON string e.g. `{"groups":["group1","group2"]}`.
+
+## Prometheus configuration
+
+### File service discovery
+
+Prometheus needs a basic file service discovery configuration to fetch system metrics from the host's discovered from PVE. Depending on the used metrics exporter the configuration need to be adjusted, using [Telegraf](https://github.com/influxdata/telegraf/) a starter configuration might look like this:
+
+```YAML
+- file_sd_configs:
+  - files:
+    - /opt/prometheus/conf/file_sd/proxmox.json
+  job_name: telegraf-pve
+  metrics_path: /metrics
+  relabel_configs:
+  - replacement: ${1}:9273
+    source_labels:
+    - __meta_pve_name
+    target_label: __address__
+  - source_labels:
+    - __meta_pve_name
+    target_label: instance
+```
+
+### HTTP service discovery
+
+If the static file is served by a web server, e.g. while using the [Prometheus Operator](/setup/prometheus-operator/) setup, a HTTP service discovery configuration is required:
+
+```YAML
+- http_sd_configs:
+    - url: http://pve-sd-service:80/proxmox.json
+  job_name: telegraf-pve
+  metrics_path: /metrics
+  relabel_configs:
+  - replacement: ${1}:9273
+    source_labels:
+    - __meta_pve_name
+    target_label: __address__
+  - source_labels:
+    - __meta_pve_name
+    target_label: instance
+```

docs/data/menu/main.yml

@@ -0,0 +1,25 @@
+---
+main:
+  - name: Setup
+    sub:
+      - name: Using PIP
+        ref: "/setup/pip"
+      - name: Using Docker
+        ref: "/setup/docker"
+      - name: Using  Prometheus Operator
+        ref: "/setup/prometheus-operator"
+  - name: Configuration
+    ref: "/configuration"
+    sub:
+      - name: Default settings
+        ref: "/configuration/defaults"
+      - name: CLI options
+        ref: "/configuration/cli"
+      - name: Environment variables
+        ref: "/configuration/env"
+  - name: Usage
+    sub:
+      - name: Getting Started
+        ref: "/usage/getting-started"
+      - name: Advanced
+        ref: "/usage/advanced"

docs/data/menu/more.yml

@@ -0,0 +1,10 @@
+---
+more:
+  - name: Releases
+    ref: "https://github.com/thegeeklab/prometheus-pve-sd/releases"
+    external: true
+    icon: "gdoc_download"
+  - name: "View Source"
+    ref: "https://github.com/thegeeklab/prometheus-pve-sd"
+    external: true
+    icon: "gdoc_github"

docs/static/.htaccess

@@ -0,0 +1,16 @@
+ErrorDocument 404 /404.html
+
+ExpiresActive On
+ExpiresDefault "access plus 600 seconds"
+ExpiresByType text/css "access plus 1 week"
+ExpiresByType text/javascript "access plus 1 month"
+ExpiresByType text/html "access plus 1 seconds"
+ExpiresByType application/javascript "access plus 1 month"
+ExpiresByType application/x-javascript "access plus 1 month"
+ExpiresByType image/gif "access plus 1 week"
+ExpiresByType image/jpeg "access plus 1 week"
+ExpiresByType image/png "access plus 1 week"
+ExpiresByType image/x-icon "access plus 1 month"
+ExpiresByType image/svg+xml "access plus 1 week"
+ExpiresByType application/x-font-woff "access plus 1 week"
+ExpiresByType application/font-woff2 "access plus 1 week"

prometheuspvesd/cli.py

@@ -6,8 +6,11 @@ import json
 import shutil
 import signal
 import tempfile
+from os import chmod
 from time import sleep
 
+from prometheus_client import start_http_server
+
 import prometheuspvesd.exception
 from prometheuspvesd import __version__
 from prometheuspvesd.config import SingleConfig
@@ -34,11 +37,9 @@ class PrometheusSD:
                 self.discovery = Discovery()
             except APIError as e:
                 if not self.config.config["service"]:
-                    self.log.sysexit_with_message(
-                        "Proxmoxer API error: {0}".format(str(e).strip())
-                    )
+                    self.log.sysexit_with_message(f"Proxmoxer API error: {str(e).strip()}")
 
-                self.logger.error("Proxmoxer API error: {0}".format(str(e).strip()))
+                self.logger.error(f"Proxmoxer API error: {str(e).strip()}")
                 sleep(60)
                 continue
             else:
@@ -58,21 +59,28 @@ class PrometheusSD:
             "--config",
             dest="config_file",
             action="store",
-            help="location of configuration file"
+            help="location of configuration file",
         )
         parser.add_argument(
             "-o", "--output", dest="output_file", action="store", help="output file"
         )
+        parser.add_argument(
+            "-m", "--mode", dest="output_file_mode", action="store", help="output file mode"
+        )
         parser.add_argument(
             "-d",
             "--loop-delay",
             dest="loop_delay",
             action="store",
             type=int,
-            help="delay between discovery runs"
+            help="delay between discovery runs",
         )
         parser.add_argument(
-            "--no-service", dest="service", action="store_false", help="run discovery only once"
+            "--no-service",
+            dest="service",
+            action="store_false",
+            default=None,
+            help="run discovery only once",
         )
         parser.add_argument(
             "-f",
@@ -80,7 +88,7 @@ class PrometheusSD:
             dest="logging.format",
             metavar="LOG_FORMAT",
             action="store",
-            help="used log format"
+            help="used log format",
         )
         parser.add_argument(
             "-v", dest="logging.level", action="append_const", const=-1, help="increase log level"
@@ -88,9 +96,7 @@ class PrometheusSD:
         parser.add_argument(
             "-q", dest="logging.level", action="append_const", const=1, help="decrease log level"
         )
-        parser.add_argument(
-            "--version", action="version", version="%(prog)s {}".format(__version__)
-        )
+        parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
 
         return parser.parse_args().__dict__
 
@@ -105,40 +111,61 @@ class PrometheusSD:
                 config.config["logging"]["level"], config.config["logging"]["format"]
             )
         except ValueError as e:
-            self.log.sysexit_with_message("Can not set log level.\n{}".format(str(e)))
+            self.log.sysexit_with_message(f"Can not set log level.\n{e!s}")
 
-        required = [("pve.server", config.config["pve"]["server"]),
-                    ("pve.user", config.config["pve"]["user"]),
-                    ("pve.password", config.config["pve"]["password"])]
+        required = [
+            ("pve.server", config.config["pve"]["server"]),
+            ("pve.user", config.config["pve"]["user"]),
+        ]
         for name, value in required:
             if not value:
-                self.log.sysexit_with_message("Option '{}' is required but not set".format(name))
+                self.log.sysexit_with_message(f"Option '{name}' is required but not set")
 
-        self.logger.info("Using config file {}".format(config.config_file))
+        if not config.config["pve"]["password"] and not (
+            config.config["pve"]["token_name"] and config.config["pve"]["token_value"]
+        ):
+            self.log.sysexit_with_message(
+                "Either 'pve.password' or 'pve.token_name' and 'pve.token_value' "
+                "are required but not set"
+            )
+
+        self.logger.info(f"Using config file {config.config_file}")
 
         return config
 
     def _fetch(self):
-        loop_delay = self.config.config["loop_delay"]
-        output_file = self.config.config["output_file"]
-
-        self.logger.info("Writes targets to {}".format(output_file))
+        self.logger.info("Writes targets to {}".format(self.config.config["output_file"]))
         self.logger.debug("Propagate from PVE")
 
+        if self.config.config["service"] and self.config.config["metrics"]["enabled"]:
+            self.logger.info(
+                "Starting metrics http endpoint on port {}".format(
+                    self.config.config["metrics"]["port"]
+                )
+            )
+            start_http_server(
+                self.config.config["metrics"]["port"],
+                addr=self.config.config["metrics"]["address"],
+            )
+
         while True:
             try:
                 inventory = self.discovery.propagate()
             except APIError as e:
-                self.logger.error("Proxmoxer API error: {0}".format(str(e).strip()))
+                self.logger.error(f"Proxmoxer API error: {str(e).strip()}")
             except Exception as e:  # noqa
-                self.logger.error("Unknown error: {0}".format(str(e).strip()))
+                self.logger.error(f"Unknown error: {str(e).strip()}")
             else:
                 self._write(inventory)
 
             if not self.config.config["service"]:
                 break
 
-            self.logger.info("Waiting {} seconds for next discovery loop".format(loop_delay))
+            self.logger.info(
+                "Waiting {} seconds for next discovery loop".format(
+                    self.config.config["loop_delay"]
+                )
+            )
             sleep(self.config.config["loop_delay"])
 
     def _write(self, host_list: HostList):
@@ -152,8 +179,9 @@ class PrometheusSD:
             json.dump(output, tf, indent=4)
 
         shutil.move(temp_file.name, self.config.config["output_file"])
+        chmod(self.config.config["output_file"], int(self.config.config["output_file_mode"], 8))
 
-    def _terminate(self, signal, frame):
+    def _terminate(self, signal, frame):  # noqa
         self.log.sysexit_with_message("Terminating", code=0)
 
 

prometheuspvesd/client.py

@@ -0,0 +1,105 @@
+"""Proxmox Client."""
+
+import requests
+from prometheus_client import Counter
+
+from prometheuspvesd.config import SingleConfig
+from prometheuspvesd.exception import APIError
+from prometheuspvesd.logger import SingleLog
+from prometheuspvesd.model import HostList
+from prometheuspvesd.utils import to_bool
+
+try:
+    from proxmoxer import ProxmoxAPI
+
+    HAS_PROXMOXER = True
+except ImportError:
+    HAS_PROXMOXER = False
+
+PVE_REQUEST_COUNT_TOTAL = Counter("pve_sd_requests_total", "Total count of requests to PVE API")
+PVE_REQUEST_COUNT_ERROR_TOTAL = Counter(
+    "pve_sd_requests_error_total", "Total count of failed requests to PVE API"
+)
+
+
+class ProxmoxClient:
+    """Proxmox API Client."""
+
+    def __init__(self):
+        if not HAS_PROXMOXER:
+            self.log.sysexit_with_message(
+                "The Proxmox VE Prometheus SD requires proxmoxer: "
+                "https://pypi.org/project/proxmoxer/"
+            )
+
+        self.config = SingleConfig()
+        self.log = SingleLog()
+        self.logger = SingleLog().logger
+        self.client = self._auth()
+        self.logger.debug("Successfully authenticated")
+        self.host_list = HostList()
+
+    def _auth(self):
+        try:
+            self.logger.debug(
+                "Trying to authenticate against {} as user {}".format(
+                    self.config.config["pve"]["server"], self.config.config["pve"]["user"]
+                )
+            )
+
+            if self.config.config["pve"]["token_name"]:
+                self.logger.debug("Using token login")
+                return ProxmoxAPI(
+                    self.config.config["pve"]["server"],
+                    user=self.config.config["pve"]["user"],
+                    token_name=self.config.config["pve"]["token_name"],
+                    token_value=self.config.config["pve"]["token_value"],
+                    verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
+                    timeout=self.config.config["pve"]["auth_timeout"],
+                )
+
+            return ProxmoxAPI(
+                self.config.config["pve"]["server"],
+                user=self.config.config["pve"]["user"],
+                password=self.config.config["pve"]["password"],
+                verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
+                timeout=self.config.config["pve"]["auth_timeout"],
+            )
+        except requests.RequestException as e:
+            PVE_REQUEST_COUNT_ERROR_TOTAL.inc()
+            raise APIError(str(e)) from e
+
+    def _do_request(self, *args):
+        PVE_REQUEST_COUNT_TOTAL.inc()
+        try:
+            # create a new tuple containing nodes and unpack it again for client.get
+            return self.client.get(*("nodes", *args))
+        except requests.RequestException as e:
+            PVE_REQUEST_COUNT_ERROR_TOTAL.inc()
+            raise APIError(str(e)) from e
+
+    def get_nodes(self):
+        self.logger.debug("fetching all nodes")
+        return self._do_request()
+
+    def get_all_vms(self, pve_node):
+        self.logger.debug(f"fetching all vms on node {pve_node}")
+        return self._do_request(pve_node, "qemu")
+
+    def get_all_containers(self, pve_node):
+        self.logger.debug(f"fetching all containers on node {pve_node}")
+        return self._do_request(pve_node, "lxc")
+
+    def get_instance_config(self, pve_node, pve_type, vmid):
+        self.logger.debug(f"fetching instance config for {vmid} on {pve_node}")
+        return self._do_request(pve_node, pve_type, vmid, "config")
+
+    def get_agent_info(self, pve_node, pve_type, vmid):
+        self.logger.debug(f"fetching agent info for {vmid} on {pve_node}")
+        return self._do_request(pve_node, pve_type, vmid, "agent", "info")["result"]
+
+    def get_network_interfaces(self, pve_node, vmid):
+        self.logger.debug(f"fetching network interfaces for {vmid} on {pve_node}")
+        return self._do_request(pve_node, "qemu", vmid, "agent", "network-get-interfaces")[
+            "result"
+        ]

prometheuspvesd/config.py

@@ -2,8 +2,7 @@
 """Global settings definition."""
 
 import os
-from pathlib import Path
-from pathlib import PurePath
+from pathlib import Path, PurePath
 
 import anyconfig
 import environs
@@ -21,7 +20,7 @@ cache_dir = AppDirs("prometheus-pve-sd").user_cache_dir
 default_output_file = os.path.join(cache_dir, "pve.json")
 
 
-class Config():
+class Config:
     """
     Create an object with all necessary settings.
 
@@ -32,86 +31,137 @@ class Config():
     """
 
     SETTINGS = {
+        "metrics.enabled": {
+            "default": True,
+            "env": "METRICS_ENABLED",
+            "type": environs.Env().bool,
+        },
+        "metrics.address": {
+            "default": "127.0.0.1",
+            "env": "METRICS_ADDRESS",
+            "type": environs.Env().str,
+        },
+        "metrics.port": {
+            "default": 8000,
+            "env": "METRICS_PORT",
+            "type": environs.Env().int,
+        },
         "config_file": {
             "default": "",
             "env": "CONFIG_FILE",
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "logging.level": {
             "default": "WARNING",
             "env": "LOG_LEVEL",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "logging.format": {
             "default": "console",
             "env": "LOG_FORMAT",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "output_file": {
             "default": default_output_file,
             "env": "OUTPUT_FILE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
+        },
+        "output_file_mode": {
+            "default": "0640",
+            "env": "OUTPUT_FILE_MODE",
+            "file": True,
+            "type": environs.Env().str,
         },
         "loop_delay": {
             "default": 300,
             "env": "LOOP_DELAY",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "service": {
             "default": True,
             "env": "SERVICE",
             "file": True,
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
         "exclude_state": {
             "default": [],
             "env": "EXCLUDE_STATE",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "exclude_vmid": {
             "default": [],
-            "env": "EXCLUDE_STATE",
+            "env": "EXCLUDE_VMID",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
+        },
+        "include_vmid": {
+            "default": [],
+            "env": "INCLUDE_VMID",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "exclude_tags": {
+            "default": [],
+            "env": "EXCLUDE_TAGS",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "include_tags": {
+            "default": [],
+            "env": "INCLUDE_TAGS",
+            "file": True,
+            "type": environs.Env().list,
         },
         "pve.server": {
             "default": "",
             "env": "PVE_SERVER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.user": {
             "default": "",
             "env": "PVE_USER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.password": {
             "default": "",
             "env": "PVE_PASSWORD",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
+        },
+        "pve.token_name": {
+            "default": "",
+            "env": "PVE_TOKEN_NAME",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.token_value": {
+            "default": "",
+            "env": "PVE_TOKEN_VALUE",
+            "file": True,
+            "type": environs.Env().str,
         },
         "pve.auth_timeout": {
             "default": 5,
             "env": "PVE_AUTH_TIMEOUT",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "pve.verify_ssl": {
             "default": True,
             "env": "PVE_VERIFY_SSL",
             "file": True,
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
     }
 
-    def __init__(self, args={}):
+    def __init__(self, args=None):
         """
         Initialize a new settings class.
 
@@ -120,7 +170,10 @@ class Config():
         :returns: None
 
         """
-        self._args = args
+        if args is None:
+            self._args = {}
+        else:
+            self._args = args
         self._schema = None
         self.config_file = default_config_file
         self.config = None
@@ -161,12 +214,12 @@ class Config():
                     value = item["type"](envname)
                     normalized = self._add_dict_branch(normalized, key.split("."), value)
                 except environs.EnvError as e:
-                    if '"{}" not set'.format(envname) in str(e):
+                    if f'"{envname}" not set' in str(e):
                         pass
                     else:
                         raise prometheuspvesd.exception.ConfigError(
                             "Unable to read environment variable", str(e)
-                        )
+                        ) from e
 
         return normalized
 
@@ -187,17 +240,18 @@ class Config():
 
         for config in source_files:
             if config and os.path.exists(config):
-                with open(config, "r", encoding="utf8") as stream:
+                with open(config, encoding="utf8") as stream:
                     s = stream.read()
                     try:
-                        file_dict = ruamel.yaml.safe_load(s)
+                        file_dict = ruamel.yaml.YAML(typ="safe", pure=True).load(s)
                     except (
-                        ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
+                        ruamel.yaml.composer.ComposerError,
+                        ruamel.yaml.scanner.ScannerError,
                     ) as e:
-                        message = "{} {}".format(e.context, e.problem)
+                        message = f"{e.context} {e.problem}"
                         raise prometheuspvesd.exception.ConfigError(
-                            "Unable to read config file {}".format(config), message
-                        )
+                            f"Unable to read config file {config}", message
+                        ) from e
 
                     if self._validate(file_dict):
                         anyconfig.merge(defaults, file_dict, ac_merge=anyconfig.MS_DICTS)
@@ -224,27 +278,26 @@ class Config():
         if not os.path.isabs(path):
             base = os.path.join(os.getcwd(), path)
             return os.path.abspath(os.path.expanduser(os.path.expandvars(base)))
-        else:
-            return path
+
+        return path
 
     def _validate(self, config):
         try:
             anyconfig.validate(config, self.schema, ac_schema_safe=False)
         except jsonschema.exceptions.ValidationError as e:
-            schema_error = "Failed validating '{validator}' in schema{schema}\n{message}".format(
-                validator=e.validator,
-                schema=format_as_index(list(e.relative_schema_path)[:-1]),
-                message=e.message
-            )
-            raise prometheuspvesd.exception.ConfigError("Configuration error", schema_error)
+            schema = format_as_index(list(e.relative_schema_path)[:-1], 0)
+            schema_error = f"Failed validating '{e.validator}' in schema {schema}\n{e.message}"
+            raise prometheuspvesd.exception.ConfigError("Configuration error", schema_error) from e
 
         return True
 
     def _add_dict_branch(self, tree, vector, value):
         key = vector[0]
-        tree[key] = value \
-            if len(vector) == 1 \
-            else self._add_dict_branch(tree[key] if key in tree else {}, vector[1:], value)
+        tree[key] = (
+            value
+            if len(vector) == 1
+            else self._add_dict_branch(tree.get(key, {}), vector[1:], value)
+        )
         return tree
 
 

prometheuspvesd/discovery.py

@@ -1,55 +1,35 @@
 #!/usr/bin/env python3
 """Prometheus Discovery."""
 
+import ipaddress
 import json
 import re
-import socket
 from collections import defaultdict
 
-import requests
+from prometheus_client import Gauge, Summary
 
+from prometheuspvesd.client import ProxmoxClient
 from prometheuspvesd.config import SingleConfig
 from prometheuspvesd.exception import APIError
 from prometheuspvesd.logger import SingleLog
-from prometheuspvesd.model import Host
-from prometheuspvesd.model import HostList
-from prometheuspvesd.utils import to_bool
+from prometheuspvesd.model import Host, HostList
 
-try:
-    from proxmoxer import ProxmoxAPI
-    HAS_PROXMOXER = True
-except ImportError:
-    HAS_PROXMOXER = False
+PROPAGATION_TIME = Summary(
+    "pve_sd_propagate_seconds", "Time spent propagating the inventory from PVE"
+)
+HOST_GAUGE = Gauge("pve_sd_hosts", "Number of hosts discovered by PVE SD")
 
 
-class Discovery():
+class Discovery:
     """Prometheus PVE Service Discovery."""
 
     def __init__(self):
-        if not HAS_PROXMOXER:
-            self.log.sysexit_with_message(
-                "The Proxmox VE Prometheus SD requires proxmoxer: "
-                "https://pypi.org/project/proxmoxer/"
-            )
-
         self.config = SingleConfig()
         self.log = SingleLog()
         self.logger = SingleLog().logger
-        self.client = self._auth()
+        self.client = ProxmoxClient()
         self.host_list = HostList()
 
-    def _auth(self):
-        try:
-            return ProxmoxAPI(
-                self.config.config["pve"]["server"],
-                user=self.config.config["pve"]["user"],
-                password=self.config.config["pve"]["password"],
-                verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
-                timeout=self.config.config["pve"]["auth_timeout"]
-            )
-        except requests.RequestException as e:
-            raise APIError(str(e))
-
     def _get_names(self, pve_list, pve_type):
         names = []
 
@@ -72,82 +52,131 @@ class Discovery():
 
         return variables
 
-    def _get_ip_address(self, pve_type, pve_node, vmid):
-
-        def validate(address):
-            try:
-                # IP address validation
-                if socket.inet_aton(address):
-                    # Ignore localhost
-                    if address != "127.0.0.1":
-                        return address
-            except socket.error:
-                return False
-
-        address = False
+    def _get_ip_addresses(self, pve_type, pve_node, vmid):
+        ipv4_address = False
+        ipv6_address = False
         networks = False
         if pve_type == "qemu":
             # If qemu agent is enabled, try to gather the IP address
             try:
-                if self.client.nodes(pve_node).get(pve_type, vmid, "agent", "info") is not None:
-                    networks = self.client.nodes(pve_node).get(
-                        "qemu", vmid, "agent", "network-get-interfaces"
-                    )["result"]
-            except Exception:  # noqa  # nosec
+                if self.client.get_agent_info(pve_node, pve_type, vmid) is not None:
+                    networks = self.client.get_network_interfaces(pve_node, vmid)
+            except Exception:  # noqa
                 pass
 
-            if networks:
-                if type(networks) is list:
-                    for network in networks:
-                        for ip_address in network["ip-addresses"]:
-                            address = validate(ip_address["ip-address"])
+            if isinstance(networks, list):
+                for network in networks:
+                    for ip_address in network.get("ip-addresses", []):
+                        if ip_address["ip-address-type"] == "ipv4" and not ipv4_address:
+                            ipv4_address = self._validate_ip(ip_address["ip-address"])
+                        elif ip_address["ip-address-type"] == "ipv6" and not ipv6_address:
+                            ipv6_address = self._validate_ip(ip_address["ip-address"])
 
-        if not address:
+        config = self.client.get_instance_config(pve_node, pve_type, vmid)
+        if config and not ipv4_address:
             try:
-                config = self.client.nodes(pve_node).get(pve_type, vmid, "config")
-                sources = [config["net0"], config["ipconfig0"]]
+                if "ipconfig0" in config:
+                    sources = [config["net0"], config["ipconfig0"]]
+                else:
+                    sources = [config["net0"]]
 
                 for s in sources:
-                    find = re.search(r"ip=(\d*\.\d*\.\d*\.\d*)", str(sources))
+                    find = re.search(r"ip=(\d*\.\d*\.\d*\.\d*)", str(s))
                     if find and find.group(1):
-                        address = find.group(1)
+                        ipv4_address = find.group(1)
                         break
-            except Exception:  # noqa  # nosec
+            except Exception:  # noqa
                 pass
 
-        return address
+        if config and not ipv6_address:
+            try:
+                if "ipconfig0" in config:
+                    sources = [config["net0"], config["ipconfig0"]]
+                else:
+                    sources = [config["net0"]]
 
-    def _exclude(self, pve_list):
+                for s in sources:
+                    find = re.search(
+                        r"ip=(([a-fA-F0-9]{0,4}:{0,2}){0,7}:[0-9a-fA-F]{1,4})", str(s)
+                    )
+                    if find and find.group(1):
+                        ipv6_address = find.group(1)
+                        break
+            except Exception:  # noqa
+                pass
+
+        return ipv4_address, ipv6_address
+
+    def _filter(self, pve_list):
         filtered = []
         for item in pve_list:
             obj = defaultdict(dict, item)
+            tags = []
+            tags_excl = self.config.config["exclude_tags"]
+
+            if isinstance(obj["tags"], str):
+                tags = obj["tags"].split(";")
+                self.logger.debug(f"vmid {obj['vmid']}: discovered tags: {tags}")
+
+            if (
+                len(self.config.config["include_vmid"]) > 0
+                and str(obj["vmid"]) not in self.config.config["include_vmid"]
+            ):
+                continue
+
+            if len(self.config.config["include_tags"]) > 0 and (
+                bool(obj["tags"]) is False  # continue if tags is not set
+                or set(tags).isdisjoint(self.config.config["include_tags"])
+            ):
+                continue
+
             if obj["template"] == 1:
                 continue
 
-            if obj["status"] in self.config.config["exclude_state"]:
+            if obj["status"] in map(str, self.config.config["exclude_state"]):
                 continue
 
-            if obj["vmid"] in self.config.config["exclude_vmid"]:
+            if str(obj["vmid"]) in self.config.config["exclude_vmid"]:
+                continue
+
+            if isinstance(obj["tags"], str) and not set(tags).isdisjoint(tags_excl):
+                self.logger.debug(
+                    f"vmid {obj['vmid']}: "
+                    f"excluded by tags: {list(set(tags).intersection(tags_excl))}"
+                )
                 continue
 
             filtered.append(item.copy())
         return filtered
 
+    def _validate_ip(self, address: object) -> object:
+        try:
+            if (
+                not ipaddress.ip_address(address).is_loopback
+                and not ipaddress.ip_address(address).is_link_local
+            ):
+                return address
+        except ValueError:
+            return False
+
+    @PROPAGATION_TIME.time()
     def propagate(self):
         self.host_list.clear()
-
-        for node in self._get_names(self.client.nodes.get(), "node"):
+        nodelist = self._get_names(self.client.get_nodes(), "node")
+        self.logger.info(f"Discovered nodes: {','.join(nodelist)}")
+        for node in nodelist:
             try:
-                qemu_list = self._exclude(self.client.nodes(node).qemu.get())
-                container_list = self._exclude(self.client.nodes(node).lxc.get())
-            except Exception as e:  # noqa
-                raise APIError(str(e))
+                qemu_list = self._filter(self.client.get_all_vms(node))
+                container_list = self._filter(self.client.get_all_containers(node))
+            except Exception as e:
+                raise APIError(str(e)) from e
 
             # Merge QEMU and Containers lists from this node
             instances = self._get_variables(qemu_list, "qemu").copy()
             instances.update(self._get_variables(container_list, "container"))
 
-            self.logger.info("Found {} targets".format(len(instances)))
+            HOST_GAUGE.set(len(instances))
+            self.logger.info(f"{node}: Found {len(instances)} targets")
             for host in instances:
                 host_meta = instances[host]
                 vmid = host_meta["proxmox_vmid"]
@@ -157,14 +186,14 @@ class Discovery():
                 except KeyError:
                     pve_type = "qemu"
 
-                config = self.client.nodes(node).get(pve_type, vmid, "config")
+                config = self.client.get_instance_config(node, pve_type, vmid)
 
                 try:
-                    description = (config["description"])
+                    description = config["description"]
                 except KeyError:
                     description = None
-                except Exception as e:  # noqa
-                    raise APIError(str(e))
+                except Exception as e:
+                    raise APIError(str(e)) from e
 
                 try:
                     metadata = json.loads(description)
@@ -173,12 +202,12 @@ class Discovery():
                 except ValueError:
                     metadata = {"notes": description}
 
-                address = self._get_ip_address(pve_type, node, vmid) or host
+                ipv4_address, ipv6_address = self._get_ip_addresses(pve_type, node, vmid)
 
-                prom_host = Host(vmid, host, address, pve_type)
+                prom_host = Host(vmid, host, ipv4_address, ipv6_address, pve_type)
 
                 config_flags = [("cpu", "sockets"), ("cores", "cores"), ("memory", "memory")]
-                meta_flags = [("status", "proxmox_status")]
+                meta_flags = [("status", "proxmox_status"), ("tags", "proxmox_tags")]
 
                 for key, flag in config_flags:
                     if flag in config:
@@ -192,6 +221,6 @@ class Discovery():
                     prom_host.add_label("groups", ",".join(metadata["groups"]))
 
                 self.host_list.add_host(prom_host)
-                self.logger.debug("Discovered {}".format(prom_host))
+                self.logger.debug(f"Discovered {prom_host}")
 
         return self.host_list

prometheuspvesd/exception.py

@@ -3,11 +3,10 @@
 
 
 class PrometheusSDError(Exception):
-    """Generic exception class for promtheus-pve-sd."""
+    """Generic exception class for Prometheus-pve-sd."""
 
     def __init__(self, msg, original_exception=""):
-        super(PrometheusSDError,
-              self).__init__("{msg}\n{org}".format(msg=msg, org=original_exception))
+        super().__init__(f"{msg}\n{original_exception}")
         self.original_exception = original_exception
 
 

prometheuspvesd/logger.py

@@ -8,8 +8,7 @@ import sys
 import colorama
 from pythonjsonlogger import jsonlogger
 
-from prometheuspvesd.utils import Singleton
-from prometheuspvesd.utils import to_bool
+from prometheuspvesd.utils import Singleton, to_bool
 
 CONSOLE_FORMAT = "{}{}[%(levelname)s]{} %(message)s"
 JSON_FORMAT = "%(asctime)s %(levelname)s %(message)s"
@@ -26,7 +25,7 @@ def _should_do_markup():
 colorama.init(autoreset=True, strip=not _should_do_markup())
 
 
-class LogFilter(object):
+class LogFilter:
     """A custom log filter which excludes log messages above the logged level."""
 
     def __init__(self, level):
@@ -47,22 +46,22 @@ class LogFilter(object):
 class SimpleFormatter(logging.Formatter):
     """Logging Formatter for simple logs."""
 
-    def format(self, record):  # noqa
+    def format(self, record):
         return logging.Formatter.format(self, record)
 
 
 class MultilineFormatter(logging.Formatter):
     """Logging Formatter to reset color after newline characters."""
 
-    def format(self, record):  # noqa
-        record.msg = record.msg.replace("\n", "\n{}... ".format(colorama.Style.RESET_ALL))
+    def format(self, record):
+        record.msg = record.msg.replace("\n", f"\n{colorama.Style.RESET_ALL}... ")
         return logging.Formatter.format(self, record)
 
 
 class MultilineJsonFormatter(jsonlogger.JsonFormatter):
     """Logging Formatter to remove newline characters."""
 
-    def format(self, record):  # noqa
+    def format(self, record):
         record.msg = record.msg.replace("\n", " ")
         return jsonlogger.JsonFormatter.format(self, record)
 
@@ -70,11 +69,11 @@ class MultilineJsonFormatter(jsonlogger.JsonFormatter):
 class Log:
     """Handle logging."""
 
-    def __init__(self, level=logging.WARN, name="prometheuspvesd", log_format="console"):
+    def __init__(self, level=logging.WARNING, name="prometheuspvesd", log_format="console"):
         self.logger = logging.getLogger(name)
         self.logger.setLevel(level)
         self.logger.addHandler(self._get_error_handler(log_format))
-        self.logger.addHandler(self._get_warn_handler(log_format))
+        self.logger.addHandler(self._get_warning_handler(log_format))
         self.logger.addHandler(self._get_info_handler(log_format))
         self.logger.addHandler(self._get_critical_handler(log_format))
         self.logger.addHandler(self._get_debug_handler(log_format))
@@ -102,10 +101,10 @@ class Log:
 
         return handler
 
-    def _get_warn_handler(self, log_format):
+    def _get_warning_handler(self, log_format):
         handler = logging.StreamHandler(sys.stdout)
-        handler.setLevel(logging.WARN)
-        handler.addFilter(LogFilter(logging.WARN))
+        handler.setLevel(logging.WARNING)
+        handler.addFilter(LogFilter(logging.WARNING))
 
         if log_format == "json":
             handler.setFormatter(MultilineJsonFormatter(JSON_FORMAT))
@@ -114,7 +113,7 @@ class Log:
         else:
             handler.setFormatter(
                 MultilineFormatter(
-                    self.warn(
+                    self.warning(
                         CONSOLE_FORMAT.format(
                             colorama.Fore.YELLOW, colorama.Style.BRIGHT, colorama.Style.RESET_ALL
                         )
@@ -196,7 +195,7 @@ class Log:
 
         self.logger.setLevel(level)
         self.logger.addHandler(self._get_error_handler(log_level))
-        self.logger.addHandler(self._get_warn_handler(log_level))
+        self.logger.addHandler(self._get_warning_handler(log_level))
         self.logger.addHandler(self._get_info_handler(log_level))
         self.logger.addHandler(self._get_critical_handler(log_level))
         self.logger.addHandler(self._get_debug_handler(log_level))
@@ -213,8 +212,8 @@ class Log:
         """Format error messages and return string."""
         return msg
 
-    def warn(self, msg):
-        """Format warn messages and return string."""
+    def warning(self, msg):
+        """Format warning messages and return string."""
         return msg
 
     def info(self, msg):
@@ -230,7 +229,7 @@ class Log:
         :returns: string
 
         """
-        return "{}{}{}".format(color, msg, colorama.Style.RESET_ALL)
+        return f"{color}{msg}{colorama.Style.RESET_ALL}"
 
     def sysexit(self, code=1):
         sys.exit(code)

prometheuspvesd/model.py

@@ -5,19 +5,24 @@
 class Host:
     """Represents a virtual machine or container in PVE."""
 
-    def __init__(self, vmid, hostname, ip_address, pve_type):
-        self.hostname = hostname
-        self.ip_address = ip_address
-        self.vmid = vmid
-        self.pve_type = pve_type
+    def __init__(self, vmid, hostname, ipv4_address, ipv6_address, pve_type):
+        self.hostname = str(hostname)
+        self.ipv4_address = str(ipv4_address)
+        self.ipv6_address = str(ipv6_address)
+        self.vmid = str(vmid)
+        self.pve_type = str(pve_type)
         self.labels = {}
-        self.labels["__meta_pve_ip"] = ip_address
-        self.labels["__meta_pve_name"] = hostname
-        self.labels["__meta_pve_type"] = pve_type
-        self.labels["__meta_pve_vmid"] = str(vmid)
+        self.add_label("ipv4", ipv4_address)
+        self.add_label("ipv6", ipv6_address)
+        self.add_label("name", hostname)
+        self.add_label("type", pve_type)
+        self.add_label("vmid", vmid)
 
     def __str__(self):
-        return f"{self.hostname}({self.vmid}): {self.pve_type} {self.ip_address}"
+        return (
+            f"{self.hostname}({self.vmid}): "
+            f"{self.pve_type} {self.ipv4_address} {self.ipv6_address}"
+        )
 
     def add_label(self, key, value):
         key = key.replace("-", "_").replace(" ", "_")
@@ -33,6 +38,20 @@ class HostList:
     def __init__(self):
         self.hosts = []
 
+    def __eq__(self, other):
+        if not isinstance(other, HostList):
+            return False
+
+        if len(other.hosts) != len(self.hosts):
+            return False
+
+        for host in self.hosts:
+            if other.host_exists(host):
+                continue
+            return False
+
+        return True
+
     def clear(self):
         self.hosts = []
 

prometheuspvesd/test/__init__.py

@@ -0,0 +1 @@
+"""Init pytest unit tests."""

prometheuspvesd/test/data/config.yml

@@ -0,0 +1,30 @@
+---
+logging:
+  level: warning
+  format: console
+
+metrics:
+  enabled: true
+  address: "127.0.0.1"
+  port: 8000
+
+output_file: dummy
+output_file_mode: "0640"
+loop_delay: 300
+service: true
+
+exclude_state: []
+exclude_vmid: []
+exclude_tags: []
+
+include_vmid: []
+include_tags: []
+
+pve:
+  server: proxmox.example.com
+  user: root
+  password: secure
+  token_name: pve_sd
+  token_value: 01234567-89ab-cdef-0123-456789abcdef
+  auth_timeout: 5
+  verify_ssl: true

prometheuspvesd/test/fixtures/__init__.py

@@ -0,0 +1 @@
+"""Init pytest fixtures."""

prometheuspvesd/test/fixtures/fixtures.py

@@ -0,0 +1,377 @@
+"""Global pytest fixtures."""
+
+import environs
+import pytest
+
+from prometheuspvesd.model import Host, HostList
+
+
+@pytest.fixture
+def builtins():
+    return {
+        "metrics.enabled": {
+            "default": True,
+            "env": "METRICS_ENABLED",
+            "type": environs.Env().bool,
+        },
+        "metrics.address": {
+            "default": "127.0.0.1",
+            "env": "METRICS_ADDRESS",
+            "type": environs.Env().str,
+        },
+        "metrics.port": {"default": 8000, "env": "METRICS_PORT", "type": environs.Env().int},
+        "config_file": {"default": "", "env": "CONFIG_FILE", "type": environs.Env().str},
+        "logging.level": {
+            "default": "WARNING",
+            "env": "LOG_LEVEL",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "logging.format": {
+            "default": "console",
+            "env": "LOG_FORMAT",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "output_file": {
+            "default": "dummy",
+            "env": "OUTPUT_FILE",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "output_file_mode": {
+            "default": "0640",
+            "env": "OUTPUT_FILE_MODE",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "loop_delay": {
+            "default": 300,
+            "env": "LOOP_DELAY",
+            "file": True,
+            "type": environs.Env().int,
+        },
+        "service": {"default": False, "env": "SERVICE", "file": True, "type": environs.Env().bool},
+        "exclude_state": {
+            "default": [],
+            "env": "EXCLUDE_STATE",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "exclude_vmid": {
+            "default": [],
+            "env": "EXCLUDE_VMID",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "exclude_tags": {
+            "default": [],
+            "env": "EXCLUDE_TAGS",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "include_vmid": {
+            "default": [],
+            "env": "INCLUDE_VMID",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "include_tags": {
+            "default": [],
+            "env": "INCLUDE_TAGS",
+            "file": True,
+            "type": environs.Env().list,
+        },
+        "pve.server": {
+            "default": "dummyserver",
+            "env": "PVE_SERVER",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.user": {
+            "default": "dummyuser",
+            "env": "PVE_USER",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.password": {
+            "default": "dummypass",
+            "env": "PVE_PASSWORD",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.token_name": {
+            "default": "dummyname",
+            "env": "PVE_TOKEN_NAME",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.token_value": {
+            "default": "dummyvalue",
+            "env": "PVE_TOKEN_VALUE",
+            "file": True,
+            "type": environs.Env().str,
+        },
+        "pve.auth_timeout": {
+            "default": 5,
+            "env": "PVE_AUTH_TIMEOUT",
+            "file": True,
+            "type": environs.Env().int,
+        },
+        "pve.verify_ssl": {
+            "default": True,
+            "env": "PVE_VERIFY_SSL",
+            "file": True,
+            "type": environs.Env().bool,
+        },
+    }
+
+
+@pytest.fixture
+def defaults():
+    return {
+        "exclude_state": [],
+        "exclude_tags": [],
+        "exclude_vmid": [],
+        "include_tags": [],
+        "include_vmid": [],
+        "logging": {"format": "console", "level": "WARNING"},
+        "loop_delay": 300,
+        "metrics": {"address": "127.0.0.1", "enabled": True, "port": 8000},
+        "output_file": "dummy",
+        "output_file_mode": "0640",
+        "pve": {
+            "auth_timeout": 5,
+            "password": "",
+            "server": "",
+            "user": "",
+            "token_name": "",
+            "token_value": "",
+            "verify_ssl": True,
+        },
+        "service": True,
+    }
+
+
+@pytest.fixture
+def nodes():
+    return [
+        {
+            "level": "",
+            "id": "node/example-node",
+            "disk": 4783488,
+            "cpu": 0.0935113631167406,
+            "maxcpu": 24,
+            "maxmem": 142073272990,
+            "mem": 135884478304,
+            "node": "example-node",
+            "type": "node",
+            "status": "online",
+            "maxdisk": 504209920,
+            "uptime": 200,
+        }
+    ]
+
+
+@pytest.fixture
+def qemus():
+    return [
+        {
+            "diskwrite": 0,
+            "vmid": "100",
+            "name": "100.example.com",
+            "cpu": 0.0202130478509556,
+            "diskread": 0,
+            "template": "",
+            "uptime": 3101505,
+            "maxdisk": 26843545600,
+            "maxmem": 1073741824,
+            "pid": "1765",
+            "cpus": 1,
+            "netin": 2856071643,
+            "disk": 0,
+            "status": "running",
+            "netout": 12159205236,
+            "mem": 496179157,
+            "tags": "unmonitored;excluded;postgres",
+        },
+        {
+            "diskwrite": 0,
+            "vmid": "101",
+            "name": "101.example.com",
+            "cpu": 0.0202130478509556,
+            "diskread": 0,
+            "template": "",
+            "uptime": 3101505,
+            "maxdisk": 26843545600,
+            "maxmem": 1073741824,
+            "pid": "1765",
+            "cpus": 1,
+            "netin": 2856071643,
+            "disk": 0,
+            "status": "running",
+            "netout": 12159205236,
+            "mem": 496179157,
+        },
+        {
+            "diskwrite": 0,
+            "vmid": "102",
+            "name": "102.example.com",
+            "cpu": 0.0202130478509556,
+            "diskread": 0,
+            "template": "",
+            "uptime": 3101505,
+            "maxdisk": 26843545600,
+            "maxmem": 1073741824,
+            "pid": "1765",
+            "cpus": 1,
+            "netin": 2856071643,
+            "disk": 0,
+            "status": "prelaunch",
+            "netout": 12159205236,
+            "mem": 496179157,
+            "tags": "monitored",
+        },
+    ]
+
+
+@pytest.fixture
+def instance_config():
+    return {
+        "name": "102.example.com",
+        "description": '{"groups": "test-group"}',
+        "net0": "virtio=D8-85-75-47-2E-8D,bridge=vmbr122,ip=192.0.2.25,ip=2001:db8::666:77:8888",
+        "cpu": 2,
+        "cores": 2,
+    }
+
+
+@pytest.fixture
+def agent_info():
+    return {
+        "supported_commands": [
+            {"name": "guest-network-get-interfaces", "enabled": True, "success-response": True}
+        ],
+        "version": "5.2.0",
+    }
+
+
+@pytest.fixture
+def addresses():
+    return {
+        "ipv4_valid": [
+            "192.0.2.1",
+            "198.51.100.1",
+        ],
+        "ipv4_invalid": [
+            "127.0.0.1",
+            "169.254.1.1",
+        ],
+        "ipv6_valid": [
+            "2001:db8:3333:4444:5555:6666:7777:8888",
+            "2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF",
+            "::",
+            "2001:db8::",
+            "::1234:5678",
+            "2001:db8::1234:5678",
+            "2001:0db8:0001:0000:0000:0ab9:C0A8:0102",
+        ],
+        "ipv6_invalid": [
+            "::1",
+            "fe80::903a:1c1a:e802:11e4",
+        ],
+    }
+
+
+@pytest.fixture
+def networks():
+    return [
+        {
+            "hardware-address": "00:00:00:00:00:00",
+            "ip-addresses": [
+                {"ip-address": "127.0.0.1", "ip-address-type": "ipv4", "prefix": 8},
+                {"ip-address": "::1", "ip-address-type": "ipv6", "prefix": 128},
+            ],
+            "name": "lo",
+            "statistics": {
+                "rx-bytes": 9280,
+                "rx-dropped": 0,
+                "rx-errs": 0,
+                "rx-packets": 92,
+                "tx-bytes": 9280,
+                "tx-dropped": 0,
+                "tx-errs": 0,
+                "tx-packets": 92,
+            },
+        },
+        {
+            "hardware-address": "92:0b:bd:c1:f8:39",
+            "ip-addresses": [
+                {"ip-address": "192.0.2.1", "ip-address-type": "ipv4", "prefix": 32},
+                {"ip-address": "192.0.2.4", "ip-address-type": "ipv4", "prefix": 32},
+                {
+                    "ip-address": "2001:db8:3333:4444:5555:6666:7777:8888",
+                    "ip-address-type": "ipv6",
+                    "prefix": 64,
+                },
+            ],
+            "name": "eth0",
+            "statistics": {
+                "rx-bytes": 2861070337,
+                "rx-dropped": 0,
+                "rx-errs": 0,
+                "rx-packets": 18065580,
+                "tx-bytes": 12185866619,
+                "tx-dropped": 0,
+                "tx-errs": 0,
+                "tx-packets": 14423878,
+            },
+        },
+        {"hardware-address": "ba:97:85:bd:9a:a5", "name": "eth1"},
+    ]
+
+
+@pytest.fixture
+def inventory():
+    hostlist = HostList()
+    hostlist.add_host(Host("100", "100.example.com", "192.0.2.1", False, "qemu"))
+    hostlist.add_host(Host("101", "101.example.com", "192.0.2.2", False, "qemu"))
+    hostlist.add_host(Host("102", "102.example.com", "192.0.2.3", False, "qemu"))
+
+    return hostlist
+
+
+@pytest.fixture
+def labels():
+    return [
+        {
+            "targets": ["100.example.com"],
+            "labels": {
+                "__meta_pve_ipv4": "192.0.2.1",
+                "__meta_pve_ipv6": "False",
+                "__meta_pve_name": "100.example.com",
+                "__meta_pve_type": "qemu",
+                "__meta_pve_vmid": "100",
+            },
+        },
+        {
+            "targets": ["101.example.com"],
+            "labels": {
+                "__meta_pve_ipv4": "192.0.2.2",
+                "__meta_pve_ipv6": "False",
+                "__meta_pve_name": "101.example.com",
+                "__meta_pve_type": "qemu",
+                "__meta_pve_vmid": "101",
+            },
+        },
+        {
+            "targets": ["102.example.com"],
+            "labels": {
+                "__meta_pve_ipv4": "192.0.2.3",
+                "__meta_pve_ipv6": "False",
+                "__meta_pve_name": "102.example.com",
+                "__meta_pve_type": "qemu",
+                "__meta_pve_vmid": "102",
+            },
+        },
+    ]

prometheuspvesd/test/unit/conftest.py

@@ -0,0 +1,60 @@
+"""Pytest conftest fixtures."""
+
+import logging
+import os
+import sys
+from contextlib import contextmanager
+
+import pytest
+from _pytest.logging import LogCaptureHandler
+
+from prometheuspvesd.utils import Singleton
+
+
+@pytest.fixture(autouse=True)
+def reset_singletons():
+    Singleton._instances = {}
+
+
+@pytest.fixture(autouse=True)
+def reset_os_environment():
+    os.environ.clear()
+
+
+@pytest.fixture(autouse=True)
+def reset_sys_argv():
+    sys.argv = ["prometheus-pve-sd"]
+
+
+@contextmanager
+def local_caplog_fn(level=logging.INFO, name="prometheuspvesd"):
+    """
+    Context manager that captures records from non-propagating loggers.
+
+    After the end of the 'with' statement, the log level is restored to its original
+    value. Code adapted from https://github.com/pytest-dev/pytest/issues/3697#issuecomment-790925527.
+
+    :param int level: The level.
+    :param logging.Logger logger: The logger to update.
+    """
+
+    logger = logging.getLogger(name)
+
+    old_level = logger.level
+    logger.setLevel(level)
+
+    handler = LogCaptureHandler()
+    logger.addHandler(handler)
+
+    try:
+        yield handler
+    finally:
+        logger.setLevel(old_level)
+        logger.removeHandler(handler)
+
+
+@pytest.fixture
+def local_caplog():
+    """Fixture that yields a context manager for capturing records from non-propagating loggers."""
+
+    yield local_caplog_fn

prometheuspvesd/test/unit/test_cli.py

@@ -0,0 +1,146 @@
+"""Test CLI class."""
+
+import json
+
+import pytest
+from proxmoxer import ProxmoxAPI
+
+import prometheuspvesd.exception
+from prometheuspvesd.cli import PrometheusSD
+from prometheuspvesd.client import ProxmoxClient
+from prometheuspvesd.config import Config
+from prometheuspvesd.discovery import Discovery
+from prometheuspvesd.exception import APIError
+from prometheuspvesd.logger import Log
+
+pytest_plugins = [
+    "prometheuspvesd.test.fixtures.fixtures",
+]
+
+
+def test_cli_required_error(mocker, capsys):
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    with pytest.raises(SystemExit) as e:
+        PrometheusSD()
+
+    stdout, stderr = capsys.readouterr()
+    assert "Option 'pve.server' is required but not set" in stderr
+    assert e.value.code == 1
+
+
+@pytest.mark.parametrize(
+    "testinput",
+    [
+        {"pve.user": "dummy", "pve.password": "", "pve.token_name": "", "pve.token_value": ""},
+        {
+            "pve.user": "dummy",
+            "pve.password": "",
+            "pve.token_name": "dummy",
+            "pve.token_value": "",
+        },
+        {
+            "pve.user": "dummy",
+            "pve.password": "",
+            "pve.token_name": "",
+            "pve.token_value": "dummy",
+        },
+    ],
+)
+def test_cli_auth_required_error(mocker, capsys, builtins, testinput):
+    for key, value in testinput.items():
+        builtins[key]["default"] = value
+
+    mocker.patch.dict(Config.SETTINGS, builtins)
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    with pytest.raises(SystemExit) as e:
+        PrometheusSD()
+
+    stdout, stderr = capsys.readouterr()
+    assert (
+        "Either 'pve.password' or 'pve.token_name' and 'pve.token_value' are required but not set"
+        in stderr
+    )
+    assert e.value.code == 1
+
+
+@pytest.mark.parametrize(
+    "testinput",
+    [
+        {"pve.password": "dummy", "pve.token_name": "", "pve.token_value": ""},
+        {"pve.password": "", "pve.token_name": "dummy", "pve.token_value": "dummy"},
+    ],
+)
+def test_cli_auth_no_error(mocker, builtins, testinput):
+    for key, value in testinput.items():
+        builtins[key]["default"] = value
+
+    mocker.patch.dict(Config.SETTINGS, builtins)
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    psd = PrometheusSD()
+
+    for key, value in testinput.items():
+        assert psd.config.config["pve"][key.split(".")[1]] == value
+
+
+def test_cli_config_error(mocker, capsys):
+    mocker.patch(
+        "prometheuspvesd.config.SingleConfig.__init__",
+        side_effect=prometheuspvesd.exception.ConfigError("Dummy Config Exception"),
+    )
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    with pytest.raises(SystemExit) as e:
+        PrometheusSD()
+
+    stdout, stderr = capsys.readouterr()
+    assert "Dummy Config Exception" in stderr
+    assert e.value.code == 1
+
+
+def test_cli_log_error(mocker, capsys):
+    mocker.patch.object(Log, "update_logger", side_effect=ValueError("Dummy Loglevel Exception"))
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    with pytest.raises(SystemExit) as e:
+        PrometheusSD()
+
+    stdout, stderr = capsys.readouterr()
+    assert "Dummy Loglevel Exception" in stderr
+    assert e.value.code == 1
+
+
+def test_cli_api_error(mocker, builtins, capsys):
+    mocker.patch.dict(Config.SETTINGS, builtins)
+    mocker.patch.object(ProxmoxClient, "_auth", side_effect=APIError("Dummy API Exception"))
+    mocker.patch.object(PrometheusSD, "_fetch", return_value=True)
+
+    with pytest.raises(SystemExit) as e:
+        PrometheusSD()
+
+    stdout, stderr = capsys.readouterr()
+    assert "Proxmoxer API error: Dummy API Exception" in stderr
+    assert e.value.code == 1
+
+
+def test_cli_write(mocker, tmp_path, builtins, inventory, labels):
+    temp = tmp_path / "temp.txt"
+    out = tmp_path / "out.txt"
+
+    builtins["output_file"]["default"] = out.as_posix()
+
+    mocker.patch.dict(Config.SETTINGS, builtins)
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+    mocker.patch.object(Discovery, "propagate", return_value=inventory)
+    mocker.patch("tempfile.NamedTemporaryFile", return_value=temp.open("w"))
+
+    psd = PrometheusSD()
+    assert json.loads(out.read_text()) == labels
+    assert oct(out.stat().st_mode & 0o777) == oct(int(psd.config.config["output_file_mode"], 8))

prometheuspvesd/test/unit/test_config.py

@@ -0,0 +1,38 @@
+"""Test Config class."""
+
+import pytest
+import ruamel.yaml
+
+import prometheuspvesd.exception
+from prometheuspvesd.config import Config
+
+pytest_plugins = [
+    "prometheuspvesd.test.fixtures.fixtures",
+]
+
+
+def test_yaml_config(mocker, defaults):
+    mocker.patch(
+        "prometheuspvesd.config.default_config_file", "./prometheuspvesd/test/data/config.yml"
+    )
+    config = Config()
+
+    defaults["pve"]["user"] = "root"
+    defaults["pve"]["password"] = "secure"
+    defaults["pve"]["server"] = "proxmox.example.com"
+    defaults["pve"]["token_name"] = "pve_sd"
+    defaults["pve"]["token_value"] = "01234567-89ab-cdef-0123-456789abcdef"
+
+    assert config.config == defaults
+
+
+def test_yaml_config_error(mocker):
+    mocker.patch(
+        "prometheuspvesd.config.default_config_file", "./prometheuspvesd/test/data/config.yml"
+    )
+    mocker.patch.object(ruamel.yaml.YAML, "load", side_effect=ruamel.yaml.composer.ComposerError)
+
+    with pytest.raises(prometheuspvesd.exception.ConfigError) as e:
+        Config()
+
+    assert "Unable to read config file ./prometheuspvesd/test/data/config.yml" in str(e.value)

prometheuspvesd/test/unit/test_discovery.py

@@ -0,0 +1,134 @@
+"""Test Discovery class."""
+
+import logging
+
+import pytest
+from proxmoxer import ProxmoxAPI
+
+from prometheuspvesd.client import ProxmoxClient
+from prometheuspvesd.discovery import Discovery
+
+pytest_plugins = [
+    "prometheuspvesd.test.fixtures.fixtures",
+]
+
+
+def records_to_messages(records):
+    return [r.getMessage() for r in records]
+
+
+@pytest.fixture
+def discovery(mocker):
+    mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
+
+    return Discovery()
+
+
+def test_exclude_vmid(discovery, qemus):
+    discovery.config.config["exclude_vmid"] = ["100", "101", "102"]
+    filtered = discovery._filter(qemus)
+
+    assert len(filtered) == 0
+
+
+def test_exclude_state(discovery, qemus):
+    discovery.config.config["exclude_state"] = ["prelaunch"]
+    filtered = discovery._filter(qemus)
+
+    assert len(filtered) == 2
+
+
+def test_exclude_tags(discovery, qemus, local_caplog):
+    discovery.config.config["exclude_tags"] = ["unmonitored"]
+
+    with local_caplog(level=logging.DEBUG) as caplog:
+        filtered = discovery._filter(qemus)
+
+    assert (
+        "vmid 100: discovered tags: ['unmonitored', 'excluded', 'postgres']"
+        in records_to_messages(caplog.records)
+    )
+    assert "vmid 100: excluded by tags: ['unmonitored']"
+    assert len(filtered) == 2
+
+
+@pytest.mark.parametrize(
+    "testinput,expected",
+    [
+        (["monitored"], 1),
+        (["monitored", "postgres"], 2),
+        ([], 3),
+    ],
+)
+def test_include_tags(discovery, qemus, testinput, expected):
+    discovery.config.config["include_tags"] = testinput
+    filtered = discovery._filter(qemus)
+
+    assert len(filtered) == expected
+
+
+@pytest.mark.parametrize(
+    "testinput,expected",
+    [
+        (["101", "100"], 2),
+        ([], 3),
+    ],
+)
+def test_include_vmid(discovery, qemus, testinput, expected):
+    discovery.config.config["include_vmid"] = testinput
+    filtered = discovery._filter(qemus)
+
+    assert len(filtered) == expected
+
+
+def test_include_and_exclude_tags(discovery, qemus):
+    discovery.config.config["include_tags"] = ["postgres"]
+    discovery.config.config["exclude_tags"] = ["unmonitored"]
+    filtered = discovery._filter(qemus)
+
+    assert len(filtered) == 0
+
+
+def test_validate_ip(discovery, addresses):
+    # IPv4 validation
+    for address in addresses["ipv4_valid"]:
+        assert discovery._validate_ip(address)
+    for address in addresses["ipv4_invalid"]:
+        assert not discovery._validate_ip(address)
+
+    # IPv6 validation
+    for address in addresses["ipv6_valid"]:
+        assert discovery._validate_ip(address)
+    for address in addresses["ipv6_invalid"]:
+        assert not discovery._validate_ip(address)
+
+
+def test_get_ip_addresses(mocker, discovery, networks):
+    mocker.patch.object(ProxmoxClient, "get_network_interfaces", return_value=networks)
+
+    assert discovery._get_ip_addresses("qemu", "dummy", "dummy") == (
+        networks[1]["ip-addresses"][0]["ip-address"],
+        networks[1]["ip-addresses"][2]["ip-address"],
+    )
+
+
+def test_get_ip_addresses_from_instance_config(mocker, discovery, instance_config):
+    mocker.patch.object(ProxmoxClient, "get_network_interfaces", return_value=[])
+    mocker.patch.object(ProxmoxClient, "get_instance_config", return_value=instance_config)
+
+    assert discovery._get_ip_addresses("qemu", "dummy", "dummy") == (
+        "192.0.2.25",
+        "2001:db8::666:77:8888",
+    )
+
+
+def test_propagate(
+    mocker, discovery, nodes, qemus, instance_config, agent_info, networks, inventory
+):
+    mocker.patch.object(ProxmoxClient, "get_nodes", return_value=nodes)
+    mocker.patch.object(ProxmoxClient, "get_all_vms", return_value=qemus)
+    mocker.patch.object(ProxmoxClient, "get_instance_config", return_value=instance_config)
+    mocker.patch.object(ProxmoxClient, "get_agent_info", return_value=agent_info)
+    mocker.patch.object(ProxmoxClient, "get_network_interfaces", return_value=networks)
+
+    assert discovery.propagate() == inventory

prometheuspvesd/test/unit/test_model.py

@@ -0,0 +1,58 @@
+"""Test Host class."""
+
+import pytest
+
+from prometheuspvesd.model import Host
+
+pytest_plugins = [
+    "prometheuspvesd.test.fixtures.fixtures",
+]
+
+
+@pytest.mark.parametrize(
+    "testinput,expected",
+    [
+        (
+            {
+                "vmid": 101,
+                "hostname": "host1",
+                "ipv4_address": False,
+                "ipv6_address": False,
+                "pve_type": "qemu",
+            },
+            {
+                "__meta_pve_vmid": "101",
+                "__meta_pve_name": "host1",
+                "__meta_pve_ipv4": "False",
+                "__meta_pve_ipv6": "False",
+                "__meta_pve_type": "qemu",
+            },
+        ),
+        (
+            {
+                "vmid": "202",
+                "hostname": "host2",
+                "ipv4_address": "129.168.0.1",
+                "ipv6_address": "2001:db8:3333:4444:5555:6666:7777:8888",
+                "pve_type": "qemu",
+            },
+            {
+                "__meta_pve_vmid": "202",
+                "__meta_pve_name": "host2",
+                "__meta_pve_ipv4": "129.168.0.1",
+                "__meta_pve_ipv6": "2001:db8:3333:4444:5555:6666:7777:8888",
+                "__meta_pve_type": "qemu",
+            },
+        ),
+    ],
+)
+def test_host(testinput, expected):
+    host = Host(
+        testinput["vmid"],
+        testinput["hostname"],
+        testinput["ipv4_address"],
+        testinput["ipv6_address"],
+        testinput["pve_type"],
+    )
+
+    assert host.labels == expected

prometheuspvesd/utils.py

@@ -1,7 +1,29 @@
 #!/usr/bin/env python3
 """Global utility methods and classes."""
 
-from distutils.util import strtobool
+
+def strtobool(value):
+    """Convert a string representation of truth to true or false."""
+
+    _map = {
+        "y": True,
+        "yes": True,
+        "t": True,
+        "true": True,
+        "on": True,
+        "1": True,
+        "n": False,
+        "no": False,
+        "f": False,
+        "false": False,
+        "off": False,
+        "0": False,
+    }
+
+    try:
+        return _map[str(value).lower()]
+    except KeyError as err:
+        raise ValueError(f'"{value}" is not a valid bool value') from err
 
 
 def to_bool(string):
@@ -15,5 +37,5 @@ class Singleton(type):
 
     def __call__(cls, *args, **kwargs):
         if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+            cls._instances[cls] = super().__call__(*args, **kwargs)
         return cls._instances[cls]

pyproject.toml

@@ -10,86 +10,128 @@ classifiers = [
   "Natural Language :: English",
   "Operating System :: POSIX",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.6",
-  "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
   "Topic :: Utilities",
 ]
 description = "Prometheus Service Discovery for Proxmox VE."
 documentation = "https://github.com/thegeeklab/prometheus-pve-sd/"
 homepage = "https://github.com/thegeeklab/prometheus-pve-sd/"
-include = [
-  "LICENSE",
-]
+include = ["LICENSE"]
 keywords = ["prometheus", "sd", "pve", "metrics"]
 license = "MIT"
 name = "prometheus-pve-sd"
-packages = [
-  {include = "prometheuspvesd"},
-]
+packages = [{ include = "prometheuspvesd" }]
 readme = "README.md"
 repository = "https://github.com/thegeeklab/prometheus-pve-sd/"
 version = "0.0.0"
 
 [tool.poetry.dependencies]
-anyconfig = "0.11.0"
+anyconfig = "0.14.0"
 appdirs = "1.4.4"
-colorama = "0.4.4"
-environs = "9.3.2"
-jsonschema = "3.2.0"
-nested-lookup = "0.2.22"
-proxmoxer = "1.1.1"
-python = "^3.6.0"
-python-json-logger = "2.0.1"
-requests = "2.25.1"
-"ruamel.yaml" = "0.17.9"
-
-[tool.poetry.dev-dependencies]
-bandit = "1.7.0"
-flake8 = "3.9.2"
-flake8-blind-except = "0.2.0"
-flake8-builtins = "1.5.3"
-flake8-docstrings = "1.6.0"
-flake8-eradicate = "1.0.0"
-flake8-isort = "4.0.0"
-flake8-logging-format = "0.6.0"
-flake8-pep3101 = "1.3.0"
-flake8-polyfill = "1.0.2"
-flake8-quotes = "3.2.0"
-pep8-naming = "0.11.1"
-pydocstyle = "6.1.1"
-pytest = "6.2.4"
-pytest-cov = "2.12.1"
-pytest-mock = "3.6.1"
-yapf = "0.31.0"
+colorama = "0.4.6"
+environs = "11.0.0"
+jsonschema = "4.22.0"
+nested-lookup = "0.2.25"
+prometheus-client = "0.20.0"
+proxmoxer = "2.0.1"
+python = "^3.8.0"
+python-json-logger = "2.0.7"
+requests = "2.31.0"
+"ruamel.yaml" = "0.18.6"
 
 [tool.poetry.scripts]
 prometheus-pve-sd = "prometheuspvesd.cli:main"
 
+[tool.poetry.group.dev.dependencies]
+ruff = "0.4.5"
+pytest = "8.2.1"
+pytest-mock = "3.14.0"
+pytest-cov = "5.0.0"
+toml = "0.10.2"
+
 [tool.poetry-dynamic-versioning]
 enable = true
 style = "semver"
 vcs = "git"
 
-[tool.isort]
-default_section = "THIRDPARTY"
-force_single_line = true
-line_length = 99
-sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
-skip_glob = ["**/.env*", "**/env/*", "**/.venv/*", "**/docs/*"]
-
 [tool.pytest.ini_options]
-addopts = "prometheuspvesd --cov=prometheuspvesd --cov-report=xml:coverage.xml --cov-report=term --cov-append --no-cov-on-fail"
-filterwarnings = [
-  "ignore::FutureWarning",
-  "ignore:.*collections.*:DeprecationWarning",
-  "ignore:.*pep8.*:FutureWarning",
-]
+addopts = "prometheuspvesd --cov=prometheuspvesd --cov-report=xml:coverage.xml --cov-report=term-missing --no-cov-on-fail --cov-fail-under=80"
+filterwarnings = ["ignore::FutureWarning", "ignore::DeprecationWarning"]
 
 [tool.coverage.run]
 omit = ["**/test/*"]
 
 [build-system]
-build-backend = "poetry.core.masonry.api"
+build-backend = "poetry_dynamic_versioning.backend"
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+
+[tool.ruff]
+exclude = [
+  ".git",
+  "__pycache__",
+  "build",
+  "dist",
+  "*.pyc",
+  "*.egg-info",
+  ".cache",
+  ".eggs",
+  "env*",
+]
+
+line-length = 99
+indent-width = 4
+
+[tool.ruff.lint]
+# Explanation of errors
+#
+# D102: Missing docstring in public method
+# D103: Missing docstring in public function
+# D105: Missing docstring in magic method
+# D107: Missing docstring in __init__
+# D202: No blank lines allowed after function docstring
+# D203: One blank line required before class docstring
+# D212: Multi-line docstring summary should start at the first line
+ignore = [
+  "D102",
+  "D103",
+  "D105",
+  "D107",
+  "D202",
+  "D203",
+  "D212",
+  "UP038",
+  "RUF012",
+]
+select = [
+  "D",
+  "E",
+  "F",
+  "Q",
+  "W",
+  "I",
+  "S",
+  "BLE",
+  "N",
+  "UP",
+  "B",
+  "A",
+  "C4",
+  "T20",
+  "SIM",
+  "RET",
+  "ARG",
+  "ERA",
+  "RUF",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"test_*.py" = ["S"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"

renovate.json

@@ -1,4 +1,12 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["github>thegeeklab/renovate-presets"]
+  "extends": ["github>thegeeklab/renovate-presets"],
+  "packageRules": [
+    {
+      "matchManagers": ["woodpecker"],
+      "matchFileNames": [".woodpecker/test.yml"],
+      "matchPackageNames": ["docker.io/library/python"],
+      "enabled": false
+    }
+  ]
 }

setup.cfg

@@ -1,20 +0,0 @@
-[flake8]
-# Explanation of errors
-#
-# D102: Missing docstring in public method
-# D103: Missing docstring in public function
-# D105: Missing docstring in magic method
-# D107: Missing docstring in __init__
-# D202: No blank lines allowed after function docstring
-# W503:Line break occurred before a binary operator
-ignore = D102, D103, D105, D107, D202, W503
-max-line-length = 99
-inline-quotes = double
-exclude = .git, __pycache__, build, dist, test, *.pyc, *.egg-info, .cache, .eggs, env*
-
-[yapf]
-based_on_style = google
-column_limit = 99
-dedent_closing_brackets = true
-coalesce_brackets = true
-split_before_logical_operator = true