From 3ad678f91026f824e0c14c2348e0129033f651b3 Mon Sep 17 00:00:00 2001 From: Satrio Arditama Date: Sat, 2 Jan 2021 22:14:39 +0700 Subject: [PATCH] upload --- Dockerfile | 12 + LICENSE | 1337 ++++++++++++++++++++----------------- Makefile | 44 ++ README.md | 274 +++++++- build-tests.sh | 5 + config.json | 80 +++ doc/ipo.md | 240 +++++++ getting-started.md | 327 +++++++++ go.mod | 13 + go.sum | 34 + main.go | 344 ++++++++++ run-tests.sh | 4 + test/Dockerfile | 34 + test/docker-compose.yml | 31 + test/docker-entrypoint.sh | 11 + test/test-environment.sh | 27 + test/test-run.sh | 247 +++++++ 17 files changed, 2444 insertions(+), 620 deletions(-) create mode 100644 Dockerfile create mode 100644 Makefile create mode 100644 build-tests.sh create mode 100644 config.json create mode 100644 doc/ipo.md create mode 100644 getting-started.md create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go create mode 100644 run-tests.sh create mode 100644 test/Dockerfile create mode 100644 test/docker-compose.yml create mode 100644 test/docker-entrypoint.sh create mode 100644 test/test-environment.sh create mode 100644 test/test-run.sh diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ea5b89f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,12 @@ +FROM golang:1.14 +COPY . /app/ +WORKDIR /app +RUN go build + +FROM bitnami/minideb:stretch +RUN apt-get update && \ + apt-get install lizardfs-client -y && \ + apt-get clean && \ + rm -rf /var/lib/apt/lists/* +COPY --from=0 /app/lizardfs-volume-plugin /usr/bin/ +ENTRYPOINT ["lizardfs-volume-plugin"] diff --git a/LICENSE b/LICENSE index e142a52..9723be8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,625 +1,726 @@ -GNU GENERAL PUBLIC LICENSE - -Version 3, 29 June 2007 - -Copyright © 2007 Free Software Foundation, Inc. - -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. - - - -Copyright (C) - -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 . + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . 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: + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: - Copyright (C) + Copyright (C) + 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. -This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. +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". -This is free software, and you are welcome to redistribute it under certain -conditions; type `show c' for details. + 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 +. -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 . - -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 . + 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 +. + + +Every line commited in this repository before May 24, 2020 has following license + +The MIT License (MIT) + +Copyright (c) 2018 Kadima Solutions + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + +Makefile based on a Makefile for vieux/docker-volume-sshfs and is under the +following license. + +The MIT License (MIT) + +Copyright (c) 2015-2017 Victor Vieux + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..68f91c6 --- /dev/null +++ b/Makefile @@ -0,0 +1,44 @@ +PLUGIN_NAME = docker.inweb.id/lizardfs-volume-plugin +PLUGIN_TAG ?= 3.10 +TRAVIS_BUILD_NUMBER ?= local + +all: clean rootfs create + +clean: + @echo "### rm ./plugin" + @rm -rf ./plugin + +config: + @echo "### copy config.json to ./plugin/" + @mkdir -p ./plugin + @cp config.json ./plugin/ + +rootfs: config + @echo "### docker build: rootfs image with" + @docker build -t ${PLUGIN_NAME}:rootfs . + @echo "### create rootfs directory in ./plugin/rootfs" + @mkdir -p ./plugin/rootfs + @docker create --name tmp ${PLUGIN_NAME}:rootfs + @docker export tmp | tar -x -C ./plugin/rootfs + @docker rm -vf tmp + +create: + @echo "### remove existing plugin ${PLUGIN_NAME}:${PLUGIN_TAG} if exists" + @docker plugin rm -f ${PLUGIN_NAME}:${PLUGIN_TAG} || true + @docker plugin rm -f ${PLUGIN_NAME}:${TRAVIS_BUILD_NUMBER} || true + @echo "### create new plugin ${PLUGIN_NAME}:${PLUGIN_TAG} from ./plugin" + @docker plugin create ${PLUGIN_NAME}:${PLUGIN_TAG} ./plugin + @docker plugin create ${PLUGIN_NAME}:${TRAVIS_BUILD_NUMBER} ./plugin + +enable: + @echo "### enable plugin ${PLUGIN_NAME}:${PLUGIN_TAG}" + @docker plugin enable ${PLUGIN_NAME}:${PLUGIN_TAG} + +disable: + @echo "### disable plugin ${PLUGIN_NAME}:${PLUGIN_TAG}" + @docker plugin disable ${PLUGIN_NAME}:${PLUGIN_TAG} + +push: clean rootfs create + @echo "### push plugin ${PLUGIN_NAME}:${PLUGIN_TAG}" + @docker plugin push ${PLUGIN_NAME}:${TRAVIS_BUILD_NUMBER} + @docker plugin push ${PLUGIN_NAME}:${PLUGIN_TAG} diff --git a/README.md b/README.md index 5534d07..dc3cdf6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,273 @@ -# lizardfs-docker-volume-plugin +# LizardFS Docker Plugin -LizardFS 3.10 volume plugin for Docker \ No newline at end of file +A Docker volume driver plugin for mounting a [LizardFS](https://lizardfs.com) filesystem. Allows you to transparently provide storage for your Docker containers using LizardFS. This plugin can be used in combination with our [LizardFS Docker Image](https://github.com/kadimasolutions/docker_lizardfs) to create a fully containerized, clustered storage solution for Docker Swarm. Documentation and development are still in progress. A guide for getting started with Swarm can be found in [Getting Started](getting-started.md). The Swarm usage will likely be changed soon in favor of combining the LizardFS services with the plugin. + +[![Build Status](https://travis-ci.org/lizardfs/lizardfs-docker-volume-plugin.svg?branch=master)](https://travis-ci.org/lizardfs/lizardfs-docker-volume-plugin) + +## Usage + +### Prerequisites + +Before you can use the plugin you must have: + +* A running LizardFS cluster that your Docker host can access. +* A directory on the LizardFS filesystem that can be used by the plugin to store Docker volumes. This can be any normal directory. By default the plugin will use `/docker/volumes`, but this can be changed ( see [REMOTE_PATH](#remote-path) ). + +Once these conditions are met you are ready to install the plugin. + +### Installation + +The plugin is simple use and can be installed as a Docker container without having to install any other system dependencies. + + $ docker plugin install --alias lizardfs kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster PORT=9421 + +Docker will prompt asking if you want to grant the permissions required to run the plugin. Select yes and the plugin will download and install. + +> **Note:** We set the plugin alias to `lizardfs`. This is completely optional, but it allows us to refer to the plugin with a much shorter name. Throughout this readme, when reference is made to the `lizardfs` driver, it is referring to this alias. + +That's it! You can now see your newly installed Docker plugin by running `docker plugin ls`. + + $ docker plugin ls + ID NAME DESCRIPTION ENABLED + 4a08a23cf2eb lizardfs:latest LizardFS volume plugin for Docker true + +You should now be able to create a Docker volume using our new `lizardfs` driver. + + $ docker volume create --driver lizardfs lizard-vol + lizard-vol + +You can see it by running `docker volume ls`. + + $ docker volume ls + DRIVER VOLUME NAME + lizardfs:latest lizard-vol + +Now that you have created the volume you can mount it into a container using its name. Lets mount it into an alpine container and put some data in it. + +```sh +$ docker run -it --rm -v lizard-vol:/data alpine sh +/ $ cd /data # Switch to our volume mountpoint +/data $ cp -R /etc . # Copy the whole container /etc directory to it +/data $ ls # See that the copy was successful +etc +/data $ exit # Exit ( the container will be removed because of the --rm ) +``` + +We should now have a copy of the alpine container's whole `/etc` directory on our `lizard-vol` volume. You can verify this by checking the `/docker/volumes/lizard-vol/` directory on your LizardFS installation. You should see the `etc` folder with all of its files and folders in it. Congratulations! You have successfully mounted your LizardFS filesytem into a docker container and stored data in it! + +If you run another container, you can mount the same volume into it and that container will also see the data. Your data will stick around as long as that volume exists. When you are done with it, you can remove the volume by running `docker volume rm lizard-vol`. + +### Features + +#### Shared Mounts + +Any number of containers on any number of hosts can mount the same volume at the same time. The only requirement is that each Docker host have the LizardFS plugin installed on it. + +#### Transparent Data Storage ( No Hidden Metadata ) + +Each LizardFS Docker volume maps 1-to-1 to a directory on the LizardFS filesystem. All directories in the [REMOTE_PATH](#remote-path) on the LizardFS filesystem will be exposed as a Docker volume regardless of whether or not the directory was created by running `docker volume create`. There is no special metadata or any other extra information used by the plugin to keep track of what volumes exist. If there is a directory there, it is a Docker volume and it can be mounted ( and removed ) by the LizardFS plugin. This makes it easy to understand and allows you to manage your Docker volumes directly on the filesystem, if necessary, for things like backup and restore. + +#### LizardFS Global Trash Bin + +Using LizardFS for your Docker volumes means that you now get the benefit of LizardFS's global trash bin. Removed files and volumes can be restored using LizardFS's [trash bin](https://docs.lizardfs.com/adminguide/advanced_configuration.html?highlight=trash#mounting-the-meta-data) mechanism. Note that the plugin itself has nothing to do with this; it is a native feature of LizardFS. + +#### Multiple LizardFS Clusters + +It is also possible, if you have multiple LizardFS clusters, to install the plugin multiple times with different settings for the different clusters. For example, if you have two LizardFS clusters, one at `mfsmaster1` and another at `mfsmaster2`, you can install the plugin two times, with different aliases, to allow you to create volumes on both clusters. + + $ docker plugin install --alias lizardfs1 --grant-all-permissions kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster1 PORT=9421 + $ docker plugin install --alias lizardfs2 --grant-all-permissions kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster2 PORT=9421 + +This gives you the ability to create volumes for both clusters by specifying either `lizardfs1` or `lizardfs2` as the volume driver when creating a volume. + +#### Root Mount Option + +The plugin has the ability to provide a volume that contains *all* of the LizardFS Docker volumes in it. This is called the Root Volume and is identical to mounting the configured `REMOTE_PATH` on your LizardFS filesystem into your container. This volume does not exist by default. The Root Volume is enabled by setting the `ROOT_VOLUME_NAME` to the name that you want the volume to have. You should pick a name that does not conflict with any other volume. If there is a volume with the same name as the Root Volume, the Root Volume will take precedence over the other volume. + +There are a few different uses for the Root Volume. Kadima Solutions designed the Root Volume feature to accommodate for containerized backup solutions. By mounting the Root Volume into a container that manages your Backups, you can backup *all* of your LizardFS Docker volumes without having to manually add a mount to the container every time you create a new volume that needs to be backed up. + +The Root Volume also give you the ability to have containers create and remove LizardFS volumes without having to mount the Docker socket and make Docker API calls. Volumes can be added, removed, and otherwise manipulated simply by mounting the Root Volume and making the desired changes. + +### Known Issues + +#### Hangs on Unresponsive LizardFS Master + +In most cases, when the plugin cannot connect to the LizardFS cluster, the plugin will timeout quickly and simply fail to create mounts or listings of volumes. However, when the plugin *has* been able to open a connection with the LizardFS master, and the LizardFS master subsequently fails to respond, a volume list operation will cause the plugin to hang for a period of time. This will cause any Docker operations that request the volume list to freeze while the plugin attempts to connect to the cluster. To fix the issue, the connectivity to the LizardFS master must be restored, otherwise the plugin should be disabled to prevent stalling the Docker daemon. + +## Configuration + +### Plugin Configuration + +You can configure the plugin through plugin variables. You may set these variables at installation time by putting `VARIABLE_NAME=value` after the plugin name, or you can set them after the plugin has been installed using `docker plugin set kadimasolutions/lizardfs-volume-plugin VARIABLE_NAME=value`. + +> **Note:** When configuring the plugin after installation, the plugin must first be disabled before you can set variables. There is no danger of accidentally setting variables while the plugin is enabled, though. Docker will simply tell you that it is not possible. + +#### HOST + +The hostname/ip address that will be used when connecting to the LizardFS master. + +> **Note:** The plugin runs in `host` networking mode. This means that even though it is in a container, it shares its network configuration with the host and should resolve all network addresses as the host system would. + +**Default:** `mfsmaster` + +#### PORT + +The port on which to connect to the LizardFS master. + +**Default:** `9421` + +#### MOUNT_OPTIONS + +Options passed to the `mfsmount` command when mounting LizardFS volumes. More information can be found in the [LizardFS documentation](https://docs.lizardfs.com/man/mfsmount.1.html). + +**Default:** empty string + +#### REMOTE_PATH + +The path on the LizardFS filesystem that Docker volumes will be stored in. This path will be mounted for volume storage by the plugin and must exist on the LizardFS filesystem. The plugin fail to connect to the master server if the path does not exist. + +**Default:** `/docker/volumes` + +#### ROOT_VOLUME_NAME + +The name of the Root Volume. If specified, a special volume will be created of the given name will be created that will contain all of the LizardFS volumes. It is equivalent to mounting the `REMOTE_PATH` on the LizardFS filesystem. See [Root Mount Option](#root-mount-option). + +**Default:** empty string + +#### CONNECT_TIMEOUT + +The timeout for LizardFS mount commands. If a mount takes longer than the `CONNECT_TIMEOUT` in milliseconds, it will be terminated and the volume will not be mounted. This is to keep Docker operations from hanging in the event of an unresponsive master. + +**Default:** `10000` + +#### LOG_LEVEL + +Plugin logging level. Set to `DEBUG` to get more verbose log messages. Logs from Docker plugins can be found in the Docker log and will be suffixed with the plugin ID. + +**Default:** `INFO` + +### Volume Options + +Volume options are options that can be passed to Docker when creating a Docker volume. Volume options are set per volume, therefore setting an option for one volume does not set that option for any other volume. + +Volume options can be passed in on the command line by +adding `-o OptionName=value` after the volume name. For example: + + $ docker volume create -d lizardfs my-volume -o ReplicationGoal=3 + +#### ReplicationGoal + +The replication goal option can be used to set the LizardFS replication goal on a newly created volume. The goal can be any valid goal name or number that exists on the LizardFS master. See the LizardFS [documentation](https://docs.lizardfs.com/adminguide/replication.html) for more information. + +Note that even after a volume has been created and a goal has been set, it is still possible to manually change the goal of the volume directory on the LizardFS filesystem manually. For example, assuming you have mounted the LizardFS filesystem manually ( not using a docker volume ): + + lizardfs setgoal goal_name /mnt/mfs/docker/volumes/volume_name + +Also, if you want to set a default goal for all of your Docker volumes, you can manually set the goal of the directory containing your docker volumes on the LizardFS filesystem ( `/docker/volumes` by default, see [REMOTE_PATH](#remote-path) ). + +**Default:** empty string + +## Development + +Docker plugins are made up of a `config.json` file and `rootfs` directory. The `config.json` has all of the metadata and information about the plugin that Docker needs when installing and configuring the plugin. The `rootfs` is the root filesystem of the plugin container. Unfortunately the Docker CLI doesn't allow you to create Docker plugins using a Dockerfile so we use a Makefile to automate the process of creating the plugin `rootfs` from a Dockerfile. + +### Building the Plugin + +To build the plugin simply run `make rootfs` in the project directory. + + $ make rootfs + +This will build the Dockerfile, export the new Docker image's rootfs, and copy the rootfs and the config.json file to the `plugin` directory. When it is done you should have a new plugin directory with a config.json file and a rootfs folder in it. + +``` +plugin/ + config.json + rootfs/ +``` + +After that is finished you can run `make create`. + + $ make create + +This will install the Docker plugin from the `plugin` dirctory with the name `kadimasolutions/lizardfs-volume-plugin`. + +Finally run `make enable` to start the plugin. + + $ make enable + + Here is a list of the `make` targets: + +* **clean**: Remove the `plugin` directory +* **config**: Copy the `config.json` file to the `plugin` directory +* **rootfs**: Generate the plugin rootfs from the Dockerfile and put it in the `plugin` directory with the `config.json` +* **create**: Install the plugin from the `plugin` directory +* **enable**: Enable the plugin +* **disable**: Disable the plugin +* **push**: Run the `clean`, `rootfs`, `create`, and `enable` targets, and push the plugin to DockerHub + +### Running the tests + +The automated tests for the plugin are run using a Docker-in-Docker container that creates a Dockerized LizardFS cluster to test the plugin against. When you run the test container, it will install the plugin inside the Docker-in-Docker container and proceed to create a Dockerized LizardFS cluster in it as well. A shell script is run that manipulates the plugin and runs containers to ensure the plugin behaves as is expected. + +Before you can run the tests, the test Docker image must first be built. This is done by running the `build-tests.sh` script. + + $ ./build-tests.sh + +This will build a Docker image, `lizardfs-volume-plugin_test`, using the Dockerfile in the `test` directory. After the image has been built, you can use it to run the tests against the plugin. This is done with the `run-tests.sh` script. + + $ ./run-tests.sh + +By default running `run-tests.sh` will install the plugin from the `plugin` directory before running the tests against it. This means that you must first build the plugin by running `make rootfs`, if you have not already done so. Alternatively, you can also run the tests against a version of the plugin from DockerHub by passing in the plugin tag as a parameter to the `run-tests.sh` script. + + $ ./run-tests.sh kadimasolutions/lizardfs-volume-plugin:latest + +This will download the plugin from DockerHub and run the tests against that version of the plugin. + +### Tips & Tricks + +If you don't have a fast disk on your development machine, developing Docker plugins can be somewhat tricky, because it can take some time to build and install the plugin every time you need to make a change. Here are some tricks that you can use to help maximize your development time. + +#### Patching the Plugin Rootfs + +All of the plugin logic is in the `index.js` file. During development it can take a long time to rebuild the entire plugin every time you need to test a change to `index.js`. To get around this, it is possible to copy just that file into the installed plugin without having to reinstall the entire plugin. + +When you install a Docker plugin, it is given a plugin ID. You can see the first 12 characters of the plugin ID by running `docker plugin ls`. + +``` +$ docker plugin ls +ID NAME DESCRIPTION ENABLED +2f5b68535b92 kadimasolutions/lizardfs-volume-plugin:latest LizardFS volume plugin for Docker false +``` + +Using that ID you can find where the plugin's rootfs was installed. By default, it should be located in `/var/lib/docker/plugins/[pluginID]/rootfs`. For our particular plugin, the file that we need to replace is the `/project/index.js` file in the plugin's rootfs. By replacing that file with an updated version and restarting ( disabling and re-enabling ) the plugin, you can update the plugin without having to re-install it. + +#### Exec-ing Into the Plugin Container + +It may be useful during development to exec into the plugin container while it is running. You can find out how in the [Docker Documentation](https://docs.docker.com/engine/extend/#debugging-plugins). + +#### Test Case Development + +Writing new automated test cases for the plugin can also be difficult because of the time required for the test container to start. When writing new test cases for the plugin, it may be useful to start the container and interactively run the tests. If you make a mistake that causes a test to fail, even though the plugin *is* working, you can still edit and re-run the tests without having to restart the test container completely. + +Once you have built the test image using the `build-tests.sh` script, you need to run the test container as a daemon that you can exec into. We override the entrypoint of the container so that it won't run the test script as soon as it starts. We want it just to sit there and wait for us to run commands in it. + + $ docker run -it --rm -d --name lizardfs-test --privileged \ + -v $(pwd)/plugin:/plugin \ + -v $(pwd)/test/test-run.sh:/test-run.sh \ + --entrypoint=sh \ + lizardfs-volume-plugin_test + +> **Note:** We also mount our `test-run.sh` script into the container so that updates to the script are reflected immediately in the container. + +After the container is running we can shell into it and run the script that starts up Docker. + + $ docker exec -it lizardfs-test sh + /project # /test-environment.sh + +This will start Docker, load the LizardFS image used for creating the test LizardFS environment, and install the plugin from the plugin directory. Once this is done you can run the tests. + + /project # sh /test-run.sh + +This will run through all of the tests. If the tests fail, you can still edit and re-run the `test-run.sh` script without having to re-install the plugin. + +When you are done writing your test cases, you can `exit` the shell and `docker stop lizardfs-test`. The container will be automatically removed after it stops. You should make sure that your tests still run correctly in a completely fresh environment by rebuilding and re-running the tests using the `build-tests.sh` and `run-tests.sh` scripts. diff --git a/build-tests.sh b/build-tests.sh new file mode 100644 index 0000000..b7b4114 --- /dev/null +++ b/build-tests.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash +pushd test +docker build \ +-t lizardfs-volume-plugin_test . +popd diff --git a/config.json b/config.json new file mode 100644 index 0000000..bbe0748 --- /dev/null +++ b/config.json @@ -0,0 +1,80 @@ + +{ + "description": "LizardFS 3.10 volume plugin for Docker", + "documentation": "https://docs.docker.com/engine/extend/plugins/", + "workdir": "/app", + "entrypoint": [ + "lizardfs-volume-plugin" + ], + "env": [ + { + "name": "HOST", + "settable": [ + "value" + ], + "value": "mfsmaster" + }, + { + "name": "PORT", + "settable": [ + "value" + ], + "value": "9421" + }, + { + "name": "ROOT_VOLUME_NAME", + "settable": [ + "value" + ], + "value": "" + }, + { + "name": "MOUNT_OPTIONS", + "settable": [ + "value" + ], + "value": "" + }, + { + "name": "REMOTE_PATH", + "settable": [ + "value" + ], + "value": "/docker/volumes" + }, + { + "name": "CONNECT_TIMEOUT", + "settable": [ + "value" + ], + "value": "10000" + }, + { + "name": "LOG_LEVEL", + "settable": [ + "value" + ], + "value": "info" + } + ], + "interface": { + "socket": "lizardfs310.sock", + "types": [ + "docker.volumedriver/2.0" + ] + }, + "linux": { + "capabilities": [ + "CAP_SYS_ADMIN" + ], + "devices": [ + { + "path": "/dev/fuse" + } + ] + }, + "network": { + "type": "host" + }, + "propagatedMount": "/mnt/docker-volumes" +} diff --git a/doc/ipo.md b/doc/ipo.md new file mode 100644 index 0000000..b853d73 --- /dev/null +++ b/doc/ipo.md @@ -0,0 +1,240 @@ +# IPO Outline + +This document outlines the basic Input-Process-Output flow of the volume plugin. + +## Environment + +The LizardFS Docker plugin implements the [Docker Plugin API](https://docs.docker.com/engine/extend/plugin_api/). The Inputs to the program are requests made by the Docker daemon to the plugin. Request such as `Plugin.Activate`, and `VolumeDriver.Create`, will be sent by the Docker daemon to the the unix socket, `/run/docker/plugins/lizardfs.sock`, and the LizardFS Docker plugin will process the request, take the required actions, and respond with an appropriate response. + +## Requests + +These are the requests that Docker will make to the plugin over the Unix socket. All requests will be HTTP POST requests and may contain a JSON payload. The plugin's response to the request should also be a JSON payload if applicable. Details about these requests can be found in the Docker documentation for the [Plugins API](https://docs.docker.com/engine/extend/plugin_api/) and the [Volume Plugin API](https://docs.docker.com/engine/extend/plugins_volume/#volumedrivercapabilities). + +### /Plugin.Activate + +#### Input + +Empty payload. + +#### Process + +* Mount a subpath of the LizardFS filesystem specified by the `REMOTE_PATH` environment variable ( `/docker/volumes` by default) to `/mnt/lizardfs`. This is where the docker volumes will be stored. The `/mnt/lizardfs` directory will be referred to as the "volume root" throughout this document. + +#### Output + +```json +{ + "Implements": ["VolumeDriver"] +} +``` + +### /VolumeDriver.Create + +#### Input + +```json +{ + "Name": "volume_name", + "Opts": { + "ReplicationGoal": "replication_goal_number_or_name" + } +} +``` + +#### Process + +* Create sub-directory of volume root with the given `Name`. For example, `/mnt/lizardfs/volume_name`. +* Use `lizardfs setgoal` to set the replication goal for that Docker Volume to the value specified in the `Opts` ( if specified ). + +#### Output + +Error message ( if one occurred ). + +```json +{ + "Err": "" +} +``` + +### /VolumeDriver.Remove + +#### Input + +```json +{ + "Name": "volume_name" +} +``` + +#### Process + +* Delete the directory in the volume root with the given `Name`. For example, `/mnt/lizardfs/volume_name`. + +#### Output + +Error message ( if one occurred ). + +```json +{ + "Err": "" +} +``` + +### /VolumeDriver.Mount + +#### Input + +```json +{ + "Name": "volume_name", + "ID": "b87d7442095999a92b65b3d9691e697b61713829cc0ffd1bb72e4ccd51aa4d6c" +} +``` + +#### Process + +* Create a directory outside of the LizardFS root mountpoint using the given `Name`, such as `/mnt/docker-volumes/volume_name`. +* Mount the subpath of the LizardFS filesystem ( for example, `/docker/volumes/volume_name` ) to the newly created mountpoint. +* Add the `ID` to the list of containers that have mounted `Name` in the `mounted_volumes` Javascript object. This variable is used to keep track of which containers have mounted the volume. + +#### Output + +We need to tell Docker where we mounted the volume or give an error message if there was a problem. + +```json +{ + "Mountpoint": "/mnt/docker-volumes/volume_name", + "Err": "" +} +``` + +### /VolumeDriver.Path + +#### Input + +```json +{ + "Name": "volume_name" +} +``` + +#### Process + +* Determine the path at which the volume is mounted based on the `Name`. + +#### Output + +Error message ( if one occurred ). + +```json +{ + "Mountpoint": "/mnt/docker-volumes/volume_name", + "Err": "" +} +``` + +### /VolumeDriver.Unmount + +#### Input + +```json +{ + "Name": "volume_name", + "ID": "b87d7442095999a92b65b3d9691e697b61713829cc0ffd1bb72e4ccd51aa4d6c" +} +``` + +#### Process + +* Remove the `ID` from the list of containers that have mounted `Name` in `mounted_volumes` Javascript variable. +* If there are no containers in the list anymore, unmount the `/mnt/docker-volumes/volume_name` because it no longer needs to be mounted. + +#### Output + +Error message ( if one occurred ). + +```json +{ + "Err": "" +} +``` + +### /VolumeDriver.Get + +#### Input + +```json +{ + "Name": "volume_name" +} +``` + +#### Process + +* Make sure the volume exists: check that the directory of the name `volume_name` exists and that the process has read-write access. +* If the volume is mounted, return the mountpoint as well as the name. + +#### Output + +Return the volume name + +```json +{ + "Volume": { + "Name": "volume_name", + "Mountpoint": "/mnt/docker-volumes/volume_name", + }, + "Err": "Error if directory doesn't exist or we don't have read-write access to it." +} +``` + +### /VolumeDriver.List + +#### Input + +```json +{} +``` + +#### Process + +* Get a list of the directories in the volume root: `/mnt/lizardfs/`. +* If the volume is mounted on the host, provide the `Mountpoint`. + +#### Output + +Error message ( if one occurred ). + +```json +{ + "Volumes": [ + { + "Name": "volume_name", + "Mountpoint": "/mnt/docker-volumes/volume_name" + } + ], + "Err": "" +} +``` + +### /VolumeDriver.Capabilities + +#### Input + +```json +{} +``` + +#### Process + +Not applicable. + +#### Output + +```json +{ + "Capabilities": { + "Scope": "global" + } +} +``` diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..551032a --- /dev/null +++ b/getting-started.md @@ -0,0 +1,327 @@ +Hello Everybody, I have recently developed a Docker plugin that allows you to create LizardFS Docker volumes! There are two different versions of the plugin: a Docker managed plugin that works well for individual Docker instances, and a version that can be deployed as a stack on Docker Swarm to create a self-contained storage solution for a Docker cluster. + +The Docker plugin has been developed by me and my team at @kadimasolutions to create a distributed storage solution that can be deployed on Docker Swarm and provide shared volumes for the containers in the Docker Swarm cluster. As far as I have found it is **the only** solution that does so. + +We will soon mirror the source code for the plugin to GitHub. In the meantime, you can test out the plugin using the Docker images that are on DockerHub. The plugin can be considered in beta and is, as far as I can tell, completely functional, but there may still be bugs or nuances that we have not yet found. Feedback is appreciated. :smiley: Updates to the image on DockerHub may be made without notice, I will try to mention any changes that I make here. + +In addition, I will soon be attempting to get the Swarm deployment setup with the very latest highly available LizardFS master from the LizardFS 3.13 release candidate ( thanks to the folks at @lizardfs for getting that to me early ) so that the deployed LizardFS cluster will have automatic failover. + +Here are detailed instructions for getting started with both versions of the plugin. If you need any help just comment on this thread and I will try to do what I can when I have the time. + +# Docker Managed plugin + +The Docker managed plugin can be installed very easily on any Docker host and is great for connecting your Docker containers to an existing LizardFS cluster. + +> **Note:** If you don't have a LizardFS cluster, yet you may want to consider using the Swarm deployment instead. You can use the Docker Swarm deployment to create a LizardFS cluster out of your Docker hosts that will supply your Docker containers with shared LizardFS volumes that are distributed across you Docker cluster. + +## Usage + +### Prerequisites + +Before you can use the plugin you must have: + +* A running LizardFS cluster that your Docker host can access. +* A directory on the LizardFS filesystem that can be used by the plugin to store Docker volumes. This can be any normal directory. By default the plugin will use `/docker/volumes`, but this can be changed ( see [REMOTE_PATH](#remote-path) ). + +Once these conditions are met you are ready to install the plugin. + +### Installation + +The plugin is simple use and can be installed as a Docker container without having to install any other system dependencies. + + $ docker plugin install --alias lizardfs kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster PORT=9421 + +Docker will prompt asking if you want to grant the permissions required to run the plugin. Select yes and the plugin will download and install. + +> **Note:** We set the plugin alias to `lizardfs`. This is completely optional, but it allows us to refer to the plugin with a much shorter name. Throughout this readme, when reference is made to the `lizardfs` driver, it is referring to this alias. + +That's it! You can now see your newly installed Docker plugin by running `docker plugin ls`. + + $ docker plugin ls + ID NAME DESCRIPTION ENABLED + 4a08a23cf2eb lizardfs:latest LizardFS volume plugin for Docker true + +You should now be able to create a Docker volume using our new `lizardfs` driver. + + $ docker volume create --driver lizardfs lizard-vol + lizard-vol + +You can see it by running `docker volume ls`. + + $ docker volume ls + DRIVER VOLUME NAME + lizardfs:latest lizard-vol + +Now that you have created the volume you can mount it into a container using its name. Lets mount it into an alpine container and put some data in it. + +```sh +$ docker run -it --rm -v lizard-vol:/data alpine sh +/ $ cd /data # Switch to our volume mountpoint +/data $ cp -R /etc . # Copy the whole container /etc directory to it +/data $ ls # See that the copy was successful +etc +/data $ exit # Exit ( the container will be removed because of the --rm ) +``` + +We should now have a copy of the alpine container's whole `/etc` directory on our `lizard-vol` volume. You can verify this by checking the `/docker/volumes/lizard-vol/` directory on your LizardFS installation. You should see the `etc` folder with all of its files and folders in it. Congratulations! You have successfully mounted your LizardFS filesytem into a docker container and stored data in it! + +If you run another container, you can mount the same volume into it and that container will also see the data. Your data will stick around as long as that volume exists. When you are done with it, you can remove the volume by running `docker volume rm lizard-vol`. + +### Features + +#### Shared Mounts + +Any number of containers on any number of hosts can mount the same volume at the same time. The only requirement is that each Docker host have the LizardFS plugin installed on it. + +#### Transparent Data Storage ( No Hidden Metadata ) + +Each LizardFS Docker volume maps 1-to-1 to a directory on the LizardFS filesystem. All directories in the [REMOTE_PATH](#remote-path) on the LizardFS filesystem will be exposed as a Docker volume regardless of whether or not the directory was created by running `docker volume create`. There is no special metadata or any other extra information used by the plugin to keep track of what volumes exist. If there is a directory there, it is a Docker volume and it can be mounted ( and removed ) by the LizardFS plugin. This makes it easy to understand and allows you to manage your Docker volumes directly on the filesystem, if necessary, for things like backup and restore. + +#### LizardFS Global Trash Bin + +Using LizardFS for your Docker volumes means that you now get the benefit of LizardFS's global trash bin. Removed files and volumes can be restored using LizardFS's [trash bin](https://docs.lizardfs.com/adminguide/advanced_configuration.html?highlight=trash#mounting-the-meta-data) mechanism. Note that the plugin itself has nothing to do with this; it is a native feature of LizardFS. + +#### Multiple LizardFS Clusters + +It is also possible, if you have multiple LizardFS clusters, to install the plugin multiple times with different settings for the different clusters. For example, if you have two LizardFS clusters, one at `mfsmaster1` and another at `mfsmaster2`, you can install the plugin two times, with different aliases, to allow you to create volumes on both clusters. + + $ docker plugin install --alias lizardfs1 --grant-all-permissions kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster1 PORT=9421 + $ docker plugin install --alias lizardfs2 --grant-all-permissions kadimasolutions/lizardfs-volume-plugin HOST=mfsmaster2 PORT=9421 + +This gives you the ability to create volumes for both clusters by specifying either `lizardfs1` or `lizardfs2` as the volume driver when creating a volume. + +#### Root Mount Option + +The plugin has the ability to provide a volume that contains *all* of the LizardFS Docker volumes in it. This is called the Root Volume and is identical to mounting the configured `REMOTE_PATH` on your LizardFS filesystem into your container. This volume does not exist by default. The Root Volume is enabled by setting the `ROOT_VOLUME_NAME` to the name that you want the volume to have. You should pick a name that does not conflict with any other volume. If there is a volume with the same name as the Root Volume, the Root Volume will take precedence over the other volume. + +There are a few different uses for the Root Volume. Kadima Solutions designed the Root Volume feature to accommodate for containerized backup solutions. By mounting the Root Volume into a container that manages your Backups, you can backup *all* of your LizardFS Docker volumes without having to manually add a mount to the container every time you create a new volume that needs to be backed up. + +The Root Volume also give you the ability to have containers create and remove LizardFS volumes without having to mount the Docker socket and make Docker API calls. Volumes can be added, removed, and otherwise manipulated simply by mounting the Root Volume and making the desired changes. + +### Known Issues + +#### Hangs on Unresponsive LizardFS Master + +In most cases, when the plugin cannot connect to the LizardFS cluster, the plugin will timeout quickly and simply fail to create mounts or listings of volumes. However, when the plugin *has* been able to open a connection with the LizardFS master, and the LizardFS master subsequently fails to respond, a volume list operation will cause the plugin to hang for a period of time. This will cause any Docker operations that request the volume list to freeze while the plugin attempts to connect to the cluster. To fix the issue, the connectivity to the LizardFS master must be restored, otherwise the plugin should be disabled to prevent stalling the Docker daemon. + +## Configuration + +### Plugin Configuration + +You can configure the plugin through plugin variables. You may set these variables at installation time by putting `VARIABLE_NAME=value` after the plugin name, or you can set them after the plugin has been installed using `docker plugin set kadimasolutions/lizardfs-volume-plugin VARIABLE_NAME=value`. + +> **Note:** When configuring the plugin after installation, the plugin must first be disabled before you can set variables. There is no danger of accidentally setting variables while the plugin is enabled, though. Docker will simply tell you that it is not possible. + +#### HOST + +The hostname/ip address that will be used when connecting to the LizardFS master. + +> **Note:** The plugin runs in `host` networking mode. This means that even though it is in a container, it shares its network configuration with the host and should resolve all network addresses as the host system would. + +**Default:** `mfsmaster` + +#### PORT + +The port on which to connect to the LizardFS master. + +**Default:** `9421` + +#### MOUNT_OPTIONS + +Options passed to the `mfsmount` command when mounting LizardFS volumes. More information can be found in the [LizardFS documentation](https://docs.lizardfs.com/man/mfsmount.1.html). + +**Default:** empty string + +#### REMOTE_PATH + +The path on the LizardFS filesystem that Docker volumes will be stored in. This path will be mounted for volume storage by the plugin and must exist on the LizardFS filesystem. The plugin fail to connect to the master server if the path does not exist. + +**Default:** `/docker/volumes` + +#### ROOT_VOLUME_NAME + +The name of the Root Volume. If specified, a special volume will be created of the given name will be created that will contain all of the LizardFS volumes. It is equivalent to mounting the `REMOTE_PATH` on the LizardFS filesystem. See [Root Mount Option](#root-mount-option). + +**Default:** empty string + +#### CONNECT_TIMEOUT + +The timeout for LizardFS mount commands. If a mount takes longer than the `CONNECT_TIMEOUT` in milliseconds, it will be terminated and the volume will not be mounted. This is to keep Docker operations from hanging in the event of an unresponsive master. + +**Default:** `10000` + +#### LOG_LEVEL + +Plugin logging level. Set to `DEBUG` to get more verbose log messages. Logs from Docker plugins can be found in the Docker log and will be suffixed with the plugin ID. + +**Default:** `INFO` + +### Volume Options + +Volume options are options that can be passed to Docker when creating a Docker volume. Volume options are set per volume, therefore setting an option for one volume does not set that option for any other volume. + +Volume options can be passed in on the command line by +adding `-o OptionName=value` after the volume name. For example: + + $ docker volume create -d lizardfs my-volume -o ReplicationGoal=3 + +#### ReplicationGoal + +The replication goal option can be used to set the LizardFS replication goal on a newly created volume. The goal can be any valid goal name or number that exists on the LizardFS master. See the LizardFS [documentation](https://docs.lizardfs.com/adminguide/replication.html) for more information. + +Note that even after a volume has been created and a goal has been set, it is still possible to manually change the goal of the volume directory on the LizardFS filesystem manually. For example, assuming you have mounted the LizardFS filesystem manually ( not using a docker volume ): + + lizardfs setgoal goal_name /mnt/mfs/docker/volumes/volume_name + +Also, if you want to set a default goal for all of your Docker volumes, you can manually set the goal of the directory containing your docker volumes on the LizardFS filesystem ( `/docker/volumes` by default, see [REMOTE_PATH](#remote-path) ). + +**Default:** empty string + +# Swarm Deployment + +Docker Swarm is where the LizardFS plugin shows its full potential. You can deploy an entire LizardFS cluster *and* the Docker volume plugin as a single stack on you Docker Swarm. This lets you create a shared storage cluster out of any Docker Swarm. There are a few steps to prepare your hosts before launching the stack. + +## Usage + +### Setup Master + +One node in your Swarm cluster needs to have the label `lizardfs.master-personality=master`. This is the node that the LizardFS master will be deployed on. + +The master server is also expected to have a directory /lizardfs/mfsmaster on the host that will be used to store the master data. In production this should be the mountpoint for an XFS or ZFS filesystem. +Setup Chunkservers + +Every node in the Swarm cluster gets a Chunkserver deployed to it. All servers are expected to have a `/lizardfs/chunkserver` directory that will be used for storing chunks. Like the master storage directory, `/lizardfs/chunkserver` should be formatted XFS or ZFS for production installations. + +### ( Optional ) Setup Shadow Masters + +You can optionally add the lizardfs.master-personality=shadow label to any nodes in the cluster that you want to run shadow masters on. Shadow master servers should have a /lizardfs/mfsmaster-shadow directory that is mounted to an XFS or ZFS filesystem for storage. +Deploy The LizardFS Stack + +> Note: Before you deploy the stack you should make sure that you have disabled the Docker managed version of the LizardFS plugin if it is installed. + +After you have provided for the storage for your LizardFS cluster, you can deploy the LizardFS stack to your Swarm cluster by downloading the attached lizardfs.yml and using docker stack deploy -c lizardfs.yml lizardfs. The particular yaml I gave you requires that the name of the stack be lizardfs. + +### Deploy the Stack + +After you have setup the storage directories for you Swarm cluster you deploy the stack with the following yaml. + + $ docker stack deploy -c docker-stack.yml lizardfs + +> **Note:** The stack **must** be named `lizardfs` for this yaml. It is because the `docker-run-d` container has the network name `lizardfs_lizardfs` hard-codded into the yaml. Reading the "Swarm Service Privileges Workaround" explanation below will help explain the `docker-run-d` container. + +**docker-stack.yml** +```yaml +version: '3.6' +services: + mfsmaster: + image: kadimasolutions/lizardfs:latest + command: master + environment: + MFSMASTER_AUTO_RECOVERY: 1 + networks: + - lizardfs + volumes: + - /lizardfs/mfsmaster:/var/lib/mfs + deploy: + mode: global + placement: + constraints: + - node.labels.lizardfs.master-personality==master + mfsmaster-shadow: + image: kadimasolutions/lizardfs:latest + command: master + networks: + - lizardfs + environment: + MFSMASTER_PERSONALITY: shadow + volumes: + - /lizardfs/mfsmaster-shadow:/var/lib/mfs + deploy: + mode: global + placement: + constraints: + - node.labels.lizardfs.master-personality==shadow + chunkserver: + image: kadimasolutions/lizardfs:latest + command: chunkserver + networks: + - lizardfs + environment: + # This lets you run the chunkserver with less available disk space + MFSCHUNKSERVER_HDD_LEAVE_SPACE_DEFAULT: 400Mi # 4Gi is the default + MFSHDD_1: /mnt/mfshdd + volumes: + - /lizardfs/chunkserver:/mnt/mfshdd + deploy: + mode: global + cgiserver: + image: kadimasolutions/lizardfs:latest + command: cgiserver + networks: + - lizardfs + restart: on-failure + ports: + - 8080:80 + deploy: + replicas: 0 + docker-plugin: + image: kadimasolutions/docker-run-d:latest + volumes: + - /var/run/docker.sock:/var/run/docker.sock + command: + - "--restart=always -v /var/lib/docker/plugins/lizardfs/propagated-mount:/mnt/docker-volumes/:rshared -v /run/docker/plugins/lizardfs:/run/docker/plugins/ --net lizardfs_lizardfs --cap-add SYS_ADMIN --device=/dev/fuse:/dev/fuse --security-opt=apparmor:unconfined -e ROOT_VOLUME_NAME=lizardfs -e LOG_LEVEL=debug -e REMOTE_PATH=/docker/volumes -e LOCAL_PATH=/var/lib/docker/plugins/lizardfs/propagated-mount -e MOUNT_OPTIONS='-o big_writes -o cacheexpirationtime=500 -o readaheadmaxwindowsize=1024' kadimasolutions/lizardfs-volume-driver" + environment: + CONTAINER_NAME: lizardfs-plugin + deploy: + mode: global + lizardfs-client: + image: kadimasolutions/docker-run-d:latest + volumes: + - /var/run/docker.sock:/var/run/docker.sock + command: + - "--restart=always --net lizardfs_lizardfs --cap-add SYS_ADMIN --device=/dev/fuse:/dev/fuse --security-opt=apparmor:unconfined kadimasolutions/lizardfs client" + environment: + CONTAINER_NAME: lizardfs-client + deploy: + mode: global + +networks: + lizardfs: + attachable: true +``` + +This will deploy the Docker plugin, the LizardFS chunkserver, and a LizardFS client container on *every* host in your cluster. If you have different goals, you may want to update the scheduling rules to match your particular use case. + +The stack uses @kadimasolutions's LizardFS Docker image to create the LizardFS cluster. You can modify the environment variables for the mfsmaster, mfsmaster-shadow, and chunkserver containers to completely configure your LizardFS cluster. Documetnation for the `kadimasolutions/lizardfs` docker image can be found in the [git repo](https://github.com/kadimasolutions/docker_lizardfs). + +### Things You Should Know + +Here are some things that you should know about the setup. + +#### Different Container Image + +The new container for deploying the plugin is actually the same software as the Docker managed plugin, but it is under a different repo on DockerHub. The plugin that you install with docker plugin install is under the kadimasolutions/lizardfs-volume-plugin repository. The plugin that you run as a standard Docker container on Swarm is under the kadimasolutions/lizardfs-volume-driver repository ( these may or may not be the final names for either ). The only difference between the two are how they are installed, otherwise they are running the same code. + +#### Swarm Service Privileges Workaround + +There is a limitation imposed by the Docker daemon on Swarm services that prevents them from running with admin privileges on the host. This is an issue for the LizardFS plugin container because it needs to have the SYS_ADMIN capability along with the FUSE device. In order to work around this I created a very simple container ( kadimasolutions/docker-run-d ) that uses the Docker CLI to run a container that does have privileges. This container can be deployed as a Swarm service to allow you to run privileged swarm containers. This is how the docker-plugin and lizardfs-client services are deployed in the attached yaml. + +#### lizardfs-client Convenience Container + +As a convenience, the stack will deploy a container named lizardfs-client on every host in your Swarm. This container mounts the root of the LizardFS filesystem to /mnt/mfs and provides the LizardFS CLI tools to allow you to manage your LizardFS filesystem. To access the tools you exec into the lizardfs-client container on any host in your cluster. For example: + + $ docker exec -it lizardfs-client bash + root@containerid $ lizardfs setgoal 3 /mnt/mfs/docker/volumes + root@containerid $ exit + +This removes the need to install any LizardFS tools on your hosts. + +### Known Issues + +#### Docker Restart Issue + +> **Note:** This is only a concern when using the Swarm deployment. It is not a problem when using the Docker managed version of the plguin. + +When the Docker daemon is started it checks to make sure that all of your LizardFS volumes exist and it tries to connect to the LizardFS Docker plugin. Because I am running the plugin in a Docker container, the Docker daemon cannot connect to the plugin as the daemon is still starting up and the plugin container has not been started yet. Unfortunately, Docker will spend about 15 seconds timing out for each lizardfs volume before it finishes starting up. This can push your Docker daemon startup time up by several minutes if you have a lot of LizardFS volumes. After it finishes timing out for each volume, the Docker daemon starts up and everything works as you would expect. + +This doesn’t cause any critical issues it just takes longer to start Docker because of all of the timeouts. Another option that I’ve speculated is to run two Docker daemons on each host in the cluster and create a dedicated Swarm cluster just for LizardFS. This would be more of a specialized setup, but I think it would still work. In the end I think that the method of deployment will depend on the individual user’s needs. Eventually I may try to test and document more deployment methods diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..efe6962 --- /dev/null +++ b/go.mod @@ -0,0 +1,13 @@ +module lizardfs-volume-plugin + +go 1.14 + +require ( + github.com/Microsoft/go-winio v0.4.14 // indirect + github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf // indirect + github.com/docker/go-connections v0.4.0 // indirect + github.com/docker/go-plugins-helpers v0.0.0-20200102110956-c9a8a2d92ccc + github.com/ramr/go-reaper v0.2.0 + github.com/sirupsen/logrus v1.6.0 + golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..6b60847 --- /dev/null +++ b/go.sum @@ -0,0 +1,34 @@ +github.com/Microsoft/go-winio v0.4.14 h1:+hMXMk01us9KgxGb7ftKQt2Xpf5hH/yky+TDA+qxleU= +github.com/Microsoft/go-winio v0.4.14/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA= +github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf h1:iW4rZ826su+pqaw19uhpSCzhj44qo35pNgKFGqzDKkU= +github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/docker/go-connections v0.4.0 h1:El9xVISelRB7BuFusrZozjnkIM5YnzCViNKohAFqRJQ= +github.com/docker/go-connections v0.4.0/go.mod h1:Gbd7IOopHjR8Iph03tsViu4nIes5XhDvyHbTtUxmeec= +github.com/docker/go-plugins-helpers v0.0.0-20200102110956-c9a8a2d92ccc h1:/A+mPcpajLsWiX9gSnzdVKM/IzZoYiNqXHe83z50k2c= +github.com/docker/go-plugins-helpers v0.0.0-20200102110956-c9a8a2d92ccc/go.mod h1:LFyLie6XcDbyKGeVK6bHe+9aJTYCxWLBg5IrJZOaXKA= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.3 h1:CE8S1cTafDpPvMhIxNJKvHsGVBgn1xWYf1NbHQhywc8= +github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/ramr/go-reaper v0.2.0 h1:hhGZ1SRZ9fJfSEf9e14hRB4O0MafRwHK5O33j70qTNI= +github.com/ramr/go-reaper v0.2.0/go.mod h1:DFg2AhfQCvkJwRKUfsycOSSZELGBA9gt46ne3SOecJM= +github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= +github.com/sirupsen/logrus v1.6.0 h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I= +github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2 h1:eDrdRpKgkcCqKZQwyZRyeFZgfqt37SL7Kv3tok06cKE= +golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd h1:xhmwyvizuTgC2qz7ZlMluP20uW+C3Rm0FD/WLDX8884= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= diff --git a/main.go b/main.go new file mode 100644 index 0000000..c3e6859 --- /dev/null +++ b/main.go @@ -0,0 +1,344 @@ +package main + +import ( + "context" + "errors" + "fmt" + "github.com/docker/go-plugins-helpers/volume" + "github.com/ramr/go-reaper" + log "github.com/sirupsen/logrus" + "io/ioutil" + "os" + "os/exec" + "path" + "strconv" + "strings" + "syscall" + "time" +) + +const socketAddress = "/run/docker/plugins/lizardfs310.sock" +const containerVolumePath = "/mnt/docker-volumes" +const hostVolumePath = "/mnt/docker-volumes" +const volumeRoot = "/mnt/lizardfs/" + +var host = os.Getenv("HOST") +var port = os.Getenv("PORT") +var remotePath = os.Getenv("REMOTE_PATH") +var mountOptions = os.Getenv("MOUNT_OPTIONS") +var rootVolumeName = os.Getenv("ROOT_VOLUME_NAME") +var connectTimeoutStr = os.Getenv("CONNECT_TIMEOUT") +var connectTimeout = 3000 + +var mounted = make(map[string][]string) + +type lizardfsVolume struct { + Name string + Goal int + Path string +} + +type lizardfsDriver struct { + volumes map[string]*lizardfsVolume + statePath string +} + +func (l lizardfsDriver) Create(request *volume.CreateRequest) error { + log.WithField("method", "create").Debugf("%#v", l) + volumeName := request.Name + volumePath := fmt.Sprintf("%s%s", volumeRoot, volumeName) + replicationGoal := request.Options["ReplicationGoal"] + + if volumeName == rootVolumeName { + log.Warning("tried to create a volume with same name as root volume. Ignoring request.") + } + + errs := make(chan error, 1) + go func() { + err := os.MkdirAll(volumePath, 760) + errs <- err + }() + + select { + case err := <-errs: + if err != nil { + return err + } + case <-time.After(time.Duration(connectTimeout) * time.Millisecond): + return errors.New("create operation timeout") + } + + _, err := strconv.Atoi(replicationGoal) + if err == nil { + ctx, cancel := context.WithTimeout(context.Background(), time.Duration(connectTimeout)*time.Millisecond) + defer cancel() + cmd := exec.CommandContext(ctx, "lizardfs", "setgoal", "-r", replicationGoal, volumePath) + cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true, Pgid: 1} + err = cmd.Start() + if err != nil { + return err + } + err = cmd.Wait() + if err != nil { + log.Error(err) + } + } + + return nil +} + +func (l lizardfsDriver) List() (*volume.ListResponse, error) { + log.WithField("method", "list").Debugf("") + volumes := make(chan []*volume.Volume, 1) + errs := make(chan error, 1) + go func() { + var vols []*volume.Volume + directories, err := ioutil.ReadDir(volumeRoot) + if err != nil { + errs <- err + } + for _, directory := range directories { + if len(mounted[directory.Name()]) == 0 { + vols = append(vols, &volume.Volume{Name: directory.Name()}) + } else { + vols = append(vols, &volume.Volume{Name: directory.Name(), Mountpoint: path.Join(hostVolumePath, directory.Name())}) + } + } + + if rootVolumeName != "" { + if len(mounted[rootVolumeName]) == 0 { + vols = append(vols, &volume.Volume{Name: rootVolumeName}) + } else { + vols = append(vols, &volume.Volume{Name: rootVolumeName, Mountpoint: path.Join(hostVolumePath, rootVolumeName)}) + } + } + volumes <- vols + }() + + select { + case res := <-volumes: + return &volume.ListResponse{Volumes: res}, nil + case err := <-errs: + return nil, err + case <-time.After(time.Duration(connectTimeout) * time.Millisecond): + return nil, errors.New("list operation timeout") + } +} + +func (l lizardfsDriver) Get(request *volume.GetRequest) (*volume.GetResponse, error) { + log.WithField("method", "get").Debugf("") + volumeName := request.Name + volumePath := volumeRoot + if volumeName != rootVolumeName { + volumePath = fmt.Sprintf("%s%s", volumeRoot, volumeName) + } + errs := make(chan error, 1) + go func() { + if _, err := os.Stat(volumePath); os.IsNotExist(err) { + errs <- err + } else { + errs <- nil + } + }() + + select { + case err := <-errs: + if err != nil { + return nil, err + } else { + return &volume.GetResponse{Volume: &volume.Volume{Name: volumeName, Mountpoint: volumePath}}, nil + } + case <-time.After(time.Duration(connectTimeout) * time.Millisecond): + return nil, errors.New("get operation timeout") + } +} + +func (l lizardfsDriver) Remove(request *volume.RemoveRequest) error { + log.WithField("method", "remove").Debugf("") + volumeName := request.Name + volumePath := fmt.Sprintf("%s%s", volumeRoot, volumeName) + + if volumeName == rootVolumeName { + return fmt.Errorf("can't remove root volume %s", rootVolumeName) + } + + err := os.RemoveAll(volumePath) + return err +} + +func (l lizardfsDriver) Path(request *volume.PathRequest) (*volume.PathResponse, error) { + log.WithField("method", "path").Debugf("") + var volumeName = request.Name + var hostMountpoint = path.Join(hostVolumePath, volumeName) + + if len(mounted[volumeName]) == 0 { + return &volume.PathResponse{Mountpoint: hostMountpoint}, nil + } + return &volume.PathResponse{}, nil +} + +func (l lizardfsDriver) Mount(request *volume.MountRequest) (*volume.MountResponse, error) { + log.WithField("method", "mount").Debugf("") + var volumeName = request.Name + var mountID = request.ID + var containerMountpoint = path.Join(containerVolumePath, volumeName) + var hostMountpoint = path.Join(hostVolumePath, volumeName) + + if len(mounted[volumeName]) == 0 { + err := os.MkdirAll(containerMountpoint, 760) + if err != nil && err != os.ErrExist { + return nil, err + } + + mountRemotePath := remotePath + + if volumeName != rootVolumeName { + mountRemotePath = path.Join(remotePath, volumeName) + } + + params := []string{ "-o", "mfsmaster="+host, "-o", "mfsport="+port, "-o", "mfssubfolder="+mountRemotePath} + if mountOptions != "" { + params = append(params, strings.Split(mountOptions, " ")...) + } + params = append(params, []string{containerMountpoint}...) + ctx, cancel := context.WithTimeout(context.Background(), time.Duration(connectTimeout)*time.Millisecond) + defer cancel() + cmd := exec.CommandContext(ctx, "mfsmount", params...) + cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true, Pgid: 1} + err = cmd.Start() + if err != nil { + return nil, err + } + err = cmd.Wait() + if err != nil { + log.Error(err) + } + mounted[volumeName] = append(mounted[volumeName], mountID) + return &volume.MountResponse{Mountpoint: hostMountpoint}, nil + } else { + return &volume.MountResponse{Mountpoint: hostMountpoint}, nil + } +} + +func indexOf(word string, data []string) int { + for k, v := range data { + if word == v { + return k + } + } + return -1 +} + +func (l lizardfsDriver) Unmount(request *volume.UnmountRequest) error { + log.WithField("method", "unmount").Debugf("") + var volumeName = request.Name + var mountID = request.ID + var containerMountpoint = path.Join(containerVolumePath, volumeName) + + index := indexOf(mountID, mounted[volumeName]) + + if index > -1 { + mounted[volumeName] = append(mounted[volumeName][:index], mounted[volumeName][index+1:]...) + } + if len(mounted[volumeName]) == 0 { + output, err := exec.Command("umount", containerMountpoint).CombinedOutput() + if err != nil { + log.Error(string(output)) + return err + } + log.Debug(string(output)) + return nil + } + return nil +} + +func (l lizardfsDriver) Capabilities() *volume.CapabilitiesResponse { + log.WithField("method", "capabilities").Debugf("") + return &volume.CapabilitiesResponse{Capabilities: volume.Capability{Scope: "global"}} +} + +func newLizardfsDriver(root string) (*lizardfsDriver, error) { + log.WithField("method", "new driver").Debug(root) + + d := &lizardfsDriver{ + volumes: map[string]*lizardfsVolume{}, + } + + return d, nil +} + +func initClient() { + log.WithField("host", host).WithField("port", port).WithField("remote path", remotePath).Info("initializing client") + err := os.MkdirAll(volumeRoot, 760) + if err != nil { + log.Error(err) + } + params := []string{"-o", "mfsmaster="+host, "-o", "mfsport="+port, "-o", "mfssubfolder="+remotePath} + if mountOptions != "" { + params = append(params, strings.Split(mountOptions, " ")...) + } + params = append(params, []string{volumeRoot}...) + + ctx, cancel := context.WithTimeout(context.Background(), time.Duration(connectTimeout)*time.Millisecond) + defer cancel() + + output, err := exec.CommandContext(ctx, "mfsmount", params...).CombinedOutput() + if err != nil { + log.Error(string(output)) + log.Fatal(err) + } + log.Debug(string(output)) +} + +func startReaperWorker() { + // See related issue in go-reaper https://github.com/ramr/go-reaper/issues/11 + if _, hasReaper := os.LookupEnv("REAPER"); !hasReaper { + go reaper.Reap() + + args := append(os.Args, "#worker") + + pwd, err := os.Getwd() + if err != nil { + panic(err) + } + + workerEnv := []string{fmt.Sprintf("REAPER=%d", os.Getpid())} + + var wstatus syscall.WaitStatus + pattrs := &syscall.ProcAttr{ + Dir: pwd, + Env: append(os.Environ(), workerEnv...), + Sys: &syscall.SysProcAttr{Setsid: true}, + Files: []uintptr{0, 1, 2}, + } + workerPid, _ := syscall.ForkExec(args[0], args, pattrs) + _, err = syscall.Wait4(workerPid, &wstatus, 0, nil) + for syscall.EINTR == err { + _, err = syscall.Wait4(workerPid, &wstatus, 0, nil) + } + } +} + +func main() { + logLevel, err := log.ParseLevel(os.Getenv("LOG_LEVEL")) + if err != nil { + log.SetLevel(log.InfoLevel) + } else { + log.SetLevel(logLevel) + } + log.Debugf("log level set to %s", log.GetLevel()) + startReaperWorker() + connectTimeout, err = strconv.Atoi(connectTimeoutStr) + if err != nil { + log.Errorf("failed to parse timeout with error %v. Assuming default %v", err, connectTimeout) + } + initClient() + + d, err := newLizardfsDriver("/mnt") + if err != nil { + log.Fatal(err) + } + h := volume.NewHandler(d) + log.Infof("listening on %s", socketAddress) + log.Error(h.ServeUnix(socketAddress, 0)) +} diff --git a/run-tests.sh b/run-tests.sh new file mode 100644 index 0000000..b6dfc57 --- /dev/null +++ b/run-tests.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +docker run -it --rm --privileged \ +-v $(pwd)/plugin:/plugin \ +lizardfs-volume-plugin_test $@ diff --git a/test/Dockerfile b/test/Dockerfile new file mode 100644 index 0000000..866ca58 --- /dev/null +++ b/test/Dockerfile @@ -0,0 +1,34 @@ +FROM docker:stable-dind + +# Install dependencies +RUN apk add --no-cache bash curl jq python3 wget docker-compose go + + +# Create our working directory +RUN mkdir /project + +# Switch to our working directory +WORKDIR /project + +# Pull the LizardFS image used for creating the test environment +RUN wget https://raw.githubusercontent.com/moby/moby/master/contrib/download-frozen-image-v2.sh -O /download-image.sh +RUN chmod 744 /download-image.sh +RUN mkdir -p /images/lizardfs +RUN /download-image.sh /images/lizardfs kadimasolutions/lizardfs:latest + +# Copy in the docker compose file that we will use to create test LizardFS +# clusters +COPY ./docker-compose.yml /project/ + +# Copy in the test scripts +COPY ./test-environment.sh /test-environment.sh +RUN chmod 744 /test-environment.sh +COPY ./test-run.sh /test-run.sh +RUN chmod 744 /test-run.sh + +# Copy in our entrypoint script +COPY ./docker-entrypoint.sh /docker-entrypoint.sh +RUN chmod 744 /docker-entrypoint.sh + +# Set the entrypoint +ENTRYPOINT ["/docker-entrypoint.sh"] diff --git a/test/docker-compose.yml b/test/docker-compose.yml new file mode 100644 index 0000000..e95cd0a --- /dev/null +++ b/test/docker-compose.yml @@ -0,0 +1,31 @@ +version: '3' +services: + mfsmaster: + image: kadimasolutions/lizardfs + command: master + restart: on-failure + volumes: + - /var/lib/mfs + ports: + - ${MASTER_PORT}:9421 + chunkserver: + image: kadimasolutions/lizardfs + command: chunkserver + restart: on-failure + environment: + # This lets you run the chunkserver with less available disk space + MFSCHUNKSERVER_HDD_LEAVE_SPACE_DEFAULT: 20Mi # 4Gi is the default + MFSHDD_1: /mnt/mfshdd + volumes: + - /mnt/mfshdd + client: + image: kadimasolutions/lizardfs + command: client /mnt/mfs + restart: on-failure + # Required permissions and devices for container to mount filesystem + cap_add: + - SYS_ADMIN + devices: + - /dev/fuse:/dev/fuse + security_opt: + - apparmor:unconfined diff --git a/test/docker-entrypoint.sh b/test/docker-entrypoint.sh new file mode 100644 index 0000000..fc7fd21 --- /dev/null +++ b/test/docker-entrypoint.sh @@ -0,0 +1,11 @@ +#!/bin/sh + +image_tag=$1 + +log_prefix="[Root]" + +echo "$log_prefix Creating Test Environment" +/test-environment.sh $image_tag + +echo "$log_prefix Running Tests" +/test-run.sh diff --git a/test/test-environment.sh b/test/test-environment.sh new file mode 100644 index 0000000..817e79a --- /dev/null +++ b/test/test-environment.sh @@ -0,0 +1,27 @@ +#!/bin/sh + +image_tag=$1 + +log_prefix="[Plugin Environment]" + +echo "$log_prefix Starting Docker" +dockerd-entrypoint.sh 2> /var/log/docker.log & +echo $! > /run/dockerd-entrypoint.pid + +# Wait for Docker to startup +while ! docker ps > /var/log/docker.log; do + sleep 1 +done +echo "$log_prefix Docker finished startup" + +echo "$log_prefix Loading baked LizardFS image" +tar -cC '/images/lizardfs' . | docker load + +# Install plugin +if [ -z "$image_tag" ]; then + echo "$log_prefix Installing plugin from local dir" + docker plugin create lizardfs /plugin +else + echo "$log_prefix Installing Plugin from DockerHub: $image_tag" + docker plugin install --alias lizardfs --grant-all-permissions --disable $image_tag +fi diff --git a/test/test-run.sh b/test/test-run.sh new file mode 100644 index 0000000..ac42a9b --- /dev/null +++ b/test/test-run.sh @@ -0,0 +1,247 @@ +#!/bin/sh + +#### +# Plugin Test Cases +#### + +log_prefix="[Plugin Test]" + +# Start a LizardFS cluster for the plugin to connect to + +# Set the LizardFS master port +echo "MASTER_PORT=9421" > .env + +echo "$log_prefix Starting up local LizardFS cluster" +docker-compose down -v +docker-compose up -d + +echo "$log_prefix Creating volume directory on LizardFS filesystem" +docker-compose exec client mkdir -p /mnt/mfs/docker/volumes + +# Configure and enable plugin + +echo "$log_prefix Configurin plugin to connect to 127.0.0.1:9421" +docker plugin disable lizardfs 2> /dev/null +docker plugin set lizardfs HOST=127.0.0.1 && \ +docker plugin set lizardfs PORT=9421 && \ +docker plugin set lizardfs REMOTE_PATH=/docker/volumes && \ +docker plugin set lizardfs ROOT_VOLUME_NAME="" && \ +docker plugin set lizardfs MOUNT_OPTIONS="" && \ +docker plugin set lizardfs CONNECT_TIMEOUT=10000 && \ +docker plugin set lizardfs LOG_LEVEL=info && \ +docker plugin enable lizardfs + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Create volumes and make sure that they exist + +echo "$log_prefix Create volume: lizardfs-volume-1" && \ +docker volume create --driver lizardfs lizardfs-volume-1 && \ +\ +echo "$log_prefix Make sure lizardfs-volume-1 exists in volume list" && \ +docker volume ls | grep "lizardfs.*lizardfs-volume-1" && \ +\ +echo "$log_prefix Make sure lizardfs-volume-1 exists on LizardFS filesystem" && \ +docker-compose exec client ls /mnt/mfs/docker/volumes | grep lizardfs-volume-1 && \ +\ +echo "$log_prefix Create a second volume: lizardfs-volume-2" && \ +docker volume create --driver lizardfs lizardfs-volume-2 && \ +\ +echo "$log_prefix Make sure lizardfs-volume-2 exists" && \ +docker volume ls | grep "lizardfs.*lizardfs-volume-2" && \ +\ +echo "$log_prefix Make sure lizardfs-volume-1 still exists" && \ +docker volume ls | grep "lizardfs.*lizardfs-volume-1" + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Store data in a volume and make sure that the data is persisted + +echo "$log_prefix Create test data on lizardfs-volume-1" && \ +docker run -it --rm -v lizardfs-volume-1:/data --entrypoint=bash \ +kadimasolutions/lizardfs -c 'echo "Hello World" > /data/test-data.txt' && \ +\ +echo "$log_prefix Make sure data exists in volume" && \ +docker run -it --rm -v lizardfs-volume-1:/data --entrypoint=cat \ +kadimasolutions/lizardfs /data/test-data.txt | grep "Hello World" && \ +\ +echo "$log_prefix Make sure data exists on LizardFS filesystem" && \ +docker-compose exec client cat \ +/mnt/mfs/docker/volumes/lizardfs-volume-1/test-data.txt | grep "Hello World" + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Mount a volume into multiple containers, then remove the containers, +# and remount + +echo "$log_prefix Mount lizardfs-volume-1 into container1 and container2" && \ +docker run -d --name container1 -it --rm -v lizardfs-volume-1:/data --entrypoint=bash \ +kadimasolutions/lizardfs && \ +\ +docker run -d --name container2 -it --rm -v lizardfs-volume-1:/data --entrypoint=bash \ +kadimasolutions/lizardfs && \ +\ +echo "$log_prefix Make sure data exists in container1" && \ +docker exec -it container1 cat /data/test-data.txt | grep "Hello World" && \ +\ +echo "$log_prefix Make sure data exists in container2" && \ +docker exec -it container2 cat /data/test-data.txt | grep "Hello World" && \ +\ +echo "$log_prefix Remove container1" && \ +docker stop container1 && \ +\ +echo "$log_prefix Make sure data still exists in container2" && \ +docker exec -it container2 cat /data/test-data.txt | grep "Hello World" && \ +\ +echo "$log_prefix Remove container2" && \ +docker stop container2 && \ +\ +echo "$log_prefix Make sure lizardfs-volume-1 can still be mounted into a new container" && \ +docker run -it --rm -v lizardfs-volume-1:/data --entrypoint=cat \ +kadimasolutions/lizardfs /data/test-data.txt | grep "Hello World" + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Create a volume with a specified replication goal and check that it is set +# when the volume is created + +echo "$log_prefix Create lizardfs-volume-3 with a replication goal of '3'" && \ +docker volume create --driver lizardfs lizardfs-volume-3 -o ReplicationGoal=3 && \ +\ +echo "$log_prefix Make sure that the volume has a replication goal of '3'" && \ +docker-compose exec \ +client lizardfs getgoal /mnt/mfs/docker/volumes/lizardfs-volume-3 | \ +grep ".*lizardfs-volume-3: 3" + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Bring down the cluster + +echo "$log_prefix Bringing down LizardFS cluster" && \ +echo "$log_prefix Remove volumes" && \ +docker volume rm lizardfs-volume-1 && \ +docker volume rm lizardfs-volume-2 && \ +docker volume rm lizardfs-volume-3 && \ +echo "$log_prefix Remove LizardFS cluster" && \ +docker-compose down -v && \ +echo "$log_prefix Disable plugin" && \ +docker plugin disable -f lizardfs + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Test connecting to cluster on a different port, storage directory, with mount +# options, and with the root volume name set + +echo "MASTER_PORT=9900" > .env + +echo "$log_prefix Creating cluster with master port 9900" && \ +docker-compose up -d && \ +\ +echo "$log_prefix Creating storage directory, /alternate-volumes, on LizardFS filesystem" && \ +docker-compose exec client mkdir -p /mnt/mfs/alternate-volumes && \ +\ +echo "$log_prefix Enabling plugin with PORT=9900, REMOTE_PATH=/alternate-volumes," && \ +echo "$log_prefix MOUNT_OPTIONS='-o allow_other', and ROOT_VOLUME_NAME=lizardfs" && \ +docker plugin set lizardfs PORT=9900 REMOTE_PATH=/alternate-volumes \ +MOUNT_OPTIONS='-o allow_other' ROOT_VOLUME_NAME=lizardfs && \ +docker plugin enable lizardfs && \ +\ +echo "$log_prefix Create volume 'volume-on-different-port' to test connection" && \ +docker volume create --driver lizardfs volume-on-different-port && \ +\ +echo "$log_prefix Make sure volume-on-different-port exists in volume list" && \ +docker volume ls | grep "lizardfs.*volume-on-different-port" && \ +\ +echo "$log_prefix Make sure that the mount options are getting set" && \ +ps -ef | grep "allow_other" | grep -v "grep" && \ +\ +echo "$log_prefix Remove volume: volume-on-different-port" && \ +docker volume rm volume-on-different-port + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Run tests for the Root Volume + +echo "$log_prefix Create volumes: liz-1, liz-2" && \ +docker volume create --driver lizardfs liz-1 && \ +docker volume create --driver lizardfs liz-2 && \ +\ +echo "$log_prefix Add test-files liz-1, liz-2" && \ +docker run -it --rm -v liz-1:/data --entrypoint=touch \ +kadimasolutions/lizardfs /data/liz-1.txt && \ +docker run -it --rm -v liz-2:/data --entrypoint=touch \ +kadimasolutions/lizardfs /data/liz-2.txt && \ +\ +echo "$log_prefix Mount Root Volume and make sure liz-1, liz-2, and their files are in it" && \ +docker run -it --rm -v lizardfs:/lizardfs --entrypoint=ls \ +kadimasolutions/lizardfs /lizardfs/liz-1 | grep "liz-1.txt" && \ +docker run -it --rm -v lizardfs:/lizardfs --entrypoint=ls \ +kadimasolutions/lizardfs /lizardfs/liz-2 | grep "liz-2.txt" && \ +\ +echo "$log_prefix Create a new directory, liz-3, in the Root Volume" && \ +docker run -it --rm -v lizardfs:/lizardfs --entrypoint=mkdir \ +kadimasolutions/lizardfs /lizardfs/liz-3 && \ +\ +echo "$log_prefix Make sure the new directory registers in the volume list" && \ +docker volume ls | grep "lizardfs.*liz-3" && \ +\ +echo "$log_prefix Create a volume with the same name as the Root Volume" && \ +docker run -it --rm -v lizardfs:/lizardfs --entrypoint=mkdir \ +kadimasolutions/lizardfs /lizardfs/lizardfs && \ +\ +echo "$log_prefix Make sure that the Root Volume takes precedence when mounting" && \ +docker run -it --rm -v lizardfs:/lizardfs --entrypoint=ls \ +kadimasolutions/lizardfs /lizardfs/liz-1 | grep "liz-1.txt" + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +echo "$log_prefix Make sure you can't delete the Root Volume" && +docker volume rm lizardfs + +if [ $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +echo "$log_prefix Make sure all volumes still exist after attempting to delete the Root Volume" +docker volume ls | grep "lizardfs.*liz-1" && \ +docker volume ls | grep "lizardfs.*liz-2" && \ +docker volume ls | grep "lizardfs.*liz-3" && \ +\ +echo "$log_prefix Delete the volumes" && \ +docker volume rm liz-1 && \ +docker volume rm liz-2 && \ +docker volume rm liz-3 + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Test setting the log level + +plugin_id=$(docker plugin ls | grep lizardfs | awk '{print $1}') + +echo "$log_prefix Test a 'docker volume ls'" && \ +docker volume ls +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +echo "$log_prefix Make sure plugin is not logging DEBUG messages" +cat /var/log/docker.log | grep $plugin_id | tail -n 1 | grep -i DEBUG +if [ $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +echo "$log_prefix Set log level to 'DEBUG'" && \ +docker plugin disable -f lizardfs && \ +docker plugin set lizardfs LOG_LEVEL=DEBUG && \ +docker plugin enable lizardfs && \ +\ +echo "$log_prefix Test a 'docker volume ls'" && \ +docker volume ls && \ +\ +echo "$log_prefix Make Sure that the plugin does log a DEBUG message" && \ +cat /var/log/docker.log | grep $plugin_id | tail -n 1 | grep -i DEBUG + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +# Bring down the cluster + +echo "$log_prefix Remove LizardFS cluster" && \ +docker-compose down -v + +if [ ! $? -eq 0 ]; then echo "TEST FAILED"; exit $?; fi + +echo "$log_prefix ALL DONE. SUCCESS!"