Merge branch 'develop'

elabit · Sep 30, 2021 · 9bdd23a · 9bdd23a
2 parents 1e09130 + 2851fa0
commit 9bdd23a
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.1.2 - 2021-09-30
+
+### Changed 
+
+* Improved the documentation for logdir permissions in external mode (#174)
+
 ## 1.2.1.1 - 2021-09-29
 
 ### Changed

diff --git a/agents_plugins/robotmk.py b/agents_plugins/robotmk.py
@@ -49,7 +49,7 @@
 
 local_tz = datetime.utcnow().astimezone().tzinfo
 
-ROBOTMK_VERSION = 'v1.2.1.1'
+ROBOTMK_VERSION = 'v1.2.1.2'
 
 class RMKConfig():
     _PRESERVED_WORDS = [

diff --git a/bakery/v1/robotmk.py b/bakery/v1/robotmk.py
@@ -18,7 +18,7 @@
 # to the Free Software Foundation, Inc., 51 Franklin St,  Fifth Floor,
 # Boston, MA 02110-1301 USA.
 
-ROBOTMK_VERSION = 'v1.2.1.1'
+ROBOTMK_VERSION = 'v1.2.1.2'
 
 import cmk.utils.paths
 import os

diff --git a/bakery/v2/robotmk.py b/bakery/v2/robotmk.py
@@ -18,7 +18,7 @@
 # to the Free Software Foundation, Inc., 51 Franklin St,  Fifth Floor,
 # Boston, MA 02110-1301 USA.
 
-ROBOTMK_VERSION = 'v1.2.1.1'
+ROBOTMK_VERSION = 'v1.2.1.2'
 
 from typing import Iterable, TypedDict, List
 from pathlib import Path

diff --git a/checks/v1/robotmk b/checks/v1/robotmk
@@ -34,7 +34,7 @@ from collections import namedtuple
 iam = "robotmk"
 # DO NOT DELETE
 inventory_robotmk_rules = []
-ROBOTMK_VERSION = 'v1.2.1.1'
+ROBOTMK_VERSION = 'v1.2.1.2'
 DEFAULT_SVC_PREFIX = 'Robot Framework E2E $SUITEID$SPACE-$SPACE'
 HTML_LOG_DIR = "%s/%s" % (os.environ['OMD_ROOT'], 'local/share/addons/robotmk')
 

diff --git a/checks/v2/robotmk.py b/checks/v2/robotmk.py
@@ -35,7 +35,7 @@
 from cmk.base.plugins.agent_based.agent_based_api.v1 import *
 from cmk.utils.exceptions import MKGeneralException
 
-ROBOTMK_VERSION = 'v1.2.1.1'
+ROBOTMK_VERSION = 'v1.2.1.2'
 DEFAULT_SVC_PREFIX = 'Robot Framework E2E $SUITEID$SPACE-$SPACE'
 HTML_LOG_DIR = "%s/%s" % (os.environ['OMD_ROOT'], 'local/share/addons/robotmk')
 

diff --git a/web_plugins/wato/robotmk_wato_params_bakery.py b/web_plugins/wato/robotmk_wato_params_bakery.py
@@ -203,8 +203,9 @@ def outputdir(self, val):
 helptext_execution_mode_agent_parallel = "This is only a placeholder for the parallel execution of RF suites. <b>Please choose another mode.</b>"
 helptext_execution_mode_external = """
     The Checkmk agent starts the Robotmk <b>controller</b> as a <i>synchronous</i> check plugin in the <i>agent check interval</i>.<br><br>
-    <b>Important note for Checkmk 1.6</b>: The rule <i>Deploy custom files with agent</i> (package <tt>robotmk-external</tt>) must be used to place the <b>runner</b> within the agent's <tt>bin</tt> directory (there is no other way in Checkmk 1 to deploy files to that folder).<br>
-    From there, you can start the runner with any external tool (e.g. systemd timer/cron/task scheduler).<br><br>
+    <b>Important note for Checkmk 1.6</b>: The rule <i>Deploy custom files with agent</i> (package <tt>robotmk-external</tt>) must be used to place the <b>runner</b> within the agent's <tt>bin</tt> directory (there is no other way in Checkmk 1 to deploy files to that folder).<br><br>
+    You can start the runner from the <tt>bin</tt> folder with any external tool (e.g. systemd timer/cron/task scheduler) and in the user context of your choice.<br>
+    Make sure that the output/log dir (see below) can be written by the user which executes <tt>robotmk-runner.py</tt> or choose another location with the setting <i>Change default directories</i> below.<br><br>
     If no suites are specified, the runner will execute all suites listed in <tt>robotmk.yml</tt>.<br>
     If no suites are defined at all, the runner will execute all suites found in the <i>Robot suites directory</i>. <br><br>   
     <b>Use cases</b> for this mode: <br>

diff --git a/web_plugins/wato/robotmk_wato_params_discovery.py b/web_plugins/wato/robotmk_wato_params_discovery.py
@@ -62,12 +62,12 @@
         help=_("""Robotmk can display two action icons right of each discovered service which allows to open the <b>last error log</b> and the <b>current log</b>.<br>
         In order to make this work, just follow these two steps: <br><br>
         <b>1.</b> In rule <i>Robotmk (Linux, Windows)</i>, configure Robotmk clients to <i>Transmit HTML logs to server</i>.<br>
-        <b>2.</b> Add the following lines to <tt>$OMD_ROOT/etc/apache/conf.d/check_mk.conf</tt> (replace <tt>--SITE--</tt> with your site name):<br><br>
+        <b>2.</b> Add the following lines to <tt>$OMD_ROOT/etc/apache/conf.d/check_mk.conf</tt> (replace <tt>--SITE--</tt> with your site name) and execute <tt>omd reload apache</tt>:<br><br>
         <tt>Alias /--SITE--/check_mk/addons "/omd/sites/--SITE--/local/share/addons"<br>
-        <Directory "/omd/sites/--SITE--/local/share/addons"><br>
+        < Directory "/omd/sites/--SITE--/local/share/addons"><br>
         Options +Indexes<br>
         AllowOverride None<br>
-        </Directory></tt><br> <br>
+        < /Directory></tt><br> <br>
         <b>3.</b> In <i>Global settings > Custom icons and actions</i>, create <b>two custom actions</b>:<br>
         * id:<tt>robotmk_last_log</tt>, tite: "Robot Framework: last HTML log", icon: <i>robotmk80.png</i>, action URL: <tt>addons/robotmk/$HOSTNAME_URL_ENCODED$/$SERVICEDESC$/suite_last_log.html</tt><br>
         * id:<tt>robotmk_last_error_log</tt>, tite: "Robot Framework: last error HTML log", icon: <i>robotmk80_dot.png</i>, action URL: <tt>addons/robotmk/$HOSTNAME_URL_ENCODED$/$SERVICEDESC$/suite_last_error_log.html</tt><br>