cmdbsyncer 4.5.0.dev0__tar.gz → 4.5.0.dev2__tar.gz

{cmdbsyncer-4.5.0.dev0/cmdbsyncer.egg-info → cmdbsyncer-4.5.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmdbsyncer
-Version: 4.5.0.dev0
+Version: 4.5.0.dev2
 Summary: Rule-based modular synchronizer for Checkmk, Netbox, Ansible, I-DOIT, Jira CMDB and 15+ other CMDB/monitoring systems
 Author-email: Kuhn & Ruess GmbH <info@kuhn-ruess.de>
 Maintainer-email: Bastian Kuhn <mail@bastian-kuhn.de>

cmdbsyncer-4.5.0.dev2/application/buildinfo.txt

@@ -0,0 +1 @@
+BUILD_DATE=2026-10-30T08:47:03Z

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2}/application/changelog/v4.4.md

@@ -1,6 +1,7 @@
 # Version 4.4
 
 ## Unreleased
+- FIX: Checkmk: Manage OMD Server creates a missing site again, including the initial cmkadmin password, instead of failing on the update step
 - FIX: REST import: entries without the hostname field are skipped instead of aborting the whole import
 - FIX: Checkmk users: an empty row under Roles or Contact Groups is no longer sent to Checkmk, which rejected the user because of it
 - FIX: Files: creating a folder, uploading, renaming or editing a file works again when the syncer runs under a sub-path such as /cmdbsyncer — the dialog sent its form to the address without that path

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2}/application/changelog/v4.5.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- FEAT: Checkmk Settings: a Run Playbook button on every entry, and the list action Run Manage OMD Server, install or update Checkmk right from the settings, only on the servers of the enabled sites that use them; the list shows only name, documentation, version and server user
+- FEAT: New OP5 Monitor import: `op5 import_hosts` and `op5 inventorize_hosts` read all hosts with address, alias, host groups, contacts, contact groups, parents and custom variables from an account of type OP5 Monitor
+- FEAT: New Ansible playbook `deploy_configs/install/install_redhat.yml` installs the Syncer on RedHat, Rocky or Alma with MongoDB, Gunicorn and Apache, either as its own virtual host or under a sub-path, served over HTTPS
 - FEAT: API: the cron status (`/api/v1/syncer/cron/`) tells whether a cron group is enabled, so the Checkmk plugin no longer monitors disabled or deleted cron groups
 - FEAT: Checkmk: new Manage LDAP Connections maintains the LDAP connections Checkmk logs its users in with, including contact groups and roles from directory groups; server and bind password come from an LDAP account, `checkmk export_ldap_connections` creates, updates or removes them
 - FEAT: `rules export_all_rules --zip` writes the export compressed into a zip archive, and `rules import_rules` reads such an archive back as it is

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2}/application/plugins/checkmk/views.py

@@ -26,6 +26,7 @@ from flask_admin.contrib.mongoengine.filters import (
 from flask import redirect, url_for, request, render_template, flash
 
 from flask_login import current_user
+from flask_wtf.csrf import generate_csrf
 from application import app
 from application.views.default import DefaultModelView
 from application.models.account import Account, CustomEntry
@@ -41,6 +42,7 @@ from application.modules.rule.views import (
 )
 from application.views._form_sections import modern_form, section
 from application.models.project import Project
+from application.plugins.ansible.runner import run_playbook
 from application.helpers.syncer_jinja import check_jinja_syntax
 from application.modules.rule.list_source import is_list_rule, rule_uses_list
 from application.modules.rule.list_source_views import (
@@ -1633,6 +1635,20 @@ class CheckmkUserMngmtView(DefaultModelView):
 
 
 
+def _render_run_server_mngmt(_view, _context, model, _name):
+    """Button that starts Manage OMD Server for the sites of these settings"""
+    run_url = url_for('.run_server_mngmt', settings_id=model.id)
+    return Markup(
+        f'<form method="POST" action="{escape(run_url)}" style="display:inline" '
+        f"onsubmit=\"return confirm('Install or update Checkmk on the servers "
+        f"of the enabled sites that use these settings?');\">"
+        f'<input type="hidden" name="csrf_token" value="{escape(generate_csrf())}">'
+        f'<button class="btn btn-primary btn-sm" type="submit">'
+        f'<i class="fa fa-play"></i> Run Playbook</button>'
+        f'</form>'
+    )
+
+
 class CheckmkSettingsView(DefaultModelView):
     """
     Checkmk Server Settings View
@@ -1748,13 +1764,15 @@ class CheckmkSettingsView(DefaultModelView):
         ),
     ]
 
-    column_exclude_list = [
-        'inital_password',
-        'subscription_username',
-        'subscription_password',
-        'download_proxy',
-        'cmk_secret',
-    ]
+    column_list = ('name', 'documentation', 'cmk_version', 'server_user', 'run_playbook')
+
+    column_formatters = {
+        'run_playbook': _render_run_server_mngmt,
+    }
+
+    column_labels = {
+        'run_playbook': 'Manage OMD Server',
+    }
 
     # Fill-in help for version and filename, see _checkmk_download_help.html
     create_template = 'admin/checkmk_settings_create.html'
@@ -1805,6 +1823,45 @@ class CheckmkSettingsView(DefaultModelView):
         url = url_for('.set_cmk_version_form', ids=','.join(ids))
         return redirect(url)
 
+    @action('run_server_mngmt', 'Run Manage OMD Server',
+            'Install or update Checkmk on the servers of the enabled sites '
+            'that use the selected settings?')
+    def action_run_server_mngmt(self, ids):
+        """
+        Action to start Manage OMD Server for the selected Entries
+        """
+        return self._run_server_mngmt(ids)
+
+    @expose('/run/<settings_id>', methods=('POST',))
+    def run_server_mngmt(self, settings_id):
+        """
+        Run button of a single row
+        """
+        return self._run_server_mngmt([settings_id])
+
+    def _run_server_mngmt(self, ids):
+        """
+        Start the Manage OMD Server playbook, limited to the servers of the
+        enabled sites that use the given settings
+        """
+        if not current_user.has_right('ansible'):
+            flash('Running playbooks needs the Ansible right', 'error')
+            return redirect(url_for('.index_view'))
+        settings = list(CheckmkSettings.objects(id__in=ids))
+        servers = sorted({site.server_address for site in
+                          CheckmkSite.objects(settings_master__in=settings, enabled=True)})
+        if not servers:
+            flash('No enabled site uses the selected settings', 'error')
+            return redirect(url_for('.index_view'))
+        stats = run_playbook(
+            'cmk_server_mngmt.yml',
+            target_host=','.join(servers),
+            source='ui',
+            triggered_by=current_user.email,
+        )
+        flash(f"Run started for {', '.join(servers)}", 'success')
+        return redirect(url_for('ansiblerunstats.details_view', id=str(stats.pk)))
+
     @expose('/set_cmk_version_form')
     def set_cmk_version_form(self):
         """

cmdbsyncer-4.5.0.dev2/application/plugins/op5/__init__.py

@@ -0,0 +1,42 @@
+"""OP5 Monitor plugin."""
+import click
+from application import app
+from application.helpers.plugins import register_cli_group
+
+from syncerapi.v1 import register_cronjob
+
+from .op5 import inventorize_op5, import_op5
+
+op5_cli = register_cli_group(app, 'op5', 'op5', "OP5 Monitor Commands")
+
+@op5_cli.command('import_hosts')
+@click.argument("account")
+@click.option("--debug", is_flag=True)
+def cmd_import_op5(account, debug):
+    """
+    Import Hosts from OP5 Monitor
+    """
+    try:
+        import_op5(account, debug)
+    except Exception as error:  # pylint: disable=broad-exception-caught
+        if debug:
+            raise
+        print(f"Error: {error}")
+
+register_cronjob('OP5 Monitor: Import Hosts', import_op5)
+
+@op5_cli.command('inventorize_hosts')
+@click.argument("account")
+@click.option("--debug", is_flag=True)
+def cmd_inventorize_op5(account, debug):
+    """
+    Inventorize Hosts from OP5 Monitor
+    """
+    try:
+        inventorize_op5(account, debug)
+    except Exception as error:  # pylint: disable=broad-exception-caught
+        if debug:
+            raise
+        print(f"Error: {error}")
+
+register_cronjob('OP5 Monitor: Inventorize Hosts', inventorize_op5)

cmdbsyncer-4.5.0.dev2/application/plugins/op5/op5.py

@@ -0,0 +1,127 @@
+"""
+Import Hosts from OP5 Monitor
+
+Reads the hosts through the filter API of OP5 Monitor:
+GET /api/filter/query?query=[hosts] all&columns=...&format=json
+
+API Output (one entry per host):
+[{'name': 'web01',
+  'alias': 'Webserver 01',
+  'display_name': 'web01',
+  'address': '10.0.0.1',
+  'groups': ['linux', 'web'],
+  'contacts': ['admin'],
+  'contact_groups': ['linux-admins'],
+  'parents': ['switch01'],
+  'notes': '',
+  'custom_variables': {'LOCATION': 'Berlin'}}]
+"""
+from syncerapi.v1 import (
+    cc,
+)
+
+from application.modules.plugin import Plugin
+from application.helpers.inventory import run_inventory
+from application.helpers.import_hostnames import get_import_hosts, update_import_host
+
+DEFAULT_COLUMNS = [
+    "name", "alias", "display_name", "address", "groups", "contacts",
+    "contact_groups", "parents", "notes", "custom_variables",
+]
+
+
+class Op5(Plugin):
+    """
+    OP5 Monitor Import
+    """
+    page_size = 1000
+
+    def columns(self):
+        """
+        Columns to request, the account field `columns` overrides the default.
+        The hostname column `name` is always part of the request.
+        """
+        configured = [x.strip() for x in self.config.get('columns', '').split(',')
+                      if x.strip()]
+        columns = configured or list(DEFAULT_COLUMNS)
+        if 'name' not in columns:
+            columns.insert(0, 'name')
+        return columns
+
+    @staticmethod
+    def prepare_attributes(host):
+        """
+        Flatten the custom variables of a host into own attributes,
+        so they can be used like every other attribute.
+        """
+        attributes = dict(host)
+        custom_variables = attributes.pop('custom_variables', None)
+        if isinstance(custom_variables, dict):
+            for key, value in custom_variables.items():
+                attributes[f'custom_variable_{key.lower()}'] = value
+        return attributes
+
+    def get_hosts(self):
+        """
+        Return Hostname and Attributes of every host, paging through the API
+        """
+        url = f"{self.config['address'].rstrip('/')}/api/filter/query"
+        auth = (self.config['username'], self.config['password'])
+        print(f"{cc.OKGREEN} -- {cc.ENDC}Request: Read all Hosts")
+
+        offset = 0
+        while True:
+            params = {
+                "query": "[hosts] all",
+                "columns": ",".join(self.columns()),
+                "format": "json",
+                "limit": str(self.page_size),
+                "offset": str(offset),
+            }
+            response = self.inner_request(method="GET", url=url, params=params, auth=auth)
+            hosts = response.json()
+            if not isinstance(hosts, list):
+                raise ValueError(f"Unexpected answer from OP5: {hosts}")
+            for host in hosts:
+                yield host['name'], self.prepare_attributes(host)
+
+            if len(hosts) < self.page_size:
+                return
+            offset += len(hosts)
+
+    def import_objects(self):
+        """
+        Import Hosts from OP5
+        """
+        for hostname, attributes in self.get_hosts():
+            for name, host_obj in get_import_hosts(hostname, self.config, attributes):
+                print(f" {cc.OKGREEN}** {cc.ENDC} Update {name}")
+                update_import_host(host_obj, attributes, self.config)
+
+    def inventorize_objects(self):
+        """
+        Inventorize OP5 Hosts
+        """
+        run_inventory(self.config, self.get_hosts())
+
+def import_op5(account, debug=False):
+    """
+    Import
+    """
+    op5 = Op5(account)
+    op5.debug = debug
+    op5.name = "OP5 Monitor: Import Hosts"
+    op5.source = "op5_import"
+
+    op5.import_objects()
+
+def inventorize_op5(account, debug=False):
+    """
+    Inventorize
+    """
+    op5 = Op5(account)
+    op5.debug = debug
+    op5.name = "OP5 Monitor: Inventorize Hosts"
+    op5.source = "op5_inventorize"
+
+    op5.inventorize_objects()

cmdbsyncer-4.5.0.dev2/application/plugins/op5/plugin.json

@@ -0,0 +1,14 @@
+{
+    "version": "1.0.0",
+    "author": "Kuhn & Rueß GmbH",
+    "name": "OP5 Monitor",
+    "description": "",
+    "ident": "op5",
+    "account_presets" : {
+        "address": "https://op5server"
+    },
+    "account_custom_field_presets": {
+        "columns": "",
+        "rewrite_hostname": ""
+    }
+}

cmdbsyncer-4.5.0.dev2/application/plugins/op5/tests/test_op5.py

@@ -0,0 +1,68 @@
+"""
+Unit tests for the OP5 Monitor import
+"""
+# pylint: disable=missing-function-docstring
+import unittest
+from unittest.mock import MagicMock
+
+from application.plugins.op5.op5 import Op5, DEFAULT_COLUMNS
+
+
+def make_op5(columns=''):
+    op5 = Op5.__new__(Op5)
+    op5.config = {
+        'address': 'https://op5.example.com/',
+        'username': 'user',
+        'password': 'secret',
+        'columns': columns,
+    }
+    return op5
+
+
+class TestOp5(unittest.TestCase):
+    """Tests for the OP5 host import"""
+
+    def test_default_columns(self):
+        self.assertEqual(make_op5().columns(), DEFAULT_COLUMNS)
+
+    def test_configured_columns_always_contain_name(self):
+        self.assertEqual(make_op5('address, groups').columns(),
+                         ['name', 'address', 'groups'])
+
+    def test_custom_variables_are_flattened(self):
+        attributes = Op5.prepare_attributes({
+            'name': 'web01',
+            'groups': ['linux'],
+            'custom_variables': {'LOCATION': 'Berlin'},
+        })
+        self.assertEqual(attributes, {
+            'name': 'web01',
+            'groups': ['linux'],
+            'custom_variable_location': 'Berlin',
+        })
+
+    def test_get_hosts_pages_through_api(self):
+        op5 = make_op5()
+        op5.page_size = 2
+        pages = [
+            [{'name': 'a'}, {'name': 'b'}],
+            [{'name': 'c'}],
+        ]
+        op5.inner_request = MagicMock(side_effect=[
+            MagicMock(json=MagicMock(return_value=page)) for page in pages
+        ])
+        hostnames = [name for name, _ in op5.get_hosts()]
+        self.assertEqual(hostnames, ['a', 'b', 'c'])
+
+        first_call = op5.inner_request.call_args_list[0].kwargs
+        self.assertEqual(first_call['url'], 'https://op5.example.com/api/filter/query')
+        self.assertEqual(first_call['auth'], ('user', 'secret'))
+        self.assertEqual(first_call['params']['query'], '[hosts] all')
+        self.assertEqual(op5.inner_request.call_args_list[1].kwargs['params']['offset'], '2')
+
+    def test_error_answer_raises(self):
+        op5 = make_op5()
+        op5.inner_request = MagicMock(return_value=MagicMock(
+            json=MagicMock(return_value={'error': 'Invalid column'})))
+        with self.assertRaises(ValueError):
+            list(op5.get_hosts())

cmdbsyncer-4.5.0.dev2/application/plugins/servicenow/tests/__init__.py

@@ -0,0 +1,3 @@
+# pylint: disable=unused-import
+"""Bootstrap test stubs before any test in this package runs."""
+import tests  # noqa: F401 — triggers MongoDB stub setup

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2/cmdbsyncer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmdbsyncer
-Version: 4.5.0.dev0
+Version: 4.5.0.dev2
 Summary: Rule-based modular synchronizer for Checkmk, Netbox, Ansible, I-DOIT, Jira CMDB and 15+ other CMDB/monitoring systems
 Author-email: Kuhn & Ruess GmbH <info@kuhn-ruess.de>
 Maintainer-email: Bastian Kuhn <mail@bastian-kuhn.de>

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2}/cmdbsyncer.egg-info/SOURCES.txt

@@ -293,6 +293,11 @@ application/plugins/netbox/views.py
 application/plugins/netbox/virtualmachines.py
 application/plugins/netbox/tests/__init__.py
 application/plugins/netbox/tests/test_import_filter.py
+application/plugins/op5/__init__.py
+application/plugins/op5/op5.py
+application/plugins/op5/plugin.json
+application/plugins/op5/tests/__init__.py
+application/plugins/op5/tests/test_op5.py
 application/plugins/prtg/__init__.py
 application/plugins/prtg/plugin.json
 application/plugins/prtg/prtg.py

{cmdbsyncer-4.5.0.dev0 → cmdbsyncer-4.5.0.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cmdbsyncer"
-version = "4.5.0.dev0"
+version = "4.5.0.dev2"
 description = "Rule-based modular synchronizer for Checkmk, Netbox, Ansible, I-DOIT, Jira CMDB and 15+ other CMDB/monitoring systems"
 readme = "README.md"
 license = { text = "MIT" }

cmdbsyncer-4.5.0.dev0/application/buildinfo.txt

@@ -1 +0,0 @@
-BUILD_DATE=2026-10-29T12:50:13Z