summaryrefslogtreecommitdiffstats
path: root/share/man/ceph-info.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/ceph-info.1.txt')
-rw-r--r--share/man/ceph-info.1.txt93
1 files changed, 93 insertions, 0 deletions
diff --git a/share/man/ceph-info.1.txt b/share/man/ceph-info.1.txt
new file mode 100644
index 0000000..72c50b1
--- /dev/null
+++ b/share/man/ceph-info.1.txt
@@ -0,0 +1,93 @@
+// storage-tools - Additional utilities to manage storage related tasks
+// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program 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. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+CEPH-INFO(1)
+============
+:doctype: manpage
+:man manual: Open Infrastructure
+:man source: storage-tools
+:man version: {revnumber}
+
+
+NAME
+----
+ceph-info - show Ceph cluster information as a website.
+
+
+SYNOPSIS
+--------
+*ceph-info*
+
+
+DESCRIPTION
+-----------
+When operating large, central storage systems the trust of the users that their
+data is always safe is paramount. Specifically in the enterprise environment,
+gaining trust from the users to save their data on your Ceph cluster (which
+is "just" SDS) can be achieved with technical transparency.
+
+The ceph-info program shows Ceph cluster information as a website where anyone
+interested can observe the clusters health and action transparently, without
+requireing Ceph specific knowledge or access privileges.
+
+For the system administrators it provides a neat "one page" overview of all
+essential health information of the cluster, rather than to do the same commands
+over the command line.
+
+The info page is by default visible on http://localhost/ceph-info
+
+
+OPTIONS
+-------
+The ceph-info program has no options.
+
+
+FILES
+-----
+The following files are used:
+
+*/etc/default/storage-tools*::
+ Configuration file.
+
+*/var/log/storage-tools/ceph-info/*.txt*::
+ Ceph cluster information dumps.
+
+*/usr/share/storage-tools/ceph-info/web*::
+ ceph-info document root.
+
+
+SEE ALSO
+--------
+storage-tools(7).
+
+
+HOMEPAGE
+--------
+More information about storage-tools and the Open Infrastructure project can be
+found on the homepage at https://open-infrastructure.net.
+
+
+CONTACT
+-------
+Bug reports, feature requests, help, patches, support and everything else
+are welcome on the Open Infrastructure Software Mailing List <software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs.debian.org.
+
+
+AUTHORS
+-------
+storage-tools was written by Daniel Baumann <daniel.baumann@open-infrastructure.net>.