summaryrefslogtreecommitdiffstats
path: root/share/man/ceph-info.1
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/ceph-info.1')
-rw-r--r--share/man/ceph-info.178
1 files changed, 78 insertions, 0 deletions
diff --git a/share/man/ceph-info.1 b/share/man/ceph-info.1
new file mode 100644
index 0000000..263437a
--- /dev/null
+++ b/share/man/ceph-info.1
@@ -0,0 +1,78 @@
+'\" t
+.\" Title: ceph-info
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 20171101
+.\" Manual: Open Infrastructure
+.\" Source: storage-tools
+.\" Language: English
+.\"
+.TH "CEPH\-INFO" "1" "20171101" "storage\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+ceph-info \- show Ceph cluster information as a website\&.
+.SH "SYNOPSIS"
+.sp
+\fBceph\-info\fR
+.SH "DESCRIPTION"
+.sp
+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\&.
+.sp
+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\&.
+.sp
+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\&.
+.sp
+The info page is by default visible on http://localhost/ceph\-info
+.SH "OPTIONS"
+.sp
+The ceph\-info program has no options\&.
+.SH "FILES"
+.sp
+The following files are used:
+.PP
+\fB/etc/open\-infrastructure/ceph\-tools\&.conf\fR
+.RS 4
+Configuration file\&.
+.RE
+.PP
+\fB/var/cache/open\-infrastructure/ceph\-info/\fR\&.txt*
+.RS 4
+Ceph cluster information dumps\&.
+.RE
+.PP
+\fB/usr/share/open\-infrastructure/ceph\-info/web\fR
+.RS 4
+ceph\-info document root\&.
+.RE
+.SH "SEE ALSO"
+.sp
+storage\-tools(7)\&.
+.SH "HOMEPAGE"
+.sp
+More information about storage\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+storage\-tools was written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>\&.