Basket: provide CLI command

application/clicommands/BasketCommand.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Icinga\Module\Director\Clicommands;
+
+use Icinga\Date\DateFormatter;
+use Icinga\Module\Director\Cli\Command;
+use Icinga\Module\Director\DirectorObject\Automation\Basket;
+use Icinga\Module\Director\DirectorObject\Automation\BasketSnapshot;
+
+/**
+ * Export Director Config Objects
+ */
+class BasketCommand extends Command
+{
+    /**
+     * List configured Baskets
+     *
+     * USAGE
+     *
+     * icingacli director basket list
+     *
+     * OPTIONS
+     */
+    public function listAction()
+    {
+        $db = $this->db()->getDbAdapter();
+        $query = $db->select()
+            ->from('director_basket', 'basket_name')
+            ->order('basket_name');
+        foreach ($db->fetchCol($query) as $name) {
+            echo "$name\n";
+        }
+    }
+
+    /**
+     * JSON-dump for objects related to the given Basket
+     *
+     * USAGE
+     *
+     * icingacli director basket dump --name <basket>
+     *
+     * OPTIONS
+     */
+    public function dumpAction()
+    {
+        $basket = $this->requireBasket();
+        $snapshot = BasketSnapshot::createForBasket($basket, $this->db());
+        echo $snapshot->getJsonDump() . "\n";
+    }
+
+    /**
+     * Take a snapshot for the given Basket
+     *
+     * USAGE
+     *
+     * icingacli director basket snapshot --name <basket>
+     *
+     * OPTIONS
+     */
+    public function snapshotAction()
+    {
+        $basket = $this->requireBasket();
+        $snapshot = BasketSnapshot::createForBasket($basket, $this->db());
+        $snapshot->store();
+        $hexSum = bin2hex($snapshot->get('content_checksum'));
+        printf(
+            "Snapshot '%s' taken for Basket '%s' at %s\n",
+            substr($hexSum, 0, 7),
+            $basket->get('basket_name'),
+            DateFormatter::formatDateTime($snapshot->get('ts_create') / 1000)
+        );
+    }
+
+    /**
+     * Restore a Basket from JSON dump provided on STDIN
+     *
+     * USAGE
+     *
+     * icingacli director basket restore < basket-dump.json
+     *
+     * OPTIONS
+     */
+    public function restoreAction()
+    {
+        $json = file_get_contents('php://stdin');
+        BasketSnapshot::restoreJson($json, $this->db());
+        echo "Objects from Basket Snapshot have been restored\n";
+    }
+
+    /**
+     */
+    protected function requireBasket()
+    {
+        return Basket::load($this->params->getRequired('name'), $this->db());
+    }
+}

doc/60-CLI.md

@@ -342,6 +342,34 @@ specific type:
 This feature is available since v1.5.0.
 
 
+Director Configuration Basket
+-----------------------------
+
+A basket contains a set of Director Configuration objects (like Templates,
+Commands, Import/Sync definitions - but not single Hosts or Services). This
+CLI command allows you to integrate them into your very own workflows
+
+## Available Actions
+
+| Action     | Description                                       |
+|------------|---------------------------------------------------|
+| `dump`     | JSON-dump for objects related to the given Basket |
+| `list`     | List configured Baskets                           |
+| `restore`  | Restore a Basket from JSON dump provided on STDIN |
+| `snapshot` | Take a snapshot for the given Basket              |
+
+### Options
+
+| Option   | Description                                          |
+|----------|------------------------------------------------------|
+| `--name` | `dump` and `snapshot` require a specific object name |
+
+Use `icingacli director basket restore < exported-basket.json` to restore objects
+from a specific basket. Take a snapshot or a backup first to be on the safe side.
+
+This feature is available since v1.6.0.
+
+
 Health Check Plugin
 -------------------