From 6481194f6aeaca3a9e37f289461b27908db87f4f Mon Sep 17 00:00:00 2001 From: Tobias Bauriedel Date: Thu, 19 Sep 2024 11:08:53 +0200 Subject: [PATCH] Rebuild module to use influxdb-client library (#13) * update module influxdb2_organizations * add influxdb bucket handler * update workflow --- .github/workflows/molecule.yml | 5 +- LICENSE | 850 ++++++++++++++---- README.md | 36 +- doc/modules/influxdb2_bucket.md | 40 + doc/modules/influxdb2_organization.md | 29 + molecule/influxdb2/converge.yml | 17 +- molecule/influxdb2/molecule.yml | 2 + molecule/influxdb2/prepare.yml | 5 +- plugins/module_utils/api.py | 15 + plugins/module_utils/influxdb2_bucket.py | 118 +++ .../module_utils/influxdb2_organization.py | 102 +++ plugins/module_utils/utils.py | 139 --- plugins/modules/influxdb2_bucket.py | 60 ++ plugins/modules/influxdb2_organization.py | 52 ++ plugins/modules/organize_bucket.py | 88 -- requirements-test.txt | 1 + requirements.txt | 1 + roles/influxdb2/README.md | 42 +- roles/influxdb2/defaults/main.yml | 1 + roles/influxdb2/tasks/install.yml | 2 +- roles/influxdb2/tasks/main.yml | 10 - roles/influxdb2/tasks/setup.yml | 18 +- roles/influxdb2/vars/Debian.yml | 1 - roles/influxdb2/vars/RedHat.yml | 1 - roles/influxdb2/vars/default.yml | 2 - vagrant/Vagrantfile | 24 - vagrant/playbook.yml | 22 - 27 files changed, 1186 insertions(+), 497 deletions(-) create mode 100644 doc/modules/influxdb2_bucket.md create mode 100644 doc/modules/influxdb2_organization.md create mode 100644 plugins/module_utils/api.py create mode 100644 plugins/module_utils/influxdb2_bucket.py create mode 100644 plugins/module_utils/influxdb2_organization.py delete mode 100644 plugins/module_utils/utils.py create mode 100644 plugins/modules/influxdb2_bucket.py create mode 100644 plugins/modules/influxdb2_organization.py delete mode 100644 plugins/modules/organize_bucket.py delete mode 100644 roles/influxdb2/vars/Debian.yml delete mode 100644 roles/influxdb2/vars/RedHat.yml delete mode 100644 roles/influxdb2/vars/default.yml delete mode 100644 vagrant/Vagrantfile delete mode 100644 vagrant/playbook.yml diff --git a/.github/workflows/molecule.yml b/.github/workflows/molecule.yml index d1af569..fe69099 100644 --- a/.github/workflows/molecule.yml +++ b/.github/workflows/molecule.yml @@ -2,9 +2,12 @@ name: Build on: + push: + branches: + - "*" pull_request: branches: - - '*' + - "*" jobs: build: diff --git a/LICENSE b/LICENSE index 7acc4a1..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,176 +1,674 @@ -Apache License -Version 2.0, January 2004 -http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - -"License" shall mean the terms and conditions for use, reproduction, -and distribution as defined by Sections 1 through 9 of this document. - -"Licensor" shall mean the copyright owner or entity authorized by -the copyright owner that is granting the License. - -"Legal Entity" shall mean the union of the acting entity and all -other entities that control, are controlled by, or are under common -control with that entity. For the purposes of this definition, -"control" means (i) the power, direct or indirect, to cause the -direction or management of such entity, whether by contract or -otherwise, or (ii) ownership of fifty percent (50%) or more of the -outstanding shares, or (iii) beneficial ownership of such entity. - -"You" (or "Your") shall mean an individual or Legal Entity -exercising permissions granted by this License. - -"Source" form shall mean the preferred form for making modifications, -including but not limited to software source code, documentation -source, and configuration files. - -"Object" form shall mean any form resulting from mechanical -transformation or translation of a Source form, including but -not limited to compiled object code, generated documentation, -and conversions to other media types. - -"Work" shall mean the work of authorship, whether in Source or -Object form, made available under the License, as indicated by a -copyright notice that is included in or attached to the work -(an example is provided in the Appendix below). - -"Derivative Works" shall mean any work, whether in Source or Object -form, that is based on (or derived from) the Work and for which the -editorial revisions, annotations, elaborations, or other modifications -represent, as a whole, an original work of authorship. For the purposes -of this License, Derivative Works shall not include works that remain -separable from, or merely link (or bind by name) to the interfaces of, -the Work and Derivative Works thereof. - -"Contribution" shall mean any work of authorship, including -the original version of the Work and any modifications or additions -to that Work or Derivative Works thereof, that is intentionally -submitted to Licensor for inclusion in the Work by the copyright owner -or by an individual or Legal Entity authorized to submit on behalf of -the copyright owner. For the purposes of this definition, "submitted" -means any form of electronic, verbal, or written communication sent -to the Licensor or its representatives, including but not limited to -communication on electronic mailing lists, source code control systems, -and issue tracking systems that are managed by, or on behalf of, the -Licensor for the purpose of discussing and improving the Work, but -excluding communication that is conspicuously marked or otherwise -designated in writing by the copyright owner as "Not a Contribution." - -"Contributor" shall mean Licensor and any individual or Legal Entity -on behalf of whom a Contribution has been received by Licensor and -subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of -this License, each Contributor hereby grants to You a perpetual, -worldwide, non-exclusive, no-charge, royalty-free, irrevocable -copyright license to reproduce, prepare Derivative Works of, -publicly display, publicly perform, sublicense, and distribute the -Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of -this License, each Contributor hereby grants to You a perpetual, -worldwide, non-exclusive, no-charge, royalty-free, irrevocable -(except as stated in this section) patent license to make, have made, -use, offer to sell, sell, import, and otherwise transfer the Work, -where such license applies only to those patent claims licensable -by such Contributor that are necessarily infringed by their -Contribution(s) alone or by combination of their Contribution(s) -with the Work to which such Contribution(s) was submitted. If You -institute patent litigation against any entity (including a -cross-claim or counterclaim in a lawsuit) alleging that the Work -or a Contribution incorporated within the Work constitutes direct -or contributory patent infringement, then any patent licenses -granted to You under this License for that Work shall terminate -as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the -Work or Derivative Works thereof in any medium, with or without -modifications, and in Source or Object form, provided that You -meet the following conditions: - -(a) You must give any other recipients of the Work or -Derivative Works a copy of this License; and - -(b) You must cause any modified files to carry prominent notices -stating that You changed the files; and - -(c) You must retain, in the Source form of any Derivative Works -that You distribute, all copyright, patent, trademark, and -attribution notices from the Source form of the Work, -excluding those notices that do not pertain to any part of -the Derivative Works; and - -(d) If the Work includes a "NOTICE" text file as part of its -distribution, then any Derivative Works that You distribute must -include a readable copy of the attribution notices contained -within such NOTICE file, excluding those notices that do not -pertain to any part of the Derivative Works, in at least one -of the following places: within a NOTICE text file distributed -as part of the Derivative Works; within the Source form or -documentation, if provided along with the Derivative Works; or, -within a display generated by the Derivative Works, if and -wherever such third-party notices normally appear. The contents -of the NOTICE file are for informational purposes only and -do not modify the License. You may add Your own attribution -notices within Derivative Works that You distribute, alongside -or as an addendum to the NOTICE text from the Work, provided -that such additional attribution notices cannot be construed -as modifying the License. - -You may add Your own copyright statement to Your modifications and -may provide additional or different license terms and conditions -for use, reproduction, or distribution of Your modifications, or -for any such Derivative Works as a whole, provided Your use, -reproduction, and distribution of the Work otherwise complies with -the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, -any Contribution intentionally submitted for inclusion in the Work -by You to the Licensor shall be under the terms and conditions of -this License, without any additional terms or conditions. -Notwithstanding the above, nothing herein shall supersede or modify -the terms of any separate license agreement you may have executed -with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade -names, trademarks, service marks, or product names of the Licensor, -except as required for reasonable and customary use in describing the -origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or -agreed to in writing, Licensor provides the Work (and each -Contributor provides its Contributions) on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -implied, including, without limitation, any warranties or conditions -of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A -PARTICULAR PURPOSE. You are solely responsible for determining the -appropriateness of using or redistributing the Work and assume any -risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, -whether in tort (including negligence), contract, or otherwise, -unless required by applicable law (such as deliberate and grossly -negligent acts) or agreed to in writing, shall any Contributor be -liable to You for damages, including any direct, indirect, special, -incidental, or consequential damages of any character arising as a -result of this License or out of the use or inability to use the -Work (including but not limited to damages for loss of goodwill, -work stoppage, computer failure or malfunction, or any and all -other commercial damages or losses), even if such Contributor -has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing -the Work or Derivative Works thereof, You may choose to offer, -and charge a fee for, acceptance of support, warranty, indemnity, -or other liability obligations and/or rights consistent with this -License. However, in accepting such obligations, You may act only -on Your own behalf and on Your sole responsibility, not on behalf -of any other Contributor, and only if You agree to indemnify, -defend, and hold each Contributor harmless for any liability -incurred by, or claims asserted against, such Contributor by reason -of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS \ No newline at end of file + 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: + + 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. + +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 +. \ No newline at end of file diff --git a/README.md b/README.md index 1bd414a..012de87 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -![Lint](https://github.com/tbauriedel/ansible-collection-influxdb2/actions/workflows/yamllint.yml/badge.svg) +![Lint](https://github.com/tbauriedel/ansible-collection-influxdb2/actions/workflows/yamllint.yml/badge.svg) ![Build](https://github.com/tbauriedel/ansible-collection-influxdb2/actions/workflows/molecule.yml/badge.svg) -> **Note:** Collection is work in progress +> **Note:** Collection is not production-ready yet # ansible-collection-influxdb2 @@ -16,26 +16,36 @@ It was created with the aim of refreshing my Ansible knowledge and getting in to * [Role: repos](roles/repos/README.md) - Install the official InfluxDb repositories * [Role: influxdb2](roles/influxdb2/README.md) - Install and configure InfluxDBv2 +## Modules + +* [Module: influxdb2_organization](doc/modules/influxdb2_organization.py): Create, update and delete InfluxDBv2 organizations +* [Module: influxdb2_bucket](doc/modules/influxdb2_bucket.md.py): Create, update and delete InfluxDBv2 buckets + ## Example ``` -- hosts: all - become: true +- name: InfluxDB + hosts: all + vars: - influxdb_influxdb2_admin_token: 12345678abcdefg + influxdb_influxdb2_admin_token: 123456789abc! + influxdb_influxdb2_orgs: + - name: org1 + desc: "This is a description" + token: "{{ influxdb_influxdb2_admin_token }}" + influxdb_influxdb2_buckets: - - name: foobar1 - state: absent - org: default - token: "{{ influxdb_influxdb2admin_token }}" - host: "{{ influxdb_influxdb2_host }}" + - name: bucket-1 + desc: "This is a description" + org: org1 + token: "{{ influxdb_influxdb2_admin_token }}" retention: type: 'expire' - everySeconds: '50000' - shardGroupDurationSeconds: '0' + everySeconds: '60000' + shardGroupDurationSeconds: '7600' collections: - tbauriedel.influxdb2 + - tbauriedel.influxdb2 roles: - repos diff --git a/doc/modules/influxdb2_bucket.md b/doc/modules/influxdb2_bucket.md new file mode 100644 index 0000000..e04c7f9 --- /dev/null +++ b/doc/modules/influxdb2_bucket.md @@ -0,0 +1,40 @@ +# Ansible module: influxdb_bucket + +This module creates, updates and deletes buckets from your InfluxDB2. + +## Requirements + +As this module uses the InfluxDB2 API you will need to install the InfluxDB2 Python3 library. + +`pip3 install influxdb-client` + +## Module arguments + +* `name`: Bucket name +* `state`: State of the bucket ('present' or 'absent') +* `org`: Name of the corresponding organization +* `desc`: Description +* `token`: API token to manage the organization +* `host`: InfluxDB API Endpoint +* `retention`: Dict of retention rules containing a single object with the following fields + * `type`: Retention type + * `everySeconds`: Number of seconds to retain data (0 means forever) + * `shardGroupDurationSeconds`: Number of seconds to retain shard groups (**Caution**: The [default values](https://docs.influxdata.com/influxdb/v2/reference/internals/shards/#shard-group-duration) also correspond to the necessary minimum!) + +## Example usage + +``` +- name: Manage bucket + tbauriedel.influxdb2.influxdb2_bucket: + name: "Example" + state: present + desc: "This is a bucket" + org: "{{ item.org }}" + token: "{{ item.token }}" + host: "{{ influxdb_influxdb2_host }}" + retention: + type: "{{ item.retention.type }}" + everySeconds: "{{ item.retention.everySeconds }}" + shardGroupDurationSeconds: "{{ item.retention.shardGroupDurationSeconds) }}" + loop: "{{ influxdb_influxdb2_buckets }}" +``` diff --git a/doc/modules/influxdb2_organization.md b/doc/modules/influxdb2_organization.md new file mode 100644 index 0000000..4c47b1f --- /dev/null +++ b/doc/modules/influxdb2_organization.md @@ -0,0 +1,29 @@ +# Ansible module: influxdb2_organization + +This module creates, updates and deletes organizations from your InfluxDB2. + +## Requirements + +As this module uses the InfluxDB2 API you will need to install the InfluxDB2 Python3 library. + +`pip3 install influxdb-client` + +## Module arguments + +* `name`: Organization name +* `state`: State of the organization ('present' or 'absent') +* `desc`: Description +* `token`: API token to manage the organization +* `host`: InfluxDB API Endpoint + +## Example usage + +``` +- name: Manage organization + tbauriedel.influxdb2.influxdb2_organization: + name: "Example" + state: present + desc: "This is a organization" + token: "{{ influxdb_api_token }}" + host: "{{ http://localhost:8086 }}" +``` diff --git a/molecule/influxdb2/converge.yml b/molecule/influxdb2/converge.yml index 254612d..b27043d 100644 --- a/molecule/influxdb2/converge.yml +++ b/molecule/influxdb2/converge.yml @@ -1,19 +1,22 @@ ---- - name: Converge hosts: all vars: influxdb_influxdb2_admin_token: 123456789abc! + influxdb_influxdb2_orgs: + - name: org1 + desc: "This is a description" + token: "{{ influxdb_influxdb2_admin_token }}" + influxdb_influxdb2_buckets: - - name: foobar1 - state: present - org: default + - name: bucket-1 + desc: "This is a description" + org: org1 token: "{{ influxdb_influxdb2_admin_token }}" - host: "{{ influxdb_influxdb2_host }}" retention: type: 'expire' - everySeconds: 50000 - shardGroupDurationSeconds: 0 + everySeconds: '60000' + shardGroupDurationSeconds: '7600' collections: - tbauriedel.influxdb2 diff --git a/molecule/influxdb2/molecule.yml b/molecule/influxdb2/molecule.yml index 8f822ee..17a35df 100644 --- a/molecule/influxdb2/molecule.yml +++ b/molecule/influxdb2/molecule.yml @@ -14,5 +14,7 @@ platforms: pre_build_image: true provisioner: name: ansible + env: + ANSIBLE_VERBOSITY: 3 verifier: name: ansible diff --git a/molecule/influxdb2/prepare.yml b/molecule/influxdb2/prepare.yml index addfb56..61571fe 100644 --- a/molecule/influxdb2/prepare.yml +++ b/molecule/influxdb2/prepare.yml @@ -4,4 +4,7 @@ tasks: - name: Ensure python3-requests is installed ansible.builtin.pip: - name: requests + name: "{{ item }}" + loop: + - requests + - influxdb_client diff --git a/plugins/module_utils/api.py b/plugins/module_utils/api.py new file mode 100644 index 0000000..3ba3e9b --- /dev/null +++ b/plugins/module_utils/api.py @@ -0,0 +1,15 @@ +# !/usr/bin/python3 + +# Copyright (c) 2024, Tobias Bauriedel +# Licensed under the Apache License, Version 2.0 (the "License"); +# You may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 + + +from influxdb_client import InfluxDBClient + +class Api(): + def new_client(host, token, timeout=10000) -> InfluxDBClient: + return InfluxDBClient(host, token, timeout=timeout) diff --git a/plugins/module_utils/influxdb2_bucket.py b/plugins/module_utils/influxdb2_bucket.py new file mode 100644 index 0000000..78b085c --- /dev/null +++ b/plugins/module_utils/influxdb2_bucket.py @@ -0,0 +1,118 @@ +# !/usr/bin/python3 + +# Copyright (c) 2024, Tobias Bauriedel +# Licensed under the Apache License, Version 2.0 (the "License"); +# You may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 + +from re import T +from influxdb_client import Bucket, BucketRetentionRules, Buckets +from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.api import ( + Api +) +from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.influxdb2_organization import ( + OrgApi +) + + +class BucketApi(): + def __init__(self, name, state, desc, result, host, token, org, retention): + self.name = name + self.state = state + self.desc = desc + self.org = org + self.retention = retention + self.result = result + + self.client = Api.new_client(host=host, token=token).buckets_api() + + self.host = host + self.token = token + + def return_result(self) -> dict: + return self.result + + def handle(self): + if self.state == 'absent': + self.handle_absent() + elif self.state == 'present': + self.handle_present() + + return + + def handle_absent(self): + bucket = Bucket(name=self.name, description=self.desc, id="0", retention_rules=[BucketRetentionRules(type=self.retention['type'], every_seconds=int( + self.retention['everySeconds']), shard_group_duration_seconds=int(self.retention['shardGroupDurationSeconds']))]) + for row in self.get_all().buckets: + if row.name != self.name: + continue + bucket = row + break + + if bucket.id == "0": + return + + self.delete(bucket.id) + self.result['changed'] = True + self.result['msg'] = self.name + " has been deleted" + + return + + def handle_present(self): + pre_bucket = Bucket(name=self.name, description=self.desc, id="0", retention_rules=[BucketRetentionRules(type=self.retention['type'], every_seconds=int( + self.retention['everySeconds']), shard_group_duration_seconds=int(self.retention['shardGroupDurationSeconds']))]) + + # fetch all buckets and save found bucket into pre_bucket + for row in self.get_all().buckets: + if row.name != self.name: + continue + pre_bucket = self.get_by_id(row.id) + + break + + # Create new bucket if not exists + if pre_bucket.id == "0": + bucket = self.create() + if bucket.id == '0': + self.result['changed'] = False + self.result['msg'] = self.name + \ + " cant create new bucket because organization does not exists" + return + + self.result['changed'] = True + self.result['msg'] = self.name + " has been created" + return + + if ( + pre_bucket.name != self.name or + (pre_bucket.description or "") != self.desc or + pre_bucket.retention_rules != [BucketRetentionRules(type=self.retention['type'], every_seconds=int( + self.retention['everySeconds']), shard_group_duration_seconds=int(self.retention['shardGroupDurationSeconds']))] + ): + self.update(pre_bucket.id) + self.result['changed'] = True + self.result['msg'] = self.name + " has been updated" + return + + def create(self) -> Bucket: + orgApi = OrgApi(host=self.host, token=self.token) + org = orgApi.get_by_name(self.org) + if org.status != 'inactive': + return self.client.create_bucket(bucket=Bucket(name=self.name, org_id=org.id, description=self.desc, retention_rules=[BucketRetentionRules(type=self.retention['type'], every_seconds=int( + self.retention['everySeconds']), shard_group_duration_seconds=int(self.retention['shardGroupDurationSeconds']))])) + + return Bucket(name='', id='0') + + def update(self, id) -> Bucket: + return self.client.update_bucket(bucket=Bucket(name=self.name, description=self.desc, id=id, retention_rules=[BucketRetentionRules(type=self.retention['type'], every_seconds=int(self.retention['everySeconds']), shard_group_duration_seconds=int(self.retention['shardGroupDurationSeconds']))])) + + def delete(self, id): + return self.client.delete_bucket(bucket=id) + + def get_all(self) -> Buckets: + return self.client.find_buckets() + + def get_by_id(self, id) -> Bucket: + return self.client.find_bucket_by_id(id=id) diff --git a/plugins/module_utils/influxdb2_organization.py b/plugins/module_utils/influxdb2_organization.py new file mode 100644 index 0000000..853fff2 --- /dev/null +++ b/plugins/module_utils/influxdb2_organization.py @@ -0,0 +1,102 @@ +# !/usr/bin/python3 + +# Copyright (c) 2024, Tobias Bauriedel +# Licensed under the Apache License, Version 2.0 (the "License"); +# You may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 + +from influxdb_client import Organization +from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.api import ( + Api +) + + +class OrgApi(): + def __init__(self, host, token, name='', state='', desc='', result=dict): + self.name = name + self.state = state + self.desc = desc + self.result = result + + self.client = Api.new_client( + host=host, token=token).organizations_api() + + def return_result(self) -> dict: + return self.result + + def handle(self): + if self.state == 'absent': + self.handle_absent() + elif self.state == 'present': + self.handle_present() + + return + + def handle_absent(self): + org = Organization(name=self.name, status='inactive') + for row in self.get_all(): + if row.name != self.name: + continue + org = row + break + + if org.status != 'active': + return + + self.delete(org.id) + self.result['changed'] = True + self.result['msg'] = self.name + " has been deleted" + + return + + def handle_present(self): + # build emtpy org + pre_org = Organization( + name=self.name, description=self.desc, status='inactive') + + # fetch all orgs and save found bucket into pre_org + for row in self.get_all(): + if row.name != self.name: + continue + pre_org = self.get_by_id(row.id) + break + + if pre_org.status != 'active': + res = self.create() + self.result['changed'] = True + self.result['msg'] = self.name + " has been created" + return + + if ( + (pre_org.description or "") != self.desc or + self.name != pre_org.name + ): + self.update(pre_org.id) + self.result['changed'] = True + self.result['msg'] = self.name + " has been updated" + + return + + def create(self) -> Organization: + return self.client.create_organization(name=self.name, organization=Organization(name=self.name, description=self.desc)) + + def update(self, id) -> Organization: + return self.client.update_organization(organization=Organization(name=self.name, description=self.desc, id=id)) + + def delete(self, id): + return self.client.delete_organization(org_id=id) + + def get_all(self) -> list[Organization]: + return self.client.find_organizations() + + def get_by_id(self, id) -> Organization: + return self.client.find_organization(org_id=id) + + def get_by_name(self, name) -> Organization: + for row in self.get_all(): + if row.name != name: + continue + return row + return Organization(name='', status='inactive') diff --git a/plugins/module_utils/utils.py b/plugins/module_utils/utils.py deleted file mode 100644 index 34710e5..0000000 --- a/plugins/module_utils/utils.py +++ /dev/null @@ -1,139 +0,0 @@ -"""InfluxDB v2 API utilites""" -#!/usr/bin/python3 - -import json -import requests - -class Influx2Api: - ''' - Common api requests to for InfluxDBv2 - ''' - - api_token: str - endpoint: str - timeout: int - - def __init__(self, token, host) -> None: - ''' - Initialize API class - ''' - self.api_token, self.endpoint, self.timeout = token, host, 10 - - - # Organizations - - def get_all_orgs(self) -> json: - ''' - Get all organizations from InfluxDB. Queries. - Returns JSON. - ''' - - headers = { - 'Authorization': 'Token ' + self.api_token - } - response = requests.get(self.endpoint + '/api/v2/orgs', headers=headers, timeout=self.timeout) - - return json.loads(response.content) - - - def get_orgid_by_name(self, name) -> str: - ''' - Get organization ID by name. Returns ID - If no organization is found by name, 'not found' will be returned. - ''' - - orgs = self.get_all_orgs() - - for org in orgs['orgs']: - if org['name'] == name: - return org['id'] - - return "not found" - - - # Buckets - - def get_bucketid_by_name(self, name, org): # pyling - ''' - Get bucket ID by name. Returns ID - If no bucket is found by name, 'not found' will be returned - ''' - - headers = { - 'Authorization': 'Token ' + self.api_token - } - - url = self.endpoint + '/api/v2/buckets?name=' + name + "&orgID=" + self.get_orgid_by_name(org) - response = requests.get(url, headers=headers, timeout=self.timeout) - json_resp = json.loads(response.content) - - for bucket in json_resp['buckets']: - return bucket['id'] - - return "not found" - - - def get_bucket_status(self, name, org_id): - ''' - Get state of single bucket of org from InfluxDB. Returns 'present' if found and 'absent' if not present. - ''' - - headers = { - 'Authorization': 'Token ' + self.api_token - } - - url = self.endpoint + '/api/v2/buckets?name=' + name + "&orgID=" + org_id - response = requests.get(url, headers=headers, timeout=self.timeout) - json_resp = json.loads(response.content) - - if "code" in json_resp: - if json_resp["code"] == "not found": - return "absent" - - for bucket in json_resp["buckets"]: - if bucket['name'] == name: - return 'present' - - return 'absent' - - - def create_bucket(self, name, org_id, retention): - ''' - Create bucket - ''' - - headers = { - 'Authorization': 'Token ' + self.api_token, - 'Content-type': 'application/json' - } - - url = self.endpoint + '/api/v2/buckets' - payload = { - 'orgID': org_id, - 'name': name, - 'retentionRules': [ - { - 'type': retention['type'], - 'everySeconds': int(retention['everySeconds']), - 'shardGroupDurationSeconds': int(retention['shardGroupDurationSeconds']) - } - ] - } - response = requests.post(url, headers=headers, data=json.dumps(payload), timeout=self.timeout) - - return response.status_code, response.content - - - def delete_bucket(self, name, org): - ''' - Delete bucket - ''' - - headers = { - 'Authorization': 'Token ' + self.api_token - } - - url = self.endpoint + '/api/v2/buckets/' + self.get_bucketid_by_name(name, org) - response = requests.delete(url, headers=headers, timeout=self.timeout) - - return response.status_code, response.content diff --git a/plugins/modules/influxdb2_bucket.py b/plugins/modules/influxdb2_bucket.py new file mode 100644 index 0000000..6540594 --- /dev/null +++ b/plugins/modules/influxdb2_bucket.py @@ -0,0 +1,60 @@ +#!/usr/bin/python3 +# pylint: disable=missing-module-docstring + +from ansible.module_utils.basic import AnsibleModule + +from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.influxdb2_bucket import ( + BucketApi +) + + +def run_module(): + ''' + Module to manage InfluxDB buckets + ''' + + # Define new Module with arguments + module = AnsibleModule( + argument_spec=dict( + name=dict(type=str, required=True), + state=dict(type=str, required=True), + desc=dict(type=str, required=False), + token=dict(type=str, Required=True, no_log=True), + host=dict(type=str, Required=True), + org=dict(type=str, required=False), + retention=dict(type=dict, required=False) + ) + ) + + if module.params['state'] != 'absent' and module.params['state'] != 'present': + module.exit_json( + failed=True, + stderr="Invalid state provided. Use 'present' or 'absent'" + ) + + # Default result + result = dict( + changed=False, + failed=False, + ) + + bucket = BucketApi( + result=result, + name=module.params['name'], + state=module.params['state'], + host=module.params['host'], + token=module.params['token'], + desc=module.params['desc'], + org=module.params['org'], + retention=module.params['retention'] + ) + + bucket.handle() + + result = bucket.return_result() + + module.exit_json(**result) + + +if __name__ == '__main__': + run_module() diff --git a/plugins/modules/influxdb2_organization.py b/plugins/modules/influxdb2_organization.py new file mode 100644 index 0000000..1c0ce14 --- /dev/null +++ b/plugins/modules/influxdb2_organization.py @@ -0,0 +1,52 @@ +#!/usr/bin/python3 +# pylint: disable=missing-module-docstring + +from ansible.module_utils.basic import ( + AnsibleModule, +) + +from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.influxdb2_organization import ( + OrgApi +) + + +def run_module(): + module = AnsibleModule( + argument_spec=dict( + name=dict(type=str, required=True), + state=dict(type=str, required=True), + desc=dict(type=str, required=False), + host=dict(type=str, required=True), + token=dict(type=str, required=True, no_log=True) + ) + ) + + result = dict( + changed=False, + failed=False, + ) + + if module.params['state'] != 'absent' and module.params['state'] != 'present': + result['stderr'] = "Invalid state given. Please use 'absent' or 'present'" + result['failed'] = True + + module.exit_json(**result) + + org = OrgApi( + result=result, + host=module.params['host'], + token=module.params['token'], + desc=module.params['desc'], + name=module.params['name'], + state=module.params['state'], + ) + + org.handle() + + result = org.return_result() + + module.exit_json(**result) + + +if __name__ == "__main__": + run_module() diff --git a/plugins/modules/organize_bucket.py b/plugins/modules/organize_bucket.py deleted file mode 100644 index b0d655b..0000000 --- a/plugins/modules/organize_bucket.py +++ /dev/null @@ -1,88 +0,0 @@ -#!/usr/bin/python3 -# pylint: disable=missing-module-docstring - -from ansible.module_utils.basic import AnsibleModule -from ansible_collections.tbauriedel.influxdb2.plugins.module_utils.utils import ( - Influx2Api, -) - -def run_module(): - ''' - Module to manage InfluxDB buckets - ''' - - # Define new Module with arguments - module = AnsibleModule( - argument_spec=dict( - name=dict(type=str, required=True), - state=dict(type=str, required=True), - token=dict(type=str, Required=True, no_log=True), - host=dict(type=str, Required=True), - org=dict(type=str, required=False), - retention=dict(type=dict, required=False) - ) - ) - - if module.params['state'] != 'absent' and module.params['state'] != 'present': - module.exit_json( - failed=True, - stderr="Invalid state provided. Use 'present' or 'absent'" - ) - - # Default result - result = dict( - changed=False, - failed=False, - rc="" - ) - - # Prepare API class - API = Influx2Api(module.params['token'], module.params['host']) # pylint: disable=invalid-name - - # Get state of current bucket - org_id = API.get_orgid_by_name(module.params['org']) - if org_id == "not found": - module.exit_json( - failed=True, - stderr="No org id found for given org name" - ) - - # Get state of bucket ('present' or 'absent') - bucket_state = API.get_bucket_status(module.params['name'], org_id) - - # Create bucket if not 'present' but 'present' in configuration - if module.params['state'] == 'present' and bucket_state == 'absent': - result['debug'] = "Create bucket" - - rc, content = API.create_bucket(module.params['name'], org_id, module.params['retention']) - result['rc'] = rc - if rc != 201: - module.exit_json( - failed=True, - stderr=content - ) - - result['changed'] = True - - # Delete bucket if 'present' but 'absent' in configuration - elif module.params['state'] == 'absent' and bucket_state == 'present': - result['debug'] = "Delete bucket" - - rc, content = API.delete_bucket(module.params['name'], module.params['org']) - result['rc'] = rc - if rc != 204: - module.exit_json( - failed=True, - stderr=content - ) - - result['changed'] = True - - else: - result['debug'] = "Keep state of bucket" - - module.exit_json(**result) - - -if __name__ == '__main__': - run_module() diff --git a/requirements-test.txt b/requirements-test.txt index e3c5540..f123bc5 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -2,3 +2,4 @@ ansible-core==2.16.3 ansible-lint molecule molecule-docker +influxdb-client diff --git a/requirements.txt b/requirements.txt index e69de29..15838e1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1 @@ +influxdb-client \ No newline at end of file diff --git a/roles/influxdb2/README.md b/roles/influxdb2/README.md index 0dcd910..83f8ca0 100644 --- a/roles/influxdb2/README.md +++ b/roles/influxdb2/README.md @@ -21,26 +21,54 @@ At the moment the configuration is very basic. Over time, this role will be expa * `influxdb_influxdb2_retention`: Retention for primary bucket (default: '0') * `influxdb_influxdb2_admin_token`: Admin API token created in the setup (default: 'Random123ChangeMe!') +**Organizations** +* `influxdb_influxdb2_orgs`: List of organizations to manage + * `name`: Name of the organization + * `state`: State ('present' or 'absent') + * `desc`: Description + * `token`: API token to manage the organization + **Buckets** * `influxdb_influxdb2_buckets`: List of buckets to manage - * `name`: Name of bucket. (watch [bucket naming restrictions](https://docs.influxdata.com/influxdb/v2/admin/buckets/create-bucket/?t=InfluxDB+API#bucket-naming-restrictions)) - * `state`: state of bucket ('present' or 'absent') + * `name`: Name of bucket. ([Bucket naming restrictions!](https://docs.influxdata.com/influxdb/v2/admin/buckets/create-bucket/?t=InfluxDB+API#bucket-naming-restrictions)) + * `state`: State of the bucket ('present' or 'absent') + * `desc`: Description * `org`: InfluxDB organization name * `token`: API token to manage the bucket - * `retention`: List of retention rules containing a single object with the following fields + * `retention`: Dict of retention rules containing a single object with the following fields * `type`: expire * `everySeconds`: Number of seconds to retain data (0 means forever) - * `shardGroupDurationSeconds`: Number of seconds to retain shard groups (0 means forever) + * `shardGroupDurationSeconds`: Number of seconds to retain shard groups (**Caution**: The [default values](https://docs.influxdata.com/influxdb/v2/reference/internals/shards/#shard-group-duration) also correspond to the necessary minimum!) Defaults can be viewed in vars/defaults.yml ## Example -Install the official InfluxDB repository: ``` -- hosts: all - become: true +- name: InfluxDB + hosts: all + + vars: + influxdb_influxdb2_admin_token: 123456789abc! + influxdb_influxdb2_orgs: + - name: org1 + desc: "This is a description" + token: "{{ influxdb_influxdb2_admin_token }}" + + influxdb_influxdb2_buckets: + - name: bucket-1 + desc: "This is a description" + org: org1 + token: "{{ influxdb_influxdb2_admin_token }}" + retention: + type: 'expire' + everySeconds: '60000' + shardGroupDurationSeconds: '7600' + + collections: + - tbauriedel.influxdb2 roles: + - repos - influxdb2 ``` \ No newline at end of file diff --git a/roles/influxdb2/defaults/main.yml b/roles/influxdb2/defaults/main.yml index 8af2eac..b9d75d3 100644 --- a/roles/influxdb2/defaults/main.yml +++ b/roles/influxdb2/defaults/main.yml @@ -18,3 +18,4 @@ influxdb_influxdb2_admin_token: "Random123ChangeMe!" influxdb_influxdb2_retention: 0 influxdb_influxdb2_buckets: [] +influxdb_influxdb2_orgs: [] diff --git a/roles/influxdb2/tasks/install.yml b/roles/influxdb2/tasks/install.yml index 02ff6a0..2e7bc00 100644 --- a/roles/influxdb2/tasks/install.yml +++ b/roles/influxdb2/tasks/install.yml @@ -6,7 +6,7 @@ loop: "{{ influxdb_influxdb2_packages }}" notify: Restart InfluxDB -- name: Ensure startup config is there +- name: Ensure startup config is placed ansible.builtin.template: src: config.toml.j2 dest: /etc/influxdb/config.toml diff --git a/roles/influxdb2/tasks/main.yml b/roles/influxdb2/tasks/main.yml index 2536ebd..2573293 100644 --- a/roles/influxdb2/tasks/main.yml +++ b/roles/influxdb2/tasks/main.yml @@ -1,14 +1,4 @@ --- -- name: Include OS specific vars - ansible.builtin.include_vars: "{{ lookup('first_found', params) }}" - vars: - params: - files: - - "{{ ansible_os_family }}.yml" - - default.yml - paths: - - "{{ role_path }}/vars" - - name: Include installation ansible.builtin.include_tasks: install.yml diff --git a/roles/influxdb2/tasks/setup.yml b/roles/influxdb2/tasks/setup.yml index ab50df0..0e245fd 100644 --- a/roles/influxdb2/tasks/setup.yml +++ b/roles/influxdb2/tasks/setup.yml @@ -20,11 +20,21 @@ - '"has already been set up" not in _influx_setup.stderr' changed_when: _influx_setup.rc == 0 -# TODO add handling for orgs, buckets, etc. -- name: Organize buckets - tbauriedel.influxdb2.organize_bucket: +- name: Manage organizations + tbauriedel.influxdb2.influxdb2_organization: name: "{{ item.name }}" - state: "{{ item.state }}" + state: "{{ item.state | default('present') }}" + desc: "{{ item.desc | default('') }}" + token: "{{ item.token }}" + host: "{{ influxdb_influxdb2_host }}" + loop: "{{ influxdb_influxdb2_orgs }}" + when: influxdb_influxdb2_orgs | length > 0 + +- name: Manage buckets + tbauriedel.influxdb2.influxdb2_bucket: + name: "{{ item.name }}" + state: "{{ item.state | default('present') }}" + desc: "{{ item.desc | default('') }}" org: "{{ item.org }}" token: "{{ item.token }}" host: "{{ influxdb_influxdb2_host }}" diff --git a/roles/influxdb2/vars/Debian.yml b/roles/influxdb2/vars/Debian.yml deleted file mode 100644 index ed97d53..0000000 --- a/roles/influxdb2/vars/Debian.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/roles/influxdb2/vars/RedHat.yml b/roles/influxdb2/vars/RedHat.yml deleted file mode 100644 index ed97d53..0000000 --- a/roles/influxdb2/vars/RedHat.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/roles/influxdb2/vars/default.yml b/roles/influxdb2/vars/default.yml deleted file mode 100644 index 059fbdb..0000000 --- a/roles/influxdb2/vars/default.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -# default vars for influxdb.influxdb diff --git a/vagrant/Vagrantfile b/vagrant/Vagrantfile deleted file mode 100644 index 4e0373d..0000000 --- a/vagrant/Vagrantfile +++ /dev/null @@ -1,24 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : -# you're doing. -Vagrant.configure("2") do |config| - config.vm.define "ubuntu" do |ubuntu| - ubuntu.vm.hostname = "influxdb-ubuntu" - ubuntu.vm.box = "bento/ubuntu-20.04" - ubuntu.vm.network "forwarded_port", guest: 8086, host: 8086 - ubuntu.vm.provision "ansible" do |ansible| - ansible.playbook = "playbook.yml" -# ansible.verbose = "vvv" - end - end - - config.vm.define "rocky" do |rocky| - rocky.vm.hostname = "influxdb-rocky" - rocky.vm.box = "rockylinux/9" - rocky.vm.network "forwarded_port", guest: 8086, host: 8087 - rocky.vm.provision "ansible" do |ansible| - ansible.playbook = "playbook.yml" -# ansible.verbose = "vvv" - end - end -end diff --git a/vagrant/playbook.yml b/vagrant/playbook.yml deleted file mode 100644 index b2bb34e..0000000 --- a/vagrant/playbook.yml +++ /dev/null @@ -1,22 +0,0 @@ ---- -- hosts: all - become: true - vars: - influxdb_influxdb2_admin_token: 12345678abcdefg - influxdb_influxdb2_buckets: - - name: foobar1 - state: present - org: default - token: "{{ influxdb_influxdb2_admin_token }}" - host: "{{ influxdb_influxdb2_host }}" - retention: - type: 'expire' - everySeconds: 50000 - shardGroupDurationSeconds: 0 - - collections: - - tbauriedel.influxdb2 - - roles: - - repos - - influxdb2