Compare commits

..

No commits in common. "main" and "v2.5.16" have entirely different histories.

42 changed files with 1747 additions and 1541 deletions

23
.chglog/CHANGELOG.tpl.md Executable file
View File

@ -0,0 +1,23 @@
# 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 }}
{{ range .Commits -}}
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ (regexReplaceAll "(.*)/issues/(.*)" (regexReplaceAll "(Co-\\w*-by.*)" .Subject "") "${1}/pull/${2}") | trim }}
{{ end }}
{{- end -}}
{{- if .NoteGroups -}}
{{ range .NoteGroups -}}
### {{ .Title }}
{{ range .Notes }}
{{ .Body }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}

25
.chglog/config.yml Executable file
View File

@ -0,0 +1,25 @@
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

445
.drone.jsonnet Normal file
View File

@ -0,0 +1,445 @@
local PythonVersion(pyversion='3.7') = {
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 run pytest --cov-append',
'poetry version',
'poetry run prometheus-pve-sd --help',
],
depends_on: [
'fetch',
],
};
local PipelineLint = {
kind: 'pipeline',
name: 'lint',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'check-format',
image: 'python:3.11',
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: 'check-coding',
image: 'python:3.11',
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 ruff ./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.11',
commands: [
'git fetch -tq',
],
},
PythonVersion(pyversion='3.7'),
PythonVersion(pyversion='3.8'),
PythonVersion(pyversion='3.9'),
PythonVersion(pyversion='3.10'),
PythonVersion(pyversion='3.11'),
{
name: 'codecov',
image: 'python:3.11',
environment: {
PY_COLORS: 1,
CODECOV_TOKEN: { from_secret: 'codecov_token' },
},
commands: [
'pip install codecov -qq',
'codecov --required -X gcov',
],
depends_on: [
'python37-pytest',
'python38-pytest',
'python39-pytest',
'python310-pytest',
'python311-pytest',
],
},
],
depends_on: [
'lint',
],
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.11',
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.11',
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: [
'test',
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
},
};
local PipelineBuildContainer = {
kind: 'pipeline',
name: 'build-container',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'build',
image: 'python:3.11',
commands: [
'git fetch -tq',
'pip install poetry poetry-dynamic-versioning -qq',
'poetry build',
],
},
{
name: 'dryrun',
image: 'thegeeklab/drone-docker-buildx:23',
settings: {
dry_run: true,
dockerfile: 'Dockerfile.multiarch',
repo: 'thegeeklab/${DRONE_REPO_NAME}',
platforms: [
'linux/amd64',
'linux/arm64',
],
provenance: false,
},
depends_on: ['build'],
when: {
ref: ['refs/pull/**'],
},
},
{
name: 'publish-dockerhub',
image: 'thegeeklab/drone-docker-buildx:23',
settings: {
auto_tag: true,
dockerfile: 'Dockerfile.multiarch',
repo: 'thegeeklab/${DRONE_REPO_NAME}',
username: { from_secret: 'docker_username' },
password: { from_secret: 'docker_password' },
platforms: [
'linux/amd64',
'linux/arm64',
],
provenance: false,
},
when: {
ref: ['refs/heads/main', 'refs/tags/**'],
},
depends_on: ['dryrun'],
},
{
name: 'publish-quay',
image: 'thegeeklab/drone-docker-buildx:23',
settings: {
auto_tag: true,
dockerfile: 'Dockerfile.multiarch',
registry: 'quay.io',
repo: 'quay.io/thegeeklab/${DRONE_REPO_NAME}',
username: { from_secret: 'quay_username' },
password: { from_secret: 'quay_password' },
platforms: [
'linux/amd64',
'linux/arm64',
],
provenance: false,
},
when: {
ref: ['refs/heads/main', 'refs/tags/**'],
},
depends_on: ['dryrun'],
},
],
depends_on: [
'test',
],
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: 'thegeeklab/alpine-tools',
commands: [
"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.105.0',
commands: [
'hugo --panicOnWarning -s docs/ -b http://localhost:8000/',
],
},
{
name: 'link-validation',
image: 'thegeeklab/link-validator',
commands: [
'link-validator --color=always --rate-limit 10',
],
environment: {
LINK_VALIDATOR_BASE_DIR: 'docs/public',
LINK_VALIDATOR_RETRIES: '3',
},
},
{
name: 'build',
image: 'thegeeklab/hugo:0.105.0',
commands: [
'hugo --panicOnWarning -s docs/',
],
},
{
name: 'beautify',
image: 'thegeeklab/alpine-tools',
commands: [
"html-beautify -r -f 'docs/public/**/*.html'",
],
environment: {
FORCE_COLOR: true,
NPM_CONFIG_LOGLEVEL: 'error',
},
},
{
name: 'publish',
image: 'thegeeklab/drone-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',
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
},
};
local PipelineNotifications = {
kind: 'pipeline',
name: 'notifications',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'pushrm-dockerhub',
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',
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: 'thegeeklab/drone-matrix',
settings: {
homeserver: { from_secret: 'matrix_homeserver' },
roomid: { from_secret: 'matrix_roomid' },
template: 'Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}',
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,
PipelineBuildPackage,
PipelineBuildContainer,
PipelineDocs,
PipelineNotifications,
]

454
.drone.yml Normal file
View File

@ -0,0 +1,454 @@
---
kind: pipeline
name: lint
platform:
os: linux
arch: amd64
steps:
- name: check-format
image: python:3.11
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: check-coding
image: python:3.11
commands:
- git fetch -tq
- pip install poetry poetry-dynamic-versioning -qq
- poetry config experimental.new-installer false
- poetry install
- poetry run ruff ./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.11
commands:
- git fetch -tq
- name: python37-pytest
image: python:3.7
commands:
- pip install poetry poetry-dynamic-versioning -qq
- poetry config experimental.new-installer false
- poetry install
- poetry run pytest --cov-append
- 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 run pytest --cov-append
- 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 run pytest --cov-append
- poetry version
- poetry run prometheus-pve-sd --help
environment:
PY_COLORS: 1
depends_on:
- fetch
- name: python310-pytest
image: python:3.10
commands:
- pip install poetry poetry-dynamic-versioning -qq
- poetry config experimental.new-installer false
- poetry install
- poetry run pytest --cov-append
- poetry version
- poetry run prometheus-pve-sd --help
environment:
PY_COLORS: 1
depends_on:
- fetch
- name: python311-pytest
image: python:3.11
commands:
- pip install poetry poetry-dynamic-versioning -qq
- poetry config experimental.new-installer false
- poetry install
- poetry run pytest --cov-append
- poetry version
- poetry run prometheus-pve-sd --help
environment:
PY_COLORS: 1
depends_on:
- fetch
- name: codecov
image: python:3.11
commands:
- pip install codecov -qq
- codecov --required -X gcov
environment:
CODECOV_TOKEN:
from_secret: codecov_token
PY_COLORS: 1
depends_on:
- python37-pytest
- python38-pytest
- python39-pytest
- python310-pytest
- python311-pytest
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
depends_on:
- lint
---
kind: pipeline
name: build-package
platform:
os: linux
arch: amd64
steps:
- name: build
image: python:3.11
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.11
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:
- test
---
kind: pipeline
name: build-container
platform:
os: linux
arch: amd64
steps:
- name: build
image: python:3.11
commands:
- git fetch -tq
- pip install poetry poetry-dynamic-versioning -qq
- poetry build
- name: dryrun
image: thegeeklab/drone-docker-buildx:23
settings:
dockerfile: Dockerfile.multiarch
dry_run: true
platforms:
- linux/amd64
- linux/arm64
provenance: false
repo: thegeeklab/${DRONE_REPO_NAME}
when:
ref:
- refs/pull/**
depends_on:
- build
- name: publish-dockerhub
image: thegeeklab/drone-docker-buildx:23
settings:
auto_tag: true
dockerfile: Dockerfile.multiarch
password:
from_secret: docker_password
platforms:
- linux/amd64
- linux/arm64
provenance: false
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-buildx:23
settings:
auto_tag: true
dockerfile: Dockerfile.multiarch
password:
from_secret: quay_password
platforms:
- linux/amd64
- linux/arm64
provenance: false
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:
- test
---
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: thegeeklab/alpine-tools
commands:
- 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.105.0
commands:
- hugo --panicOnWarning -s docs/ -b http://localhost:8000/
- name: link-validation
image: thegeeklab/link-validator
commands:
- link-validator --color=always --rate-limit 10
environment:
LINK_VALIDATOR_BASE_DIR: docs/public
LINK_VALIDATOR_RETRIES: 3
- name: build
image: thegeeklab/hugo:0.105.0
commands:
- hugo --panicOnWarning -s docs/
- name: beautify
image: thegeeklab/alpine-tools
commands:
- html-beautify -r -f 'docs/public/**/*.html'
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: publish
image: thegeeklab/drone-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/**
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
depends_on:
- build-package
- build-container
---
kind: pipeline
name: notifications
platform:
os: linux
arch: amd64
steps:
- name: pushrm-dockerhub
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
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: thegeeklab/drone-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 }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}"
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: 90ec9fda47481ade8b36802ec1c9ff733ae7e77ec7b0b7b7d916de7aa1b7578f
...

View File

@ -52,11 +52,7 @@ branches:
required_status_checks: required_status_checks:
strict: false strict: false
contexts: contexts:
- ci/woodpecker/pr/lint - continuous-integration/drone/pr
- ci/woodpecker/pr/test enforce_admins: true
- ci/woodpecker/pr/build-package
- ci/woodpecker/pr/build-container
- ci/woodpecker/pr/docs
enforce_admins: false
required_linear_history: true required_linear_history: true
restrictions: null restrictions: null

View File

@ -1,47 +0,0 @@
---
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]+"

View File

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

View File

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

View File

@ -1,82 +0,0 @@
---
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: security-build
image: quay.io/thegeeklab/wp-docker-buildx:5
depends_on: [build]
settings:
containerfile: Containerfile.multiarch
output: type=oci,dest=oci/${CI_REPO_NAME},tar=false
repo: ${CI_REPO}
- name: security-scan
image: docker.io/aquasec/trivy
depends_on: [security-build]
commands:
- trivy -v
- trivy image --input oci/${CI_REPO_NAME}
environment:
TRIVY_EXIT_CODE: "1"
TRIVY_IGNORE_UNFIXED: "true"
TRIVY_NO_PROGRESS: "true"
TRIVY_SEVERITY: HIGH,CRITICAL
TRIVY_TIMEOUT: 1m
TRIVY_DB_REPOSITORY: docker.io/aquasec/trivy-db:2
- name: publish-dockerhub
image: quay.io/thegeeklab/wp-docker-buildx:5
depends_on: [security-scan]
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:5
depends_on: security-scan
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

View File

@ -1,56 +0,0 @@
---
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
environment:
POETRY_HTTP_BASIC_PYPI_PASSWORD:
from_secret: pypi_password
POETRY_HTTP_BASIC_PYPI_USERNAME:
from_secret: pypi_username
commands:
- pip install poetry poetry-dynamic-versioning -qq
- poetry publish -n
when:
- event: [tag]
depends_on:
- lint
- test

View File

@ -1,101 +0,0 @@
---
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
depends_on: [assets]
commands:
- markdownlint 'README.md' 'CONTRIBUTING.md'
- name: spellcheck
image: quay.io/thegeeklab/alpine-tools
depends_on: [assets]
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
depends_on: [assets]
commands:
- lychee --no-progress --format detailed docs/content README.md
- name: build
image: quay.io/thegeeklab/hugo:0.136.5
depends_on: [link-validation]
commands:
- hugo --panicOnWarning -s docs/
- name: beautify
image: quay.io/thegeeklab/alpine-tools
depends_on: [build]
commands:
- html-beautify -r -f 'docs/public/**/*.html'
- name: publish
image: quay.io/thegeeklab/wp-s3-action
depends_on: [beautify]
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
depends_on: [publish]
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: ${CI_REPO}
when:
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
status: [success]
- name: pushrm-quay
image: docker.io/chko/docker-pushrm:1
depends_on: [publish]
environment:
APIKEY__QUAY_IO:
from_secret: quay_token
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

View File

@ -1,27 +0,0 @@
---
when:
- event: [pull_request, tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
- name: check-format
image: docker.io/library/python:3.12
depends_on: []
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
depends_on: []
commands:
- pip install poetry poetry-dynamic-versioning -qq
- poetry install
- poetry run ruff check ./${CI_REPO_NAME//-/}
environment:
PY_COLORS: "1"

View File

@ -1,26 +0,0 @@
---
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
room_id:
from_secret: matrix_room_id
user_id:
from_secret: matrix_user_id
access_token:
from_secret: matrix_access_token
when:
- status: [success, failure]
depends_on:
- docs

View File

@ -1,39 +0,0 @@
---
when:
- event: [pull_request, tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
variables:
- &pytest_base
depends_on: []
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

View File

@ -3,7 +3,7 @@
## Security ## Security
If you think you have found a **security issue**, please do not mention it in this repository. 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 ## Bug Reports and Feature Requests

View File

@ -1,4 +1,4 @@
FROM python:3.12-alpine@sha256:38e179a0f0436c97ecc76bcd378d7293ab3ee79e4b8c440fdc7113670cb6e204 FROM python:3.11-alpine@sha256:84630610c68e7c97384bc6e10f5490ab7b8398c30cdfffefa139ae20c3407cda
LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>" LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>"
LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>" LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>"

View File

@ -1,5 +1,5 @@
# renovate: datasource=github-releases depName=thegeeklab/hugo-geekdoc # renovate: datasource=github-releases depName=thegeeklab/hugo-geekdoc
THEME_VERSION := v1.1.0 THEME_VERSION := v0.37.1
THEME := hugo-geekdoc THEME := hugo-geekdoc
BASEDIR := docs BASEDIR := docs
THEMEDIR := $(BASEDIR)/themes THEMEDIR := $(BASEDIR)/themes

View File

@ -2,12 +2,13 @@
Prometheus Service Discovery for Proxmox VE Prometheus Service Discovery for Proxmox VE
[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/prometheus-pve-sd/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/prometheus-pve-sd) [![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)
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/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) [![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/) [![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 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/) [![PyPI Release](https://img.shields.io/pypi/v/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
[![Codecov](https://img.shields.io/codecov/c/github/thegeeklab/prometheus-pve-sd)](https://codecov.io/gh/thegeeklab/prometheus-pve-sd)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/graphs/contributors) [![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) [![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) [![License: MIT](https://img.shields.io/github/license/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/blob/main/LICENSE)

View File

View File

@ -2,12 +2,13 @@
title: Documentation 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) [![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)
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/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) [![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/) [![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 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/) [![PyPI Release](https://img.shields.io/pypi/v/prometheus-pve-sd.svg)](https://pypi.org/project/prometheus-pve-sd/)
[![Codecov](https://img.shields.io/codecov/c/github/thegeeklab/prometheus-pve-sd)](https://codecov.io/gh/thegeeklab/prometheus-pve-sd)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/graphs/contributors) [![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) [![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) [![License: MIT](https://img.shields.io/github/license/thegeeklab/prometheus-pve-sd)](https://github.com/thegeeklab/prometheus-pve-sd/blob/main/LICENSE)

View File

@ -35,30 +35,18 @@ include_vmid: []
exclude_tags: [] exclude_tags: []
include_tags: [] include_tags: []
# Set either password or token_name and token_value
pve: pve:
server: server:
user: user:
password: password:
token_name:
token_value:
auth_timeout: 5 auth_timeout: 5
verify_ssl: true verify_ssl: true
# Example with password # Example
# pve: # pve:
# server: proxmox.example.com # server: proxmox.example.com
# user: root # user: root
# password: secure # password: secure
# auth_timeout: 5 # auth_timeout: 5
# verify_ssl: true # 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
``` ```

View File

@ -36,8 +36,6 @@ PROMETHEUS_PVE_SD_INCLUDE_TAGS=
PROMETHEUS_PVE_SD_PVE_SERVER= PROMETHEUS_PVE_SD_PVE_SERVER=
PROMETHEUS_PVE_SD_PVE_USER= PROMETHEUS_PVE_SD_PVE_USER=
PROMETHEUS_PVE_SD_PVE_PASSWORD= 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_AUTH_TIMEOUT=5
PROMETHEUS_PVE_SD_PVE_VERIFY_SSL=true PROMETHEUS_PVE_SD_PVE_VERIFY_SSL=true
``` ```

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 40 KiB

956
poetry.lock generated

File diff suppressed because it is too large Load Diff

View File

@ -59,7 +59,7 @@ class PrometheusSD:
"--config", "--config",
dest="config_file", dest="config_file",
action="store", action="store",
help="location of configuration file", help="location of configuration file"
) )
parser.add_argument( parser.add_argument(
"-o", "--output", dest="output_file", action="store", help="output file" "-o", "--output", dest="output_file", action="store", help="output file"
@ -73,14 +73,14 @@ class PrometheusSD:
dest="loop_delay", dest="loop_delay",
action="store", action="store",
type=int, type=int,
help="delay between discovery runs", help="delay between discovery runs"
) )
parser.add_argument( parser.add_argument(
"--no-service", "--no-service",
dest="service", dest="service",
action="store_false", action="store_false",
default=None, default=None,
help="run discovery only once", help="run discovery only once"
) )
parser.add_argument( parser.add_argument(
"-f", "-f",
@ -88,7 +88,7 @@ class PrometheusSD:
dest="logging.format", dest="logging.format",
metavar="LOG_FORMAT", metavar="LOG_FORMAT",
action="store", action="store",
help="used log format", help="used log format"
) )
parser.add_argument( parser.add_argument(
"-v", dest="logging.level", action="append_const", const=-1, help="increase log level" "-v", dest="logging.level", action="append_const", const=-1, help="increase log level"
@ -111,24 +111,15 @@ class PrometheusSD:
config.config["logging"]["level"], config.config["logging"]["format"] config.config["logging"]["level"], config.config["logging"]["format"]
) )
except ValueError as e: except ValueError as e:
self.log.sysexit_with_message(f"Can not set log level.\n{e!s}") self.log.sysexit_with_message(f"Can not set log level.\n{str(e)}")
required = [ required = [("pve.server", config.config["pve"]["server"]),
("pve.server", config.config["pve"]["server"]),
("pve.user", config.config["pve"]["user"]), ("pve.user", config.config["pve"]["user"]),
] ("pve.password", config.config["pve"]["password"])]
for name, value in required: for name, value in required:
if not value: if not value:
self.log.sysexit_with_message(f"Option '{name}' is required but not set") self.log.sysexit_with_message(f"Option '{name}' is required but not set")
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}") self.logger.info(f"Using config file {config.config_file}")
return config return config
@ -145,7 +136,7 @@ class PrometheusSD:
) )
start_http_server( start_http_server(
self.config.config["metrics"]["port"], self.config.config["metrics"]["port"],
addr=self.config.config["metrics"]["address"], addr=self.config.config["metrics"]["address"]
) )
while True: while True:
@ -174,10 +165,11 @@ class PrometheusSD:
output.append(host.to_sd_json()) output.append(host.to_sd_json())
# Write to tmp file and move after write # Write to tmp file and move after write
with tempfile.NamedTemporaryFile(mode="w", prefix="prometheus-pve-sd", delete=False) as tf: temp_file = tempfile.NamedTemporaryFile(mode="w", prefix="prometheus-pve-sd", delete=False)
with temp_file as tf:
json.dump(output, tf, indent=4) json.dump(output, tf, indent=4)
shutil.move(tf.name, self.config.config["output_file"]) shutil.move(temp_file.name, self.config.config["output_file"])
chmod(self.config.config["output_file"], int(self.config.config["output_file_mode"], 8)) chmod(self.config.config["output_file"], int(self.config.config["output_file_mode"], 8))
def _terminate(self, signal, frame): # noqa def _terminate(self, signal, frame): # noqa

View File

@ -1,5 +1,4 @@
"""Proxmox Client.""" """Proxmox Client."""
import requests import requests
from prometheus_client import Counter from prometheus_client import Counter
@ -11,7 +10,6 @@ from prometheuspvesd.utils import to_bool
try: try:
from proxmoxer import ProxmoxAPI from proxmoxer import ProxmoxAPI
HAS_PROXMOXER = True HAS_PROXMOXER = True
except ImportError: except ImportError:
HAS_PROXMOXER = False HAS_PROXMOXER = False
@ -46,24 +44,12 @@ class ProxmoxClient:
self.config.config["pve"]["server"], self.config.config["pve"]["user"] 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( return ProxmoxAPI(
self.config.config["pve"]["server"], self.config.config["pve"]["server"],
user=self.config.config["pve"]["user"], user=self.config.config["pve"]["user"],
password=self.config.config["pve"]["password"], password=self.config.config["pve"]["password"],
verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]), verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
timeout=self.config.config["pve"]["auth_timeout"], timeout=self.config.config["pve"]["auth_timeout"]
) )
except requests.RequestException as e: except requests.RequestException as e:
PVE_REQUEST_COUNT_ERROR_TOTAL.inc() PVE_REQUEST_COUNT_ERROR_TOTAL.inc()
@ -100,6 +86,5 @@ class ProxmoxClient:
def get_network_interfaces(self, pve_node, vmid): def get_network_interfaces(self, pve_node, vmid):
self.logger.debug(f"fetching network interfaces for {vmid} on {pve_node}") self.logger.debug(f"fetching network interfaces for {vmid} on {pve_node}")
return self._do_request(pve_node, "qemu", vmid, "agent", "network-get-interfaces")[ return self._do_request(pve_node, "qemu", vmid, "agent",
"result" "network-get-interfaces")["result"]
]

View File

@ -20,7 +20,7 @@ cache_dir = AppDirs("prometheus-pve-sd").user_cache_dir
default_output_file = os.path.join(cache_dir, "pve.json") default_output_file = os.path.join(cache_dir, "pve.json")
class Config: class Config():
""" """
Create an object with all necessary settings. Create an object with all necessary settings.
@ -34,130 +34,118 @@ class Config:
"metrics.enabled": { "metrics.enabled": {
"default": True, "default": True,
"env": "METRICS_ENABLED", "env": "METRICS_ENABLED",
"type": environs.Env().bool, "type": environs.Env().bool
}, },
"metrics.address": { "metrics.address": {
"default": "127.0.0.1", "default": "127.0.0.1",
"env": "METRICS_ADDRESS", "env": "METRICS_ADDRESS",
"type": environs.Env().str, "type": environs.Env().str
}, },
"metrics.port": { "metrics.port": {
"default": 8000, "default": 8000,
"env": "METRICS_PORT", "env": "METRICS_PORT",
"type": environs.Env().int, "type": environs.Env().int
}, },
"config_file": { "config_file": {
"default": "", "default": "",
"env": "CONFIG_FILE", "env": "CONFIG_FILE",
"type": environs.Env().str, "type": environs.Env().str
}, },
"logging.level": { "logging.level": {
"default": "WARNING", "default": "WARNING",
"env": "LOG_LEVEL", "env": "LOG_LEVEL",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"logging.format": { "logging.format": {
"default": "console", "default": "console",
"env": "LOG_FORMAT", "env": "LOG_FORMAT",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"output_file": { "output_file": {
"default": default_output_file, "default": default_output_file,
"env": "OUTPUT_FILE", "env": "OUTPUT_FILE",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"output_file_mode": { "output_file_mode": {
"default": "0640", "default": "0640",
"env": "OUTPUT_FILE_MODE", "env": "OUTPUT_FILE_MODE",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"loop_delay": { "loop_delay": {
"default": 300, "default": 300,
"env": "LOOP_DELAY", "env": "LOOP_DELAY",
"file": True, "file": True,
"type": environs.Env().int, "type": environs.Env().int
}, },
"service": { "service": {
"default": True, "default": True,
"env": "SERVICE", "env": "SERVICE",
"file": True, "file": True,
"type": environs.Env().bool, "type": environs.Env().bool
}, },
"exclude_state": { "exclude_state": {
"default": [], "default": [],
"env": "EXCLUDE_STATE", "env": "EXCLUDE_STATE",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"exclude_vmid": { "exclude_vmid": {
"default": [], "default": [],
"env": "EXCLUDE_VMID", "env": "EXCLUDE_VMID",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"include_vmid": { "include_vmid": {
"default": [], "default": [],
"env": "INCLUDE_VMID", "env": "INCLUDE_VMID",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"exclude_tags": { "exclude_tags": {
"default": [], "default": [],
"env": "EXCLUDE_TAGS", "env": "EXCLUDE_TAGS",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"include_tags": { "include_tags": {
"default": [], "default": [],
"env": "INCLUDE_TAGS", "env": "INCLUDE_TAGS",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"pve.server": { "pve.server": {
"default": "", "default": "",
"env": "PVE_SERVER", "env": "PVE_SERVER",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"pve.user": { "pve.user": {
"default": "", "default": "",
"env": "PVE_USER", "env": "PVE_USER",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"pve.password": { "pve.password": {
"default": "", "default": "",
"env": "PVE_PASSWORD", "env": "PVE_PASSWORD",
"file": True, "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": { "pve.auth_timeout": {
"default": 5, "default": 5,
"env": "PVE_AUTH_TIMEOUT", "env": "PVE_AUTH_TIMEOUT",
"file": True, "file": True,
"type": environs.Env().int, "type": environs.Env().int
}, },
"pve.verify_ssl": { "pve.verify_ssl": {
"default": True, "default": True,
"env": "PVE_VERIFY_SSL", "env": "PVE_VERIFY_SSL",
"file": True, "file": True,
"type": environs.Env().bool, "type": environs.Env().bool
}, },
} }
@ -219,7 +207,7 @@ class Config:
else: else:
raise prometheuspvesd.exception.ConfigError( raise prometheuspvesd.exception.ConfigError(
"Unable to read environment variable", str(e) "Unable to read environment variable", str(e)
) from e )
return normalized return normalized
@ -245,8 +233,7 @@ class Config:
try: try:
file_dict = ruamel.yaml.YAML(typ="safe", pure=True).load(s) file_dict = ruamel.yaml.YAML(typ="safe", pure=True).load(s)
except ( except (
ruamel.yaml.composer.ComposerError, ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
ruamel.yaml.scanner.ScannerError,
) as e: ) as e:
message = f"{e.context} {e.problem}" message = f"{e.context} {e.problem}"
raise prometheuspvesd.exception.ConfigError( raise prometheuspvesd.exception.ConfigError(
@ -285,19 +272,20 @@ class Config:
try: try:
anyconfig.validate(config, self.schema, ac_schema_safe=False) anyconfig.validate(config, self.schema, ac_schema_safe=False)
except jsonschema.exceptions.ValidationError as e: except jsonschema.exceptions.ValidationError as e:
schema = format_as_index(list(e.relative_schema_path)[:-1], 0) schema_error = "Failed validating '{validator}' in schema{schema}\n{message}".format(
schema_error = f"Failed validating '{e.validator}' in schema {schema}\n{e.message}" validator=e.validator,
schema=format_as_index(list(e.relative_schema_path)[:-1], 0),
message=e.message
)
raise prometheuspvesd.exception.ConfigError("Configuration error", schema_error) from e raise prometheuspvesd.exception.ConfigError("Configuration error", schema_error) from e
return True return True
def _add_dict_branch(self, tree, vector, value): def _add_dict_branch(self, tree, vector, value):
key = vector[0] key = vector[0]
tree[key] = ( tree[key] = value \
value if len(vector) == 1 \
if len(vector) == 1 else self._add_dict_branch(tree[key] if key in tree else {}, vector[1:], value)
else self._add_dict_branch(tree.get(key, {}), vector[1:], value)
)
return tree return tree

View File

@ -20,7 +20,7 @@ PROPAGATION_TIME = Summary(
HOST_GAUGE = Gauge("pve_sd_hosts", "Number of hosts discovered by PVE SD") HOST_GAUGE = Gauge("pve_sd_hosts", "Number of hosts discovered by PVE SD")
class Discovery: class Discovery():
"""Prometheus PVE Service Discovery.""" """Prometheus PVE Service Discovery."""
def __init__(self): def __init__(self):
@ -38,7 +38,7 @@ class Discovery:
elif pve_type == "pool": elif pve_type == "pool":
names = [pool["poolid"] for pool in pve_list] names = [pool["poolid"] for pool in pve_list]
return names return names # noqa
def _get_variables(self, pve_list, pve_type): def _get_variables(self, pve_list, pve_type):
variables = {} variables = {}
@ -61,10 +61,10 @@ class Discovery:
try: try:
if self.client.get_agent_info(pve_node, pve_type, vmid) is not None: if self.client.get_agent_info(pve_node, pve_type, vmid) is not None:
networks = self.client.get_network_interfaces(pve_node, vmid) networks = self.client.get_network_interfaces(pve_node, vmid)
except Exception: # noqa except Exception: # noqa # nosec
pass pass # noqa
if isinstance(networks, list): if type(networks) is list:
for network in networks: for network in networks:
for ip_address in network.get("ip-addresses", []): for ip_address in network.get("ip-addresses", []):
if ip_address["ip-address-type"] == "ipv4" and not ipv4_address: if ip_address["ip-address-type"] == "ipv4" and not ipv4_address:
@ -85,8 +85,8 @@ class Discovery:
if find and find.group(1): if find and find.group(1):
ipv4_address = find.group(1) ipv4_address = find.group(1)
break break
except Exception: # noqa except Exception: # noqa # nosec
pass pass # noqa
if config and not ipv6_address: if config and not ipv6_address:
try: try:
@ -102,8 +102,8 @@ class Discovery:
if find and find.group(1): if find and find.group(1):
ipv6_address = find.group(1) ipv6_address = find.group(1)
break break
except Exception: # noqa except Exception: # noqa # nosec
pass pass # noqa
return ipv4_address, ipv6_address return ipv4_address, ipv6_address
@ -111,22 +111,17 @@ class Discovery:
filtered = [] filtered = []
for item in pve_list: for item in pve_list:
obj = defaultdict(dict, item) 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 ( if (
len(self.config.config["include_vmid"]) > 0 len(self.config.config["include_vmid"]) > 0
and str(obj["vmid"]) not in self.config.config["include_vmid"] and str(obj["vmid"]) not in self.config.config["include_vmid"]
): ):
continue continue
if len(self.config.config["include_tags"]) > 0 and ( if (
len(self.config.config["include_tags"]) > 0 and (
bool(obj["tags"]) is False # continue if tags is not set bool(obj["tags"]) is False # continue if tags is not set
or set(tags).isdisjoint(self.config.config["include_tags"]) or set(obj["tags"].split(",")).isdisjoint(self.config.config["include_tags"])
)
): ):
continue continue
@ -139,11 +134,10 @@ class Discovery:
if str(obj["vmid"]) in self.config.config["exclude_vmid"]: if str(obj["vmid"]) in self.config.config["exclude_vmid"]:
continue continue
if isinstance(obj["tags"], str) and not set(tags).isdisjoint(tags_excl): if (
self.logger.debug( isinstance(obj["tags"], str)
f"vmid {obj['vmid']}: " and not set(obj["tags"].split(",")).isdisjoint(self.config.config["exclude_tags"])
f"excluded by tags: {list(set(tags).intersection(tags_excl))}" ):
)
continue continue
filtered.append(item.copy()) filtered.append(item.copy())
@ -162,13 +156,12 @@ class Discovery:
@PROPAGATION_TIME.time() @PROPAGATION_TIME.time()
def propagate(self): def propagate(self):
self.host_list.clear() self.host_list.clear()
nodelist = self._get_names(self.client.get_nodes(), "node")
self.logger.info(f"Discovered nodes: {','.join(nodelist)}") for node in self._get_names(self.client.get_nodes(), "node"):
for node in nodelist:
try: try:
qemu_list = self._filter(self.client.get_all_vms(node)) qemu_list = self._filter(self.client.get_all_vms(node))
container_list = self._filter(self.client.get_all_containers(node)) container_list = self._filter(self.client.get_all_containers(node))
except Exception as e: except Exception as e: # noqa
raise APIError(str(e)) from e raise APIError(str(e)) from e
# Merge QEMU and Containers lists from this node # Merge QEMU and Containers lists from this node
@ -176,7 +169,7 @@ class Discovery:
instances.update(self._get_variables(container_list, "container")) instances.update(self._get_variables(container_list, "container"))
HOST_GAUGE.set(len(instances)) HOST_GAUGE.set(len(instances))
self.logger.info(f"{node}: Found {len(instances)} targets") self.logger.info(f"Found {len(instances)} targets")
for host in instances: for host in instances:
host_meta = instances[host] host_meta = instances[host]
vmid = host_meta["proxmox_vmid"] vmid = host_meta["proxmox_vmid"]
@ -189,10 +182,10 @@ class Discovery:
config = self.client.get_instance_config(node, pve_type, vmid) config = self.client.get_instance_config(node, pve_type, vmid)
try: try:
description = config["description"] description = (config["description"])
except KeyError: except KeyError:
description = None description = None
except Exception as e: except Exception as e: # noqa
raise APIError(str(e)) from e raise APIError(str(e)) from e
try: try:

View File

@ -46,14 +46,14 @@ class LogFilter:
class SimpleFormatter(logging.Formatter): class SimpleFormatter(logging.Formatter):
"""Logging Formatter for simple logs.""" """Logging Formatter for simple logs."""
def format(self, record): def format(self, record): # noqa
return logging.Formatter.format(self, record) return logging.Formatter.format(self, record)
class MultilineFormatter(logging.Formatter): class MultilineFormatter(logging.Formatter):
"""Logging Formatter to reset color after newline characters.""" """Logging Formatter to reset color after newline characters."""
def format(self, record): def format(self, record): # noqa
record.msg = record.msg.replace("\n", f"\n{colorama.Style.RESET_ALL}... ") record.msg = record.msg.replace("\n", f"\n{colorama.Style.RESET_ALL}... ")
return logging.Formatter.format(self, record) return logging.Formatter.format(self, record)
@ -61,7 +61,7 @@ class MultilineFormatter(logging.Formatter):
class MultilineJsonFormatter(jsonlogger.JsonFormatter): class MultilineJsonFormatter(jsonlogger.JsonFormatter):
"""Logging Formatter to remove newline characters.""" """Logging Formatter to remove newline characters."""
def format(self, record): def format(self, record): # noqa
record.msg = record.msg.replace("\n", " ") record.msg = record.msg.replace("\n", " ")
return jsonlogger.JsonFormatter.format(self, record) return jsonlogger.JsonFormatter.format(self, record)

View File

@ -19,10 +19,8 @@ class Host:
self.add_label("vmid", vmid) self.add_label("vmid", vmid)
def __str__(self): def __str__(self):
return ( return f"{self.hostname}({self.vmid}): {self.pve_type} \
f"{self.hostname}({self.vmid}): " {self.ipv4_address} {self.ipv6_address}"
f"{self.pve_type} {self.ipv4_address} {self.ipv6_address}"
)
def add_label(self, key, value): def add_label(self, key, value):
key = key.replace("-", "_").replace(" ", "_") key = key.replace("-", "_").replace(" ", "_")

View File

@ -24,7 +24,5 @@ pve:
server: proxmox.example.com server: proxmox.example.com
user: root user: root
password: secure password: secure
token_name: pve_sd
token_value: 01234567-89ab-cdef-0123-456789abcdef
auth_timeout: 5 auth_timeout: 5
verify_ssl: true verify_ssl: true

View File

@ -3,7 +3,8 @@
import environs import environs
import pytest import pytest
from prometheuspvesd.model import Host, HostList from prometheuspvesd.model import Host
from prometheuspvesd.model import HostList
@pytest.fixture @pytest.fixture
@ -12,118 +13,119 @@ def builtins():
"metrics.enabled": { "metrics.enabled": {
"default": True, "default": True,
"env": "METRICS_ENABLED", "env": "METRICS_ENABLED",
"type": environs.Env().bool, "type": environs.Env().bool
}, },
"metrics.address": { "metrics.address": {
"default": "127.0.0.1", "default": "127.0.0.1",
"env": "METRICS_ADDRESS", "env": "METRICS_ADDRESS",
"type": environs.Env().str, "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
}, },
"metrics.port": {"default": 8000, "env": "METRICS_PORT", "type": environs.Env().int},
"config_file": {"default": "", "env": "CONFIG_FILE", "type": environs.Env().str},
"logging.level": { "logging.level": {
"default": "WARNING", "default": "WARNING",
"env": "LOG_LEVEL", "env": "LOG_LEVEL",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"logging.format": { "logging.format": {
"default": "console", "default": "console",
"env": "LOG_FORMAT", "env": "LOG_FORMAT",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"output_file": { "output_file": {
"default": "dummy", "default": "dummy",
"env": "OUTPUT_FILE", "env": "OUTPUT_FILE",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"output_file_mode": { "output_file_mode": {
"default": "0640", "default": "0640",
"env": "OUTPUT_FILE_MODE", "env": "OUTPUT_FILE_MODE",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"loop_delay": { "loop_delay": {
"default": 300, "default": 300,
"env": "LOOP_DELAY", "env": "LOOP_DELAY",
"file": True, "file": True,
"type": environs.Env().int, "type": environs.Env().int
},
"service": {
"default": False,
"env": "SERVICE",
"file": True,
"type": environs.Env().bool
}, },
"service": {"default": False, "env": "SERVICE", "file": True, "type": environs.Env().bool},
"exclude_state": { "exclude_state": {
"default": [], "default": [],
"env": "EXCLUDE_STATE", "env": "EXCLUDE_STATE",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"exclude_vmid": { "exclude_vmid": {
"default": [], "default": [],
"env": "EXCLUDE_VMID", "env": "EXCLUDE_VMID",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"exclude_tags": { "exclude_tags": {
"default": [], "default": [],
"env": "EXCLUDE_TAGS", "env": "EXCLUDE_TAGS",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"include_vmid": { "include_vmid": {
"default": [], "default": [],
"env": "INCLUDE_VMID", "env": "INCLUDE_VMID",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"include_tags": { "include_tags": {
"default": [], "default": [],
"env": "INCLUDE_TAGS", "env": "INCLUDE_TAGS",
"file": True, "file": True,
"type": environs.Env().list, "type": environs.Env().list
}, },
"pve.server": { "pve.server": {
"default": "dummyserver", "default": "dummyserver",
"env": "PVE_SERVER", "env": "PVE_SERVER",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"pve.user": { "pve.user": {
"default": "dummyuser", "default": "dummyuser",
"env": "PVE_USER", "env": "PVE_USER",
"file": True, "file": True,
"type": environs.Env().str, "type": environs.Env().str
}, },
"pve.password": { "pve.password": {
"default": "dummypass", "default": "dummypass",
"env": "PVE_PASSWORD", "env": "PVE_PASSWORD",
"file": True, "file": True,
"type": environs.Env().str, "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": { "pve.auth_timeout": {
"default": 5, "default": 5,
"env": "PVE_AUTH_TIMEOUT", "env": "PVE_AUTH_TIMEOUT",
"file": True, "file": True,
"type": environs.Env().int, "type": environs.Env().int
}, },
"pve.verify_ssl": { "pve.verify_ssl": {
"default": True, "default": True,
"env": "PVE_VERIFY_SSL", "env": "PVE_VERIFY_SSL",
"file": True, "file": True,
"type": environs.Env().bool, "type": environs.Env().bool
}, }
} }
@ -135,9 +137,16 @@ def defaults():
"exclude_vmid": [], "exclude_vmid": [],
"include_tags": [], "include_tags": [],
"include_vmid": [], "include_vmid": [],
"logging": {"format": "console", "level": "WARNING"}, "logging": {
"format": "console",
"level": "WARNING"
},
"loop_delay": 300, "loop_delay": 300,
"metrics": {"address": "127.0.0.1", "enabled": True, "port": 8000}, "metrics": {
"address": "127.0.0.1",
"enabled": True,
"port": 8000
},
"output_file": "dummy", "output_file": "dummy",
"output_file_mode": "0640", "output_file_mode": "0640",
"pve": { "pve": {
@ -145,9 +154,7 @@ def defaults():
"password": "", "password": "",
"server": "", "server": "",
"user": "", "user": "",
"token_name": "", "verify_ssl": True
"token_value": "",
"verify_ssl": True,
}, },
"service": True, "service": True,
} }
@ -155,8 +162,7 @@ def defaults():
@pytest.fixture @pytest.fixture
def nodes(): def nodes():
return [ return [{
{
"level": "", "level": "",
"id": "node/example-node", "id": "node/example-node",
"disk": 4783488, "disk": 4783488,
@ -168,9 +174,8 @@ def nodes():
"type": "node", "type": "node",
"status": "online", "status": "online",
"maxdisk": 504209920, "maxdisk": 504209920,
"uptime": 200, "uptime": 200
} }]
]
@pytest.fixture @pytest.fixture
@ -193,7 +198,7 @@ def qemus():
"status": "running", "status": "running",
"netout": 12159205236, "netout": 12159205236,
"mem": 496179157, "mem": 496179157,
"tags": "unmonitored;excluded;postgres", "tags": "unmonitored,excluded,postgres"
}, },
{ {
"diskwrite": 0, "diskwrite": 0,
@ -211,7 +216,7 @@ def qemus():
"disk": 0, "disk": 0,
"status": "running", "status": "running",
"netout": 12159205236, "netout": 12159205236,
"mem": 496179157, "mem": 496179157
}, },
{ {
"diskwrite": 0, "diskwrite": 0,
@ -230,7 +235,7 @@ def qemus():
"status": "prelaunch", "status": "prelaunch",
"netout": 12159205236, "netout": 12159205236,
"mem": 496179157, "mem": 496179157,
"tags": "monitored", "tags": "monitored"
}, },
] ]
@ -242,17 +247,19 @@ def instance_config():
"description": '{"groups": "test-group"}', "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", "net0": "virtio=D8-85-75-47-2E-8D,bridge=vmbr122,ip=192.0.2.25,ip=2001:db8::666:77:8888",
"cpu": 2, "cpu": 2,
"cores": 2, "cores": 2
} }
@pytest.fixture @pytest.fixture
def agent_info(): def agent_info():
return { return {
"supported_commands": [ "supported_commands": [{
{"name": "guest-network-get-interfaces", "enabled": True, "success-response": True} "name": "guest-network-get-interfaces",
], "enabled": True,
"version": "5.2.0", "success-response": True
}],
"version": "5.2.0"
} }
@ -289,8 +296,16 @@ def networks():
{ {
"hardware-address": "00:00:00:00:00:00", "hardware-address": "00:00:00:00:00:00",
"ip-addresses": [ "ip-addresses": [
{"ip-address": "127.0.0.1", "ip-address-type": "ipv4", "prefix": 8}, {
{"ip-address": "::1", "ip-address-type": "ipv6", "prefix": 128}, "ip-address": "127.0.0.1",
"ip-address-type": "ipv4",
"prefix": 8
},
{
"ip-address": "::1",
"ip-address-type": "ipv6",
"prefix": 128
},
], ],
"name": "lo", "name": "lo",
"statistics": { "statistics": {
@ -301,18 +316,26 @@ def networks():
"tx-bytes": 9280, "tx-bytes": 9280,
"tx-dropped": 0, "tx-dropped": 0,
"tx-errs": 0, "tx-errs": 0,
"tx-packets": 92, "tx-packets": 92
}, }
}, },
{ {
"hardware-address": "92:0b:bd:c1:f8:39", "hardware-address": "92:0b:bd:c1:f8:39",
"ip-addresses": [ "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": "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": "2001:db8:3333:4444:5555:6666:7777:8888",
"ip-address-type": "ipv6", "ip-address-type": "ipv6",
"prefix": 64, "prefix": 64
}, },
], ],
"name": "eth0", "name": "eth0",
@ -324,10 +347,13 @@ def networks():
"tx-bytes": 12185866619, "tx-bytes": 12185866619,
"tx-dropped": 0, "tx-dropped": 0,
"tx-errs": 0, "tx-errs": 0,
"tx-packets": 14423878, "tx-packets": 14423878
}
}, },
{
"hardware-address": "ba:97:85:bd:9a:a5",
"name": "eth1"
}, },
{"hardware-address": "ba:97:85:bd:9a:a5", "name": "eth1"},
] ]
@ -343,35 +369,31 @@ def inventory():
@pytest.fixture @pytest.fixture
def labels(): def labels():
return [ return [{
{
"targets": ["100.example.com"], "targets": ["100.example.com"],
"labels": { "labels": {
"__meta_pve_ipv4": "192.0.2.1", "__meta_pve_ipv4": "192.0.2.1",
"__meta_pve_ipv6": "False", "__meta_pve_ipv6": "False",
"__meta_pve_name": "100.example.com", "__meta_pve_name": "100.example.com",
"__meta_pve_type": "qemu", "__meta_pve_type": "qemu",
"__meta_pve_vmid": "100", "__meta_pve_vmid": "100"
}, }
}, }, {
{
"targets": ["101.example.com"], "targets": ["101.example.com"],
"labels": { "labels": {
"__meta_pve_ipv4": "192.0.2.2", "__meta_pve_ipv4": "192.0.2.2",
"__meta_pve_ipv6": "False", "__meta_pve_ipv6": "False",
"__meta_pve_name": "101.example.com", "__meta_pve_name": "101.example.com",
"__meta_pve_type": "qemu", "__meta_pve_type": "qemu",
"__meta_pve_vmid": "101", "__meta_pve_vmid": "101"
}, }
}, }, {
{
"targets": ["102.example.com"], "targets": ["102.example.com"],
"labels": { "labels": {
"__meta_pve_ipv4": "192.0.2.3", "__meta_pve_ipv4": "192.0.2.3",
"__meta_pve_ipv6": "False", "__meta_pve_ipv6": "False",
"__meta_pve_name": "102.example.com", "__meta_pve_name": "102.example.com",
"__meta_pve_type": "qemu", "__meta_pve_type": "qemu",
"__meta_pve_vmid": "102", "__meta_pve_vmid": "102"
}, }
}, }]
]

View File

@ -1,12 +1,8 @@
"""Pytest conftest fixtures.""" """Pytest conftest fixtures."""
import logging
import os import os
import sys import sys
from contextlib import contextmanager
import pytest import pytest
from _pytest.logging import LogCaptureHandler
from prometheuspvesd.utils import Singleton from prometheuspvesd.utils import Singleton
@ -18,43 +14,9 @@ def reset_singletons():
@pytest.fixture(autouse=True) @pytest.fixture(autouse=True)
def reset_os_environment(): def reset_os_environment():
os.environ.clear() os.environ = {}
@pytest.fixture(autouse=True) @pytest.fixture(autouse=True)
def reset_sys_argv(): def reset_sys_argv():
sys.argv = ["prometheus-pve-sd"] 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

View File

@ -1,5 +1,4 @@
"""Test CLI class.""" """Test CLI class."""
import json import json
import pytest import pytest
@ -30,68 +29,10 @@ def test_cli_required_error(mocker, capsys):
assert e.value.code == 1 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): def test_cli_config_error(mocker, capsys):
mocker.patch( mocker.patch(
"prometheuspvesd.config.SingleConfig.__init__", "prometheuspvesd.config.SingleConfig.__init__",
side_effect=prometheuspvesd.exception.ConfigError("Dummy Config Exception"), side_effect=prometheuspvesd.exception.ConfigError("Dummy Config Exception")
) )
mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI)) mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
mocker.patch.object(PrometheusSD, "_fetch", return_value=True) mocker.patch.object(PrometheusSD, "_fetch", return_value=True)

View File

@ -1,5 +1,4 @@
"""Test Config class.""" """Test Config class."""
import pytest import pytest
import ruamel.yaml import ruamel.yaml
@ -20,13 +19,11 @@ def test_yaml_config(mocker, defaults):
defaults["pve"]["user"] = "root" defaults["pve"]["user"] = "root"
defaults["pve"]["password"] = "secure" defaults["pve"]["password"] = "secure"
defaults["pve"]["server"] = "proxmox.example.com" 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 assert config.config == defaults
def test_yaml_config_error(mocker): def test_yaml_config_error(mocker, capsys):
mocker.patch( mocker.patch(
"prometheuspvesd.config.default_config_file", "./prometheuspvesd/test/data/config.yml" "prometheuspvesd.config.default_config_file", "./prometheuspvesd/test/data/config.yml"
) )

View File

@ -1,7 +1,5 @@
"""Test Discovery class.""" """Test Discovery class."""
import logging
import pytest import pytest
from proxmoxer import ProxmoxAPI from proxmoxer import ProxmoxAPI
@ -13,10 +11,6 @@ pytest_plugins = [
] ]
def records_to_messages(records):
return [r.getMessage() for r in records]
@pytest.fixture @pytest.fixture
def discovery(mocker): def discovery(mocker):
mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI)) mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
@ -38,27 +32,19 @@ def test_exclude_state(discovery, qemus):
assert len(filtered) == 2 assert len(filtered) == 2
def test_exclude_tags(discovery, qemus, local_caplog): def test_exclude_tags(discovery, qemus):
discovery.config.config["exclude_tags"] = ["unmonitored"] discovery.config.config["exclude_tags"] = ["unmonitored"]
with local_caplog(level=logging.DEBUG) as caplog:
filtered = discovery._filter(qemus) 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 assert len(filtered) == 2
@pytest.mark.parametrize( @pytest.mark.parametrize(
"testinput,expected", "testinput,expected", [
[
(["monitored"], 1), (["monitored"], 1),
(["monitored", "postgres"], 2), (["monitored", "postgres"], 2),
([], 3), ([], 3),
], ]
) )
def test_include_tags(discovery, qemus, testinput, expected): def test_include_tags(discovery, qemus, testinput, expected):
discovery.config.config["include_tags"] = testinput discovery.config.config["include_tags"] = testinput
@ -67,13 +53,10 @@ def test_include_tags(discovery, qemus, testinput, expected):
assert len(filtered) == expected assert len(filtered) == expected
@pytest.mark.parametrize( @pytest.mark.parametrize("testinput,expected", [
"testinput,expected",
[
(["101", "100"], 2), (["101", "100"], 2),
([], 3), ([], 3),
], ])
)
def test_include_vmid(discovery, qemus, testinput, expected): def test_include_vmid(discovery, qemus, testinput, expected):
discovery.config.config["include_vmid"] = testinput discovery.config.config["include_vmid"] = testinput
filtered = discovery._filter(qemus) filtered = discovery._filter(qemus)

View File

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

View File

@ -1,29 +1,7 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""Global utility methods and classes.""" """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): def to_bool(string):

View File

@ -10,11 +10,11 @@ classifiers = [
"Natural Language :: English", "Natural Language :: English",
"Operating System :: POSIX", "Operating System :: POSIX",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Utilities", "Topic :: Utilities",
] ]
description = "Prometheus Service Discovery for Proxmox VE." description = "Prometheus Service Discovery for Proxmox VE."
@ -30,43 +30,56 @@ repository = "https://github.com/thegeeklab/prometheus-pve-sd/"
version = "0.0.0" version = "0.0.0"
[tool.poetry.dependencies] [tool.poetry.dependencies]
anyconfig = "0.14.0" anyconfig = "0.13.0"
appdirs = "1.4.4" appdirs = "1.4.4"
colorama = "0.4.6" colorama = "0.4.6"
environs = "11.0.0" environs = "9.5.0"
jsonschema = "4.23.0" jsonschema = "4.17.3"
nested-lookup = "0.2.25" nested-lookup = "0.2.25"
prometheus-client = "0.21.0" prometheus-client = "0.16.0"
proxmoxer = "2.1.0" proxmoxer = "2.0.1"
python = "^3.8.0" python = "^3.7.0"
python-json-logger = "2.0.7" python-json-logger = "2.0.4"
requests = "2.32.3" requests = "2.28.2"
"ruamel.yaml" = "0.18.6" "ruamel.yaml" = "0.17.21"
[tool.poetry.scripts] [tool.poetry.scripts]
prometheus-pve-sd = "prometheuspvesd.cli:main" prometheus-pve-sd = "prometheuspvesd.cli:main"
[tool.poetry.group.dev.dependencies] [tool.poetry.group.dev.dependencies]
ruff = "0.7.1" ruff = "0.0.243"
pytest = "8.3.3" pytest = "7.2.1"
pytest-mock = "3.14.0" pytest-mock = "3.10.0"
pytest-cov = "5.0.0" pytest-cov = "4.0.0"
toml = "0.10.2" toml = "0.10.2"
yapf = "0.32.0"
[tool.poetry-dynamic-versioning] [tool.poetry-dynamic-versioning]
enable = true enable = true
style = "semver" style = "semver"
vcs = "git" 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] [tool.pytest.ini_options]
addopts = "prometheuspvesd --cov=prometheuspvesd --cov-report=xml:coverage.xml --cov-report=term-missing --no-cov-on-fail --cov-fail-under=80" addopts = "prometheuspvesd --cov=prometheuspvesd --cov-report=xml:coverage.xml --cov-report=term --no-cov-on-fail"
filterwarnings = ["ignore::FutureWarning", "ignore::DeprecationWarning"] filterwarnings = [
"ignore::FutureWarning",
"ignore:.*distutils.*:DeprecationWarning",
"ignore:.*collections.*:DeprecationWarning",
"ignore:.*pep8.*:FutureWarning",
]
[tool.coverage.run] [tool.coverage.run]
omit = ["**/test/*"] omit = ["**/test/*"]
[build-system] [build-system]
build-backend = "poetry_dynamic_versioning.backend" build-backend = "poetry.core.masonry.api"
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"] requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
[tool.ruff] [tool.ruff]
@ -75,17 +88,13 @@ exclude = [
"__pycache__", "__pycache__",
"build", "build",
"dist", "dist",
"test",
"*.pyc", "*.pyc",
"*.egg-info", "*.egg-info",
".cache", ".cache",
".eggs", ".eggs",
"env*", "env*",
] ]
line-length = 99
indent-width = 4
[tool.ruff.lint]
# Explanation of errors # Explanation of errors
# #
# D102: Missing docstring in public method # D102: Missing docstring in public method
@ -103,9 +112,8 @@ ignore = [
"D202", "D202",
"D203", "D203",
"D212", "D212",
"UP038",
"RUF012",
] ]
line-length = 99
select = [ select = [
"D", "D",
"E", "E",
@ -128,10 +136,14 @@ select = [
"RUF", "RUF",
] ]
[tool.ruff.lint.per-file-ignores] [tool.ruff.flake8-quotes]
"test_*.py" = ["S"] inline-quotes = "double"
[tool.ruff.format] [tool.yapf]
quote-style = "double" based_on_style = "google"
indent-style = "space" column_limit = 99
line-ending = "lf" dedent_closing_brackets = true
coalesce_brackets = true
split_before_logical_operator = true
indent_dictionary_value = true
allow_split_before_dict_value = false

View File

@ -1,12 +1,4 @@
{ {
"$schema": "https://docs.renovatebot.com/renovate-schema.json", "$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
}
]
} }