initial commit

This commit is contained in:
Robert Kaussow 2021-07-12 22:38:50 +02:00
commit 0d775b75ba
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0
26 changed files with 708 additions and 0 deletions

159
.drone.jsonnet Normal file
View File

@ -0,0 +1,159 @@
local PipelineLinting = {
kind: 'pipeline',
name: 'linting',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'ansible-later',
image: 'thegeeklab/ansible-later',
commands: [
'ansible-later',
],
},
{
name: 'python-format',
image: 'python:3.9',
environment: {
PY_COLORS: 1,
},
commands: [
'pip install -qq yapf',
'[ ! -z "$(find . -type f -name *.py)" ] && yapf -rd ./',
],
},
{
name: 'python-flake8',
image: 'python:3.9',
environment: {
PY_COLORS: 1,
},
commands: [
'pip install -qq flake8',
'flake8',
],
},
],
trigger: {
ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
},
};
local PipelineDeployment(scenario='centos7') = {
kind: 'pipeline',
name: 'testing-' + scenario,
platform: {
os: 'linux',
arch: 'amd64',
},
concurrency: {
limit: 1,
},
workspace: {
base: '/drone/src',
path: '${DRONE_REPO_NAME}',
},
steps: [
{
name: 'ansible-molecule',
image: 'thegeeklab/molecule:3',
environment: {
HCLOUD_TOKEN: { from_secret: 'hcloud_token' },
},
commands: [
'molecule test -s ' + scenario,
],
},
],
depends_on: [
'linting',
],
trigger: {
ref: ['refs/heads/master', 'refs/tags/**'],
},
};
local PipelineDocumentation = {
kind: 'pipeline',
name: 'documentation',
platform: {
os: 'linux',
arch: 'amd64',
},
steps: [
{
name: 'generate',
image: 'thegeeklab/ansible-doctor',
environment: {
ANSIBLE_DOCTOR_LOG_LEVEL: 'INFO',
ANSIBLE_DOCTOR_FORCE_OVERWRITE: true,
ANSIBLE_DOCTOR_EXCLUDE_FILES: 'molecule/',
ANSIBLE_DOCTOR_TEMPLATE: 'hugo-book',
ANSIBLE_DOCTOR_ROLE_NAME: '${DRONE_REPO_NAME#*.}',
ANSIBLE_DOCTOR_OUTPUT_DIR: '_docs/',
},
},
{
name: 'publish',
image: 'plugins/gh-pages',
settings: {
remote_url: 'https://gitea.rknet.org/ansible/${DRONE_REPO_NAME}',
netrc_machine: 'gitea.rknet.org',
username: { from_secret: 'gitea_username' },
password: { from_secret: 'gitea_token' },
pages_directory: '_docs/',
target_branch: 'docs',
},
when: {
ref: ['refs/heads/master'],
},
},
],
trigger: {
ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
},
depends_on: [
'testing-centos7',
],
};
local PipelineNotification = {
kind: 'pipeline',
name: 'notification',
platform: {
os: 'linux',
arch: 'amd64',
},
clone: {
disable: true,
},
steps: [
{
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' },
},
},
],
depends_on: [
'documentation',
],
trigger: {
status: ['success', 'failure'],
ref: ['refs/heads/master', 'refs/tags/**'],
},
};
[
PipelineLinting,
PipelineDeployment(scenario='centos7'),
PipelineDocumentation,
PipelineNotification,
]

11
.gitignore vendored Normal file
View File

@ -0,0 +1,11 @@
# ---> Ansible
*.retry
plugins
library
# ---> Python
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

19
.later.yml Normal file
View File

@ -0,0 +1,19 @@
---
ansible:
custom_modules:
- iptables_raw
- openssl_pkcs12
- proxmox_kvm
- ucr
- corenetworks_dns
- corenetworks_token
rules:
exclude_files:
- molecule/
- "LICENSE*"
- "**/*.md"
- "**/*.ini"
exclude_filter:
- LINT0009

1
.prettierignore Normal file
View File

@ -0,0 +1 @@
.drone*

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

10
README.md Normal file
View File

@ -0,0 +1,10 @@
# xoxys.pve_sd
[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.pve_sd?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.pve_sd)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](LICENSE)
Setup Proxmox VE service discovery for Prometheus. You can find the full documentation at [https://galaxy.geekdocs.de](https://galaxy.geekdocs.de/roles/cloud/pve_sd/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

25
defaults/main.yml Normal file
View File

@ -0,0 +1,25 @@
---
# @var pve_sd_version:description: Set a fix version of the PVE SD package to install.
# @var pve_sd_version: $ "_unset_"
# @var pve_sd_packages_extra:description: Extra packages to install with pip (e.g. DNS plugins).
pve_sd_packages_extra: []
pve_sd_virtualenv_command: /usr/bin/python3 -m venv
pve_sd_virtualenv: /opt/python3/pve_sd
pve_sd_user: "prometheus_adm"
pve_sd_group: "{{ pve_sd_user }}"
pve_sd_extra_groups: []
# @var pve_sd_interval:description: Interval for the systemd timer.
pve_sd_interval: "*:0/15"
pve_sd_service_stopped: False
pve_sd_log_level: info
pve_sd_log_format: console
pve_sd_output_file: /out/pve.json
pve_sd_service: False
pve_sd_pve_server: pve.example.com
pve_sd_pve_user: root
pve_sd_pve_password: secure

9
handlers/main.yml Normal file
View File

@ -0,0 +1,9 @@
---
- name: Restart PVE SD
service:
state: "{{ pve_sd_service_stopped | ternary('stopped', 'restarted', 'restarted') }}"
daemon_reload: yes
name: pve_sd
listen: __pve_sd_restart
become: True
become_user: root

23
meta/main.yml Normal file
View File

@ -0,0 +1,23 @@
# Standards: 0.2
---
galaxy_info:
# @meta author:value: [Robert Kaussow](https://gitea.rknet.org/xoxys)
author: "Robert Kaussow <mail@thegeeklab.de>"
namespace: xoxys
role_name: pve_sd
# @meta description: >
# [![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.pve_sd)
# [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.pve_sd?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.pve_sd)
# [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.pve_sd/src/branch/main/LICENSE)
#
# Setup Proxmox VE service discovery for Prometheus.
# @end
description: Setup Proxmox VE service discovery for Prometheus
license: MIT
min_ansible_version: 2.10
platforms:
- name: EL
versions:
- 7
galaxy_tags: []
dependencies: []

View File

@ -0,0 +1,9 @@
---
- name: Converge
hosts: all
vars:
pve_sd_service_stopped: True
roles:
- role: xoxys.python3
- role: xoxys.pve_sd

120
molecule/centos7/create.yml Normal file
View File

@ -0,0 +1,120 @@
---
- name: Create
hosts: localhost
connection: local
gather_facts: false
no_log: "{{ molecule_no_log }}"
vars:
ssh_port: 22
ssh_user: root
ssh_path: "{{ lookup('env', 'MOLECULE_EPHEMERAL_DIRECTORY') }}/ssh_key"
tasks:
- name: Create SSH key
user:
name: "{{ lookup('env', 'USER') }}"
generate_ssh_key: true
ssh_key_file: "{{ ssh_path }}"
force: true
register: generated_ssh_key
- name: Register the SSH key name
set_fact:
ssh_key_name: "molecule-generated-{{ 12345 | random | to_uuid }}"
- name: Register SSH key for test instance(s)
hcloud_ssh_key:
name: "{{ ssh_key_name }}"
public_key: "{{ generated_ssh_key.ssh_public_key }}"
state: present
- name: Create molecule instance(s)
hcloud_server:
name: "{{ item.name }}"
server_type: "{{ item.server_type }}"
ssh_keys:
- "{{ ssh_key_name }}"
image: "{{ item.image }}"
location: "{{ item.location | default(omit) }}"
datacenter: "{{ item.datacenter | default(omit) }}"
user_data: "{{ item.user_data | default(omit) }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: present
register: server
loop: "{{ molecule_yml.platforms }}"
async: 7200
poll: 0
- name: Wait for instance(s) creation to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_jobs
until: hetzner_jobs.finished
retries: 300
loop: "{{ server.results }}"
- name: Create volume(s)
hcloud_volume:
name: "{{ item.name }}"
server: "{{ item.name }}"
location: "{{ item.location | default(omit) }}"
size: "{{ item.volume_size | default(10) }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: "present"
loop: "{{ molecule_yml.platforms }}"
when: item.volume | default(False) | bool
register: volumes
async: 7200
poll: 0
- name: Wait for volume(s) creation to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_volumes
until: hetzner_volumes.finished
retries: 300
when: volumes.changed
loop: "{{ volumes.results }}"
# Mandatory configuration for Molecule to function.
- name: Populate instance config dict
set_fact:
instance_conf_dict:
{
"instance": "{{ item.hcloud_server.name }}",
"ssh_key_name": "{{ ssh_key_name }}",
"address": "{{ item.hcloud_server.ipv4_address }}",
"user": "{{ ssh_user }}",
"port": "{{ ssh_port }}",
"identity_file": "{{ ssh_path }}",
"volume": "{{ item.item.item.volume | default(False) | bool }}",
}
loop: "{{ hetzner_jobs.results }}"
register: instance_config_dict
when: server.changed | bool
- name: Convert instance config dict to a list
set_fact:
instance_conf: "{{ instance_config_dict.results | map(attribute='ansible_facts.instance_conf_dict') | list }}"
when: server.changed | bool
- name: Dump instance config
copy:
content: |
# Molecule managed
{{ instance_conf | to_nice_yaml(indent=2) }}
dest: "{{ molecule_instance_config }}"
when: server.changed | bool
- name: Wait for SSH
wait_for:
port: "{{ ssh_port }}"
host: "{{ item.address }}"
search_regex: SSH
delay: 10
loop: "{{ lookup('file', molecule_instance_config) | from_yaml }}"
- name: Wait for VM to settle down
pause:
seconds: 30

View File

@ -0,0 +1,78 @@
---
- name: Destroy
hosts: localhost
connection: local
gather_facts: false
no_log: "{{ molecule_no_log }}"
tasks:
- name: Check existing instance config file
stat:
path: "{{ molecule_instance_config }}"
register: cfg
- name: Populate the instance config
set_fact:
instance_conf: "{{ (lookup('file', molecule_instance_config) | from_yaml) if cfg.stat.exists else [] }}"
- name: Destroy molecule instance(s)
hcloud_server:
name: "{{ item.instance }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: absent
register: server
loop: "{{ instance_conf }}"
async: 7200
poll: 0
- name: Wait for instance(s) deletion to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_jobs
until: hetzner_jobs.finished
retries: 300
loop: "{{ server.results }}"
- pause:
seconds: 5
- name: Destroy volume(s)
hcloud_volume:
name: "{{ item.instance }}"
server: "{{ item.instance }}"
api_token: "{{ lookup('env', 'HCLOUD_TOKEN') }}"
state: "absent"
register: volumes
loop: "{{ instance_conf }}"
when: item.volume | default(False) | bool
async: 7200
poll: 0
- name: Wait for volume(s) deletion to complete
async_status:
jid: "{{ item.ansible_job_id }}"
register: hetzner_volumes
until: hetzner_volumes.finished
retries: 300
when: volumes.changed
loop: "{{ volumes.results }}"
- name: Remove registered SSH key
hcloud_ssh_key:
name: "{{ instance_conf[0].ssh_key_name }}"
state: absent
when: (instance_conf | default([])) | length > 0
# Mandatory configuration for Molecule to function.
- name: Populate instance config
set_fact:
instance_conf: {}
- name: Dump instance config
copy:
content: |
# Molecule managed
{{ instance_conf | to_nice_yaml(indent=2) }}
dest: "{{ molecule_instance_config }}"
when: server.changed | bool

View File

@ -0,0 +1,24 @@
---
dependency:
name: galaxy
options:
role-file: molecule/requirements.yml
requirements-file: molecule/requirements.yml
env:
ANSIBLE_GALAXY_DISPLAY_PROGRESS: "false"
driver:
name: delegated
platforms:
- name: centos7-pve-sd
image: centos-7
server_type: cx11
lint: |
/usr/local/bin/flake8
provisioner:
name: ansible
env:
ANSIBLE_FILTER_PLUGINS: ${ANSIBLE_FILTER_PLUGINS:-./plugins/filter}
ANSIBLE_LIBRARY: ${ANSIBLE_LIBRARY:-./library}
log: False
verifier:
name: testinfra

View File

@ -0,0 +1,15 @@
---
- name: Prepare
hosts: all
gather_facts: false
tasks:
- name: Bootstrap python for Ansible
raw: |
command -v python3 python || (
(test -e /usr/bin/dnf && sudo dnf install -y python3) ||
(test -e /usr/bin/apt && (apt -y update && apt install -y python-minimal)) ||
(test -e /usr/bin/yum && sudo yum -y -qq install python3) ||
echo "Warning: Python not boostrapped due to unknown platform."
)
become: true
changed_when: false

View File

@ -0,0 +1,13 @@
import os
import testinfra.utils.ansible_runner
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
os.environ["MOLECULE_INVENTORY_FILE"]
).get_hosts("all")
def test_sd_timer_valid_and_enabled(host):
service = host.service("pve_sd.timer")
assert service.is_enabled

1
molecule/default Symbolic link
View File

@ -0,0 +1 @@
centos7

3
molecule/pytest.ini Normal file
View File

@ -0,0 +1,3 @@
[pytest]
filterwarnings =
ignore::DeprecationWarning

10
molecule/requirements.yml Normal file
View File

@ -0,0 +1,10 @@
---
collections:
- name: https://gitea.rknet.org/ansible/xoxys.general/releases/download/v2.1.1/xoxys-general-2.1.1.tar.gz
- name: community.general
roles:
- src: https://gitea.rknet.org/ansible/xoxys.python3.git
name: xoxys.python3
scm: git
version: master

12
setup.cfg Normal file
View File

@ -0,0 +1,12 @@
[flake8]
ignore = D100, D101, D102, D103, D105, D107, E402, W503
max-line-length = 99
inline-quotes = double
exclude = .git,.tox,__pycache__,build,dist,tests,*.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

2
tasks/main.yml Normal file
View File

@ -0,0 +1,2 @@
---
- include_tasks: setup.yml

94
tasks/setup.yml Normal file
View File

@ -0,0 +1,94 @@
---
- block:
- name: Create group '{{ pve_sd_group }}'
group:
name: "{{ pve_sd_group }}"
state: present
- name: Create user '{{ pve_sd_user }}'
user:
comment: pve_sd
name: "{{ pve_sd_user }}"
group: "{{ pve_sd_group }}"
groups: "{{ pve_sd_extra_groups | join(',') }}"
- name: Upgrade python dependencies
pip:
name: "{{ item }}"
virtualenv: "{{ pve_sd_virtualenv }}"
virtualenv_command: "{{ pve_sd_virtualenv_command }}"
extra_args: --upgrade
loop:
- pip
- setuptools
- name: Install dependencies
pip:
name: "{{ item }}"
virtualenv: "{{ pve_sd_virtualenv }}"
virtualenv_command: "{{ pve_sd_virtualenv_command }}"
environment:
TMPDIR: /opt/python3/tmp
loop: "{{ pve_sd_packages_extra }}"
- name: Install PVE SD
pip:
name: "{{ item }}"
virtualenv: "{{ pve_sd_virtualenv }}"
virtualenv_command: "{{ pve_sd_virtualenv_command }}"
loop: "{{ __pve_sd_packages }}"
- name: Adjust file permissions
file:
name: "{{ pve_sd_virtualenv }}"
recurse: True
mode: u+rwX,go+rX,go-w
state: directory
- name: Make PVE SD binaries executable
file:
name: "{{ pve_sd_virtualenv }}/bin/{{ item }}"
mode: 0755
loop: "{{ __pve_sd_binaries }}"
- name: Deploy PVE SD bin wrappers
template:
src: usr/local/bin/pve-sd-wrapper.j2
dest: "/usr/local/bin/{{ item }}"
owner: root
group: root
mode: 0755
loop: "{{ __pve_sd_binaries }}"
become: True
become_user: root
- block:
- name: Write environment file
template:
src: etc/sysconfig/pve_sd.j2
dest: /etc/sysconfig/pve_sd
mode: 0600
notify: __pve_sd_restart
- name: Write timer file
template:
src: etc/systemd/system/pve_sd.timer.j2
dest: /etc/systemd/system/pve_sd.timer
mode: 0644
notify: __pve_sd_restart
- name: Write service file
template:
src: etc/systemd/system/pve_sd.service.j2
dest: /etc/systemd/system/pve_sd.service
mode: 0644
notify: __pve_sd_restart
- name: Ensure PVE SD timer is up and running
service:
name: pve_sd.timer
daemon_reload: yes
enabled: yes
state: "{{ pve_sd_service_stopped | ternary('stopped', 'started', 'started') }}"
become: True
become_user: root

View File

@ -0,0 +1,9 @@
#jinja2:lstrip_blocks: True
{{ ansible_managed | comment }}
PROMETHEUS_PVE_SD_LOG_LEVEL={{ pve_sd_log_level }}
PROMETHEUS_PVE_SD_LOG_FORMAT={{ pve_sd_log_format }}
PROMETHEUS_PVE_SD_OUTPUT_FILE={{ pve_sd_output_file }}
PROMETHEUS_PVE_SD_SERVICE={{ pve_sd_service | bool | lower }}
PROMETHEUS_PVE_SD_PVE_SERVER={{ pve_sd_pve_server }}
PROMETHEUS_PVE_SD_PVE_USER={{ pve_sd_pve_user }}
PROMETHEUS_PVE_SD_PVE_PASSWORD={{ pve_sd_pve_password }}

View File

@ -0,0 +1,19 @@
#jinja2:lstrip_blocks: True
{{ ansible_managed | comment }}
[Unit]
Description=Promtheus PVE SD
After=network-online.target
Requires=local-fs.target
After=local-fs.target
[Service]
Type=oneshot
EnvironmentFile=/etc/sysconfig/pve_sd
User={{ pve_sd_user }}
Group={{ pve_sd_group }}
WorkingDirectory={{ pve_sd_output_file | dirname }}
ExecStart=/usr/local/bin/prometheus-pve-sd
[Install]
WantedBy=multi-user.target

View File

@ -0,0 +1,9 @@
[Unit]
Description=Promtheus PVE SD timer
[Timer]
OnCalendar={{ pve_sd_interval }}
Persistent=true
[Install]
WantedBy=timers.target

View File

@ -0,0 +1,4 @@
#!/usr/bin/env sh
set -eo pipefail
exec {{ pve_sd_virtualenv }}/bin/{{ item }} "$@"

8
vars/main.yml Normal file
View File

@ -0,0 +1,8 @@
---
__pve_sd_packages:
- "prometheus-pve-sd{{ '==' + pve_sd_version if pve_sd_version is defined else '' }}"
__pve_sd_binaries:
- prometheus-pve-sd
__pve_sd_bin: "/usr/local/bin/pve_sd"