diff options
31 files changed, 612 insertions, 208 deletions
diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 13be2a3..84002b4 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,3 +1,14 @@ +2019-03-01 Daniel Baumann <daniel.baumann@open-infrastructure.net> + + * Releasing version 20190301. + + [ Daniel Baumann ] + * Updating copyright headers. + * Removing ceph-remove-osd until it's completely tested. + * Updating ceph default release in ceph-dns. + * Fixing formatting in changelog. + * Updating all paths to reflect rename to ceph-tools. + 2018-09-15 Daniel Baumann <daniel.baumann@open-infrastructure.net> * Releasing version 20180915. @@ -35,6 +46,7 @@ 2017-04-10 Daniel Baumann <daniel.baumann@open-infrastructure.net> * Releasing version 20170410. + * Backward incompatible changes: - cephfs-snap changed name of snapshots: + old: ${TYPE}_${YEAR}-${MONTH}-${DAY}_${HOUR}${MINUTES}${TIMEZONE} @@ -1,7 +1,4 @@ -# Makefile - -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # @@ -20,7 +17,10 @@ SHELL := sh -e +PROJECT = open-infrastructure SOFTWARE = storage-tools +PROGRAM = ceph-tools + SCRIPTS = bin/* all: build @@ -60,21 +60,27 @@ install: build mkdir -p $(DESTDIR)/usr/bin cp -r bin/* $(DESTDIR)/usr/bin + mkdir -p $(DESTDIR)/usr/share/$(PROJECT)/$(PROGRAM) + cp -r VERSION.txt $(DESTDIR)/usr/share/$(PROJECT)/$(PROGRAM) + + mkdir -p $(DESTDIR)/etc/apache2/conf-available + cp -a share/apache/conf/* $(DESTDIR)/etc/apache2/conf-available + mkdir -p $(DESTDIR)/etc/cron.d cp -r share/cron/* $(DESTDIR)/etc/cron.d mkdir -p $(DESTDIR)/etc/logrotate.d cp -r share/logrotate/* $(DESTDIR)/etc/logrotate.d - mkdir -p $(DESTDIR)/usr/share/$(SOFTWARE) - cp -r share/ceph-info $(DESTDIR)/usr/share/$(SOFTWARE) + mkdir -p $(DESTDIR)/lib/systemd/system + cp -r share/systemd/* $(DESTDIR)/lib/systemd/system + + mkdir -p $(DESTDIR)/usr/share/$(PROJECT)/$(PROGRAM) + cp -r share/ceph-info $(DESTDIR)/usr/share/$(PROJECT) mkdir -p $(DESTDIR)/usr/share/doc/$(SOFTWARE) cp -r CHANGELOG.txt LICENSE.txt README.txt share/doc/* $(DESTDIR)/usr/share/doc/$(SOFTWARE) - mkdir -p $(DESTDIR)/etc/apache2/conf-available - cp -a share/apache/conf/* $(DESTDIR)/etc/apache2/conf-available - for SECTION in $$(seq 1 8); \ do \ if ls share/man/*.$${SECTION} > /dev/null 2>&1; \ @@ -84,18 +90,10 @@ install: build fi; \ done - mkdir -p $(DESTDIR)/lib/systemd/system - cp -r share/systemd/* $(DESTDIR)/lib/systemd/system - - mkdir -p $(DESTDIR)/var/log/$(SOFTWARE) + mkdir -p $(DESTDIR)/var/log/$(PROJECT) uninstall: - rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/var/log/$(SOFTWARE) || true - - for FILE in share/systemd*; \ - do \ - rm -f $(DESTDIR)/lib/systemd/system/$$(basename $${FILE}); \ - done + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/var/log/$(PROJECT) || true for SECTION in $$(seq 1 8); \ do \ @@ -106,6 +104,11 @@ uninstall: rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share/man/man$${SECTION} || true; \ done + for FILE in share/systemd*; \ + do \ + rm -f $(DESTDIR)/lib/systemd/system/$$(basename $${FILE}); \ + done + for FILE in share/logrotate/*; \ do \ rm -f $(DESTDIR)/etc/logrotate.d/$$(basename $${FILE}); \ @@ -125,7 +128,7 @@ uninstall: rm -rf $(DESTDIR)/usr/share/doc/$(SOFTWARE) rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share/doc || true - rm -rf $(DESTDIR)/usr/share/$(SOFTWARE) + rm -rf $(DESTDIR)/usr/share/$(PROJECT)/$(SOFTWARE) rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share || true for FILE in bin/*; \ diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..1301859 --- /dev/null +++ b/README.txt @@ -0,0 +1,68 @@ +NAME +---- +storage-tools - Additional utilities to manage storage related tasks + + +DESCRIPTION +----------- +"Computer data storage [...] is a technology consisting of computer components +and recording media used to retain digital data. It is a core function and +fundamental component of computers." + -- Wikipedia (https://en.wikipedia.org/wiki/Data_storage_device) + +storage-tools contains additional utilities to manage storage related tasks. + + +DOWNLOAD +-------- + * Upstream Releases: https://files.open-infrastructure.net/software/storage-tools/upstream + * Upstream Sources: https://sources.open-infrastructure.net/software/storage-tools + * Debian Releases: https://files.open-infrastructure.net/software/storage-tools/debian + * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-storage-tools + + +INSTALLATION +------------ + +SOURCE +~~~~~~ + 1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc + 2. git clone https://sources.open-infrastructure.net/software/storage-tools + 3. cd storage-tools && sudo make install + +DEBIAN 10 (BUSTER) AND NEWER +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * sudo apt install storage-tools + + +DEVELOPMENT +----------- +Bug reports, feature requests, help, patches, support and everything else +are welcome on the Open Infrastructure Software Mailing List: + + * https://lists.open-infrastructure.net/listinfo/software + +Please base patches against the 'next' Git branch using common sense: + + * https://www.kernel.org/doc/Documentation/SubmittingPatches + +Debian specific bugs can also be reported in the Debian Bug Tracking System: + + * https://bugs.debian.org + + +TOOLS +----- +*ceph-log(1):*:: + store Ceph cluster log as a logfile. + +*ceph-info(1):*:: + show Ceph cluster information as a website. + +*cephfs-snap(1):*:: + create CephFS snapshots periodically. + + +AUTHORS +------- + * Daniel Baumann <daniel.baumann@open-infrastructure.net> diff --git a/VERSION.txt b/VERSION.txt index 0c5aadd..868c05a 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -20171101 +20190301 diff --git a/bin/ceph-dns b/bin/ceph-dns index 59c5150..9adafa2 100755 --- a/bin/ceph-dns +++ b/bin/ceph-dns @@ -1,7 +1,6 @@ #!/bin/sh -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # @@ -138,7 +137,7 @@ shift 1 Parameters "${@}" NUMBER="${NUMBER:-3}" -RELEASE="${RELEASE:-luminous}" +RELEASE="${RELEASE:-mimic}" case "${ZONE}" in "") diff --git a/bin/ceph-info b/bin/ceph-info index 845e306..8fa4c8f 100755 --- a/bin/ceph-info +++ b/bin/ceph-info @@ -1,7 +1,6 @@ #!/bin/sh -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # @@ -20,12 +19,13 @@ set -e +PROJECT="open-infrastructure" SOFTWARE="storage-tools" PROGRAM="ceph-info" -if [ -e "/etc/default/${SOFTWARE}" ] +if [ -e "/etc/${PROJECT}/ceph-tools.conf" ] then - . "/etc/default/${SOFTWARE}" + . "/etc/${PROJECT}/ceph-tools.conf" fi case "${CEPH_INFO}" in diff --git a/bin/ceph-log b/bin/ceph-log index 1470101..68cfc16 100755 --- a/bin/ceph-log +++ b/bin/ceph-log @@ -1,7 +1,6 @@ #!/bin/sh -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # @@ -20,12 +19,13 @@ set -e +PROJECT="open-infrastructure" SOFTWARE="storage-tools" PROGRAM="ceph-log" -if [ -e "/etc/default/${SOFTWARE}" ] +if [ -e "/etc/${PROJECT}/ceph-tools.conf" ] then - . "/etc/default/${SOFTWARE}" + . "/etc/${PROJECT}/ceph-tools.conf" fi case "${CEPH_LOG}" in diff --git a/bin/ceph-remove-osd b/bin/ceph-remove-osd deleted file mode 100755 index 1b16a47..0000000 --- a/bin/ceph-remove-osd +++ /dev/null @@ -1,69 +0,0 @@ -#!/bin/sh - -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> -# -# SPDX-License-Identifier: GPL-3.0+ -# -# 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/>. - -set -e - -PROGRAM="$(basename ${0})" - -OSDS="${@}" - -Usage () -{ - echo "Usage: ${PROGRAM} OSD1 OSD2.. OSDn" - exit 1 -} - -if [ -z "${OSDS}" ] -then - Usage -fi - -if [ ! -x /usr/bin/jq ] -then - echo "'${PROGRAM}': /usr/bin/jp - no such file." >&2 - exit 1 -fi - -# Run -for OSD in ${OSDS} -do - HOST="$(ceph osd find ${OSD} | jq -r '.["crush_location"]["host"]')" - - # remove the failed OSD - ceph osd out ${OSD} - - # stop the osd.${OSD} daemon on the respective storage host - ssh ceph-deploy@${HOST} sudo service ceph-osd@${OSD} stop - - # unmount the disk - ssh ceph-deploy@${HOST} sudo umount /var/lib/ceph/osd/ceph-${OSD} - - # remove osd from crush map - ceph osd crush remove osd.${OSD} - - # remove cephx key - ceph auth del osd.${OSD} - - # mark osd as down - ceph osd down osd.${OSD} - - # remove the osd - ceph osd rm osd.${OSD} -done diff --git a/bin/cephfs-snap b/bin/cephfs-snap index d6bb96d..5d20726 100755 --- a/bin/cephfs-snap +++ b/bin/cephfs-snap @@ -1,7 +1,6 @@ #!/bin/sh -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # @@ -20,6 +19,7 @@ set -e +PROJECT="open-infrastructure" SOFTWARE="storage-tools" PROGRAM="cephfs-snap" @@ -31,9 +31,9 @@ Usage () exit 1 } -if [ -e "/etc/default/${SOFTWARE}" ] +if [ -e "/etc/${PROJECT}/ceph-tools.conf" ] then - . "/etc/default/${SOFTWARE}" + . "/etc/${PROJECT}/ceph-tools.conf" fi case "${CEPHFS_SNAP}" in @@ -47,7 +47,7 @@ esac if [ -z "${CEPHFS_SNAP_DIRECTORIES}" ] then - echo "E: no cephfs directories defined in /etc/default/${SOFTWARE}" >&2 + echo "E: no cephfs directories defined in /etc/${PROJECT}/ceph-tools.conf" >&2 exit 1 fi @@ -57,7 +57,7 @@ case "${ACTION}" in if [ -z "${ROTATION}" ] then - echo "E: no cephfs snapshot rotation for ${ACTION} defined in /etc/default/${SOFTWARE}" >&2 + echo "E: no cephfs snapshot rotation for ${ACTION} defined in /etc/${PROJECT}/ceph-tools.conf" >&2 exit 1 fi ;; @@ -106,7 +106,7 @@ mkdir -p "/var/log/${SOFTWARE}/${PROGRAM}" echo "${DATE} ${HOST} ${PROGRAM} creating ${ACTION} snapshots" >> "/var/log/${SOFTWARE}/${PROGRAM}/${PROGRAM}.log" # irc -if [ -e /usr/bin/irk ] && [ -e "/etc/default/${SOFTWARE}" ] +if [ -e /usr/bin/irk ] && [ -e "/etc/${PROJECT}/ceph-tools.conf" ] then if [ -n "${IRK_TARGETS}" ] then diff --git a/share/apache/conf/ceph-info.conf b/share/apache/conf/ceph-info.conf index a1136e0..bac9681 100644 --- a/share/apache/conf/ceph-info.conf +++ b/share/apache/conf/ceph-info.conf @@ -1,8 +1,8 @@ <IfModule alias_module> - Alias /ceph-info /usr/share/storage-tools/ceph-info/web + Alias /ceph-info /usr/share/open-infrastructure/ceph-info/web </IfModule> -<Directory /usr/share/storage-tools/ceph-info/web> +<Directory /usr/share/open-infrastructure/ceph-info/web> Options FollowSymlinks Options -Indexes diff --git a/share/ceph-info/web/ceph-df.txt b/share/ceph-info/web/ceph-df.txt index dff3a13..e47ee39 120000 --- a/share/ceph-info/web/ceph-df.txt +++ b/share/ceph-info/web/ceph-df.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-df.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-df.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-health-detail.txt b/share/ceph-info/web/ceph-health-detail.txt index e78c3e7..bcedc12 120000 --- a/share/ceph-info/web/ceph-health-detail.txt +++ b/share/ceph-info/web/ceph-health-detail.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-health-detail.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-health-detail.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-osd-df.txt b/share/ceph-info/web/ceph-osd-df.txt index c5de915..5e61d4c 120000 --- a/share/ceph-info/web/ceph-osd-df.txt +++ b/share/ceph-info/web/ceph-osd-df.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-osd-df.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-osd-df.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-osd-tree.txt b/share/ceph-info/web/ceph-osd-tree.txt index 019a0bb..7418b7d 120000 --- a/share/ceph-info/web/ceph-osd-tree.txt +++ b/share/ceph-info/web/ceph-osd-tree.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-osd-tree.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-osd-tree.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-status.txt b/share/ceph-info/web/ceph-status.txt index c7042bb..35e400e 120000 --- a/share/ceph-info/web/ceph-status.txt +++ b/share/ceph-info/web/ceph-status.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-status.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-status.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-versions.txt b/share/ceph-info/web/ceph-versions.txt index bb9d86e..7bd9fb4 120000 --- a/share/ceph-info/web/ceph-versions.txt +++ b/share/ceph-info/web/ceph-versions.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/ceph-versions.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-versions.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-watch.log b/share/ceph-info/web/ceph-watch.log index 3644891..660f345 120000 --- a/share/ceph-info/web/ceph-watch.log +++ b/share/ceph-info/web/ceph-watch.log @@ -1 +1 @@ -/var/log/storage-tools/ceph-log/ceph-watch.log
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/ceph-watch.log
\ No newline at end of file diff --git a/share/ceph-info/web/date.txt b/share/ceph-info/web/date.txt index 22fb159..33dad46 120000 --- a/share/ceph-info/web/date.txt +++ b/share/ceph-info/web/date.txt @@ -1 +1 @@ -/var/log/storage-tools/ceph-info/date.txt
\ No newline at end of file +/var/cache/open-infrastructure/ceph-info/date.txt
\ No newline at end of file diff --git a/share/doc/examples/storage-tools b/share/doc/examples/ceph-tools index c74cb78..f665390 100644 --- a/share/doc/examples/storage-tools +++ b/share/doc/examples/ceph-tools @@ -1,4 +1,4 @@ -# /etc/default/storage-tools +# /etc/open-infrastructure/ceph-tools.conf CEPH_INFO="true" CEPH_LOG="true" diff --git a/share/logrotate/ceph-log b/share/logrotate/ceph-log index 7bcaf3f..2e62e60 100644 --- a/share/logrotate/ceph-log +++ b/share/logrotate/ceph-log @@ -1,4 +1,4 @@ -/var/log/storage-tools/ceph-log/ceph-watch.log { +/var/log/open-infrastructure/ceph-watch.log { compress create 0644 root root dateext diff --git a/share/logrotate/cephfs-snap b/share/logrotate/cephfs-snap index 21aae15..e444829 100644 --- a/share/logrotate/cephfs-snap +++ b/share/logrotate/cephfs-snap @@ -1,4 +1,4 @@ -/var/log/storage-tools/cephfs-snap/cephfs-snap.log { +/var/log/open-infrastructure/cephfs-snap.log { compress create 0640 root adm dateext diff --git a/share/man/Makefile b/share/man/Makefile index 101186e..2fe75b5 100644 --- a/share/man/Makefile +++ b/share/man/Makefile @@ -1,7 +1,4 @@ -# Makefile - -# storage-tools - Additional utilities to manage storage related tasks -# Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +# Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> # # SPDX-License-Identifier: GPL-3.0+ # 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>\&. diff --git a/share/man/ceph-info.1.txt b/share/man/ceph-info.1.txt index cf9088a..13d485b 100644 --- a/share/man/ceph-info.1.txt +++ b/share/man/ceph-info.1.txt @@ -1,5 +1,4 @@ -// storage-tools - Additional utilities to manage storage related tasks -// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +// Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> // // SPDX-License-Identifier: GPL-3.0+ // @@ -61,13 +60,13 @@ FILES ----- The following files are used: -*/etc/default/storage-tools*:: +*/etc/open-infrastructure/ceph-tools.conf*:: Configuration file. -*/var/log/storage-tools/ceph-info/*.txt*:: +*/var/cache/open-infrastructure/ceph-info/*.txt*:: Ceph cluster information dumps. -*/usr/share/storage-tools/ceph-info/web*:: +*/usr/share/open-infrastructure/ceph-info/web*:: ceph-info document root. diff --git a/share/man/ceph-log.1 b/share/man/ceph-log.1 new file mode 100644 index 0000000..9391492 --- /dev/null +++ b/share/man/ceph-log.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: ceph-log +.\" 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\-LOG" "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-log \- store Ceph cluster log as a logfile +.SH "SYNOPSIS" +.sp +\fBceph\-log\fR +.SH "DESCRIPTION" +.sp +When operating a Ceph storage cluster, the command \fIceph \-w\fR let\(cqs the system administrator watch everything that is happening in a ceph cluster, such as the health state of the cluster, any cluster changes and any commands and mounts from clients that are happening\&. +.sp +Unfortunately the \fIceph \-w\fR command is a tool that a system administrator uses for real time information, means there is no history or looking backward what happened at a given time\&. +.sp +The ceph\-log program stores the output of \fIceph \-w\fR into a logfile and rotate its\&. This allows the system administrator to go back and check what exactly happened in detail within a Ceph storage cluster at any given time\&. +.SH "OPTIONS" +.sp +The ceph\-log 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/log/open\-infrastructure/ceph\-watch\&.log\fR +.RS 4 +Ceph cluster logfile\&. +.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>\&. diff --git a/share/man/ceph-log.1.txt b/share/man/ceph-log.1.txt index 16c39d8..f5ae604 100644 --- a/share/man/ceph-log.1.txt +++ b/share/man/ceph-log.1.txt @@ -1,5 +1,4 @@ -// storage-tools - Additional utilities to manage storage related tasks -// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +// Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> // // SPDX-License-Identifier: GPL-3.0+ // @@ -59,10 +58,10 @@ FILES ----- The following files are used: -*/etc/default/storage-tools*:: +*/etc/open-infrastructure/ceph-tools.conf*:: Configuration file. -*/var/log/storage-tools/ceph-log/ceph-watch.log*:: +*/var/log/open-infrastructure/ceph-watch.log*:: Ceph cluster logfile. diff --git a/share/man/ceph-remove-osd.1.txt b/share/man/ceph-remove-osd.1.txt deleted file mode 100644 index 81d35ae..0000000 --- a/share/man/ceph-remove-osd.1.txt +++ /dev/null @@ -1,66 +0,0 @@ -// storage-tools - Additional utilities to manage storage related tasks -// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> -// -// SPDX-License-Identifier: GPL-3.0+ -// -// 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-REMOVE-OSD(1) -================== -:doctype: manpage -:man manual: Open Infrastructure -:man source: storage-tools -:man version: {revnumber} - - -NAME ----- -ceph-remove-osd - shortcut for removing an Ceph OSD instance completly. - - -SYNOPSIS --------- -*ceph-remove-osd* OSD - - -DESCRIPTION ------------ -When replacing a broken disk in a Ceph storage cluster, the correct OSD -needs to be shut down properly and its keys removed. - -ceph-remove-osd does all required steps. - - -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>. diff --git a/share/man/cephfs-snap.1 b/share/man/cephfs-snap.1 new file mode 100644 index 0000000..8bc699f --- /dev/null +++ b/share/man/cephfs-snap.1 @@ -0,0 +1,117 @@ +'\" t +.\" Title: cephfs-snap +.\" 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 "CEPHFS\-SNAP" "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" +cephfs-snap \- create CephFS snapshots periodically +.SH "SYNOPSIS" +.sp +\fBcephfs\-snap\fR +.sp +\fBcephfs\-snap\fR [hourly|daily|weekly|monthly] +.SH "DESCRIPTION" +.sp +CephFS supports creating snapshots of the filesystem as a simple means of backups\&. +.sp +The cephfs\-snap program is a simple tool to do this periodically\&. +.SH "CONFIGURATION" +.sp +cephfs\-snap is configured in /etc/default/storage\-tools\&. The following variables are used: +.PP +\fBCEPHFS_SNAP\fR +.RS 4 +Boolean, either true or false\&. If set to false (default), cephfs will do nothing\&. +.RE +.PP +\fBCEPHFS_SNAP_DIRECTORIES\fR +.RS 4 +List of one or more space separated directories\&. If no directory is specified, cephfs\-snap will do nothing\&. +.RE +.PP +\fBCEPHFS_SNAP_HOURLY\fR +.RS 4 +Integer, number of how many most recent hourly snapshots are to be kept at any given time\&. Any older snapshots will be removed\&. Note: specify one more than you wan to keep, e\&.g\&. 25 for one day of hourly snapshots alongside the most current one\&. +.RE +.PP +\fBCEPHFS_SNAP_DAILY\fR +.RS 4 +Integer, number of how many most recent daily snapshots are to be kept at any given time\&. +.RE +.PP +\fBCEPHFS_SNAP_WEEKLY\fR +.RS 4 +Integer, number of how many most recent weekly snapshots are to be kept at any given time\&. +.RE +.PP +\fBCEPHFS_SNAP_MONTHLY\fR +.RS 4 +Integer, number of how many most recent monthly snapshots are to be kept at any given time\&. +.RE +.PP +\fBCEPHFS_SNAP_YEARLY\fR +.RS 4 +Integer, number of how many most recent yearly snapshots are to be kept at any given time\&. +.RE +.PP +\fBIRK_TARGETS\fR +.RS 4 +List of space separated IRC channels to send notifications to, e\&.g\&.: +irc://irc\&.oftc\&.net:6668/open\-infrastructure +.RE +.SH "FILES" +.sp +The following files are used: +.PP +\fB/etc/cron\&.d/cephfs\-snap\fR +.RS 4 +Cron file\&. +.RE +.PP +\fB/etc/open\-infrastructure/ceph\-tools\&.conf\fR +.RS 4 +Configuration file\&. +.RE +.PP +\fB/var/log/storage\-tools/cephfs\-snap\fR +.RS 4 +Log files\&. +.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>\&. diff --git a/share/man/cephfs-snap.1.txt b/share/man/cephfs-snap.1.txt index 2e98bf3..345ba38 100644 --- a/share/man/cephfs-snap.1.txt +++ b/share/man/cephfs-snap.1.txt @@ -1,5 +1,4 @@ -// storage-tools - Additional utilities to manage storage related tasks -// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +// Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> // // SPDX-License-Identifier: GPL-3.0+ // @@ -80,7 +79,7 @@ The following files are used: */etc/cron.d/cephfs-snap*:: Cron file. -*/etc/default/storage-tools*:: +*/etc/open-infrastructure/ceph-tools.conf*:: Configuration file. */var/log/storage-tools/cephfs-snap*:: diff --git a/share/man/storage-tools.7 b/share/man/storage-tools.7 new file mode 100644 index 0000000..bb58347 --- /dev/null +++ b/share/man/storage-tools.7 @@ -0,0 +1,201 @@ +'\" t +.\" Title: storage-tools +.\" 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 "STORAGE\-TOOLS" "7" "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" +storage-tools \- Additional utilities to manage storage related tasks +.SH "DESCRIPTION" +.sp +"Computer data storage [\&...] is a technology consisting of computer components and recording media used to retain digital data\&. It is a core function and fundamental component of computers\&." \(em Wikipedia (https://en\&.wikipedia\&.org/wiki/Data_storage_device) +.sp +storage\-tools contains additional utilities to manage storage related tasks\&. +.SH "DOWNLOAD" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Upstream Releases: +https://files\&.open\-infrastructure\&.net/software/storage\-tools/upstream +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Upstream Sources: +https://sources\&.open\-infrastructure\&.net/software/storage\-tools +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Debian Releases: +https://files\&.open\-infrastructure\&.net/software/storage\-tools/debian +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Debian Sources: +https://sources\&.progress\-linux\&.org/users/daniel/debian/packages/open\-infrastructure\-storage\-tools +.RE +.SH "INSTALLATION" +.SS "SOURCE" +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +sudo apt install asciidoc git docbook\-xml docbook\-xsl libxml2\-utils make xsltproc +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +git clone +https://sources\&.open\-infrastructure\&.net/software/storage\-tools +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +cd storage\-tools && sudo make install +.RE +.SS "DEBIAN 10 (BUSTER) AND NEWER" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +sudo apt install storage\-tools +.RE +.SH "DEVELOPMENT" +.sp +Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://lists\&.open\-infrastructure\&.net/listinfo/software +.RE +.sp +Please base patches against the \fInext\fR Git branch using common sense: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://www\&.kernel\&.org/doc/Documentation/SubmittingPatches +.RE +.sp +Debian specific bugs can also be reported in the Debian Bug Tracking System: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +https://bugs\&.debian\&.org +.RE +.SH "TOOLS" +.PP +\fBceph\-log(1):\fR +.RS 4 +store Ceph cluster log as a logfile\&. +.RE +.PP +\fBceph\-info(1):\fR +.RS 4 +show Ceph cluster information as a website\&. +.RE +.PP +\fBcephfs\-snap(1):\fR +.RS 4 +create CephFS snapshots periodically\&. +.RE +.SH "AUTHORS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> +.RE diff --git a/share/man/storage-tools.7.txt b/share/man/storage-tools.7.txt index 78a9182..61f518b 100644 --- a/share/man/storage-tools.7.txt +++ b/share/man/storage-tools.7.txt @@ -1,5 +1,4 @@ -// storage-tools - Additional utilities to manage storage related tasks -// Copyright (C) 2014-2017 Daniel Baumann <daniel.baumann@open-infrastructure.net> +// Copyright (C) 2014-2019 Daniel Baumann <daniel.baumann@open-infrastructure.net> // // SPDX-License-Identifier: GPL-3.0+ // @@ -88,9 +87,6 @@ TOOLS *cephfs-snap(1):*:: create CephFS snapshots periodically. -*ceph-remove-osd(1):*:: - shortcut for removing an Ceph OSD instance completly. - AUTHORS ------- |