diff --git a/.github/workflows/yamllint.yml b/.github/workflows/yamllint.yml new file mode 100644 index 0000000..13ed65c --- /dev/null +++ b/.github/workflows/yamllint.yml @@ -0,0 +1,14 @@ +# YAML Lint triggered via GitHub Actions +# https://github.com/marketplace/actions/yamllint-github-action +--- +name: 'Yamllint' +on: [push, pull_request] +jobs: + build: + name: 'Yamllint' + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@main + - name: Perform yamllint + uses: karancode/yamllint-github-action@master diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ce1df86 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*.log +*.json +context +env.sh +ansible.cfg +.vagrant diff --git a/.yamllint.yml b/.yamllint.yml new file mode 100644 index 0000000..ec36047 --- /dev/null +++ b/.yamllint.yml @@ -0,0 +1,8 @@ +--- +# yamllint configuration +# https://yamllint.readthedocs.io/en/stable/configuration.html + +extends: default +rules: + line-length: false + new-line-at-end-of-file: false diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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 +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..253c3f4 --- /dev/null +++ b/Makefile @@ -0,0 +1,120 @@ +# Ansible Automation Platform - Makefile for Execution Environments + +# https://ario.cloud/posts/ansible-builder-ee +# https://earthly.dev/blog/docker-and-makefiles/ + +# Best practices for building images that pass Red Hat Container Certification +# https://developers.redhat.com/articles/2021/11/11/best-practices-building-images-pass-red-hat-container-certification +# Makefile Tutorial +# https://makefiletutorial.com/ + +# Update the tag each time you build a new image +TARGET_TAG ?= v5 + +# Default settings +CONTAINER_ENGINE ?= podman +VERBOSITY ?= 3 +SOURCE_HUB ?= registry.redhat.io +SOURCE_USERNAME ?= jwadleig +TARGET_HUB ?= quay.io +TARGET_USERNAME ?= jwadleig +TARGET_NAME ?= ansible-ee-minimal + +# IMPROVEMENTS ... +#TODO: Remove TARGET_USERNAME somehow? +#TODO: Test if galaxy tokens are valid/expired before building +#TODO: See about adding info (LABELS) to the released image on Quay.io (packages, ansible-core version, collections, python deps, etc) +#TODO: Raise error when "Warning" is shown from introspect command in build section +#TODO: Decide to include scanning of original container image from Red Hat +#curl -o `basename $IMAGE_NAME`.json https://quay.io/api/v1/repository/$IMAGE_NAME/manifest/$IMAGE_DIGEST/security?vulnerabilities=true +# Workaround using `--raw` to get digest https://github.com/containers/skopeo/issues/634 +# digest := $(shell (skopeo inspect --raw docker://$(BASE_IMAGE) | jq -r .manifests[].digest)) +# check: # Check base images for security vulnerabilities +# @echo "\n\n***************************** Checking... \n" +# skopeo login $(BASE_REGISTRY) +# echo $(digest) + +.PHONY : header clean lint check build scan test publish list shell +all: header clean lint build test publish + +header: + @echo "\n\n***************************** Ansible Automation Platform - Makefile for Execution Environments \n" + +clean: # Clean temporary files, folders and images + @echo "\n\n***************************** Cleaning... \n" + rm -rf context + rm -rf ansible-navigator.log + $(CONTAINER_ENGINE) image prune -a -f + +lint: # Lint the repository with yamllint + @echo "\n\n***************************** Linting... \n" + yamllint . + +build: # Build the execution environment image + @echo "\n\n***************************** Building... \n" + $(CONTAINER_ENGINE) login -u $(SOURCE_USERNAME) $(SOURCE_HUB) + if [ -a ansible.cfg ] ; \ + then \ + echo "Using existing ansible.cfg"; \ + else \ + envsubst < files/ansible.cfg.template > ./ansible.cfg; \ + fi; + if [ -a ansible-builder.log ] ; \ + then \ + cp ansible-builder.log ansible-builder.bak.log ; \ + fi; + ansible-builder introspect --sanitize --user-pip=files/requirements.txt --user-bindep=files/bindep.txt 2>&1 | tee ansible-builder.log + ansible-builder build \ + --tag $(TARGET_NAME):$(TARGET_TAG) \ + --verbosity $(VERBOSITY) \ + --container-runtime $(CONTAINER_ENGINE) 2>&1 | tee -a ansible-builder.log + +scan: # Scan image for vulnerabilities https://www.redhat.com/sysadmin/using-quayio-scanner + @echo "\n\n***************************** Scanning... \n" + echo "TODO:" + +inspect: # Inspect built image to show information + @echo "\n\n***************************** Inspecting... \n" + $(CONTAINER_ENGINE) inspect $(TARGET_NAME):$(TARGET_TAG) + +test: # Run the example playbook using the built container image + @echo "\n\n***************************** Testing... \n" + ansible-navigator run \ + files/playbook.yml \ + --container-engine $(CONTAINER_ENGINE) \ + --mode stdout \ + --execution-environment-image $(TARGET_NAME):$(TARGET_TAG) + + +publish: # Publish the image with proper tags to container registry + @echo "\n\n***************************** Publishing... \n" + $(CONTAINER_ENGINE) login -u $(TARGET_USERNAME) $(TARGET_HUB) + $(CONTAINER_ENGINE) tag \ + $(TARGET_NAME):$(TARGET_TAG) $(TARGET_NAME):latest + $(CONTAINER_ENGINE) tag \ + $(TARGET_NAME):$(TARGET_TAG) \ + $(TARGET_HUB)/$(TARGET_NAME):$(TARGET_TAG) + $(CONTAINER_ENGINE) push \ + $(TARGET_HUB)/$(TARGET_NAME):$(TARGET_TAG) + $(CONTAINER_ENGINE) pull \ + $(TARGET_HUB)/$(TARGET_NAME):$(TARGET_TAG) + $(CONTAINER_ENGINE) tag \ + $(TARGET_HUB)/$(TARGET_NAME):$(TARGET_TAG) \ + $(TARGET_HUB)/${TARGET_NAME}\:latest + $(CONTAINER_ENGINE) push \ + $(TARGET_HUB)/${TARGET_NAME}:latest + +info: # List information about the published container image + @echo "\n\n***************************** Image Layers ... \n" + $(CONTAINER_ENGINE) history --human $(TARGET_NAME):$(TARGET_TAG) + @echo "\n\n***************************** Ansible Version ... \n" + $(CONTAINER_ENGINE) container run -it --rm $(TARGET_NAME):$(TARGET_TAG) ansible --version + @echo "\n\n***************************** Ansible Collections ... \n" + $(CONTAINER_ENGINE) container run -it --rm $(TARGET_NAME):$(TARGET_TAG) ansible-galaxy collection list + @echo "\n\n***************************** Python Modules ... \n" + $(CONTAINER_ENGINE) container run -it --rm $(TARGET_NAME):$(TARGET_TAG) pip3 list --format freeze + @echo "\n\n***************************** System Packages ... \n" + $(CONTAINER_ENGINE) container run -it --rm $(TARGET_NAME):$(TARGET_TAG) rpm -qa + +shell: # Run an interactive shell in the execution environment + $(CONTAINER_ENGINE) run -it --rm $(TARGET_NAME):$(TARGET_TAG) /bin/bash diff --git a/README.md b/README.md new file mode 100644 index 0000000..83cbd64 --- /dev/null +++ b/README.md @@ -0,0 +1,380 @@ +# Ansible Execution Environments Demo + +Basic information to help you get familiar with Ansible Execution Environments and the latest Ansible Automation Platform. + +General information on [Ansible Controller](https://docs.ansible.com/automation-controller/latest/html/userguide/index.html) and the related [execution environments](https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html). + +## Quick Start + +- Navigate to build server +- Clone down this repository +- Customize + - Edit dependencies `requirements.yml`, `requirements.txt`, `bindep.txt` + - Update tokens + - Edit `execution-environment.yml` accordingly + - Edit `Makefile` +- Build it `make build` +- Publish it `make publish` +- Destroy Vagrant machine `vagrant destroy` +- Enjoy your day + +## Requirements + +### Build server + +This repository uses `vagrant` to spin up a RHEL server and then [provisions](files/provision.sh) it. + +```shell +# Start vagrant machine +vagrant up +# Connect to vagrant machine +vagrant ssh +# Prepare Ansible environment +source ~/ansible/bin/activate && cd /vagrant +``` + +### Tokens + +To access the Ansible content (collections) and build execution environments, you'll need to provide authentication using a token. This is configured within the `ansible.cfg` in the root folder. To generate this file, use the template [ansible.cfg.template](./files/ansible.cfg.template) which authenticates to both Automation Hub and Ansible Galaxy. This means we will always pull from Automation Hub first, but if not found we default to using Ansible Galaxy for content. + +First, set the following environment variables with the appropriate token strings. And then use the `envsubst` command to generate the necessary `ansible.cfg` file. + +```shell +# Automation Hub token https://console.redhat.com/ansible/automation-hub/token +export ANSIBLE_HUB_TOKEN= + +# Generate ansible.cfg file +envsubst < files/ansible.cfg.template > ./ansible.cfg +``` + +### Image registry + +Ensure you login to the registry of choice using podman/docker command `podman login ` + +Automation Hub Registry (hub.example.com): + +- Ensure docker/podman is authorized to access registry since Automation Hub uses self-signed certificates (see info at bottom of this article) +- Run the CLI login command `podman login hub.example.com:443` + +Quay Registry (quay.io): + +- Ensure you authorize docker/podman with this registry +- Go to https://quay.io/ and login or create an account +- Navigate to top-right for Account Settings +- Select the tool icon on the left +- Set the Docker/Podman CLI Password to enable encrypted passwords +- Generate the encryped password (re-enter the password) +- Select the option "Docker Login" or "Podman Login" to get the CLI command +- Run the CLI login command to have docker/podman authorized to pull/push images + +Red Hat Registry (registry.redhat.io): + +- Ensure you perform `docker login` command to authorize with this registry. +- Go to https://access.redhat.com/terms-based-registry/ and create a registry service account (if not already created) +- Drill down on existing service account +- Select the tab "Docker Login" to get the CLI command for both docker/podman +- Run the CLI login command to have docker/podman authorized to pull/push images +- [Troubleshooting Authentication Issues with registry.redhat.io](https://access.redhat.com/articles/3560571) + +Docker Hub (hub.docker.com): + +- Create a free account on the website +- Login to the website +- Run the CLI login command `docker login` with your credentials + +## Pull the Image + +Now that you have authenticated with a registry, you can pull down images from that registry. For example, you might want to pull down the Ansible base images. You can find official Ansible container images using `https://catalog.redhat.com/software/containers/search`. + +```bash +# Pull base images for Ansible from registry.redhat.io +podman pull registry.redhat.io/ansible-automation-platform-24/ee-29-rhel8:latest +podman pull registry.redhat.io/ansible-automation-platform-24/ee-minimal-rhel8:latest +podman pull registry.redhat.io/ansible-automation-platform-24/ee-supported-rhel8:latest + +# Pull images from hub.docker.com +podman login hub.docker.com +podman pull hello-world +podman run hello-world +``` + +## Build the Image + +Ansible playbooks will be executed from a container image. We define our "golden" image using a build definition file named `execution-environment.yml`. +The image is built using that template file and running the `ansible-builder` tool. + +Let's first define our execution environment using yaml. [Here is an example file from this repository](./execution-environment.yml). + +Now let's run `ansible-builder` to create the image based on our template. Note that Podman is used by default to build images but we will use Docker instead. Also the default name and tag for the container image being built is `ansible-execution-env:latest` but it's highly recommended that you avoid using "latest" and set your own tag/version using the `--tag` argument. + +```yaml +# Set tokens using environment variables +export ANSIBLE_HUB_TOKEN="token_value" + +# Generate ansible.cfg using template +envsubst < files/ansible.cfg.template > ./ansible.cfg + +# Test tokens +mkdir collections +ansible-galaxy collection download -r requirements.yml -p collections/ +rm -rf collections + +# Build the image and tag the image +ansible-builder build --verbosity 3 --container-runtime=podman --tag ansible-ee:5.0 +# List images +$ podman image list +REPOSITORY TAG IMAGE ID CREATED SIZE +ansible-ee 5.0 9fec21fe39be 2 hours ago 987MB +``` + +## Scan the Image + +It's important to scan your image for vulnerabilities. Below are a couple articles showing how to do that. The recommendation is to implement this inside the [Makefile](./Makefile) in this repository so you can run it easily as part of your pipeline. + +- [Using Snyk and Podman to scan container images from development to deployment](https://www.redhat.com/en/blog/using-snyk-and-podman-scan-container-images-development-deployment) +- [DevSecOps: Image scanning in your pipelines using quay.io scanner](https://www.redhat.com/sysadmin/using-quayio-scanner) + +## Test the Image + +We can test that everything is working by running an Ansible Playbook in the image using `ansible-navigator`. The tool launches the container, runs the playbook and shows an interactive screen where you can watch the playbook run through. To quit the tool, use similar mechanism `:q!` like within a `vi` editor. + +```shell +# Run playbook to test basic operations against new image +ansible-navigator run playbook.yml --container-engine podman --execution-environment-image ansible-ee:5.0 + +# Check configuration of new image +ansible-navigator config --container-engine podman --execution-environment-image ansible-ee:5.0 +``` + +## Publish the Image + +Once you have built the image locally, tested it, and scanned it for security issues - you are now ready to publish the image to a registry of choice. + +```bash +# Example using quay.io +podman login quay.io +podman tag ansible-ee:5.0 quay.io/jwadleig/ansible-ee:5.0 +podman push quay.io/jwadleig/ansible-ee:5.0 + +# Example using onprem Automation Hub +podman login hub.example.com:443 +podman tag ansible-ee:6.0 hub.example.com:443/ansible-ee +podman push hub.example.com:443/ansible-ee --remove-signatures +``` + +## Tips and Tricks + +Building: + +- [How to build multi-architecture container images](https://developers.redhat.com/articles/2023/11/03/how-build-multi-architecture-container-images) + +Migration of Python Virtual Environments: + +- [Redhat Communities of Practice Execution Environment Utilities Collection](https://github.com/redhat-cop/ee_utilities) + +Ansible Collection issues: + +- Search for Ansible Collections and versions using these links: + - [Ansible Automation Platform Certified and Validated Content](https://access.redhat.com/support/articles/ansible-automation-platform-certified-content) + - [Red Hat Automation Hub - Ansible Collections](https://console.redhat.com/ansible/automation-hub) + - [Ansible Galaxy - Search](https://galaxy.ansible.com/search?) +- Issue and resolution when using `kebernetes.core` that requires `openshift-clients` package: + - [How to install the 'openshift-clients' package in Openshift Custom Execution Environment?](https://access.redhat.com/solutions/6985157) + - [Installing the OpenShift CLI by using an RPM](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli-rpm_cli-developer-commands) + - [How to download rpm packages manually from the Customer Portal?](https://access.redhat.com/solutions/6996) + - Another workaround is using the `openshift-clients` package rpm that exists inside the AAP bundle tarball + +Python dependency issues: + +- Install [johnnydep](https://pypi.org/project/johnnydep/) inside your current venv and leverage the tool to check various dependencies for python modules that might be causing issues. For example `johnnydep requests`. + +Image building and customization: + +- [Best practices for building images that pass Red Hat Container Certification](https://developers.redhat.com/articles/2021/11/11/best-practices-building-images-pass-red-hat-container-certification#) + +Pipelines: + +- [How to Build Ansible Execution Environments with OpenShift Pipelines](https://cloud.redhat.com/blog/how-to-build-ansible-execution-environments-with-openshift-pipelines) + +Ansible Navigator: + +- Default execution environment that ansible-navigator uses when not specified: [quay.io/ansible/creator-ee](https://github.com/ansible/creator-ee) +- Examine execution environment using ansible-navigator: `ansible-navigator --eei ` +- Extract list of collections from existing execution environment: `ansible-navigator --eei collections --mode stdout` +- Use Credentials within `ansible-navigator` tool: + - [How Do I Use Ansible Tower's Credential Parameters (Machine, Network, Cloud) in my Playbook?](https://access.redhat.com/solutions/3332591) + - Mount the file(s) using `--eev` parameter on ansible-navigator: `--eev --execution-environment-volume-mounts Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)` +- How to run `--syntax-check` using `ansible-navigator`: + +```shell +ansible-navigator run --syntax-check --mode stdout` +``` + +- Start shell session inside container image: + +```shell +podman run -it registry.redhat.io/ansible-automation-platform-24/ee-minimal-rhel9:latest /bin/bash +``` + +- Run adhoc commands inside image: + +```shell +podman run --rm +``` + +- Change the yum and pip repositories within the base images: + +```shell +# Create yum repository file locally +cat > ubi.repo < pip.conf < + +#Then push the containers +podman push quay.io/username/myimage +``` + +- Search for images + +The following example searches for images and then checks collections, system packages and python packages manually before we run the ansible-builder command. + +```shell +# Login to vagrant build server +vagrant ssh +source ~/ansible/bin/activate +cd /vagrant + +# Login to registry +podman login registry.redhat.io +# Search registry to find latest images +# https://docs.podman.io/en/stable/markdown/podman-search.1.html +podman search ansible-automation-platform-24 + +# Pull image and start container +podman run -it --rm registry.redhat.io/ansible-automation-platform-24/ee-minimal-rhel9:latest /bin/bash + +# Check dependencies for collections +ansible-galaxy collection install -r requirements.yml +cd /home/runner/.ansible/collections/ansible_collections/ +grep -R python39 * | grep bindep.txt +grep -R suds * +# Look at potential newer versions of the collections +ansible-galaxy collection install --upgrade -r requirements.yml + +# Install windows packages +microdnf install krb5-libs krb5-workstation krb5-devel +# Install Python 3.8 developer tools +microdnf install vi git rsync unzip tar sudo gcc openssl openssl-devel gcc-c++ dnf libpq-devel python38-devel glibc-headers libcurl-devel libssh-devel jq python3-Cython python3-devel openldap-devel +# Install Python 3.9 developer tools +microdnf install vi git rsync unzip tar sudo gcc openssl openssl-devel gcc-c++ dnf libpq-devel python39-devel glibc-headers libcurl-devel libssh-devel jq python3-Cython python3-devel openldap-devel +# Test the installation of required python libraries +pip3 install -r requirements.txt +``` + +## Tools + +ansible-builder: + +- [Introduction to Ansible Builder](https://www.ansible.com/blog/introduction-to-ansible-builder) +- [Ansible Builder - Guide](https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.1/html/ansible_builder_guide/assembly-using-builder) +- [Ansible Builder - Read The Docs](https://ansible-builder.readthedocs.io/en/latest/index.html) +- [Ansible Builder - Source Code](https://github.com/ansible/ansible-builder) +- [Ansible Builder - Releases](https://github.com/ansible/ansible-builder/releases) + +ansible-navigator: + +- [Ansible Navigator Documentation](https://ansible.readthedocs.io/projects/navigator/) +- [Ansible Navigator Creator Guide](https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/automation_content_navigator_creator_guide/index) +- [Introduction to Ansible Runner](https://ansible-runner.readthedocs.io/en/stable/intro/) +- [Ansible Navigator - Source Code](https://github.com/ansible/ansible-navigator/) +- [Ansible Navigator - Settings](https://github.com/ansible/ansible-navigator/blob/main/docs/settings.rst) + +ansible-bender: + +[ansible-bender](https://github.com/ansible-community/ansible-bender) is a tool which bends containers using Ansible playbooks and turns them into container images. It has a pluggable builder selection — it is up to you to pick the tool which will be used to construct your container image. Right now the only supported builder is buildah. More to come in the future. Ansible-bender (ab) relies on Ansible connection plugins for performing builds. + +buildah: + +[buildah](https://github.com/containers/buildah) is a tool that facilitates building Open Container Initiative (OCI) container images. The Buildah package provides a command line tool that can be used to: + +- create a working container, either from scratch or using an image as a starting point +- create an image, either from a working container or via the instructions in a Dockerfile +- images can be built in either the OCI image format or the traditional upstream docker image format +- mount a working container's root filesystem for manipulation +- unmount a working container's root filesystem +- use the updated contents of a container's root filesystem as a filesystem layer to create a new image +- delete a working container or an image +- rename a local container + +podman: + +- [Installation](https://podman.io/getting-started/installation) +- [How to set debug logging from podman?](https://access.redhat.com/solutions/3947441) +- Debugging: `podman pull --log-level debug ` + +skopeo: + +- [skopeo](https://github.com/containers/skopeo) + +## References + +General: + +- [microdnf showing ibrhsm-WARNING ** and Found 0 entitlement certificates](https://access.redhat.com/solutions/4643601) +- [Container Quickstarts by Red Hat's Community of Practice](https://github.com/redhat-cop/containers-quickstarts). This repository is meant to help bootstrap users of the OpenShift Container Platform to get started in building and using Source-to-Image to build applications to run in OpenShift. +- [Best Practices for successful DevSecOps](https://developers.redhat.com/articles/2022/06/15/best-practices-successful-devsecops) +- [What are image layers?](https://stackoverflow.com/a/51660942) +- [Best Practices for Writing Dockerfiles](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) +- [5 Podman features to try now](https://www.redhat.com/sysadmin/podman-features-1) +- [Working with Red Hat Enterprise Linux Universal Base Images (UBI)](https://developers.redhat.com/blog/2019/05/31/working-with-red-hat-enterprise-linux-universal-base-images-ubi#) +- [Running Virtual Machines Under Vagrant on the New Mac M1/M2/M3](https://betterprogramming.pub/managing-virtual-machines-under-vagrant-on-a-mac-m1-aebc650bc12c) + +Execution Environments: + +- [What are Red Hat Ansible Automation Platform automation execution environments?](https://www.redhat.com/en/technologies/management/ansible/automation-execution-environments) +- [AWX - Execution Environments and using awx-manage](https://github.com/ansible/awx/blob/devel/docs/execution_environments.md) +- [Blog - The Anatomy of Automation Execution Environments](https://www.ansible.com/blog/the-anatomy-of-automation-execution-environments) +- [Automation Controller - Execution Environments](https://docs.ansible.com/automation-controller/latest/html/userguide/execution_environments.html) +- [Execution Environment Setup Reference](https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html#execution-environment-setup-reference) + +Makefiles: + +- [Docker and Makefiles: Building and Pushing Images with Make](https://earthly.dev/blog/docker-and-makefiles/) + +## License + +[GNU General Public License v3.0](LICENSE) + +## Author + +John Wadleigh diff --git a/Vagrantfile.rhel b/Vagrantfile.rhel new file mode 100644 index 0000000..b55bc9f --- /dev/null +++ b/Vagrantfile.rhel @@ -0,0 +1,79 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +# All Vagrant configuration is done below. The "2" in Vagrant.configure +# configures the configuration version (we support older styles for +# backwards compatibility). Please don't change it unless you know what +# you're doing. +Vagrant.configure("2") do |config| + # The most common configuration options are documented and commented below. + # For a complete reference, please see the online documentation at + # https://docs.vagrantup.com. + + # Every Vagrant development environment requires a box. You can search for + # boxes at https://vagrantcloud.com/search. + config.vm.box = "sparktype/rhel9-arm64" + + # Disable automatic box update checking. If you disable this, then + # boxes will only be checked for updates when the user runs + # `vagrant box outdated`. This is not recommended. + # config.vm.box_check_update = false + + # Create a forwarded port mapping which allows access to a specific port + # within the machine from a port on the host machine. In the example below, + # accessing "localhost:8080" will access port 80 on the guest machine. + # NOTE: This will enable public access to the opened port + # config.vm.network "forwarded_port", guest: 80, host: 8080 + + # Create a forwarded port mapping which allows access to a specific port + # within the machine from a port on the host machine and only allow access + # via 127.0.0.1 to disable public access + # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1" + + # Create a private network, which allows host-only access to the machine + # using a specific IP. + # config.vm.network "private_network", ip: "192.168.33.10" + + # Create a public network, which generally matched to bridged network. + # Bridged networks make the machine appear as another physical device on + # your network. + # config.vm.network "public_network" + + # Share an additional folder to the guest VM. The first argument is + # the path on the host to the actual folder. The second argument is + # the path on the guest to mount the folder. And the optional third + # argument is a set of non-required options. + # config.vm.synced_folder "../data", "/vagrant_data" + config.vm.synced_folder ".", "/vagrant" + config.vm.provision "shell", privileged: false, path: "files/provision.sh" + + # Disable the default share of the current code directory. Doing this + # provides improved isolation between the vagrant box and your host + # by making sure your Vagrantfile isn't accessable to the vagrant box. + # If you use this you may want to enable additional shared subfolders as + # shown above. + # config.vm.synced_folder ".", "/vagrant", disabled: true + + # Provider-specific configuration so you can fine-tune various + # backing providers for Vagrant. These expose provider-specific options. + # Example for VirtualBox: + # + # config.vm.provider "virtualbox" do |vb| + # # Display the VirtualBox GUI when booting the machine + # vb.gui = true + # + # # Customize the amount of memory on the VM: + # vb.memory = "1024" + # end + # + # View the documentation for the provider you are using for more + # information on available options. + + # Enable provisioning with a shell script. Additional provisioners such as + # Ansible, Chef, Docker, Puppet and Salt are also available. Please see the + # documentation for more information about their specific syntax and use. + # config.vm.provision "shell", inline: <<-SHELL + # apt-get update + # apt-get install -y apache2 + # SHELL +end diff --git a/ansible-navigator.yml b/ansible-navigator.yml new file mode 100644 index 0000000..ee6e539 --- /dev/null +++ b/ansible-navigator.yml @@ -0,0 +1,48 @@ +--- +ansible-navigator: +# ansible: +# config: /tmp/ansible.cfg +# app: run +# collection-doc-cache-path: /tmp/cache.db +# cmdline: "--forks 15" +# editor: +# command: vim_from_setting +# console: False +# documentation: +# plugin: +# name: shell +# type: become + execution-environment: + container-engine: podman +# environment-variables: +# pass: +# - ONE +# - TWO +# - THREE +# set: +# KEY1: VALUE1 +# KEY2: VALUE2 +# KEY3: VALUE3 +# image: test_image:latest +# pull-policy: never +# help-config: True +# help-doc: True +# help-inventory: True +# help-playbook: False +# inventories: +# - /tmp/test_inventory.yml +# inventory-columns: +# - ansible_network_os +# - ansible_network_cli_ssh_type +# - ansible_connection + logging: +# append: False + level: critical +# file: /tmp/log.txt +# mode: stdout +# osc4: False +# playbook: /tmp/test_playbook.yml + playbook-artifact: + enable: False +# replay: /tmp/test_artifact.json +# save-as: /tmp/test_artifact.json diff --git a/execution-environment.yml b/execution-environment.yml new file mode 100644 index 0000000..3c91e1d --- /dev/null +++ b/execution-environment.yml @@ -0,0 +1,72 @@ +--- +version: 3 + +build_arg_defaults: + ANSIBLE_GALAXY_CLI_COLLECTION_OPTS: '--ignore-certs' + +dependencies: + galaxy: files/requirements.yml + python: files/requirements.txt + system: files/bindep.txt + +images: + base_image: + name: 'registry.redhat.io/ansible-automation-platform-24/ee-minimal-rhel9:latest' + +options: + package_manager_path: /usr/bin/microdnf + +additional_build_files: + # Windows Authentication - Kerberos + - src: files/krb5.conf + dest: configs + # Ansible Galaxy + - src: ansible.cfg + dest: configs + +additional_build_steps: + prepend_base: + - RUN whoami + - RUN cat /etc/os-release + - RUN echo PKGMGR = $PKGMGR, PYCMD = $PYCMD + + # Upgrade pip to use improved dependency resolver + - RUN $PYCMD -m pip install --upgrade pip + + # Install Red Hat OpenShift client tools by enabling repo (prepare with manual steps below) + # https://access.redhat.com/solutions/6985157 + # https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli-rpm_cli-developer-commands + # subscription-manager attach --pool=`subscription-manager list --available --matches '*OpenShift*' | grep "Pool ID" | awk '{print $3}'` + # subscription-manager repos --list | grep rhocp-4.14 + # (not needed) subscription-manager repos --enable="rhocp-4.12-for-rhel-9-x86_64-rpms" + - ENV PKGMGR_OPTS "--nodocs --setopt install_weak_deps=0 --enablerepo=rhocp-4.14-for-rhel-9-aarch64-rpms" + + # Install Microsoft azure-cli command line tool (needs dnf to install from url) + # https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=dnf + - > + RUN $PKGMGR install -y dnf && + rpm --import https://packages.microsoft.com/keys/microsoft.asc && + dnf -y install -y https://packages.microsoft.com/config/rhel/9.0/packages-microsoft-prod.rpm && + $PKGMGR -y install azure-cli + # Install HashiCorp Packer (/usr/bin/packer) + - > + RUN curl https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo --output /etc/yum.repos.d/hashicorp.repo && + $PKGMGR -y install packer + # Install Red Hat open-scap command line tool to run security scans on target systems and generate reports + - RUN $PKGMGR -y install openscap-scanner + prepend_galaxy: + # Windows Authentication - Kerberos + - COPY _build/configs/krb5.conf /etc/krb5.conf + # Ansible Galaxy + - COPY _build/configs/ansible.cfg /etc/ansible/ansible.cfg + append_final: + # Verify installed packages have compatible dependencies + # Logged issue https://github.com/ansible/ansible-builder/issues/416 + - RUN pip3 check + # Clean up + - > + RUN $PKGMGR update -y && + $PKGMGR clean all && + rm -rf /var/cache/{dnf,yum} && + rm -rf /var/lib/dnf/history.* && + rm -rf /var/log/* diff --git a/files/ansible.cfg.template b/files/ansible.cfg.template new file mode 100644 index 0000000..aebb6e1 --- /dev/null +++ b/files/ansible.cfg.template @@ -0,0 +1,31 @@ +[galaxy] +server_list = rh-certified, validated, community + + +# ACCESSING PRIVATE AUTOMATION HUB +# ------------------------------------------------------------------------------ +[galaxy_server.rh-certified] +url=https://gateway.example.com/pulp_ansible/galaxy/rh-certified/ +token=$ANSIBLE_HUB_TOKEN + +[galaxy_server.validated] +url=https://gateway.example.com/pulp_ansible/galaxy/validated/ +token=$ANSIBLE_HUB_TOKEN + +[galaxy_server.community] +url=https://gateway.example.com/pulp_ansible/galaxy/community/ +token=$ANSIBLE_HUB_TOKEN + + + +# ACCESSING REDHAT CONSOLE +# ------------------------------------------------------------------------------ +[galaxy_server.automation_hub] +url=https://console.redhat.com/api/automation-hub/content/published/ +auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token +# Get the token from https://console.redhat.com/ansible/automation-hub/token/ and use envsubst tool +token=$ANSIBLE_HUB_TOKEN + +[galaxy_server.community] +url=https://galaxy.ansible.com + diff --git a/files/bindep.txt b/files/bindep.txt new file mode 100644 index 0000000..5692065 --- /dev/null +++ b/files/bindep.txt @@ -0,0 +1,37 @@ +# System binary dependencies + +# System packages you want to include into the image. +# Packages are pulled from ubi repositories https://access.redhat.com/articles/4238681 +# Examples are zip, dnf, and other tools +# https://docs.opendev.org/opendev/bindep/latest/readme.html#writing-requirements-files +# This is a cross-platform list tracking distribution packages needed by tests; +# see https://docs.openstack.org/infra/bindep/ for additional information. + +# WORKAROUND: Error message occurs with `install-from-bindep` script but does not raise error +# /output/install-from-bindep: line 28: [: too many arguments +# https://github.com/ansible/python-builder-image/issues/48 + +dnf [platform:rpm] +git [platform:rpm] +jq [platform:rpm] +rsync [platform:rpm] +unzip [platform:rpm] +tar [platform:rpm] +sudo [platform:rpm] + +# Windows Authentication - Kerberos +# https://docs.ansible.com/automation-controller/latest/html/administration/kerberos_auth.html +krb5-libs [platform:rpm] +krb5-workstation [platform:rpm] +krb5-devel [platform:rpm] + +# Dependencies for pycurl and python-ldap +libcurl-devel [platform:rpm] +curl-devel [platform:rpm] +openssl-devel [platform:rpm] +openldap-devel [platform:rpm] + +# Dependency for supporting pip packages that need to be compiled +# This avoids errors that complain about python header files missing +# 1/19/2024 package is not found when building on arm64 rhel machine! +#python39-devel [platform:rpm] diff --git a/files/krb5.conf b/files/krb5.conf new file mode 100644 index 0000000..e69de29 diff --git a/files/playbook.yml b/files/playbook.yml new file mode 100644 index 0000000..2b71ae8 --- /dev/null +++ b/files/playbook.yml @@ -0,0 +1,10 @@ +--- +- name: Test Execution Environment + hosts: localhost + connection: local + gather_facts: false + + tasks: + - name: Ensure basic operations + ansible.builtin.debug: + msg: "TODO: Add functional testing here" diff --git a/files/provision.sh b/files/provision.sh new file mode 100644 index 0000000..1301340 --- /dev/null +++ b/files/provision.sh @@ -0,0 +1,31 @@ +# Assuming system is already registered and content attached +# https://access.redhat.com/solutions/5524661 +# subscription-manager register +# subscription-manager attach --auto + +whoami + +# Install required packages +sudo dnf install -y podman skopeo \ + python3-pip vi git jq \ + rsync unzip tar sudo \ + gcc gcc-c++ \ + openssl openssl-devel \ + libpq-devel glibc-headers \ + libcurl-devel libssh-devel \ + python3-devel openldap-devel + +# Prepare git configuration +sudo git config --global --add safe.directory /vagrant + +# Prepare for ansible-navigator on ARM64 +sudo subscription-manager repos --enable codeready-builder-for-rhel-9-aarch64-rpms +sudo dnf install -y oniguruma-devel + +# Prepare python virtual environment +python3 -m pip install --upgrade pip +python3 -m pip install virtualenv +python3 -m venv ansible +source ansible/bin/activate && \ + pip install --upgrade pip && \ + pip install ansible-navigator[ansible-core] ansible-core envsubst diff --git a/files/requirements.txt b/files/requirements.txt new file mode 100644 index 0000000..75e2c18 --- /dev/null +++ b/files/requirements.txt @@ -0,0 +1,19 @@ +# Python dependencies for Ansible Modules/Roles/Collections + +# Reference ansible collections to know what python packages you need +# Only declare python modules that are outside of the `requirements.txt` that +# already exists in the collection repo. That requirements.txt will be automatically +# picked up and installed within the image. For example: +# Azure Collection python dependencies [requirements.txt] +# https://github.com/ansible-collections/azure/blob/v1.12.0/requirements-azure.txt +# NOTE: ansible-builder removes 'ansible' from requirements.txt so we can't put it here +# https://github.com/ansible/ansible-builder/issues/323 + +# Reporting - ARA plugin: https://ara.recordsansible.org/blog/2021/12/23/recording-ansible-playbooks-from-awx-with-ara/ +ara + +# Windows automation - connectivity requirements https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html#what-is-winrm +pywinrm>=0.3.0 + +# Database automation - Mongo requirements +#pymongo diff --git a/files/requirements.yml b/files/requirements.yml new file mode 100644 index 0000000..b9b8b6d --- /dev/null +++ b/files/requirements.yml @@ -0,0 +1,141 @@ +--- +# Ansible dependencies +# Pull down ansible roles and collections required by your playbooks +# Navigate to https://console.redhat.com/ansible/automation-hub for certified content +# Complete list of certified collections: https://access.redhat.com/articles/3642632 + +# Cerified Ansible Collection Content +# https://access.redhat.com/support/articles/ansible-automation-platform-certified-content + +collections: + # Ansible Automation Platform + # ------------------------------------------------------------------- + - name: redhat_cop.aap_utilities # requires ansible-posix and kubernetes-core collections + version: 2.2.4 + - name: redhat_cop.ah_configuration + version: 1.1.1 + - name: redhat_cop.controller_configuration + version: 2.3.1 + # - name: ansible.scm # git_publish, git_retrieve modules https://github.com/ansible-collections/ansible.scm + # version: v1.1.0 + + # Platforms + # ------------------------------------------------------------------- + - name: amazon.aws + version: 5.4.0 + - name: azure.azcollection + version: 1.16.0 + - name: community.vmware + version: 3.8.0 + - name: vmware.vmware_rest + version: 2.3.1 + - name: kubernetes.core # requires openshift-clients package using rhel server + version: 2.4.0 + - name: redhat.openshift # certified collection + version: 2.3.0 + + # Virtualization + # ------------------------------------------------------------------- + # oVirt Ansible Collection https://github.com/ovirt/ovirt-ansible-collection + #- name: redhat.rhv # requires building from rhel server to install dependencies + # version: 1.4.4 + + # https://opendev.org/openstack/ansible-collections-openstack + # https://storyboard.openstack.org/#!/dashboard/stories + # Issue with bindep.txt https://storyboard.openstack.org/#!/story/2010889 + - name: openstack.cloud + + # Server Management + # ------------------------------------------------------------------- + - name: community.general + version: 7.2.1 + - name: community.windows + version: 2.0.0 + - name: ansible.windows # certified collection + version: 2.0.0 + - name: ansible.utils + version: 2.10.3 + + # Network Automation + # ------------------------------------------------------------------- + # Ansible Network Automation common content https://galaxy.ansible.com/ansible/netcommon + - name: ansible.netcommon + version: 5.1.2 + # Ansible Network Automation community modules https://galaxy.ansible.com/community/network + - name: community.network + version: 5.0.0 + # Ansible Collection targeting POSIX and POSIX-ish platforms. + - name: ansible.posix + version: 1.5.4 + + - name: cisco.asa + version: 2.1.0 + - name: cisco.ios + version: 2.5.0 + - name: cisco.iosxr + version: 2.5.0 + - name: cisco.nxos + version: 2.7.1 + + # Infoblox NIOS https://galaxy.ansible.com/infoblox/nios_modules + - name: infoblox.nios_modules + version: 1.5.0 + #- name: f5networks.f5_bigip + # version: 3.1.0 + #- name: f5networks.f5_modules + # version: 1.25.1 + #- name: paloaltonetworks.panos + # version: 2.17.3 + + # Open vSwitch https://galaxy.ansible.com/openvswitch/openvswitch + #- name: openvswitch.openvswitch + # version: 2.1.1 + # Netbox network modeling https://galaxy.ansible.com/netbox/netbox + # - name: netbox.netbox + # version: 3.13.0 + + # Monitoring + # ------------------------------------------------------------------- + # - name: dynatrace_innovationlab.dynatrace_collection + # version: 1.0.6 + + # Security Automation + # ------------------------------------------------------------------- + # The Ansible ansible.security collection is a meta collection that install all the following security supported content collections. + # - ansible.netcommon + # - ansible.utils + # - cisco.asa + # - ibm.qradar + # - splunk.es + # - trendmicro.deepsec + #- name: ansible.security + # version: 1.1.0 + #- name: dsglaser.cis_security + # version: 1.5.4 + #- name: redhat.insights + # version: 1.0.8 + + + # Ansible Cloud Common + # ------------------------------------------------------------------- + # It uses the Turbo Module https://github.com/ansible-collections/cloud.common + # A cache sharing solution to speed up Ansible modules + #- name: cloud.common + # version: 2.1.3 + + # Dynamic Inventory + # ------------------------------------------------------------------- + #- name: redhat.satellite # certified collection + # version: 3.12.0 + #- name: servicenow.itsm # certified collection + # version: 2.3.0 + + # Identity Management + # ------------------------------------------------------------------- + #- name: redhat.rhel_idm # certified collection + # version: 1.11.1 + + # Logging Aggregation + # ------------------------------------------------------------------- + #- name: splunk.es + # version: 2.1.0