From 580577ae8a2158fd456a4eec4b9abde83c20df11 Mon Sep 17 00:00:00 2001
From: Tomas Kopecek <tkopecek@redhat.com>
Date: Jun 30 2020 07:03:53 +0000
Subject: PR#2344: runroot: basic docs


Merges #2344
https://pagure.io/koji/pull-request/2344

Fixes: #2111
https://pagure.io/koji/issue/2111
runroot tasks end up in default channel

---

diff --git a/builder/kojid.conf b/builder/kojid.conf
index 5f5ec28..793aed3 100644
--- a/builder/kojid.conf
+++ b/builder/kojid.conf
@@ -126,3 +126,11 @@ from_addr=Koji Build System <buildsys@example.com>
 ;to hub. It could be useful for debugging purposes, but creates twice as many
 ;log files
 ;log_timestamps = False
+
+;enabled plugins, base koji installation has access to runroot and save_failed_tree
+;none of these is enabled by default
+;plugin = 
+
+;path where builder plugins are located, there could be multiple paths delimited
+by :
+;pluginpath = /usr/lib/koji-builder-plugins
diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst
index 7aa74c1..5fdbf75 100644
--- a/docs/source/plugins.rst
+++ b/docs/source/plugins.rst
@@ -7,7 +7,31 @@ Following plugins are available in default koji installation.
 Runroot
 =======
 
-Plugin for running any command in buildroot.
+Plugin for running any command in buildroot. It has three parts as most of the
+others (hub, builder and CLI).
+
+Builder
+-------
+You enable plugin by editing ``/etc/kojid.conf`` by adding ``plugin = runroot``
+there. Plugin itself has separate configuration file on each builder located at
+``/etc/kojid/plugins/runroot.conf`` There is a sample configuration file
+with option descriptions installed.
+
+Hub
+---
+On the hub side ``Plugins = runroot_hub`` needs to be added to
+``/etc/koji-hub/hub.conf``. Note, that by default policy runroot tasks are
+assigned to ``runroot`` channel. As this is a plugin, we don't create it
+automatically. There are three options - create channel when adding first builder
+there via ``koji add-host-to-channel --new hostname runroot`` or by changing the
+default channel policy according to :doc:`defining_hub_policies`. Last option is
+to use ``--channel-override`` option in CLI to drive task to channel of choice.
+
+CLI
+---
+CLI is looking for available plugins every run, so it if it is installed, you'll
+see new command ``runroot`` with options described in its help. No config
+options are needed to enable it.
 
 Save Failed Tree
 ================