[doc/admin] Insert instructions for maintenance commands

doc/admin/backend.rst

+.. vim: set fileencoding=utf-8 :
+
+.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
+.. Contact: beat.support@idiap.ch                                             ..
+..                                                                            ..
+.. This file is part of the beat.web module of the BEAT platform.             ..
+..                                                                            ..
+.. Commercial License Usage                                                   ..
+.. Licensees holding valid commercial BEAT licenses may use this file in      ..
+.. accordance with the terms contained in a written agreement between you     ..
+.. and Idiap. For further information contact tto@idiap.ch                    ..
+..                                                                            ..
+.. Alternatively, this file may be used under the terms of the GNU Affero     ..
+.. Public License version 3 as published by the Free Software and appearing   ..
+.. in the file LICENSE.AGPL included in the packaging of this file.           ..
+.. The BEAT platform is distributed in the hope that it will be useful, but   ..
+.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
+.. or FITNESS FOR A PARTICULAR PURPOSE.                                       ..
+..                                                                            ..
+.. You should have received a copy of the GNU Affero Public License along     ..
+.. with the BEAT platform. If not, see http://www.gnu.org/licenses/.          ..
+
+
+.. _administratorguide-backend_maintenance:
+
+Backend Maintenance
+===================
+
+This guide contains information about administrative tasks related to the
+backend. Activities include cache clean-up actions and backend (workers,
+environments, queues) reconfiguration.
+
+
+Configuration
+-------------
+
+The administrative command ``qsetup`` can be used to configure or re-configure
+the backend:
+
+.. command-output:: ./bin/django qsetup --help
+   :cwd:../..
+
+
+This command will check current queue usage w.r.t. submitted experiments and
+will modify the queue/worker/environment configuration on-the-fly. Running
+schedulers and workers will not be affected.
+
+By default, all new workers inserted are made inactive. This flag should be
+turned-on by the worker process itself once it is started.
+
+
+Cache Maintenance
+-----------------
+
+If your cache becomes very large, you may have to delete old files. The
+administative command ``cleanup_cache`` can help you in that task:
+
+.. command-output:: ./bin/django cleanup_cache --help
+   :cwd:../..
+
+
+This command will first check running experiments and database files and make
+sure not to remove any files currently used by those are removed. You may then
+specify the amount of time in minutes from the current time, cache files should
+be considered outdated and must be removed.
+
+Notice the command, by default, does not remove any files - it only lists the
+files it would remove. In order to actually remove the files, you must also
+specify the option ``--delete``.

doc/admin/index.rst

@@ -43,5 +43,6 @@ BEAT platform.
     applications
     deployment_guidelines
     installation
+    backend
     idiap_platform
     platform_extension