diff options
30 files changed, 1807 insertions, 0 deletions
diff --git a/CHANGELOG.txt b/CHANGELOG.txt new file mode 100644 index 0000000..c216033 --- /dev/null +++ b/CHANGELOG.txt @@ -0,0 +1,3 @@ +2017-04-05 Daniel Baumann <daniel.baumann@open-infrastructure.net> + + * Releasing version 20170405. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c150a59 --- /dev/null +++ b/Makefile @@ -0,0 +1,144 @@ +# Makefile + +# 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/>. + +SHELL := sh -e + +SOFTWARE = storage-tools +SCRIPTS = bin/* + +all: build + +test: + @echo -n "Checking for syntax errors" + + @for SCRIPT in $(SCRIPTS); \ + do \ + sh -n $${SCRIPT}; \ + echo -n "."; \ + done + + @echo " done." + + @echo -n "Checking for bashisms" + + @if [ -x /usr/bin/checkbashisms ]; \ + then \ + for SCRIPT in $(SCRIPTS); \ + do \ + checkbashisms -f -x $${SCRIPT}; \ + echo -n "."; \ + done; \ + else \ + echo "Note: devscripts not installed, skipping checkbashisms."; \ + fi + + @echo " done." + +build: share/man/*.txt + $(MAKE) -C share/man + + sed -n '/^NAME/,$$p' share/man/$(SOFTWARE).7.txt > README.txt + +install: build + mkdir -p $(DESTDIR)/usr/bin + cp -r bin/* $(DESTDIR)/usr/bin + + 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)/usr/share/doc/$(SOFTWARE) + cp -r CHANGELOG.txt LICENSE.txt README.txt $(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; \ + then \ + mkdir -p $(DESTDIR)/usr/share/man/man$${SECTION}; \ + cp share/man/*.$${SECTION} $(DESTDIR)/usr/share/man/man$${SECTION}; \ + fi; \ + done + + mkdir -p $(DESTDIR)/lib/systemd/system + cp -r share/systemd/* $(DESTDIR)/lib/systemd/system + + mkdir -p $(DESTDIR)/var/log/$(SOFTWARE) + +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 + + for SECTION in $$(seq 1 8); \ + do \ + for FILE in share/man/*.$${SECTION}; \ + do \ + rm -f $(DESTDIR)/usr/share/man/man$${SECTION}/$$(basename $${FILE}); \ + done; \ + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share/man/man$${SECTION} || true; \ + done + + for FILE in share/logrotate/*; \ + do \ + rm -f $(DESTDIR)/etc/logrotate.d/$$(basename $${FILE}); \ + done + + for FILE in share/cron/*; \ + do \ + rm -f $(DESTDIR)/etc/cron.d/$$(basename $${FILE}); \ + done + + for FILE in share/apache/conf/*; \ + do \ + rm -f $(DESTDIR)/etc/apache2/conf-available/$$(basename $${FILE}); \ + done + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/etc/apache2/conf-available || true + + 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) + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/share || true + + for FILE in bin/*; \ + do \ + rm -f $(DESTDIR)/usr/bin/$$(basename $${FILE}); \ + done + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR)/usr/bin || true + + rmdir --ignore-fail-on-non-empty --parents $(DESTDIR) || true + +clean: + $(MAKE) -C share/man clean + + rm -f README.txt + +distclean: + +reinstall: uninstall install diff --git a/VERSION.txt b/VERSION.txt new file mode 100644 index 0000000..68b5226 --- /dev/null +++ b/VERSION.txt @@ -0,0 +1 @@ +20170405 diff --git a/bin/ceph-info b/bin/ceph-info new file mode 100755 index 0000000..4a504b2 --- /dev/null +++ b/bin/ceph-info @@ -0,0 +1,50 @@ +#!/bin/sh + +# 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/>. + +set -e + +SOFTWARE="storage-tools" +PROGRAM="ceph-info" + +if [ -e "/etc/default/${SOFTWARE}" ] +then + . "/etc/default/${SOFTWARE}" +fi + +case "${CEPH_INFO}" in + true) + ;; + + *) + exit 0 + ;; +esac + +DATE="$(date -R)" +HOST="$(hostname -f)" + +mkdir -p "/var/log/${SOFTWARE}/${PROGRAM}" + +for INFORMATION in ceph-status ceph-df ceph-osd-df ceph-osd-tree ceph-version +do + COMMAND="$(echo ${INFORMATION} | sed -e 's|-| |g')" + + ${COMMAND} > "/var/log/${SOFTWARE}/${PROGRAM}/${INFORMATION}.txt" +done + +echo " -- ${HOST} ${DATE}" > "/var/log/${SOFTWARE}/${PROGRAM}/date.txt" diff --git a/bin/ceph-log b/bin/ceph-log new file mode 100755 index 0000000..f06605f --- /dev/null +++ b/bin/ceph-log @@ -0,0 +1,40 @@ +#!/bin/sh + +# 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/>. + +set -e + +SOFTWARE="storage-tools" +PROGRAM="ceph-log" + +if [ -e "/etc/default/${SOFTWARE}" ] +then + . "/etc/default/${SOFTWARE}" +fi + +case "${CEPH_LOG}" in + true) + ;; + + *) + exit 0 + ;; +esac + +mkdir -p "/var/log/${SOFTWARE}/${PROGRAM}" + +ceph --watch >> "/var/log/${SOFTWARE}/${PROGRAM}/ceph-watch.log" diff --git a/bin/ceph-remove-osd b/bin/ceph-remove-osd new file mode 100755 index 0000000..8c0f38a --- /dev/null +++ b/bin/ceph-remove-osd @@ -0,0 +1,67 @@ +#!/bin/sh + +# 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/>. + +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 new file mode 100755 index 0000000..d846ef4 --- /dev/null +++ b/bin/cephfs-snap @@ -0,0 +1,88 @@ +#!/bin/sh + +# 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/>. + +set -e + +SOFTWARE="storage-tools" +PROGRAM="cephfs-snap" + +ACTION="${1}" + +Usage () +{ + echo "Usage: ${PROGRAM} {hourly|daily|weekly|hourly}" >&2 + exit 1 +} + +if [ -e "/etc/default/${SOFTWARE}" ] +then + . "/etc/default/${SOFTWARE}" +fi + +case "${CEPHFS_SNAP}" in + true) + ;; + + *) + exit 0 + ;; +esac + +if [ -z "${CEPHFS_DIRECTORIES}" ] +then + echo "E: no cephfs directories defined in /etc/default/${SOFTWARE}" >&2 + exit 1 +fi + +case "${ACTION}" in + hourly|daily|weekly|monthly) + + ;; + + *) + Usage + ;; +esac + +# Run +DATE="$(date +%Y-%m-%d\ %H:%M:%S)" +HOST="$(hostname -f)" + +TIME="$(date +%Y-%m-%d_%H%M%z)" +SNAPSHOT="${ACTION}_${TIME}" + +# logfile +echo "${DATE} ${HOST} ${PROGRAM} creating ${ACTION} snapshots" >> "/var/log/${SOFTWARE}/${PROGRAM}.log" + +# irc +if [ -e /usr/bin/irk ] && [ -e "/etc/default/${SOFTWARE}" ] +then + if [ -n "${IRK_TARGETS}" ] + then + for TARGET in ${IRK_TARGETS} + do + irk ${TARGET} "\x0312${HOST}:\x03 \x0303${PROGRAM}\x03 creating \x0307${ACTION}\x03 snapshots" + done + fi +fi + +for CEPHFS_DIRECTORY in ${CEPHFS_DIRECTORIES} +do + cd "${CEPHFS_DIRECTORY}"/.snap + mkdir "${SNAPSHOT}" +done diff --git a/share/apache/conf/ceph-info.conf b/share/apache/conf/ceph-info.conf new file mode 100644 index 0000000..a1136e0 --- /dev/null +++ b/share/apache/conf/ceph-info.conf @@ -0,0 +1,11 @@ +<IfModule alias_module> + Alias /ceph-info /usr/share/storage-tools/ceph-info/web +</IfModule> + +<Directory /usr/share/storage-tools/ceph-info/web> + Options FollowSymlinks + Options -Indexes + + AllowOverride None + Require all granted +</Directory> diff --git a/share/ceph-info/web/ceph-df.txt b/share/ceph-info/web/ceph-df.txt new file mode 120000 index 0000000..dff3a13 --- /dev/null +++ b/share/ceph-info/web/ceph-df.txt @@ -0,0 +1 @@ +/var/log/storage-tools/ceph-info/ceph-df.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 new file mode 120000 index 0000000..c5de915 --- /dev/null +++ b/share/ceph-info/web/ceph-osd-df.txt @@ -0,0 +1 @@ +/var/log/storage-tools/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 new file mode 120000 index 0000000..019a0bb --- /dev/null +++ b/share/ceph-info/web/ceph-osd-tree.txt @@ -0,0 +1 @@ +/var/log/storage-tools/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 new file mode 120000 index 0000000..c7042bb --- /dev/null +++ b/share/ceph-info/web/ceph-status.txt @@ -0,0 +1 @@ +/var/log/storage-tools/ceph-info/ceph-status.txt
\ No newline at end of file diff --git a/share/ceph-info/web/ceph-version.txt b/share/ceph-info/web/ceph-version.txt new file mode 120000 index 0000000..f440f1b --- /dev/null +++ b/share/ceph-info/web/ceph-version.txt @@ -0,0 +1 @@ +/var/log/storage-tools/ceph-info/ceph-version.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 new file mode 120000 index 0000000..3644891 --- /dev/null +++ b/share/ceph-info/web/ceph-watch.log @@ -0,0 +1 @@ +/var/log/storage-tools/ceph-log/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 new file mode 120000 index 0000000..22fb159 --- /dev/null +++ b/share/ceph-info/web/date.txt @@ -0,0 +1 @@ +/var/log/storage-tools/ceph-info/date.txt
\ No newline at end of file diff --git a/share/ceph-info/web/index.html b/share/ceph-info/web/index.html new file mode 100644 index 0000000..b55f637 --- /dev/null +++ b/share/ceph-info/web/index.html @@ -0,0 +1,34 @@ +<html> + <head> + <title>ceph-info</title> + <script type="text/javascript" src="jquery.min.js"></script> + <script type="text/javascript" src="logtail.js"></script> + <meta http-equiv="refresh" content="300" /> + </head> + + <body> + <h1>ceph-info</h1> + + <h2>$ ceph --watch</h2> + <div id="header"><a id="pause" href='#'>Pause</a></div> + <pre id="data">Loading...</pre> + + <h2>$ ceph status</h2> + <p><iframe src="ceph-status.txt" frameborder="0" height="250" width="95%"></iframe></p> + + <h2>$ ceph df</h2> + <p><iframe src="ceph-df.txt" frameborder="0" height="250" width="95%"></iframe></p> + + <h2>$ ceph osd df</h2> + <p><iframe src="ceph-osd-df.txt" frameborder="0" height="250" width="95%"></iframe></p> + + <h2>$ ceph osd tree</h2> + <p><iframe src="ceph-osd-tree.txt" frameborder="0" height="250" width="95%"></iframe></p> + + <h2>$ ceph version</h2> + <p><iframe src="ceph-version.txt" frameborder="0" height="25" width="95%"></iframe></p> + + <h3>Last Updated:</h3> + <p><iframe src="date.txt" frameborder="0" height="25" width="95%"></iframe></p> + </body> +</html> diff --git a/share/ceph-info/web/jquery.min.js b/share/ceph-info/web/jquery.min.js new file mode 120000 index 0000000..7fff887 --- /dev/null +++ b/share/ceph-info/web/jquery.min.js @@ -0,0 +1 @@ +/usr/share/javascript/jquery/jquery.min.js
\ No newline at end of file diff --git a/share/ceph-info/web/logtail.js b/share/ceph-info/web/logtail.js new file mode 100644 index 0000000..b7d969c --- /dev/null +++ b/share/ceph-info/web/logtail.js @@ -0,0 +1,192 @@ +/* Copyright (c) 2012: Daniel Richman. License: GNU GPL 3 */ +/* Additional features: Priyesh Patel */ + +(function () { + +var dataelem = "#data"; +var pausetoggle = "#pause"; +var scrollelems = ["html", "body"]; + +var url = "ceph-watch.log"; +var fix_rn = true; +var load = 10 * 1024; /* 10KB */ +var poll = 1000; /* 1s */ + +var kill = false; +var loading = false; +var pause = false; +var reverse = true; +var log_data = ""; +var log_file_size = 0; + +/* :-( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/parseInt */ +function parseInt2(value) { + if(!(/^[0-9]+$/.test(value))) throw "Invalid integer " + value; + var v = Number(value); + if (isNaN(v)) throw "Invalid integer " + value; + return v; +} + +function get_log() { + if (kill | loading) return; + loading = true; + + var range; + var first_load; + var must_get_206; + if (log_file_size === 0) { + /* Get the last 'load' bytes */ + range = "-" + load.toString(); + first_load = true; + must_get_206 = false; + } else { + /* Get the (log_file_size - 1)th byte, onwards. */ + range = (log_file_size - 1).toString() + "-"; + first_load = false; + must_get_206 = log_file_size > 1; + } + + /* The "log_file_size - 1" deliberately reloads the last byte, which we already + * have. This is to prevent a 416 "Range unsatisfiable" error: a response + * of length 1 tells us that the file hasn't changed yet. A 416 shows that + * the file has been trucnated */ + + $.ajax(url, { + dataType: "text", + cache: false, + headers: {Range: "bytes=" + range}, + success: function (data, s, xhr) { + loading = false; + + var content_size; + + if (xhr.status === 206) { + var c_r = xhr.getResponseHeader("Content-Range"); + if (!c_r) + throw "Server did not respond with a Content-Range"; + + log_file_size = parseInt2(c_r.split("/")[1]); + content_size = parseInt2(xhr.getResponseHeader("Content-Length")); + } else if (xhr.status === 200) { + if (must_get_206) + throw "Expected 206 Partial Content"; + + content_size = log_file_size = + parseInt2(xhr.getResponseHeader("Content-Length")); + } else { + throw "Unexpected status " + xhr.status; + } + + if (first_load && data.length > load) + throw "Server's response was too long"; + + var added = false; + + if (first_load) { + /* Clip leading part-line if not the whole file */ + if (content_size < log_file_size) { + var start = data.indexOf("\n"); + log_data = data.substring(start + 1); + } else { + log_data = data; + } + + added = true; + } else { + /* Drop the first byte (see above) */ + log_data += data.substring(1); + + if (log_data.length > load) { + var start = log_data.indexOf("\n", log_data.length - load); + log_data = log_data.substring(start + 1); + } + + if (data.length > 1) + added = true; + } + + if (added) + show_log(added); + setTimeout(get_log, poll); + }, + error: function (xhr, s, t) { + loading = false; + + if (xhr.status === 416 || xhr.status == 404) { + /* 416: Requested range not satisfiable: log was truncated. */ + /* 404: Retry soon, I guess */ + + log_file_size = 0; + log_data = ""; + show_log(); + + setTimeout(get_log, poll); + } else { + throw "Unknown AJAX Error (status " + xhr.status + ")"; + } + } + }); +} + +function scroll(where) { + for (var i = 0; i < scrollelems.length; i++) { + var s = $(scrollelems[i]); + if (where === -1) + s.scrollTop(s.height()); + else + s.scrollTop(where); + } +} + +function show_log() { + if (pause) return; + + var t = log_data; + + if (reverse) { + var t_a = t.split(/\n/g); + t_a.reverse(); + if (t_a[0] == "") + t_a.shift(); + t = t_a.join("\n"); + } + + if (fix_rn) + t = t.replace(/\n/g, "\r\n"); + + $(dataelem).text(t); + if (!reverse) + scroll(-1); +} + +function error(what) { + kill = true; + + $(dataelem).text("An error occured :-(.\r\n" + + "Reloading may help; no promises.\r\n" + + what); + scroll(0); + + return false; +} + +$(document).ready(function () { + window.onerror = error; + + /* If URL is /logtail/?noreverse display in chronological order */ + var hash = location.search.replace(/^\?/, ""); + if (hash == "noreverse") + reverse = false; + + /* Add pause toggle */ + $(pausetoggle).click(function (e) { + pause = !pause; + $(pausetoggle).text(pause ? "Unpause" : "Pause"); + show_log(); + e.preventDefault(); + }); + + get_log(); +}); + +})(); diff --git a/share/cron/ceph-info b/share/cron/ceph-info new file mode 100644 index 0000000..9041e34 --- /dev/null +++ b/share/cron/ceph-info @@ -0,0 +1 @@ +*/10 * * * * root [ -e /usr/bin/ceph-info ] && /usr/bin/ceph-info diff --git a/share/cron/cephfs-snap b/share/cron/cephfs-snap new file mode 100644 index 0000000..40340b6 --- /dev/null +++ b/share/cron/cephfs-snap @@ -0,0 +1,4 @@ +0 * * * * root [ -e /usr/bin/cephfs-snap ] && /usr/bin/cephfs-snap hourly +0 0 * * * root [ -e /usr/bin/cephfs-snap ] && /usr/bin/cephfs-snap daily +0 0 * * 1 root [ -e /usr/bin/cephfs-snap ] && /usr/bin/cephfs-snap weekly +0 0 * 1 * root [ -e /usr/bin/cephfs-snap ] && /usr/bin/cephfs-snap monthly diff --git a/share/logrotate/ceph-log b/share/logrotate/ceph-log new file mode 100644 index 0000000..cdf8bc7 --- /dev/null +++ b/share/logrotate/ceph-log @@ -0,0 +1,17 @@ +/var/log/storage-tools/ceph-log/ceph-watch.log { + compress + create 0644 root root + dateext + dateformat -%Y%m%d + dateyesterday + missingok + daily + notifempty + rotate 365 + prerotate + service ceph-log stop > /dev/null 2>&1 + endscript + postrotate + service ceph-log start > /dev/null 2>&1 + endscript +} diff --git a/share/logrotate/cephfs-snap b/share/logrotate/cephfs-snap new file mode 100644 index 0000000..e948edf --- /dev/null +++ b/share/logrotate/cephfs-snap @@ -0,0 +1,11 @@ +/var/log/storage-tools/cephfs-snap/cephfs-snap.log { + compress + create 0640 root adm + dateext + dateformat -%Y%m + dateyesterday + missingok + monthly + notifempty + rotate 12 +} diff --git a/share/man/Makefile b/share/man/Makefile new file mode 100644 index 0000000..03b5914 --- /dev/null +++ b/share/man/Makefile @@ -0,0 +1,43 @@ +# Makefile + +# 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/>. + +# Depends: asciidoc dblatex docbook-xsl libxml2-utils source-highlight + +A2X = a2x \ + --asciidoc-opts "-a revdate=$(shell cat ../../VERSION.txt)" \ + --doctype=manpage + +SHELL := sh -e + +all: build + +clean: + rm -f *.[0-9] + rm -f *.xml + +build: man + +rebuild: clean build + +man: *.txt + for FILE in *.txt; \ + do \ + $(A2X) --format=manpage $${FILE}; \ + done + +.PHONY: all clean build rebuild man 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>. diff --git a/share/man/ceph-log.1.txt b/share/man/ceph-log.1.txt new file mode 100644 index 0000000..c3fe237 --- /dev/null +++ b/share/man/ceph-log.1.txt @@ -0,0 +1,88 @@ +// 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-LOG(1) +=========== +:doctype: manpage +:man manual: Open Infrastructure +:man source: storage-tools +:man version: {revnumber} + + +NAME +---- +ceph-log - store Ceph cluster log as a logfile + + +SYNOPSIS +-------- +*ceph-log* + + +DESCRIPTION +----------- +When operating a Ceph storage cluster, the command 'ceph -w' let's 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. + +Unfortunatly the 'ceph -w' 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. + +The ceph-log program stores the output of 'ceph -w' 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. + + +OPTIONS +------- +The ceph-log program has no options. + + +FILES +----- +The following files are used: + +*/etc/default/storage-tools*:: + Configuration file. + +*/var/log/storage-tools/ceph-log/ceph-watch.log*:: + Ceph cluster logfile. + + +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/ceph-remove-osd.1.txt b/share/man/ceph-remove-osd.1.txt new file mode 100644 index 0000000..28b6062 --- /dev/null +++ b/share/man/ceph-remove-osd.1.txt @@ -0,0 +1,64 @@ +// 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-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.txt b/share/man/cephfs-snap.1.txt new file mode 100644 index 0000000..972bcd0 --- /dev/null +++ b/share/man/cephfs-snap.1.txt @@ -0,0 +1,72 @@ +// 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/>. + +CEPHFS-SNAP(1) +============== +:doctype: manpage +:man manual: Open Infrastructure +:man source: storage-tools +:man version: {revnumber} + + +NAME +---- +cephfs-snap - create CephFS snapshots periodically + + +SYNOPSIS +-------- +*cephfs-snap* {hourly|daily|weekly|monthly} + + +DESCRIPTION +----------- +CephFS supports creating snapshots of the filesystem as a simple means of +backups. + +The cephfs-snap program is a simple tool to do this periodically. + + +FILES +----- +The following files are used: + +*/etc/default/storage-tools*:: + Configuration file. + + +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/storage-tools.7.txt b/share/man/storage-tools.7.txt new file mode 100644 index 0000000..20bae0b --- /dev/null +++ b/share/man/storage-tools.7.txt @@ -0,0 +1,91 @@ +// 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/>. + +STORAGE-TOOLS(7) +================ +:doctype: manpage +:man manual: Open Infrastructure +:man source: storage-tools +:man version: {revnumber} + + +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 + + +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. + +*ceph-remove-osd(1):*:: + shortcut for removing an Ceph OSD instance completly. + + +AUTHORS +------- + * Daniel Baumann <daniel.baumann@open-infrastructure.net> diff --git a/share/systemd/ceph-log.service b/share/systemd/ceph-log.service new file mode 100644 index 0000000..5293499 --- /dev/null +++ b/share/systemd/ceph-log.service @@ -0,0 +1,11 @@ +[Unit] +Description=ceph-log +Documentation=man:ceph-log +After=network.target + +[Service] +ExecStart=/usr/bin/ceph-log +Type=simple + +[Install] +WantedBy=multi-user.target |