├── .gitignore ├── LICENSE ├── README.md ├── embedding ├── playbook │ ├── README.md │ ├── installer.py │ └── installer.yml └── task │ ├── README.md │ └── flask_facter.py ├── extending ├── dynamic_inventory │ ├── README.md │ ├── create_inventory.py │ ├── inventory.db │ ├── playbook.yml │ ├── shelve_inventory.ini │ └── shelve_inventory.py ├── module │ ├── README.md │ ├── library │ │ └── taiga_issue.py │ ├── playbook.yml │ └── requirements.txt └── plugin │ ├── callbacks │ ├── README.md │ ├── ansible.cfg │ ├── playbook.yml │ └── plugins │ │ └── notify_send.py │ ├── filter │ ├── README.md │ ├── ansible.cfg │ ├── playbook.yml │ └── plugins │ │ └── rot13.py │ └── lookup │ ├── README.md │ ├── ansible.cfg │ ├── book.db │ ├── playbook.yml │ └── plugins │ └── shelvefile.py ├── intro ├── README.md └── deploy-nginx.yml └── requirements.txt /.gitignore: -------------------------------------------------------------------------------- 1 | *.sh 2 | *.pyc 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Embedding and Extending Ansible with Python 2 | 3 | Support material for the talk (code samples). The material is valid for Ansible v.1.9, probably won't fully work with v.2 as the Python API and plugins interface will be different. 4 | 5 | Slides can be found [here](https://slides.com/alejandroguiraorodriguez/ee-ansible-with-python). A video of the talk can be found [here](https://www.youtube.com/watch?v=qLoBHbVb0Fw). 6 | 7 | The Python dependencies can be installed running: 8 | 9 | ``` 10 | pip install -r requirements.txt 11 | ``` 12 | -------------------------------------------------------------------------------- /embedding/playbook/README.md: -------------------------------------------------------------------------------- 1 | # Automated installation script 2 | 3 | This example shows how to embed a call to an Ansible playbook. 4 | 5 | It consists on an interactive script that will ask you for your sudo password and a list of users to be created in the system and apt packages to be installed. Finally, it runs the playbook `installer.yml` supplying these values as inventory variables. 6 | 7 | In order to run it, type: 8 | 9 | ``` 10 | python installer.py 11 | ``` 12 | 13 | and follow the on-screen instructions. 14 | -------------------------------------------------------------------------------- /embedding/playbook/installer.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from getpass import getpass 3 | 4 | from ansible.playbook import PlayBook 5 | from ansible.inventory import Host, Inventory 6 | from ansible import callbacks 7 | from ansible import utils 8 | 9 | def run_installer(user_list, package_list, sudo_password): 10 | """ 11 | Runs the playbook `installer.yml` with the supplied parameters 12 | """ 13 | 14 | # Create the inventory 15 | controller = Host(name = "localhost") 16 | controller.set_variable('users', user_list) 17 | controller.set_variable('apt_packages', package_list) 18 | local_inventory = Inventory([]) 19 | local_inventory.get_group('all').add_host(controller) 20 | 21 | # Boilerplate for callbacks setup 22 | utils.VERBOSITY = 0 23 | # Output callbacks setup 24 | output_callbacks = callbacks.PlaybookCallbacks(verbose=utils.VERBOSITY) 25 | # API callbacks setup 26 | stats = callbacks.AggregateStats() 27 | api_callbacks = callbacks.PlaybookRunnerCallbacks(stats, verbose=utils.VERBOSITY) 28 | 29 | provision_playbook = PlayBook(playbook = "installer.yml", 30 | stats = stats, 31 | callbacks = output_callbacks, 32 | runner_callbacks = api_callbacks, 33 | inventory = local_inventory, 34 | transport = "local", 35 | become_pass = sudo_password 36 | ) 37 | playbook_result = provision_playbook.run() 38 | return playbook_result 39 | 40 | def get_selection_list(initial_prompt, input_prompt, continue_prompt): 41 | """ 42 | Return a selection list chosen according to a flow described by: 43 | - initial_prompt: To enter the selection menu 44 | - input_prompt: To enter an item 45 | - continue_prompt: To continue entering another item 46 | """ 47 | results = [] 48 | enter_selection = raw_input(initial_prompt) 49 | enter_selection = True if enter_selection in ["y", "Y", "yes"] else False 50 | if enter_selection: 51 | while True: 52 | current_result = raw_input(input_prompt) 53 | if not current_result: 54 | break 55 | results.append(current_result) 56 | continue_selection = raw_input(continue_prompt) 57 | continue_selection = True if continue_selection in ["y","Y","yes"] else False 58 | if not continue_selection: 59 | break 60 | return results 61 | 62 | 63 | if __name__ == '__main__': 64 | 65 | packages = [] 66 | 67 | print("") 68 | print("Automated installation script") 69 | print("=============================") 70 | print("") 71 | 72 | sudo_password = getpass("Enter sudo password:") 73 | 74 | users = get_selection_list( 75 | "Create users? (y/N)", 76 | "Enter username:", 77 | "Add more users? (y/N)" 78 | ) 79 | 80 | print("") 81 | 82 | packages = get_selection_list( 83 | "Install packages? (y/N)", 84 | "Enter package name:", 85 | "Add more packages? (y/N)" 86 | ) 87 | 88 | run_installer(user_list=users, package_list=packages, sudo_password=sudo_password) 89 | -------------------------------------------------------------------------------- /embedding/playbook/installer.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | sudo: yes 4 | tasks: 5 | - name: Create the users 6 | user: name={{ item }} 7 | with_items: "{{ users }}" 8 | 9 | - name: Install apt packages 10 | apt: name={{ item }} state=latest 11 | with_items: "{{ apt_packages }}" 12 | -------------------------------------------------------------------------------- /embedding/task/README.md: -------------------------------------------------------------------------------- 1 | # Flask facter 2 | 3 | This example shows how to embed a call to an Ansible module (equivalente to perform and ad-hoc task). It uses [FlaskRESTful](https://flask-restful.readthedocs.org/) to spin up a very simple REST api to get the Ansible facts of the machine. 4 | 5 | In order to test it, issue: 6 | 7 | ``` 8 | python flask_facter.py 9 | ``` 10 | 11 | And then, open a web browser and enter this url: [http://localhost:8000/facts/ansible_hostname](http://localhost:8000/facts/ansible_hostname). It should print your hostname. 12 | -------------------------------------------------------------------------------- /embedding/task/flask_facter.py: -------------------------------------------------------------------------------- 1 | from ansible.runner import Runner 2 | from ansible.inventory import Inventory 3 | from flask import Flask 4 | from flask_restful import Resource, Api 5 | 6 | class AnsibleFactResource(Resource): 7 | """ 8 | A read-only local ansible fact 9 | """ 10 | 11 | def __init__(self): 12 | self.facts = None 13 | Resource.__init__(self) 14 | 15 | def get_local_facts(self): 16 | """ 17 | Loads the Ansible local facts in self.facts 18 | Calls the Ansible Python API v1 'setup' module 19 | """ 20 | inventory = Inventory(["localhost"]) 21 | runner = Runner(module_name='setup', module_args='', 22 | pattern='localhost', inventory=inventory, 23 | transport="local") 24 | result = runner.run() 25 | self.facts = result["contacted"]["localhost"]["ansible_facts"] 26 | 27 | def get(self, fact_name): 28 | """ 29 | Returns a top-level fact (not nested) 30 | """ 31 | self.get_local_facts() 32 | try: 33 | return self.facts[fact_name] 34 | except KeyError: 35 | return "Not a valid fact: %s" % fact_name 36 | 37 | app = Flask(__name__) 38 | api = Api(app) 39 | api.add_resource(AnsibleFactResource, '/facts/') 40 | 41 | if __name__ == '__main__': 42 | app.run(debug=True, port=8000) 43 | -------------------------------------------------------------------------------- /extending/dynamic_inventory/README.md: -------------------------------------------------------------------------------- 1 | # Dynamic Inventory Script example: `shelve_inventory` 2 | 3 | This is an example of a dynamic inventory script for Ansible. The script reads the groups, hosts and vars information from a [shelve](https://docs.python.org/2/library/shelve.html) file. 4 | 5 | The shelve file path can be specified in the `defaults` section of the `shelve_inventory.ini`: 6 | 7 | ``` 8 | [defaults] 9 | shelvefile = inventory.db 10 | ``` 11 | 12 | The script `create_inventory.py` populates an example of shelve inventory. This will run a demo with this inventory: 13 | 14 | ``` 15 | ansible-playbook -v playbook.yml -i shelve_inventory.py -c local 16 | ``` 17 | -------------------------------------------------------------------------------- /extending/dynamic_inventory/create_inventory.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import shelve 4 | 5 | d = shelve.open("inventory.db") 6 | 7 | db_group = {} 8 | db_group['hosts'] = ["db1", "db2"] 9 | db_group['vars'] = {"db_username": "root"} 10 | 11 | web_group = {} 12 | web_group['hosts'] = ["web1", "web2", "web3"] 13 | 14 | production_group = {} 15 | production_group['hosts'] = ["web1", "db1"] 16 | 17 | hostvars = {} 18 | hostvars['web1'] = {"ansible_ssh_host": "localhost", "engine": "apache", "engine_version": 2} 19 | 20 | d['groups'] = {"databases": db_group, "web": web_group, "production": production_group} 21 | d['hostvars'] = hostvars 22 | d.close() 23 | -------------------------------------------------------------------------------- /extending/dynamic_inventory/inventory.db: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lekum/ee-ansible-with-python/49df43acf7bbdd7381d1c5e71e8189189d9a1d09/extending/dynamic_inventory/inventory.db -------------------------------------------------------------------------------- /extending/dynamic_inventory/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: web1 3 | tasks: 4 | - name: Print my host name 5 | debug: msg="Hi, my name is {{ ansible_hostname }}" 6 | 7 | - name: Print my webserver details 8 | debug: msg="I'm running {{ engine }} version {{ engine_version }}" 9 | -------------------------------------------------------------------------------- /extending/dynamic_inventory/shelve_inventory.ini: -------------------------------------------------------------------------------- 1 | [defaults] 2 | shelvefile = inventory.db 3 | -------------------------------------------------------------------------------- /extending/dynamic_inventory/shelve_inventory.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import argparse 4 | import json 5 | import sys 6 | import shelve 7 | import ConfigParser 8 | 9 | def parse_args(): 10 | parser = argparse.ArgumentParser(description="Shelve inventory script") 11 | group = parser.add_mutually_exclusive_group(required=True) 12 | group.add_argument('--list', action='store_true') 13 | group.add_argument('--host') 14 | return parser.parse_args() 15 | 16 | def get_shelve_groups(shelvefile): 17 | d = shelve.open(shelvefile) 18 | g = d["groups"] 19 | d.close() 20 | return g 21 | 22 | def get_shelve_host_details(shelvefile, host): 23 | d = shelve.open(shelvefile) 24 | h = d["hostvars"][host] 25 | d.close() 26 | return h 27 | 28 | def main(): 29 | 30 | config = ConfigParser.RawConfigParser() 31 | config.read('shelve_inventory.ini') 32 | shelvefile = config.get('defaults', 'shelvefile') 33 | 34 | args = parse_args() 35 | if args.list: 36 | groups = get_shelve_groups(shelvefile) 37 | json.dump(groups, sys.stdout) 38 | else: 39 | details = get_shelve_host_details(shelvefile, args.host) 40 | json.dump(details, sys.stdout) 41 | 42 | if __name__ == '__main__': 43 | main() 44 | -------------------------------------------------------------------------------- /extending/module/README.md: -------------------------------------------------------------------------------- 1 | # Ansible module example: `taiga_issue` 2 | 3 | This example shows the usage of the `taiga_issue` custom module. The module is included in the `./library` folder. 4 | 5 | In order to test it in you own Taiga.io hosted project, you need to: 6 | 7 | - Have the python pre-requisites installed: `pip install -r requirements.txt`. If you install `python-taiga` in a virtualenv and not globally, specify the path to the python interpreter of the virtualenv in a host variable of the host. For example, in an inventory file it could be: 8 | 9 | ``` 10 | localhost ansible_python_interpreter="~/.virtualenvs/ansible-taiga-issue/bin/python" ansible_connection=local 11 | ``` 12 | 13 | - Have credentials in environment variables. Authentication can be token-based or user/password based: 14 | - `TAIGA_TOKEN` 15 | - `TAIGA_USERNAME` and `TAIGA_PASSWORD` 16 | 17 | - Replace the `YOUR_PROJECT` placeholder in `playbook.yml` for the name of your Taiga.io project. 18 | 19 | Running the playbook: 20 | 21 | ``` 22 | ansible-playbook -v playbook.yml -i localhost, -c local 23 | ``` 24 | 25 | will create an issue, stop for up to a minute so that you can check it, and the continue and delete it. 26 | 27 | If you are using an inventory file (e.g. you have installed `python-taiga` in a virtualenv), specify the path to the inventory file using the `-i` option. 28 | -------------------------------------------------------------------------------- /extending/module/library/taiga_issue.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | 4 | # (c) 2015, Alejandro Guirao 5 | # 6 | # This file is part of Ansible. 7 | # 8 | # Ansible is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # Ansible is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with Ansible. If not, see . 20 | 21 | DOCUMENTATION = ''' 22 | --- 23 | module: taiga_issue 24 | short_description: Creates/deletes an issue in a Taiga Project Management Platform 25 | description: 26 | - Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)). 27 | - An issue is identified by the combination of project, issue subject and issue type. 28 | - This module implements the creation or deletion of issues (not the update). 29 | version_added: "2.0" 30 | options: 31 | taiga_host: 32 | description: 33 | - The hostname of the Taiga instance. 34 | required: False 35 | default: https://api.taiga.io 36 | project: 37 | description: 38 | - Name of the project containing the issue. Must exist previously. 39 | required: True 40 | subject: 41 | description: 42 | - The issue subject. 43 | required: True 44 | issue_type: 45 | description: 46 | - The issue type. Must exist previously. 47 | required: True 48 | priority: 49 | description: 50 | - The issue priority. Must exist previously. 51 | required: False 52 | default: Normal 53 | status: 54 | description: 55 | - The issue status. Must exist previously. 56 | required: False 57 | default: New 58 | severity: 59 | description: 60 | - The issue severity. Must exist previously. 61 | required: False 62 | default: Normal 63 | description: 64 | description: 65 | - The issue description. 66 | required: False 67 | default: "" 68 | attachment: 69 | description: 70 | - Path to a file to be attached to the issue. 71 | required: False 72 | default: None 73 | attachment_description: 74 | description: 75 | - A string describing the file to be attached to the issue. 76 | required: False 77 | default: "" 78 | tags: 79 | description: 80 | - A lists of tags to be assigned to the issue. 81 | required: False 82 | default: [] 83 | state: 84 | description: 85 | - Whether the issue should be present or not. 86 | required: False 87 | choices: ["present", "absent"] 88 | default: present 89 | author: Alejandro Guirao (@lekum) 90 | requirements: [python-taiga] 91 | notes: 92 | - The authentication is achieved either by the environment variable TAIGA_TOKEN or by the pair of environment variables TAIGA_USERNAME and TAIGA_PASSWORD 93 | ''' 94 | 95 | EXAMPLES = ''' 96 | # Create an issue in the my hosted Taiga environment and attach an error log 97 | - taiga_issue: 98 | taiga_host: https://mytaigahost.example.com 99 | project: myproject 100 | subject: An error has been found 101 | issue_type: Bug 102 | priority: High 103 | status: New 104 | severity: Important 105 | description: An error has been found. Please check the attached error log for details. 106 | attachment: /path/to/error.log 107 | attachment_description: Error log file 108 | tags: 109 | - Error 110 | - Needs manual check 111 | state: present 112 | 113 | # Deletes the previously created issue 114 | - taiga_issue: 115 | taiga_host: https://mytaigahost.example.com 116 | project: myproject 117 | subject: An error has been found 118 | issue_type: Bug 119 | state: absent 120 | ''' 121 | 122 | from os import getenv 123 | from os.path import isfile 124 | 125 | try: 126 | from taiga import TaigaAPI 127 | from taiga.exceptions import TaigaException 128 | TAIGA_MODULE_IMPORTED=True 129 | except ImportError: 130 | TAIGA_MODULE_IMPORTED=False 131 | 132 | def manage_issue(module, taiga_host, project_name, issue_subject, issue_priority, 133 | issue_status, issue_type, issue_severity, issue_description, 134 | issue_attachment, issue_attachment_description, 135 | issue_tags, state, check_mode=False): 136 | """ 137 | Method that creates/deletes issues depending whether they exist and the state desired 138 | 139 | The credentials should be passed via environment variables: 140 | - TAIGA_TOKEN 141 | - TAIGA_USERNAME and TAIGA_PASSWORD 142 | 143 | Returns a tuple with these elements: 144 | - A boolean representing the success of the operation 145 | - A descriptive message 146 | - A dict with the issue attributes, in case of issue creation, otherwise empty dict 147 | """ 148 | 149 | changed = False 150 | 151 | try: 152 | token = getenv('TAIGA_TOKEN') 153 | if token: 154 | api = TaigaAPI(host=taiga_host, token=token) 155 | else: 156 | api = TaigaAPI(host=taiga_host) 157 | username = getenv('TAIGA_USERNAME') 158 | password = getenv('TAIGA_PASSWORD') 159 | if not any([username, password]): 160 | return (False, changed, "Missing credentials", {}) 161 | api.auth(username=username, password=password) 162 | 163 | user_id = api.me().id 164 | project_list = filter(lambda x: x.name == project_name, api.projects.list(member=user_id)) 165 | if len(project_list) != 1: 166 | return (False, changed, "Unable to find project %s" % project_name, {}) 167 | project = project_list[0] 168 | project_id = project.id 169 | 170 | priority_list = filter(lambda x: x.name == issue_priority, api.priorities.list(project=project_id)) 171 | if len(priority_list) != 1: 172 | return (False, changed, "Unable to find issue priority %s for project %s" % (issue_priority, project_name), {}) 173 | priority_id = priority_list[0].id 174 | 175 | status_list = filter(lambda x: x.name == issue_status, api.issue_statuses.list(project=project_id)) 176 | if len(status_list) != 1: 177 | return (False, changed, "Unable to find issue status %s for project %s" % (issue_status, project_name), {}) 178 | status_id = status_list[0].id 179 | 180 | type_list = filter(lambda x: x.name == issue_type, project.list_issue_types()) 181 | if len(type_list) != 1: 182 | return (False, changed, "Unable to find issue type %s for project %s" % (issue_type, project_name), {}) 183 | type_id = type_list[0].id 184 | 185 | severity_list = filter(lambda x: x.name == issue_severity, project.list_severities()) 186 | if len(severity_list) != 1: 187 | return (False, changed, "Unable to find severity %s for project %s" % (issue_severity, project_name), {}) 188 | severity_id = severity_list[0].id 189 | 190 | issue = { 191 | "project": project_name, 192 | "subject": issue_subject, 193 | "priority": issue_priority, 194 | "status": issue_status, 195 | "type": issue_type, 196 | "severity": issue_severity, 197 | "description": issue_description, 198 | "tags": issue_tags, 199 | } 200 | 201 | # An issue is identified by the project_name, the issue_subject and the issue_type 202 | matching_issue_list = filter(lambda x: x.subject == issue_subject and x.type == type_id, project.list_issues()) 203 | matching_issue_list_len = len(matching_issue_list) 204 | 205 | if matching_issue_list_len == 0: 206 | # The issue does not exist in the project 207 | if state == "present": 208 | # This implies a change 209 | changed = True 210 | if not check_mode: 211 | # Create the issue 212 | new_issue = project.add_issue(issue_subject, priority_id, status_id, type_id, severity_id, tags=issue_tags, description=issue_description) 213 | if issue_attachment: 214 | new_issue.attach(issue_attachment, description=issue_attachment_description) 215 | issue["attachment"] = issue_attachment 216 | issue["attachment_description"] = issue_attachment_description 217 | return (True, changed, "Issue created", issue) 218 | 219 | else: 220 | # If does not exist, do nothing 221 | return (True, changed, "Issue does not exist", {}) 222 | 223 | elif matching_issue_list_len == 1: 224 | # The issue exists in the project 225 | if state == "absent": 226 | # This implies a change 227 | changed = True 228 | if not check_mode: 229 | # Delete the issue 230 | matching_issue_list[0].delete() 231 | return (True, changed, "Issue deleted", {}) 232 | 233 | else: 234 | # Do nothing 235 | return (True, changed, "Issue already exists", {}) 236 | 237 | else: 238 | # More than 1 matching issue 239 | return (False, changed, "More than one issue with subject %s in project %s" % (issue_subject, project_name), {}) 240 | 241 | except TaigaException: 242 | msg = "An exception happened: %s" % sys.exc_info()[1] 243 | return (False, changed, msg, {}) 244 | 245 | def main(): 246 | module = AnsibleModule( 247 | argument_spec=dict( 248 | taiga_host=dict(required=False, default="https://api.taiga.io"), 249 | project=dict(required=True), 250 | subject=dict(required=True), 251 | issue_type=dict(required=True), 252 | priority=dict(required=False, default="Normal"), 253 | status=dict(required=False, default="New"), 254 | severity=dict(required=False, default="Normal"), 255 | description=dict(required=False, default=""), 256 | attachment=dict(required=False, default=None), 257 | attachment_description=dict(required=False, default=""), 258 | tags=dict(required=False, default=[], type='list'), 259 | state=dict(required=False, choices=['present','absent'], default='present'), 260 | ), 261 | supports_check_mode=True 262 | ) 263 | 264 | if not TAIGA_MODULE_IMPORTED: 265 | msg = "This module needs python-taiga module" 266 | module.fail_json(msg=msg) 267 | 268 | taiga_host = module.params['taiga_host'] 269 | project_name = module.params['project'] 270 | issue_subject = module.params['subject'] 271 | issue_priority = module.params['priority'] 272 | issue_status = module.params['status'] 273 | issue_type = module.params['issue_type'] 274 | issue_severity = module.params['severity'] 275 | issue_description = module.params['description'] 276 | issue_attachment = module.params['attachment'] 277 | issue_attachment_description = module.params['attachment_description'] 278 | if issue_attachment: 279 | if not isfile(issue_attachment): 280 | msg = "%s is not a file" % issue_attachment 281 | module.fail_json(msg=msg) 282 | issue_tags = module.params['tags'] 283 | state = module.params['state'] 284 | 285 | return_status, changed, msg, issue_attr_dict = manage_issue( 286 | module, 287 | taiga_host, 288 | project_name, 289 | issue_subject, 290 | issue_priority, 291 | issue_status, 292 | issue_type, 293 | issue_severity, 294 | issue_description, 295 | issue_attachment, 296 | issue_attachment_description, 297 | issue_tags, 298 | state, 299 | check_mode=module.check_mode 300 | ) 301 | if return_status: 302 | if len(issue_attr_dict) > 0: 303 | module.exit_json(changed=changed, msg=msg, issue=issue_attr_dict) 304 | else: 305 | module.exit_json(changed=changed, msg=msg) 306 | else: 307 | module.fail_json(msg=msg) 308 | 309 | 310 | from ansible.module_utils.basic import * 311 | if __name__ == '__main__': 312 | main() 313 | -------------------------------------------------------------------------------- /extending/module/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | tasks: 4 | 5 | - name: Create a Taiga issue 6 | taiga_issue: 7 | project: YOUR_PROJECT 8 | subject: Bug report from {{ ansible_hostname }} 9 | issue_type: Bug 10 | priority: High 11 | status: New 12 | description: I'm running {{ ansible_distribution }}. I attach the logs 13 | attachment: playbook.yml 14 | attachment_description: This is the playbook 15 | tags: 16 | - ansible test 17 | - dummy 18 | state: present 19 | 20 | - name: Pause so that you can verify that the issue is open 21 | pause: minutes=1 22 | 23 | - name: Delete the Taiga issue 24 | taiga_issue: 25 | project: YOUR_PROJECT 26 | subject: Bug report from {{ ansible_hostname }} 27 | issue_type: Bug 28 | state: absent 29 | -------------------------------------------------------------------------------- /extending/module/requirements.txt: -------------------------------------------------------------------------------- 1 | ansible>=1.9,<=2.0 2 | python-taiga 3 | -------------------------------------------------------------------------------- /extending/plugin/callbacks/README.md: -------------------------------------------------------------------------------- 1 | # Ansible callback plugin example: `notify_send` 2 | 3 | This example shows the usage of a callback plugin. 4 | 5 | To test it, run: 6 | 7 | ``` 8 | ansible-playbook -v playbook.yml -i localhost, -c local 9 | ``` 10 | 11 | If you are using a system that supports [notify-send](https://developer.gnome.org/libnotify/) command, it should show you a notification with the playbook failure. 12 | -------------------------------------------------------------------------------- /extending/plugin/callbacks/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | callback_plugins = ./plugins 3 | -------------------------------------------------------------------------------- /extending/plugin/callbacks/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | tasks: 4 | - name: Debug message 5 | debug: msg="This task goes OK" 6 | 7 | - name: Fail miserably 8 | fail: msg="I'm so sorry :-(" 9 | -------------------------------------------------------------------------------- /extending/plugin/callbacks/plugins/notify_send.py: -------------------------------------------------------------------------------- 1 | from subprocess import call 2 | 3 | def notify_send(title, message, icon): 4 | call(["notify-send", title, message,"-i", icon]) 5 | 6 | class CallbackModule(object): 7 | 8 | def runner_on_failed(self, host, res, ignore_errors=False): 9 | template = "Host: {}\nModule: {}\nMessage: {}" 10 | notification = template.format( 11 | host, 12 | res.get('invocation').get('module_name'), 13 | res.get('msg') 14 | ) 15 | notify_send("ANSIBLE FAILURE", notification, "dialog-warning") 16 | -------------------------------------------------------------------------------- /extending/plugin/filter/README.md: -------------------------------------------------------------------------------- 1 | # Ansible filter plugin example: `rot13` 2 | 3 | This example shows the usage of a filter plugin. 4 | 5 | To test it, run: 6 | 7 | ``` 8 | ansible-playbook -v playbook.yml -i localhost, -c local 9 | ``` 10 | -------------------------------------------------------------------------------- /extending/plugin/filter/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | filter_plugins = ./plugins 3 | -------------------------------------------------------------------------------- /extending/plugin/filter/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | vars: 4 | roman_name: Caesar 5 | tasks: 6 | 7 | - name: Perform a rot13 8 | debug: msg="The word {{ roman_name }} becomes {{ roman_name | rot13 }}" 9 | 10 | - name: Perform another rot13 11 | debug: msg="And {{ roman_name | rot13 }} becomes {{ roman_name | rot13 | rot13 }}" 12 | -------------------------------------------------------------------------------- /extending/plugin/filter/plugins/rot13.py: -------------------------------------------------------------------------------- 1 | def rot13(s): 2 | def lookup(v): 3 | o, c = ord(v), v.lower() 4 | if 'a' <= c <= 'm': 5 | return chr(o + 13) 6 | if 'n' <= c <= 'z': 7 | return chr(o - 13) 8 | return v 9 | return ''.join(map(lookup, s)) 10 | 11 | class FilterModule(object): 12 | 13 | def filters(self): 14 | return { 15 | 'rot13': rot13 16 | } 17 | -------------------------------------------------------------------------------- /extending/plugin/lookup/README.md: -------------------------------------------------------------------------------- 1 | # Ansible lookup plugin example: `shelvefile` 2 | 3 | This example shows the usage of a lookup plugin. The plugin reads a key from a [shelve](https://docs.python.org/2/library/shelve.html#module-shelve) file. 4 | 5 | To test it, run: 6 | 7 | ``` 8 | ansible-playbook -v playbook.yml -i localhost, -c local 9 | ``` 10 | -------------------------------------------------------------------------------- /extending/plugin/lookup/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | lookup_plugins = ./plugins 3 | -------------------------------------------------------------------------------- /extending/plugin/lookup/book.db: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lekum/ee-ansible-with-python/49df43acf7bbdd7381d1c5e71e8189189d9a1d09/extending/plugin/lookup/book.db -------------------------------------------------------------------------------- /extending/plugin/lookup/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: localhost 3 | vars: 4 | book: "{{ lookup('shelvefile', 'file=book.db key=current_book_name') }}" 5 | page: "{{ lookup('shelvefile', 'file=book.db key=current_book_page') }}" 6 | author: "{{ lookup('shelvefile', 'file=book.db key=current_book_author') }}" 7 | 8 | tasks: 9 | - name: Print my current reading 10 | debug: msg="I'm on page {{ page }} of '{{ book }}' by {{ author }}" 11 | -------------------------------------------------------------------------------- /extending/plugin/lookup/plugins/shelvefile.py: -------------------------------------------------------------------------------- 1 | # (c) 2015, Alejandro Guirao 2 | # 3 | # This file is part of Ansible 4 | # 5 | # Ansible is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # Ansible is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with Ansible. If not, see . 17 | 18 | import shelve 19 | import os 20 | from ansible import utils, errors 21 | 22 | class LookupModule(object): 23 | 24 | def __init__(self, basedir=None, **kwargs): 25 | self.basedir = basedir 26 | 27 | def read_shelve(self, shelve_filename, key): 28 | """ 29 | Read the value of "key" from a shelve file 30 | """ 31 | d = shelve.open(shelve_filename) 32 | res = d.get(key, None) 33 | d.close() 34 | return res 35 | 36 | def run(self, terms, inject=None, **kwargs): 37 | 38 | terms = utils.listify_lookup_plugin_terms(terms, self.basedir, inject) 39 | ret = [] 40 | 41 | if not isinstance(terms, list): 42 | terms = [ terms ] 43 | 44 | for term in terms: 45 | playbook_path = None 46 | relative_path = None 47 | paramvals = {"file": None, "key": None} 48 | params = term.split() 49 | 50 | try: 51 | for param in params: 52 | name, value = param.split('=') 53 | assert(name in paramvals) 54 | paramvals[name] = value 55 | 56 | except (ValueError, AssertionError), e: 57 | # In case "file" or "key" are not present 58 | raise errors.AnsibleError(e) 59 | 60 | file = paramvals['file'] 61 | key = paramvals['key'] 62 | basedir_path = utils.path_dwim(self.basedir, file) 63 | 64 | # Search also in the role/files directory and in the playbook directory 65 | if '_original_file' in inject: 66 | relative_path = utils.path_dwim_relative(inject['_original_file'], 'files', file, self.basedir, check=False) 67 | if 'playbook_dir' in inject: 68 | playbook_path = os.path.join(inject['playbook_dir'], file) 69 | 70 | for path in (basedir_path, relative_path, playbook_path): 71 | if path and os.path.exists(path): 72 | res = self.read_shelve(path, key) 73 | if res is None: 74 | raise errors.AnsibleError("Key %s not found in shelve file %s" % (key, file)) 75 | # Convert the value read to string 76 | ret.append(str(res)) 77 | break 78 | else: 79 | raise errors.AnsibleError("Could not locate shelve file in lookup: %s" % file) 80 | 81 | return ret 82 | -------------------------------------------------------------------------------- /intro/README.md: -------------------------------------------------------------------------------- 1 | # Playbook example: `deploy-nginx.yml` 2 | 3 | This is an example of an Ansible playbook that will deploy `nginx` proxy to the hosts belonging to the group `web` defined in the inventory. It works for Ubuntu (it uses a ppa: to install nginx). 4 | -------------------------------------------------------------------------------- /intro/deploy-nginx.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - hosts: web 3 | sudo: yes 4 | vars: 5 | - external_port: 80 6 | - internal_port: 8000 7 | 8 | tasks: 9 | 10 | - name: Add the apt repository for nginx 11 | apt_repository: repo="ppa:nginx/stable" update_cache=yes 12 | 13 | - name: Install nginx 14 | apt: name=nginx state=present 15 | 16 | - name: Ensure that nginx is started 17 | service: name=nginx state=started 18 | 19 | - name: Remove default site 20 | file: path=/etc/nginx/sites-enabled/default state=absent 21 | notify: 22 | - Restart nginx 23 | 24 | - name: Configure a site 25 | template: src=templates/site.j2 dest=/etc/nginx/sites-available/site 26 | 27 | - name: Enable a site 28 | file: src=/etc/nginx/sites-available/site dest=/etc/nginx/sites-enabled/site state=link 29 | notify: 30 | - Restart nginx 31 | 32 | handlers: 33 | - name: Restart nginx 34 | service: name=nginx state=restarted 35 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Flask 2 | Flask-RESTful 3 | ansible>=1.9,<=2.0 4 | python-taiga 5 | --------------------------------------------------------------------------------