|
qlink(
- $instanceName,
- '/monitoring/config/editinstance',
- array('instance' => $instanceName),
+ $transportName,
+ '/monitoring/config/edittransport',
+ array('transport' => $transportName),
array(
'icon' => 'edit',
- 'title' => sprintf($this->translate('Edit monitoring instance %s'), $instanceName)
+ 'title' => sprintf($this->translate('Edit command transport %s'), $transportName)
)
); ?>
(
qlink(
'',
- '/monitoring/config/removeinstance',
- array('instance' => $instanceName),
+ '/monitoring/config/removetransport',
+ array('transport' => $transportName),
array(
'icon' => 'trash',
- 'title' => sprintf($this->translate('Remove monitoring instance %s'), $instanceName)
+ 'title' => sprintf($this->translate('Remove command transport %s'), $transportName)
)
); ?>
|
diff --git a/modules/monitoring/application/views/scripts/config/security.phtml b/modules/monitoring/application/views/scripts/config/security.phtml
new file mode 100644
index 000000000..3801678b1
--- /dev/null
+++ b/modules/monitoring/application/views/scripts/config/security.phtml
@@ -0,0 +1,6 @@
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/monitoring/doc/commandtransports.md b/modules/monitoring/doc/commandtransports.md
new file mode 100644
index 000000000..680f34ca0
--- /dev/null
+++ b/modules/monitoring/doc/commandtransports.md
@@ -0,0 +1,96 @@
+# The commandtransports.ini configuration file
+
+## Abstract
+
+The commandtransports.ini defines how Icinga Web 2 accesses the command pipe of
+your Icinga instance in order to submit external commands. Depending on the
+config path (default: /etc/icingaweb2) of your Icinga Web 2 installation you can
+find it under ./modules/monitoring/commandtransports.ini.
+
+## Syntax
+
+You can define multiple command transports in the commandtransports.ini. Every
+transport starts with a section header containing its name, followed by the
+config directives for this transport in the standard INI-format.
+
+Icinga Web 2 will try one transport after another to send a command, depending
+on the respective Icinga instance, until the command is successfully sent. The
+order in which Icinga Web 2 processes the configured transports is defined by
+the order of sections in the commandtransports.ini.
+
+## Using a local command pipe
+
+A local Icinga instance requires the following directives:
+
+````
+[icinga2]
+transport = local
+path = /var/run/icinga2/cmd/icinga2.cmd
+````
+
+When sending commands to the Icinga instance, Icinga Web 2 opens the file found
+on the local filesystem underneath 'path' and writes the external command to it.
+
+## Using SSH for accessing a remote command pipe
+
+A command pipe on a remote host's filesystem can be accessed by configuring a
+SSH based command transport and requires the following directives:
+
+````
+[icinga2]
+transport = remote
+path = /var/run/icinga2/cmd/icinga2.cmd
+host = example.tld
+;port = 22 ; Optional. The default is 22
+user = icinga
+````
+
+To make this example work, you'll need to permit your web-server's user
+public-key based access to the defined remote host so that Icinga Web 2 can
+connect to it and login as the defined user.
+
+You can also make use of a dedicated SSH resource to permit access for a
+different user than the web-server's one. This way, you can provide a private
+key file on the local filesystem that is used to access the remote host.
+
+To accomplish this, a new resource is required that is defined in your
+transport's configuration instead of a user:
+
+````
+[icinga2]
+transport = remote
+path = /var/run/icinga2/cmd/icinga2.cmd
+host = example.tld
+;port = 22 ; Optional. The default is 22
+resource = example.tld-icinga2
+````
+
+The resource's configuration needs to be put into the resources.ini file:
+
+````
+[example.tld-icinga2]
+type = ssh
+user = icinga
+private_key = /etc/icingaweb2/ssh/icinga
+````
+
+## Configuring transports for different Icinga instances
+
+If there are multiple but different Icinga instances writing to your IDO you can
+define which transport belongs to which Icinga instance by providing the
+directive 'instance'. This directive should contain the name of the Icinga
+instance you want to assign to the transport:
+
+````
+[icinga1]
+...
+instance = icinga1
+
+[icinga2]
+...
+instance = icinga2
+````
+
+Associating a transport to a specific Icinga instance causes this transport to
+be used to send commands to the linked instance only. Transports without a
+linked Icinga instance are utilized to send commands to all instances.
\ No newline at end of file
diff --git a/modules/monitoring/doc/configuration.md b/modules/monitoring/doc/configuration.md
index 7636b1a52..5c3a23aa4 100644
--- a/modules/monitoring/doc/configuration.md
+++ b/modules/monitoring/doc/configuration.md
@@ -10,7 +10,7 @@ stored in `/etc/icingaweb2` by default (depending on your config setup).
modules/monitoring | Directory | `monitoring` module specific configuration
modules/monitoring | config.ini | Security settings (e.g. protected custom vars) for the `monitoring` module
modules/monitoring | backends.ini | Backend type and resources (e.g. Icinga IDO DB)
- modules/monitoring | [instances.ini](instances.md#instances) | Instances and their transport (e.g. local external command pipe)
+ modules/monitoring | [commandtransports.ini](commandtransports.md#commandtransports) | Command transports for specific Icinga instances
diff --git a/modules/monitoring/doc/instances.md b/modules/monitoring/doc/instances.md
deleted file mode 100644
index ea8b3f5b8..000000000
--- a/modules/monitoring/doc/instances.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# The instance.ini configuration file
-
-## Abstract
-
-The instance.ini defines how icingaweb accesses the command pipe of your icinga process in order to submit external
-commands. Depending on the config path (default: /etc/icingaweb2) of your icingaweb installation you can find it
-under ./modules/monitoring/instances.ini.
-
-## Syntax
-
-You can define multiple instances in the instances.ini, icingaweb will use the first one as the default instance.
-
-Every instance starts with a section header containing the name of the instance, followed by the config directives for
-this instance in the standard ini format used by icingaweb.
-
-## Using a local icinga pipe
-
-A local icinga instance can be easily setup and only requires the 'path' parameter:
-
- [icinga]
- path=/usr/local/icinga/var/rw/icinga.cmd
-
-When sending commands to the icinga instance, icingaweb just opens the file found underneath 'path' and writes the external
-command to it.
-
-## Using ssh for accessing an icinga pipe
-
-When providing at least a host directive to the instances.ini, SSH will be used for accessing the pipe. You must have
-setup key authentication at the endpoint and allow your icingweb's user to access the machine without a password at this time:
-
- [icinga]
- path=/usr/local/icinga/var/rw/icinga.cmd ; the path on the remote machine where the icinga.cmd can be found
- host=my.remote.machine.com ; the hostname or address of the remote machine
- port=22 ; the port to use (22 if none is given)
- user=jdoe ; the user to authenticate with
-
-You can also make use of the ssh resource for accessing an icinga pipe with key-based authentication, which will give
-you the possibility to define the location of the private key for a specific user, let's have a look:
-
- [icinga]
- path=/usr/local/icinga/var/rw/icinga.cmd ; the path on the remote machine where the icinga.cmd can be found
- host=my.remote.machine.com ; the hostname or address of the remote machine
- port=22 ; the port to use (22 if none is given)
- resource=ssh ; the ssh resource which contains the username and the location of the private key
-
-And the associated ssh resource:
-
- [ssh]
- type = "ssh"
- user = "ssh-user"
- private_key = "/etc/icingaweb2/ssh/ssh-user"
-
-
-
-
diff --git a/modules/monitoring/library/Monitoring/Command/Transport/CommandTransport.php b/modules/monitoring/library/Monitoring/Command/Transport/CommandTransport.php
index f39b0b4c3..bb6709ea7 100644
--- a/modules/monitoring/library/Monitoring/Command/Transport/CommandTransport.php
+++ b/modules/monitoring/library/Monitoring/Command/Transport/CommandTransport.php
@@ -4,15 +4,19 @@
namespace Icinga\Module\Monitoring\Command\Transport;
use Icinga\Application\Config;
+use Icinga\Application\Logger;
use Icinga\Data\ConfigObject;
use Icinga\Exception\ConfigurationError;
+use Icinga\Module\Monitoring\Command\IcingaCommand;
+use Icinga\Module\Monitoring\Command\Object\ObjectCommand;
+use Icinga\Module\Monitoring\Exception\CommandTransportException;
/**
- * Command transport factory
+ * Command transport
*
* This class is subject to change as we do not have environments yet (#4471).
*/
-abstract class CommandTransport
+class CommandTransport implements CommandTransportInterface
{
/**
* Transport configuration
@@ -24,21 +28,25 @@ abstract class CommandTransport
/**
* Get transport configuration
*
- * @return Config
- * @throws ConfigurationError
+ * @return Config
+ *
+ * @throws ConfigurationError
*/
public static function getConfig()
{
- if (! isset(self::$config)) {
- self::$config = Config::module('monitoring', 'instances');
- if (self::$config->isEmpty()) {
+ if (static::$config === null) {
+ $config = Config::module('monitoring', 'commandtransports');
+ if ($config->isEmpty()) {
throw new ConfigurationError(
- 'No instances have been configured in \'%s\'.',
- self::$config->getConfigFile()
+ mt('monitoring', 'No command transports have been configured in "%s".'),
+ $config->getConfigFile()
);
}
+
+ static::$config = $config;
}
- return self::$config;
+
+ return static::$config;
}
/**
@@ -47,9 +55,10 @@ abstract class CommandTransport
* @param ConfigObject $config
*
* @return LocalCommandFile|RemoteCommandFile
+ *
* @throws ConfigurationError
*/
- public static function fromConfig(ConfigObject $config)
+ public static function createTransport(ConfigObject $config)
{
$config = clone $config;
switch (strtolower($config->transport)) {
@@ -62,14 +71,18 @@ abstract class CommandTransport
break;
default:
throw new ConfigurationError(
- 'Can\'t create command transport \'%s\'. Invalid transport defined in \'%s\'.'
- . ' Use one of \'%s\' or \'%s\'.',
+ mt(
+ 'monitoring',
+ 'Cannot create command transport "%s". Invalid transport'
+ . ' defined in "%s". Use one of "%s" or "%s".'
+ ),
$config->transport,
- self::$config->getConfigFile(),
+ static::getConfig()->getConfigFile(),
LocalCommandFile::TRANSPORT,
RemoteCommandFile::TRANSPORT
);
}
+
unset($config->transport);
foreach ($config as $key => $value) {
$method = 'set' . ucfirst($key);
@@ -79,37 +92,80 @@ abstract class CommandTransport
// when being about to send a command
continue;
}
+
$transport->$method($value);
}
+
return $transport;
}
/**
- * Create a transport by name
+ * Send the given command over an appropriate Icinga command transport
*
- * @param string $name
+ * This will try one configured transport after another until the command has been successfully sent.
*
- * @return LocalCommandFile|RemoteCommandFile
- * @throws ConfigurationError
+ * @param IcingaCommand $command The command to send
+ * @param int|null $now Timestamp of the command or null for now
+ *
+ * @throws CommandTransportException If sending the Icinga command failed
*/
- public static function create($name)
+ public function send(IcingaCommand $command, $now = null)
{
- $config = self::getConfig()->getSection($name);
- if ($config->isEmpty()) {
- throw new ConfigurationError();
+ $tries = 0;
+ foreach (static::getConfig() as $transportConfig) {
+ $transport = static::createTransport($transportConfig);
+
+ if ($this->transferPossible($command, $transport)) {
+ try {
+ $transport->send($command, $now);
+ } catch (CommandTransportException $e) {
+ Logger::error($e);
+ $tries += 1;
+ continue; // Try the next transport
+ }
+
+ return; // The command was successfully sent
+ }
}
- return self::fromConfig($config);
+
+ if ($tries > 0) {
+ throw new CommandTransportException(
+ mt(
+ 'monitoring',
+ 'Failed to send external Icinga command. None of the configured transports'
+ . ' was able to transfer the command. Please see the log for more details.'
+ )
+ );
+ }
+
+ throw new CommandTransportException(
+ mt(
+ 'monitoring',
+ 'Failed to send external Icinga command. No transport has been configured'
+ . ' for this instance. Please contact your Icinga Web administrator.'
+ )
+ );
}
/**
- * Create a transport by the first section of the configuration
+ * Return whether it is possible to send the given command using the given transport
*
- * @return LocalCommandFile|RemoteCommandFile
+ * @param IcingaCommand $command
+ * @param CommandTransportInterface $transport
+ *
+ * @return bool
*/
- public static function first()
+ protected function transferPossible($command, $transport)
{
- $config = self::getConfig();
- $config->rewind();
- return self::fromConfig($config->current());
+ if (! method_exists($transport, 'getInstance') || !$command instanceof ObjectCommand) {
+ return true;
+ }
+
+ $transportInstance = $transport->getInstance();
+ if (! $transportInstance || $transportInstance === 'none') {
+ return true;
+ }
+
+ return strtolower($transportInstance) === strtolower($command->getObject()->instance_name);
}
}
diff --git a/modules/monitoring/library/Monitoring/Command/Transport/LocalCommandFile.php b/modules/monitoring/library/Monitoring/Command/Transport/LocalCommandFile.php
index 00756da9d..b2f21a05e 100644
--- a/modules/monitoring/library/Monitoring/Command/Transport/LocalCommandFile.php
+++ b/modules/monitoring/library/Monitoring/Command/Transport/LocalCommandFile.php
@@ -22,6 +22,13 @@ class LocalCommandFile implements CommandTransportInterface
*/
const TRANSPORT = 'local';
+ /**
+ * The name of the Icinga instance this transport will transfer commands to
+ *
+ * @var string
+ */
+ protected $instanceName;
+
/**
* Path to the icinga command file
*
@@ -51,6 +58,29 @@ class LocalCommandFile implements CommandTransportInterface
$this->renderer = new IcingaCommandFileCommandRenderer();
}
+ /**
+ * Set the name of the Icinga instance this transport will transfer commands to
+ *
+ * @param string $name
+ *
+ * @return $this
+ */
+ public function setInstance($name)
+ {
+ $this->instanceName = $name;
+ return $this;
+ }
+
+ /**
+ * Return the name of the Icinga instance this transport will transfer commands to
+ *
+ * @return string
+ */
+ public function getInstance()
+ {
+ return $this->instanceName;
+ }
+
/**
* Set the path to the local Icinga command file
*
diff --git a/modules/monitoring/library/Monitoring/Command/Transport/RemoteCommandFile.php b/modules/monitoring/library/Monitoring/Command/Transport/RemoteCommandFile.php
index 383970b76..a0f597072 100644
--- a/modules/monitoring/library/Monitoring/Command/Transport/RemoteCommandFile.php
+++ b/modules/monitoring/library/Monitoring/Command/Transport/RemoteCommandFile.php
@@ -22,6 +22,13 @@ class RemoteCommandFile implements CommandTransportInterface
*/
const TRANSPORT = 'remote';
+ /**
+ * The name of the Icinga instance this transport will transfer commands to
+ *
+ * @var string
+ */
+ protected $instanceName;
+
/**
* Remote host
*
@@ -74,6 +81,29 @@ class RemoteCommandFile implements CommandTransportInterface
$this->renderer = new IcingaCommandFileCommandRenderer();
}
+ /**
+ * Set the name of the Icinga instance this transport will transfer commands to
+ *
+ * @param string $name
+ *
+ * @return $this
+ */
+ public function setInstance($name)
+ {
+ $this->instanceName = $name;
+ return $this;
+ }
+
+ /**
+ * Return the name of the Icinga instance this transport will transfer commands to
+ *
+ * @return string
+ */
+ public function getInstance()
+ {
+ return $this->instanceName;
+ }
+
/**
* Set the remote host
*
diff --git a/modules/monitoring/library/Monitoring/MonitoringWizard.php b/modules/monitoring/library/Monitoring/MonitoringWizard.php
index 4b495c36e..c35705f62 100644
--- a/modules/monitoring/library/Monitoring/MonitoringWizard.php
+++ b/modules/monitoring/library/Monitoring/MonitoringWizard.php
@@ -12,8 +12,8 @@ use Icinga\Module\Setup\RequirementSet;
use Icinga\Module\Setup\Forms\SummaryPage;
use Icinga\Module\Monitoring\Forms\Setup\WelcomePage;
use Icinga\Module\Monitoring\Forms\Setup\BackendPage;
-use Icinga\Module\Monitoring\Forms\Setup\InstancePage;
use Icinga\Module\Monitoring\Forms\Setup\SecurityPage;
+use Icinga\Module\Monitoring\Forms\Setup\TransportPage;
use Icinga\Module\Monitoring\Forms\Setup\IdoResourcePage;
use Icinga\Module\Monitoring\Forms\Setup\LivestatusResourcePage;
use Icinga\Module\Setup\Requirement\ClassRequirement;
@@ -33,7 +33,7 @@ class MonitoringWizard extends Wizard implements SetupWizard
$this->addPage(new BackendPage());
$this->addPage(new IdoResourcePage());
$this->addPage(new LivestatusResourcePage());
- $this->addPage(new InstancePage());
+ $this->addPage(new TransportPage());
$this->addPage(new SecurityPage());
$this->addPage(new SummaryPage(array('name' => 'setup_monitoring_summary')));
}
@@ -150,8 +150,8 @@ class MonitoringWizard extends Wizard implements SetupWizard
);
$setup->addStep(
- new InstanceStep(array(
- 'instanceConfig' => $pageData['setup_monitoring_instance']
+ new TransportStep(array(
+ 'transportConfig' => $pageData['setup_command_transport']
))
);
diff --git a/modules/monitoring/library/Monitoring/InstanceStep.php b/modules/monitoring/library/Monitoring/TransportStep.php
similarity index 67%
rename from modules/monitoring/library/Monitoring/InstanceStep.php
rename to modules/monitoring/library/Monitoring/TransportStep.php
index 7aa1ef760..936c9a6de 100644
--- a/modules/monitoring/library/Monitoring/InstanceStep.php
+++ b/modules/monitoring/library/Monitoring/TransportStep.php
@@ -8,7 +8,7 @@ use Icinga\Module\Setup\Step;
use Icinga\Application\Config;
use Icinga\Exception\IcingaException;
-class InstanceStep extends Step
+class TransportStep extends Step
{
protected $data;
@@ -21,13 +21,13 @@ class InstanceStep extends Step
public function apply()
{
- $instanceConfig = $this->data['instanceConfig'];
- $instanceName = $instanceConfig['name'];
- unset($instanceConfig['name']);
+ $transportConfig = $this->data['transportConfig'];
+ $transportName = $transportConfig['name'];
+ unset($transportConfig['name']);
try {
- Config::fromArray(array($instanceName => $instanceConfig))
- ->setConfigFile(Config::resolvePath('modules/monitoring/instances.ini'))
+ Config::fromArray(array($transportName => $transportConfig))
+ ->setConfigFile(Config::resolvePath('modules/monitoring/commandtransports.ini'))
->saveIni();
} catch (Exception $e) {
$this->error = $e;
@@ -40,16 +40,16 @@ class InstanceStep extends Step
public function getSummary()
{
- $pageTitle = '' . mt('monitoring', 'Monitoring Instance', 'setup.page.title') . '
';
+ $pageTitle = '' . mt('monitoring', 'Command Transport', 'setup.page.title') . '
';
- if (isset($this->data['instanceConfig']['host'])) {
+ if (isset($this->data['transportConfig']['host'])) {
$pipeHtml = '' . sprintf(
mt(
'monitoring',
'Icinga Web 2 will use the named pipe located on a remote machine at "%s" to send commands'
. ' to your monitoring instance by using the connection details listed below:'
),
- $this->data['instanceConfig']['path']
+ $this->data['transportConfig']['path']
) . '
';
$pipeHtml .= ''
@@ -57,15 +57,15 @@ class InstanceStep extends Step
. '