diff --git a/LICENSE b/LICENSE index f288702..4136aff 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,202 @@ - 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 -. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (C) 2018-2026 Ruohang Feng, @Vonng (rh@vonng.com) + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/init_k3s_single_node_gitops.yml b/init_k3s_single_node_gitops.yml index 6bd870e..0a68db6 100644 --- a/init_k3s_single_node_gitops.yml +++ b/init_k3s_single_node_gitops.yml @@ -5,4 +5,4 @@ gather_facts: yes tasks: - include_role: - name: k3s_bootstrap + name: vhosts/k3s_platform_bootstrap diff --git a/roles/vhosts/alloy/templates/config.alloy.j2 b/roles/vhosts/alloy/templates/config.alloy.j2 index 547c961..2e85cb1 100644 --- a/roles/vhosts/alloy/templates/config.alloy.j2 +++ b/roles/vhosts/alloy/templates/config.alloy.j2 @@ -1,19 +1,96 @@ -loki.write "grafanacloud" { +// VictoriaLogs配置 +loki.write "victorialogs" { endpoint { - url = "{{ loki_endpoint_url }}" + url = "http://10.146.0.6:9428/loki/api/v1/push" - basic_auth { - username = "{{ loki_basic_auth_username }}" - password = "{{ loki_basic_auth_password }}" + headers = { + "X-Scope-OrgID" = "default" } } } +// VictoriaMetrics配置 (Prometheus remote_write) +prometheus.remote_write "victoriametrics" { + endpoint { + url = "http://10.146.0.6:8428/api/v1/write" + + queue_config { + max_samples_per_send = 1000 + max_shards = 200 + capacity = 2500 + } + } +} + +// VictoriaTraces配置 (Jaeger) +jaeger "victoriatraces" { + endpoint = "http://10.146.0.6:10428" +} + +// 本地Prometheus配置用于指标收集 +prometheus.scrape "local" { + targets = [ + { + job = "alloy" + instance = "localhost" + metrics_path = "/metrics" + scheme = "http" + } + ] + forward_to = [prometheus.remote_write.victoriametrics.receiver] +} + +// 系统指标收集 +prometheus.scrape "node" { + targets = [ + { + job = "node" + instance = "localhost" + metrics_path = "/metrics" + scheme = "http" + } + ] + forward_to = [prometheus.remote_write.victoriametrics.receiver] +} + +// 本地Loki日志收集 +loki.source.file "system_logs" { + targets = [ + { + job = "system" + instance = "localhost" + labels = {job = "system"} + path = "/var/log/*.log" + } + ] + forward_to = [loki.write.victorialogs.receiver] +} + +// journal日志收集 {% for source in loki_journal_sources %} loki.source.journal "{{ source.name }}" { format_as_json = true labels = {job = "{{ source.name }}"} matches = "_SYSTEMD_UNIT={{ source.unit }}" - forward_to = [loki.write.grafanacloud.receiver] + forward_to = [loki.write.victorialogs.receiver] } {% endfor %} + +// 保留原有的loki配置作为备选 +loki.write "grafanacloud" { + endpoint { + url = "{{ loki_endpoint_url | default("http://10.146.0.6:9428/loki/api/v1/push") }}" + + basic_auth { + username = "{{ loki_basic_auth_username | default("") }}" + password = "{{ loki_basic_auth_password | default("") }}" + } + } +} + +// 追踪数据发送到VictoriaTraces +tracing "victoriatraces" { + receivers = [jaeger.victoriatraces.receiver] + processors = [] + exporters = [] +} diff --git a/roles/vhosts/k3s-addon/files/setup-egress.sh b/roles/vhosts/k3s-addon/files/setup-egress.sh index 998b079..9aa4b76 100644 --- a/roles/vhosts/k3s-addon/files/setup-egress.sh +++ b/roles/vhosts/k3s-addon/files/setup-egress.sh @@ -2,6 +2,8 @@ ip=$1 namespace=$2 +node_name=${3:-"ha-proxy-jp.svc.plus"} + cat > /tmp/egress.yaml << EOF apiVersion: cilium.io/v2 kind: CiliumEgressGatewayPolicy @@ -18,7 +20,7 @@ spec: egressGateway: nodeSelector: matchLabels: - node.kubernetes.io/name: tky-connector.onwalk.net + node.kubernetes.io/name: $node_name egressIP: $ip EOF kubectl apply -f /tmp/egress.yaml diff --git a/roles/vhosts/k3s-reset/files/reset-k3s.sh b/roles/vhosts/k3s-reset/files/reset-k3s.sh index 719a657..a7b58fe 100644 --- a/roles/vhosts/k3s-reset/files/reset-k3s.sh +++ b/roles/vhosts/k3s-reset/files/reset-k3s.sh @@ -1,22 +1,62 @@ #!/bin/bash -wget https://raw.githubusercontent.com/kubeovn/kube-ovn/release-1.10/dist/images/cleanup.sh +set -euo pipefail + +readonly PROTECTED_DIRS=( + "/opt/cloud-neutral" +) + +is_protected_path() { + local path="$1" + local protected + for protected in "${PROTECTED_DIRS[@]}"; do + if [[ "$path" == "$protected" || "$path" == "$protected"/* ]]; then + return 0 + fi + done + return 1 +} + +safe_rm_rf() { + local path + for path in "$@"; do + [[ -z "$path" ]] && continue + if is_protected_path "$path"; then + echo "skip protected path: $path" + continue + fi + rm -rf "$path" + done +} + +wget -q -O cleanup.sh https://raw.githubusercontent.com/kubeovn/kube-ovn/release-1.10/dist/images/cleanup.sh bash cleanup.sh -rm -rf /var/run/openvswitch -rm -rf /var/run/ovn -rm -rf /etc/origin/openvswitch/ -rm -rf /etc/origin/ovn/ -rm -rf /etc/cni/net.d/00-kube-ovn.conflist -rm -rf /etc/cni/net.d/01-kube-ovn.conflist -rm -rf /var/log/openvswitch -rm -rf /var/log/ovn -rm -fr /var/log/kube-ovn +systemctl stop k3s 2>/dev/null || true +systemctl stop k3s-agent 2>/dev/null || true +systemctl disable k3s 2>/dev/null || true +systemctl disable k3s-agent 2>/dev/null || true +pkill -9 -f '/usr/local/bin/k3s' 2>/dev/null || true +pkill -9 -f 'k3s server' 2>/dev/null || true +pkill -9 -f 'k3s agent' 2>/dev/null || true -/usr/local/bin/k3s-uninstall.sh -rm -rvf /opt/rancher/ /etc/rancher/ /var/lib/rancher/ ~/.kube +safe_rm_rf /var/run/openvswitch +safe_rm_rf /var/run/ovn +safe_rm_rf /etc/origin/openvswitch/ +safe_rm_rf /etc/origin/ovn/ +safe_rm_rf /etc/cni/net.d/00-kube-ovn.conflist +safe_rm_rf /etc/cni/net.d/01-kube-ovn.conflist +safe_rm_rf /var/log/openvswitch +safe_rm_rf /var/log/ovn +safe_rm_rf /var/log/kube-ovn -rm -rvf /etc/cni/net.d/* +/usr/local/bin/k3s-uninstall.sh || true +safe_rm_rf /opt/rancher/ /etc/rancher/ /var/lib/rancher/ "$HOME/.kube" +safe_rm_rf /etc/systemd/system/k3s.service /etc/systemd/system/k3s.service.env +safe_rm_rf /etc/systemd/system/k3s-agent.service /etc/systemd/system/k3s-agent.service.env +safe_rm_rf /usr/local/bin/k3s-uninstall.sh /usr/local/bin/k3s-agent-uninstall.sh + +safe_rm_rf /etc/cni/net.d/* # 移除cni命名空间 ip netns show 2>/dev/null | grep cni- | xargs -r -t -n 1 ip netns delete @@ -25,8 +65,9 @@ ip link show 2>/dev/null | grep 'master cni0' | while read ignore iface ignore; iface=${iface%%@*} [ -z "$iface" ] || ip link delete $iface done -ip link delete cni0 -ip link delete flannel.1 -rm -rf /var/lib/cni/ +ip link delete cni0 2>/dev/null || true +ip link delete flannel.1 2>/dev/null || true +safe_rm_rf /var/lib/cni/ # 清理iptables iptables-save | grep -v KUBE- | grep -v CNI- | iptables-restore +systemctl daemon-reload diff --git a/roles/vhosts/k3s_platform_bootstrap/defaults/main.yml b/roles/vhosts/k3s_platform_bootstrap/defaults/main.yml index 6b767cb..591a65f 100644 --- a/roles/vhosts/k3s_platform_bootstrap/defaults/main.yml +++ b/roles/vhosts/k3s_platform_bootstrap/defaults/main.yml @@ -9,19 +9,23 @@ k3s_platform_tls_sans: [] k3s_platform_kubeconfig_path: /etc/rancher/k3s/k3s.yaml k3s_platform_k3s_config_path: /etc/rancher/k3s/config.yaml k3s_platform_install_dir: /opt/rancher/k3s +k3s_platform_k3s_install_script_url: https://get.k3s.io +k3s_platform_k3s_install_script_path: /tmp/k3s-install.sh +k3s_platform_k3s_install_log_path: /var/log/k3s-install.log +k3s_platform_k3s_install_timeout_seconds: 1800 k3s_platform_deployment_mode: k3s_platform -k3s_platform_git_branch: main -k3s_platform_flux_namespace: flux-system -k3s_platform_flux_source_name: platform-config -k3s_platform_flux_root_path: ./infra/clusters/prod -k3s_platform_git_url: "https://github.com/x-evor/gitops.git" -k3s_platform_git_auth_mode: https-basic +k3s_platform_git_branch: "main" +k3s_platform_flux_namespace: "flux-system" +k3s_platform_flux_source_name: "platform-config" +k3s_platform_flux_root_path: "{{ lookup('env', 'K3S_PLATFORM_FLUX_ROOT_PATH') | default('./environments/clusters/prod', true) }}" +k3s_platform_git_url: "{{ lookup('env', 'GITOPS_REPO') | default('https://github.com/x-evor/gitops.git', true) }}" +k3s_platform_git_auth_mode: "{{ lookup('env', 'GITOPS_AUTH_MODE') | default('public', true) }}" k3s_platform_git_private_key: "{{ lookup('env', 'GITOPS_FLUX_DEPLOY_KEY') }}" k3s_platform_git_public_key: "{{ lookup('env', 'GITOPS_FLUX_DEPLOY_KEY_PUB') }}" k3s_platform_git_private_key_path: "{{ lookup('env', 'HOME') }}/.ssh/id_rsa" -k3s_platform_git_http_username: "x-access-token" +k3s_platform_git_http_username: "{{ lookup('env', 'GITOPS_FLUX_HTTP_USERNAME') | default('x-access-token', true) }}" k3s_platform_git_http_password: "{{ lookup('env', 'GITOPS_FLUX_HTTP_PASSWORD') | default(lookup('env', 'GITOPS_FLUX_TOKEN'), true) }}" k3s_platform_git_bearer_token: "{{ lookup('env', 'GITOPS_FLUX_BEARER_TOKEN') }}" @@ -29,22 +33,35 @@ k3s_platform_namespaces: - flux-system - platform - database - - extsvc - observability - core-prod - core-pre k3s_platform_bootstrap_namespaces: - flux-system - - extsvc +k3s_platform_manage_extsvc: false k3s_platform_vault_release_name: vault k3s_platform_vault_chart_version: "0.28.0" -k3s_platform_vault_bootstrap_mode: init -k3s_platform_vault_init_phase: post_flux +k3s_platform_vault_bootstrap_mode: "{{ lookup('env', 'K3S_PLATFORM_VAULT_BOOTSTRAP_MODE') | default('init', true) }}" +k3s_platform_vault_init_phase: "{{ lookup('env', 'K3S_PLATFORM_VAULT_INIT_PHASE') | default('post_flux', true) }}" k3s_platform_vault_admin_username: admin k3s_platform_vault_init_json_path: /tmp/vault-init.json k3s_platform_vault_init_stdout_path: /tmp/vault-init.stdout k3s_platform_vault_init_stderr_path: /tmp/vault-init.stderr -k3s_platform_vault_allow_sensitive_output: false +k3s_platform_vault_allow_sensitive_output: "{{ lookup('env', 'K3S_PLATFORM_VAULT_ALLOW_SENSITIVE_OUTPUT') | default('false', true) | bool }}" + +bootstrap_vault_url: "{{ lookup('env', 'VAULT_URL') | default('', true) }}" +bootstrap_vault_namespace: "{{ lookup('env', 'VAULT_NAMESPACE') | default('', true) }}" +bootstrap_vault_token: "{{ lookup('env', 'VAULT_TOKEN') | default('', true) }}" +bootstrap_gitops_repo: "{{ k3s_platform_git_url }}" +bootstrap_gitops_auth_mode: "{{ k3s_platform_git_auth_mode }}" +k3s_platform_vault_server_url: "{{ bootstrap_vault_url }}" +k3s_platform_vault_namespace: "{{ bootstrap_vault_namespace }}" +k3s_platform_vault_token: "{{ bootstrap_vault_token }}" + +cloudflare_api_token: "{{ lookup('env', 'CLOUDFLARE_API_TOKEN') | default(lookup('env', 'CLOUDFLARE_DNS_API_TOKEN'), true) }}" +cloudflare_zone_id: "{{ lookup('env', 'CLOUDFLARE_ZONE_ID') | default('', true) }}" +vault_root_token: "{{ lookup('env', 'VAULT_ROOT_TOKEN') | default('', true) }}" +vault_init_json: "{{ lookup('env', 'VAULT_INIT_JSON') | default('', true) }}" k3s_platform_flux_env: GIT_URL: "{{ k3s_platform_git_url }}" @@ -52,3 +69,131 @@ k3s_platform_flux_env: GIT_SOURCE_NAME: "{{ k3s_platform_flux_source_name }}" FLUX_NAMESPACE: "{{ k3s_platform_flux_namespace }}" FLUX_ROOT_PATH: "{{ k3s_platform_flux_root_path }}" + +k3s_platform_postgres_user: "{{ lookup('env', 'POSTGRES_USER') | default('postgres', true) }}" +k3s_platform_postgres_password: "{{ lookup('env', 'POSTGRES_PASSWORD') | default('', true) }}" +k3s_platform_internal_service_token: "{{ lookup('env', 'INTERNAL_SERVICE_TOKEN') | default('', true) }}" +k3s_platform_ghcr_username: "{{ lookup('env', 'GHCR_USERNAME') | default('svc-design', true) }}" +k3s_platform_ghcr_token: "{{ lookup('env', 'GHCR_TOKEN') | default('', true) }}" + +k3s_platform_helm_repos: + - { name: "external-secrets", url: "https://charts.external-secrets.io" } + - { name: "stakater", url: "https://stakater.github.io/stakater-charts" } + - { name: "caddy-ingress", url: "https://caddyserver.github.io/ingress/" } + - { name: "apisix", url: "https://charts.apiseven.com" } + - { name: "external-dns", url: "https://kubernetes-sigs.github.io/external-dns/" } + +k3s_platform_external_secrets_chart_version: "0.20.4" +k3s_platform_reloader_chart_version: "1.3.0" +k3s_platform_caddy_chart_version: "1.3.0" +k3s_platform_apisix_chart_version: "2.13.0" +k3s_platform_external_dns_chart_version: "1.20.0" + +k3s_platform_values: + namespaces: + platform: platform + vault: extsvc + components: + caddy: + enabled: true + releaseName: caddy + values: + ingressController: + enabled: true + ingressClass: + create: true + name: caddy + default: false + service: + type: LoadBalancer + apisix: + enabled: true + releaseName: apisix + values: + etcd: + enabled: false + externalEtcd: + user: "" + ingress-controller: + enabled: false + dashboard: + enabled: false + gateway: + enabled: true + type: ClusterIP + control: + enabled: false + apisix: + admin: + enabled: false + deployment: + mode: standalone + role: data_plane + standalone: + config: | + routes: + - id: 1 + uri: "/*" + hosts: + - api.svc.plus + name: api-gateway-prod + upstream: + type: roundrobin + nodes: + "accounts.core-prod.svc.cluster.local:80": 1 + - id: 2 + uri: "/*" + hosts: + - api-pre.svc.plus + name: api-gateway-pre + upstream: + type: roundrobin + nodes: + "accounts.core-pre.svc.cluster.local:80": 1 + externalDns: + enabled: true + releaseName: external-dns + values: + provider: cloudflare + policy: sync + registry: txt + txtOwnerId: svc-plus-k3s + sources: + - ingress + domainFilters: + - svc.plus + env: + - name: CF_API_TOKEN + valueFrom: + secretKeyRef: + name: cloudflare-api-token + key: api-token + sharedTlsSecretSync: + enabled: true + name: postgresql-vultr-tls-sync + sourceNamespace: platform + sourceSecretName: postgresql-vultr-tls + targetNamespace: database + targetSecretName: postgresql-vultr-tls + refreshSchedule: "*/5 * * * *" + apisixIngress: + enabled: true + name: apisix-gateway + namespace: platform + className: caddy + annotations: + external-dns.alpha.kubernetes.io/hostname: api.svc.plus,api-pre.svc.plus + tls: + secretName: apisix-gateway-tls + hosts: + - api.svc.plus + - api-pre.svc.plus + hosts: + - host: api.svc.plus + serviceName: apisix-gateway + servicePort: 80 + - host: api-pre.svc.plus + serviceName: apisix-gateway + servicePort: 80 + postgresqlTlsIngress: + enabled: false diff --git a/roles/vhosts/k3s_platform_bootstrap/tasks/main.yml b/roles/vhosts/k3s_platform_bootstrap/tasks/main.yml index b0b3e25..370300e 100644 --- a/roles/vhosts/k3s_platform_bootstrap/tasks/main.yml +++ b/roles/vhosts/k3s_platform_bootstrap/tasks/main.yml @@ -4,19 +4,23 @@ - k3s_platform_git_url | length > 0 - k3s_platform_git_branch | length > 0 - k3s_platform_flux_root_path | length > 0 - - k3s_platform_git_auth_mode | lower in ['ssh', 'https-basic', 'https-bearer'] + - k3s_platform_git_auth_mode | default('public') | lower in ['public', 'ssh', 'https-basic', 'https-bearer', ''] fail_msg: "k3s platform bootstrap requires git url, branch, root path, and a supported git auth mode." - name: Resolve flux git auth inputs ansible.builtin.set_fact: - k3s_platform_git_auth_mode_effective: "{{ k3s_platform_git_auth_mode | lower }}" + k3s_platform_git_auth_mode_effective: "{{ (k3s_platform_git_auth_mode | default('public')) | lower | trim }}" + no_log: true + +- name: Resolve SSH git private key when needed + ansible.builtin.set_fact: k3s_platform_git_private_key_resolved: >- {{ k3s_platform_git_private_key - if (k3s_platform_git_auth_mode | lower == 'ssh' and k3s_platform_git_private_key | default('') | length > 0) + if (k3s_platform_git_auth_mode_effective == 'ssh' and k3s_platform_git_private_key | default('') | length > 0) else ( lookup('ansible.builtin.file', k3s_platform_git_private_key_path) | trim - if (k3s_platform_git_auth_mode | lower == 'ssh') + if (k3s_platform_git_auth_mode_effective == 'ssh') else '' ) }} @@ -47,6 +51,12 @@ when: - k3s_platform_git_auth_mode_effective == 'https-bearer' +- name: Normalize public git auth mode + ansible.builtin.set_fact: + k3s_platform_git_auth_mode_effective: public + when: + - k3s_platform_git_auth_mode_effective in ['', 'public', 'none'] + - name: Install bootstrap dependencies ansible.builtin.package: name: @@ -76,25 +86,77 @@ dest: "{{ k3s_platform_k3s_config_path }}" mode: "0644" -- name: Install k3s if missing +- name: Check whether k3s is already installed ansible.builtin.shell: | set -euo pipefail - if [ -x /usr/local/bin/k3s ] || [ -x /usr/bin/k3s ]; then + if { [ -x /usr/local/bin/k3s ] || [ -x /usr/bin/k3s ]; } && [ -f /etc/systemd/system/k3s.service ]; then + echo "installed" exit 0 fi - curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION="{{ k3s_platform_k3s_version }}" sh - + echo "missing" args: executable: /bin/bash + register: k3s_platform_k3s_install_state + changed_when: false + +- name: Download k3s installer script + ansible.builtin.shell: | + set -euo pipefail + if [ "{{ k3s_platform_k3s_install_state.stdout | default('missing') }}" = "installed" ]; then + exit 0 + fi + echo "[k3s-bootstrap] downloading installer from {{ k3s_platform_k3s_install_script_url }}" + rm -f "{{ k3s_platform_k3s_install_script_path }}" + curl -fL \ + --retry 5 \ + --retry-all-errors \ + --connect-timeout 15 \ + --max-time 1800 \ + -o "{{ k3s_platform_k3s_install_script_path }}" \ + "{{ k3s_platform_k3s_install_script_url }}" + chmod 0755 "{{ k3s_platform_k3s_install_script_path }}" + args: + executable: /bin/bash + when: + - k3s_platform_k3s_install_state.stdout | default('missing') != 'installed' + +- name: Run k3s installer script + ansible.builtin.shell: | + set -euo pipefail + if [ "{{ k3s_platform_k3s_install_state.stdout | default('missing') }}" = "installed" ]; then + exit 0 + fi + echo "[k3s-bootstrap] starting installer at $(date -Is)" + bash -x "{{ k3s_platform_k3s_install_script_path }}" \ + 2>&1 | tee "{{ k3s_platform_k3s_install_log_path }}" + echo "[k3s-bootstrap] finished installer at $(date -Is)" + args: + executable: /bin/bash + async: "{{ k3s_platform_k3s_install_timeout_seconds }}" + poll: 15 + when: + - k3s_platform_k3s_install_state.stdout | default('missing') != 'installed' - name: Wait for k3s binary and unit file to appear ansible.builtin.shell: | set -euo pipefail - for _ in $(seq 1 30); do - if command -v k3s >/dev/null 2>&1 && [ -f /etc/systemd/system/k3s.service ]; then + for attempt in $(seq 1 30); do + k3s_state="missing" + unit_state="missing" + if command -v k3s >/dev/null 2>&1; then + k3s_state="present" + fi + if [ -f /etc/systemd/system/k3s.service ]; then + unit_state="present" + fi + echo "[k3s-bootstrap] wait ${attempt}/30: k3s=${k3s_state}, unit=${unit_state}" + if [ "${k3s_state}" = "present" ] && [ "${unit_state}" = "present" ]; then + echo "[k3s-bootstrap] k3s binary and unit file detected" exit 0 fi sleep 2 done + echo "[k3s-bootstrap] timed out waiting for k3s binary and unit file" >&2 exit 1 args: executable: /bin/bash @@ -145,6 +207,30 @@ args: executable: /bin/bash +- name: Wait for flux controllers to become ready + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n "{{ k3s_platform_flux_namespace }}" rollout status deployment/source-controller --timeout=300s + kubectl -n "{{ k3s_platform_flux_namespace }}" rollout status deployment/kustomize-controller --timeout=300s + kubectl -n "{{ k3s_platform_flux_namespace }}" rollout status deployment/helm-controller --timeout=300s + kubectl -n "{{ k3s_platform_flux_namespace }}" rollout status deployment/notification-controller --timeout=300s + args: + executable: /bin/bash + +- name: Wait for Kubernetes API to become ready for bootstrap resources + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl get --raw=/readyz >/dev/null + args: + executable: /bin/bash + register: k3s_platform_apiserver_ready + changed_when: false + retries: 24 + delay: 5 + until: k3s_platform_apiserver_ready.rc == 0 + - name: Ensure Vault bootstrap namespace exists ansible.builtin.shell: | set -euo pipefail @@ -152,12 +238,291 @@ kubectl get namespace extsvc >/dev/null 2>&1 || kubectl create namespace extsvc args: executable: /bin/bash + when: + - k3s_platform_manage_extsvc | bool + +- name: Ensure platform namespace exists for bootstrap secrets + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl get namespace platform >/dev/null 2>&1 || kubectl create namespace platform + args: + executable: /bin/bash + +- name: Ensure core namespaces exist for bootstrap secrets + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + for namespace in database core-pre core-prod; do + kubectl get namespace "${namespace}" >/dev/null 2>&1 || kubectl create namespace "${namespace}" + done + args: + executable: /bin/bash + +- name: Create runtime bootstrap configmap for platform inputs + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n platform create configmap platform-bootstrap-env \ + --from-literal=GITOPS_REPO="{{ bootstrap_gitops_repo | default('') }}" \ + --from-literal=VAULT_URL="{{ bootstrap_vault_url | default('') }}" \ + --from-literal=CLOUDFLARE_ZONE_ID="{{ cloudflare_zone_id | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + when: + - (bootstrap_gitops_repo | default('')) | length > 0 + - (bootstrap_vault_url | default('')) | length > 0 + - (cloudflare_zone_id | default('')) | length > 0 + +- name: Create runtime bootstrap secret for platform inputs + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n platform create secret generic platform-bootstrap-secrets \ + --from-literal=VAULT_TOKEN="{{ bootstrap_vault_token | default('') }}" \ + --from-literal=VAULT_ROOT_TOKEN="{{ vault_root_token | default('') }}" \ + --from-literal=CLOUDFLARE_DNS_API_TOKEN="{{ lookup('env', 'CLOUDFLARE_DNS_API_TOKEN') | default('', true) }}" \ + --from-literal=CLOUDFLARE_API_TOKEN="{{ cloudflare_api_token | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + no_log: true + when: + - (bootstrap_vault_token | default('')) | length > 0 + - (vault_root_token | default('')) | length > 0 + - (lookup('env', 'CLOUDFLARE_DNS_API_TOKEN') | default('', true)) | length > 0 + - (cloudflare_api_token | default('')) | length > 0 + +- name: Create runtime bootstrap secret for Vault seeding + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n extsvc create secret generic vault-bootstrap \ + --from-literal=rootToken="{{ vault_root_token | default('') }}" \ + --from-literal=cloudflareApiToken="{{ cloudflare_api_token | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + no_log: true + when: + - k3s_platform_manage_extsvc | bool + - (vault_root_token | default('')) | length > 0 + - (cloudflare_api_token | default('')) | length > 0 + +- name: Create runtime bootstrap secret for ExternalDNS seeding + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n platform create secret generic cloudflare-api-token \ + --from-literal=api-token="{{ cloudflare_api_token | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + no_log: true + when: + - (cloudflare_api_token | default('')) | length > 0 + +- name: Render direct Helm values for caddy + ansible.builtin.copy: + content: "{{ (k3s_platform_values.components.caddy['values'] | default({})) | to_nice_yaml(indent=2) }}" + dest: /tmp/platform-caddy-values.yaml + mode: "0600" + +- name: Render direct Helm values for apisix + ansible.builtin.copy: + content: "{{ (k3s_platform_values.components.apisix['values'] | default({})) | to_nice_yaml(indent=2) }}" + dest: /tmp/platform-apisix-values.yaml + mode: "0600" + +- name: Render direct Helm values for external-dns + ansible.builtin.copy: + content: "{{ (k3s_platform_values.components.externalDns['values'] | default({})) | to_nice_yaml(indent=2) }}" + dest: /tmp/platform-external-dns-values.yaml + mode: "0600" + +- name: Render native APISIX ingress manifest + ansible.builtin.template: + src: apisix-ingress.yaml.j2 + dest: /tmp/platform-apisix-ingress.yaml + mode: "0600" + when: + - k3s_platform_values.apisixIngress.enabled | default(false) + +- name: Render native shared TLS sync manifest + ansible.builtin.template: + src: shared-tls-secret-sync.yaml.j2 + dest: /tmp/platform-shared-tls-secret-sync.yaml + mode: "0600" + when: + - k3s_platform_values.components.sharedTlsSecretSync.enabled | default(false) + +- name: Render native PostgreSQL TLS ingress manifest + ansible.builtin.template: + src: postgresql-tls-ingress.yaml.j2 + dest: /tmp/platform-postgresql-tls-ingress.yaml + mode: "0600" + when: + - k3s_platform_values.postgresqlTlsIngress.enabled | default(false) + +- name: Ensure platform Helm repositories are configured + ansible.builtin.shell: | + set -euo pipefail + if helm repo list | awk '{print $1}' | grep -qx '{{ item.name }}'; then + helm repo add --force-update '{{ item.name }}' '{{ item.url }}' >/dev/null + else + helm repo add '{{ item.name }}' '{{ item.url }}' >/dev/null + fi + args: + executable: /bin/bash + loop: "{{ k3s_platform_helm_repos }}" + +- name: Refresh platform Helm repositories + ansible.builtin.shell: | + set -euo pipefail + helm repo update >/dev/null + args: + executable: /bin/bash + +- name: Remove legacy Flux-managed platform release objects + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n platform delete helmrelease external-secrets k3s-platform caddy apisix external-dns reloader --ignore-not-found=true + kubectl -n platform delete ocirepository k3s-platform-chart --ignore-not-found=true + kubectl -n platform delete configmap k3s-platform-values --ignore-not-found=true + args: + executable: /bin/bash + +- name: Install external-secrets directly with Helm + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + helm upgrade --install external-secrets external-secrets/external-secrets \ + --namespace platform \ + --create-namespace \ + --version "{{ k3s_platform_external_secrets_chart_version }}" \ + --set installCRDs=true \ + --wait \ + --timeout 10m + args: + executable: /bin/bash + +- name: Install reloader directly with Helm + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + helm upgrade --install reloader stakater/reloader \ + --namespace platform \ + --create-namespace \ + --version "{{ k3s_platform_reloader_chart_version }}" \ + --wait \ + --timeout 10m + args: + executable: /bin/bash + +- name: Install caddy directly with Helm + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + helm upgrade --install "{{ k3s_platform_values.components.caddy.releaseName }}" caddy-ingress/caddy-ingress-controller \ + --namespace platform \ + --create-namespace \ + --version "{{ k3s_platform_caddy_chart_version }}" \ + -f /tmp/platform-caddy-values.yaml \ + --wait \ + --timeout 10m + args: + executable: /bin/bash + when: + - k3s_platform_values.components.caddy.enabled | default(false) + +- name: Install apisix directly with Helm + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + helm upgrade --install "{{ k3s_platform_values.components.apisix.releaseName }}" apisix/apisix \ + --namespace platform \ + --create-namespace \ + --version "{{ k3s_platform_apisix_chart_version }}" \ + -f /tmp/platform-apisix-values.yaml \ + --wait \ + --timeout 10m + args: + executable: /bin/bash + when: + - k3s_platform_values.components.apisix.enabled | default(false) + +- name: Install external-dns directly with Helm + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + helm upgrade --install "{{ k3s_platform_values.components.externalDns.releaseName }}" external-dns/external-dns \ + --namespace platform \ + --create-namespace \ + --version "{{ k3s_platform_external_dns_chart_version }}" \ + -f /tmp/platform-external-dns-values.yaml \ + --wait \ + --timeout 10m + args: + executable: /bin/bash + when: + - k3s_platform_values.components.externalDns.enabled | default(false) + +- name: Apply native APISIX ingress manifest + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl apply -f /tmp/platform-apisix-ingress.yaml + args: + executable: /bin/bash + when: + - k3s_platform_values.apisixIngress.enabled | default(false) + +- name: Apply native shared TLS sync manifest + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl apply -f /tmp/platform-shared-tls-secret-sync.yaml + args: + executable: /bin/bash + when: + - k3s_platform_values.components.sharedTlsSecretSync.enabled | default(false) + +- name: Apply native PostgreSQL TLS ingress manifest + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl apply -f /tmp/platform-postgresql-tls-ingress.yaml + args: + executable: /bin/bash + when: + - k3s_platform_values.postgresqlTlsIngress.enabled | default(false) + +- name: Wait for direct platform Helm deployments to become available + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n platform wait deployment \ + -l {{ item.selector }} \ + --for=condition=Available \ + --timeout=300s + args: + executable: /bin/bash + loop: + - { name: "external-secrets", selector: "app.kubernetes.io/instance=external-secrets" } + - { name: "reloader", selector: "release=reloader" } + - { name: "caddy", selector: "app.kubernetes.io/instance=caddy" } + - { name: "apisix", selector: "app.kubernetes.io/instance=apisix" } + - { name: "external-dns", selector: "app.kubernetes.io/instance=external-dns" } - name: Render Vault bootstrap values file ansible.builtin.template: src: vault-bootstrap-values.yaml.j2 dest: /tmp/vault-bootstrap-values.yaml mode: "0600" + when: + - k3s_platform_manage_extsvc | bool - name: Bootstrap Vault server with Helm ansible.builtin.shell: | @@ -172,6 +537,8 @@ -f /tmp/vault-bootstrap-values.yaml args: executable: /bin/bash + when: + - k3s_platform_manage_extsvc | bool - name: Wait for Vault server rollout ansible.builtin.shell: | @@ -183,9 +550,8 @@ args: executable: /bin/bash when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - - k3s_platform_vault_bootstrap_mode == 'migrate' - or (k3s_platform_vault_status.initialized | default(false)) - name: Discover Vault pod name ansible.builtin.shell: | @@ -199,6 +565,7 @@ args: executable: /bin/bash when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - name: Capture Vault status @@ -217,12 +584,21 @@ changed_when: false failed_when: false when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - name: Parse Vault status JSON ansible.builtin.set_fact: - k3s_platform_vault_status: "{{ (k3s_platform_vault_status_result.stdout | default('{}')) | from_json }}" + k3s_platform_vault_status: >- + {{ + ( + k3s_platform_vault_status_result.stdout + if (k3s_platform_vault_status_result.stdout | default('') | trim | length) > 0 + else '{}' + ) | from_json + }} when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - name: Assert Vault bootstrap mode is valid @@ -231,6 +607,7 @@ - k3s_platform_vault_bootstrap_mode in ['init', 'migrate'] fail_msg: "k3s_platform_vault_bootstrap_mode must be init or migrate." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - name: Assert migrate mode has inputs when Vault is already initialized @@ -240,6 +617,7 @@ - (vault_init_json | default('')) | length > 0 fail_msg: "Vault migrate mode requires vault_root_token and vault_init_json." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_bootstrap_mode == 'migrate' - k3s_platform_vault_status.initialized | default(false) @@ -250,6 +628,7 @@ - k3s_platform_vault_status.initialized | default(false) fail_msg: "Vault migrate mode requires an already initialized Vault instance." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_bootstrap_mode == 'migrate' @@ -270,6 +649,7 @@ - -key-threshold=1 register: k3s_platform_vault_init_result when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_bootstrap_mode == 'init' - not (k3s_platform_vault_status.initialized | default(false)) @@ -280,6 +660,7 @@ dest: "{{ k3s_platform_vault_init_json_path }}" mode: "0600" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_init_result is defined @@ -287,6 +668,7 @@ ansible.builtin.set_fact: k3s_platform_vault_init_data: "{{ k3s_platform_vault_init_result.stdout | from_json }}" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_init_result is defined @@ -304,6 +686,23 @@ - unseal - "{{ k3s_platform_vault_init_data.unseal_keys_b64[0] }}" when: + - k3s_platform_manage_extsvc | bool + - k3s_platform_vault_init_phase == 'pre_flux' + - k3s_platform_vault_init_result is defined + +- name: Sync Vault bootstrap secret with generated root token + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n extsvc create secret generic vault-bootstrap \ + --from-literal=rootToken="{{ k3s_platform_vault_init_data.root_token }}" \ + --from-literal=cloudflareApiToken="{{ cloudflare_api_token | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + no_log: true + when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_init_result is defined @@ -318,6 +717,7 @@ root_token: "{{ k3s_platform_vault_init_data.root_token if (k3s_platform_vault_init_result is defined and k3s_platform_vault_allow_sensitive_output) else omit }}" init_json: "{{ k3s_platform_vault_init_result.stdout if (k3s_platform_vault_init_result is defined and k3s_platform_vault_allow_sensitive_output) else omit }}" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'pre_flux' - k3s_platform_vault_bootstrap_mode == 'init' - k3s_platform_vault_init_result is defined @@ -346,75 +746,95 @@ - k3s_platform_git_public_key | length > 0 - k3s_platform_git_auth_mode_effective == 'ssh' -- name: Create or update flux git auth secret - ansible.builtin.shell: | - set -euo pipefail - export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" - . /tmp/flux-bootstrap.env - case "{{ k3s_platform_git_auth_mode_effective }}" in - ssh) - flux create secret git "${GIT_SOURCE_NAME}" \ - --url="${GIT_URL}" \ - --private-key-file=/tmp/flux-git-deploy.key \ - --namespace="${FLUX_NAMESPACE}" \ - --export | kubectl apply -f - - ;; - https-basic) - cat <&2 - exit 1 - ;; - esac - args: - executable: /bin/bash - no_log: true +- name: Remove flux git auth secret for public repositories + ansible.builtin.command: + argv: + - kubectl + - -n + - "{{ k3s_platform_flux_namespace }}" + - delete + - secret + - "{{ k3s_platform_flux_source_name }}" + - --ignore-not-found + environment: + KUBECONFIG: "{{ k3s_platform_kubeconfig_path }}" + when: + - k3s_platform_git_auth_mode_effective in ['public', 'none', ''] -- name: Create runtime bootstrap secret for Vault seeding +- name: Create or update flux git auth secret with SSH ansible.builtin.shell: | set -euo pipefail - export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" - kubectl -n extsvc create secret generic vault-bootstrap \ - --from-literal=rootToken="{{ vault_root_token | default('') }}" \ - --from-literal=cloudflareApiToken="{{ cloudflare_api_token | default('') }}" \ - --dry-run=client -o yaml | kubectl apply -f - + . /tmp/flux-bootstrap.env + flux create secret git "${GIT_SOURCE_NAME}" \ + --url="${GIT_URL}" \ + --private-key-file=/tmp/flux-git-deploy.key \ + --namespace="${FLUX_NAMESPACE}" \ + --export | kubectl apply -f - args: executable: /bin/bash + environment: + KUBECONFIG: "{{ k3s_platform_kubeconfig_path }}" no_log: true when: - - (vault_root_token | default('')) | length > 0 - - (cloudflare_api_token | default('')) | length > 0 + - k3s_platform_git_auth_mode_effective == 'ssh' + +- name: Create or update flux git auth secret with HTTPS basic auth + ansible.builtin.shell: | + set -euo pipefail + . /tmp/flux-bootstrap.env + cat <- + {{ + ( + k3s_platform_vault_status_result.stdout + if (k3s_platform_vault_status_result.stdout | default('') | trim | length) > 0 + else '{}' + ) | from_json + }} when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - name: Assert Vault bootstrap mode is valid after Flux bootstrap @@ -534,6 +965,7 @@ - k3s_platform_vault_bootstrap_mode in ['init', 'migrate'] fail_msg: "k3s_platform_vault_bootstrap_mode must be init or migrate." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - name: Assert migrate mode has inputs when Vault is already initialized after Flux bootstrap @@ -543,6 +975,7 @@ - (vault_init_json | default('')) | length > 0 fail_msg: "Vault migrate mode requires vault_root_token and vault_init_json." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_bootstrap_mode == 'migrate' - k3s_platform_vault_status.initialized | default(false) @@ -553,6 +986,7 @@ - k3s_platform_vault_status.initialized | default(false) fail_msg: "Vault migrate mode requires an already initialized Vault instance." when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_bootstrap_mode == 'migrate' @@ -573,6 +1007,7 @@ - -key-threshold=1 register: k3s_platform_vault_init_result when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_bootstrap_mode == 'init' - not (k3s_platform_vault_status.initialized | default(false)) @@ -583,6 +1018,7 @@ dest: "{{ k3s_platform_vault_init_json_path }}" mode: "0600" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_init_result is defined @@ -590,6 +1026,7 @@ ansible.builtin.set_fact: k3s_platform_vault_init_data: "{{ k3s_platform_vault_init_result.stdout | from_json }}" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_init_result is defined @@ -607,6 +1044,23 @@ - unseal - "{{ k3s_platform_vault_init_data.unseal_keys_b64[0] }}" when: + - k3s_platform_manage_extsvc | bool + - k3s_platform_vault_init_phase == 'post_flux' + - k3s_platform_vault_init_result is defined + +- name: Sync Vault bootstrap secret with generated root token after Flux bootstrap + ansible.builtin.shell: | + set -euo pipefail + export KUBECONFIG="{{ k3s_platform_kubeconfig_path }}" + kubectl -n extsvc create secret generic vault-bootstrap \ + --from-literal=rootToken="{{ k3s_platform_vault_init_data.root_token }}" \ + --from-literal=cloudflareApiToken="{{ cloudflare_api_token | default('') }}" \ + --dry-run=client -o yaml | kubectl apply -f - + args: + executable: /bin/bash + no_log: true + when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_init_result is defined @@ -621,6 +1075,7 @@ root_token: "{{ k3s_platform_vault_init_data.root_token if (k3s_platform_vault_init_result is defined and k3s_platform_vault_allow_sensitive_output) else omit }}" init_json: "{{ k3s_platform_vault_init_result.stdout if (k3s_platform_vault_init_result is defined and k3s_platform_vault_allow_sensitive_output) else omit }}" when: + - k3s_platform_manage_extsvc | bool - k3s_platform_vault_init_phase == 'post_flux' - k3s_platform_vault_bootstrap_mode == 'init' - k3s_platform_vault_init_result is defined diff --git a/roles/vhosts/k3s_platform_bootstrap/templates/apisix-ingress.yaml.j2 b/roles/vhosts/k3s_platform_bootstrap/templates/apisix-ingress.yaml.j2 new file mode 100644 index 0000000..c073b83 --- /dev/null +++ b/roles/vhosts/k3s_platform_bootstrap/templates/apisix-ingress.yaml.j2 @@ -0,0 +1,33 @@ +{% set ingress = k3s_platform_values.apisixIngress %} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ ingress.name }} + namespace: {{ ingress.namespace }} +{% if ingress.annotations is defined and ingress.annotations %} + annotations: +{% for key, value in ingress.annotations.items() %} + {{ key }}: {{ value | to_json }} +{% endfor %} +{% endif %} +spec: + ingressClassName: {{ ingress.className }} + tls: + - hosts: +{% for host in ingress.tls.hosts %} + - {{ host }} +{% endfor %} + secretName: {{ ingress.tls.secretName }} + rules: +{% for host in ingress.hosts %} + - host: {{ host.host }} + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: {{ host.serviceName }} + port: + number: {{ host.servicePort }} +{% endfor %} diff --git a/roles/vhosts/k3s_platform_bootstrap/templates/postgresql-tls-ingress.yaml.j2 b/roles/vhosts/k3s_platform_bootstrap/templates/postgresql-tls-ingress.yaml.j2 new file mode 100644 index 0000000..0f90ed6 --- /dev/null +++ b/roles/vhosts/k3s_platform_bootstrap/templates/postgresql-tls-ingress.yaml.j2 @@ -0,0 +1,38 @@ +{% set ingress = k3s_platform_values.postgresqlTlsIngress %} +apiVersion: v1 +kind: Service +metadata: + name: {{ ingress.serviceName }} + namespace: {{ ingress.namespace }} +spec: + type: ClusterIP + ports: + - port: {{ ingress.servicePort }} + targetPort: {{ ingress.servicePort }} + protocol: TCP + name: http + selector: + app.kubernetes.io/name: {{ ingress.serviceName }} +--- +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ ingress.name }} + namespace: {{ ingress.namespace }} +spec: + ingressClassName: {{ ingress.className }} + tls: + - hosts: + - {{ ingress.host }} + secretName: {{ ingress.secretName }} + rules: + - host: {{ ingress.host }} + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: {{ ingress.serviceName }} + port: + number: {{ ingress.servicePort }} diff --git a/roles/vhosts/k3s_platform_bootstrap/templates/shared-tls-secret-sync.yaml.j2 b/roles/vhosts/k3s_platform_bootstrap/templates/shared-tls-secret-sync.yaml.j2 new file mode 100644 index 0000000..d638aa5 --- /dev/null +++ b/roles/vhosts/k3s_platform_bootstrap/templates/shared-tls-secret-sync.yaml.j2 @@ -0,0 +1,81 @@ +{% set sync = k3s_platform_values.components.sharedTlsSecretSync %} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ sync.name }} + namespace: {{ k3s_platform_values.namespaces.platform }} +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + name: {{ sync.name }}-source + namespace: {{ sync.sourceNamespace }} +rules: + - apiGroups: [""] + resources: ["secrets"] + resourceNames: ["{{ sync.sourceSecretName }}"] + verbs: ["get", "list", "watch"] +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + name: {{ sync.name }}-target + namespace: {{ sync.targetNamespace }} +rules: + - apiGroups: [""] + resources: ["secrets"] + resourceNames: ["{{ sync.targetSecretName }}"] + verbs: ["get", "create", "update", "patch"] +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: {{ sync.name }}-source + namespace: {{ sync.sourceNamespace }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: {{ sync.name }}-source +subjects: + - kind: ServiceAccount + name: {{ sync.name }} + namespace: {{ k3s_platform_values.namespaces.platform }} +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: {{ sync.name }}-target + namespace: {{ sync.targetNamespace }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: {{ sync.name }}-target +subjects: + - kind: ServiceAccount + name: {{ sync.name }} + namespace: {{ k3s_platform_values.namespaces.platform }} +--- +apiVersion: batch/v1 +kind: CronJob +metadata: + name: {{ sync.name }} + namespace: {{ k3s_platform_values.namespaces.platform }} +spec: + schedule: {{ sync.refreshSchedule | to_json }} + concurrencyPolicy: Forbid + jobTemplate: + spec: + template: + spec: + serviceAccountName: {{ sync.name }} + restartPolicy: OnFailure + containers: + - name: sync + image: bitnami/kubectl:1.30 + command: + - /bin/sh + - -ec + - | + kubectl -n {{ sync.sourceNamespace }} get secret {{ sync.sourceSecretName }} -o yaml \ + | sed '/^ resourceVersion:/d;/^ uid:/d;/^ creationTimestamp:/d;/^ managedFields:/d;/^ annotations:/d;/^ ownerReferences:/d;/^ namespace:/d;/^ selfLink:/d' \ + | kubectl -n {{ sync.targetNamespace }} apply -f - diff --git a/scripts/fluxcd_all_in_one.sh b/scripts/fluxcd_all_in_one.sh index c0aeb36..21278bf 100644 --- a/scripts/fluxcd_all_in_one.sh +++ b/scripts/fluxcd_all_in_one.sh @@ -4,7 +4,7 @@ kubectl create namespace gitops-system || true helm upgrade --install fluxcd stable/flux2 --version 2.12.1 -n gitops-system -f fluxcd-values.yaml cat > cluster-config.yaml << EOF -apiVersion: source.toolkit.fluxcd.io/v1beta2 +apiVersion: source.toolkit.fluxcd.io/v1 kind: GitRepository metadata: name: stable @@ -15,7 +15,7 @@ spec: branch: main url: https://github.com/x-evor/gitops.git --- -apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 +apiVersion: kustomize.toolkit.fluxcd.io/v1 kind: Kustomization metadata: name: cluster diff --git a/scripts/k3s-cluster/setup-k3s-with-gitops.sh b/scripts/k3s-cluster/setup-k3s-with-gitops.sh index 3691f0a..b624fb0 100644 --- a/scripts/k3s-cluster/setup-k3s-with-gitops.sh +++ b/scripts/k3s-cluster/setup-k3s-with-gitops.sh @@ -168,7 +168,7 @@ sourceController: EOF cat > cluster-config.yaml << EOF -apiVersion: source.toolkit.fluxcd.io/v1beta2 +apiVersion: source.toolkit.fluxcd.io/v1 kind: GitRepository metadata: name: stable @@ -179,7 +179,7 @@ spec: branch: main url: https://github.com/x-evor/gitops.git --- -apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 +apiVersion: kustomize.toolkit.fluxcd.io/v1 kind: Kustomization metadata: name: cluster diff --git a/scripts/k3s-cluster/setup-k3s-with-ingress.sh b/scripts/k3s-cluster/setup-k3s-with-ingress.sh index f6069b4..0455b00 100644 --- a/scripts/k3s-cluster/setup-k3s-with-ingress.sh +++ b/scripts/k3s-cluster/setup-k3s-with-ingress.sh @@ -187,7 +187,7 @@ data: EOF cat > cluster-config.yaml << EOF -apiVersion: source.toolkit.fluxcd.io/v1beta2 +apiVersion: source.toolkit.fluxcd.io/v1 kind: GitRepository metadata: name: stable @@ -198,7 +198,7 @@ spec: branch: main url: https://github.com/x-evor/gitops.git --- -apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 +apiVersion: kustomize.toolkit.fluxcd.io/v1 kind: Kustomization metadata: name: cluster diff --git a/skills/release-branch-policy/SKILL.md b/skills/release-branch-policy/SKILL.md new file mode 100644 index 0000000..662015c --- /dev/null +++ b/skills/release-branch-policy/SKILL.md @@ -0,0 +1,116 @@ +# Skill: release-branch-policy + +## Purpose + +Standardize release branch policy across Cloud-Neutral Toolkit repos: + +- `main` is the **preview** branch (fast iteration, integrates frequently). +- `release/*` branches are **production release lines** and must be protected. +- Updates to `release/*` happen via **local cherry-pick** by release managers (process gate). + +This skill includes: +- A policy doc (this file) +- A ruleset JSON template (GitHub Rulesets API) +- A `gh` script to apply the ruleset to one or many repos +- A sync script to copy this skill into all local sub-repos +- A script to generate a cross-repo release manifest (for tag association) + +Non-goals: +- This skill does NOT create/push `release/v0.1` or tags automatically. + +## Policy + +### Branch Roles + +- `main`: preview + - Accepts PRs and merges normally. + - May be ahead of production at any time. +- `release/*`: production + - No force-push. + - Require linear history. + - Prefer "cherry-pick into release branch" as the only change mechanism (process). + - Restrict who can update release branches to release managers (enforced via GitHub Rulesets/Branch protection UI). + +### “Cherry-Pick Only” Clarification + +GitHub branch rules cannot reliably guarantee "only cherry-pick" as a technical constraint. +We treat it as a **process rule**: + +1. A change lands in `main`. +2. Release manager cherry-picks specific commits onto `release/`. +3. Release manager pushes the updated release branch. + +### “No PR / No Push” Clarification + +If you literally forbid both: +- PR merges to `release/*`, and +- any push to `release/*` + +then the branch becomes non-updatable. + +What we implement is: +- No force-push, no deletion, linear history (enforceable). +- Only release managers can update `release/*` (enforceable via "restrict updates" / bypass actors). +- "Cherry-pick only" (process rule). + +### Tags + +For milestone releases like `v0.1`: +- Use an annotated tag named `v0.1` (per-repo). +- Prefer tags on `release/` tip. + +If you need SemVer tags, follow governance: `-vX.Y.Z`. + +### Cross-Repo Tag Association + +Git tags are per-repo; GitHub does not provide a first-class "one tag links all repos" concept. + +We represent "release v0.1 across repos" by committing a **release manifest** file in the control repo, generated from local git state: +- repo name +- release branch tip SHA +- tag tip SHA + +Use: `skills/release-branch-policy/scripts/generate_release_manifest.sh v0.1` + +## Ruleset Requirements (release/*) + +Enforce at minimum: +- block deletion +- block force-push (non-fast-forward) +- require linear history + +Optional (recommended if you have stable CI): +- require status checks +- require signed commits + +## Tools + +### 1) Apply Ruleset (GitHub Rulesets) + +Script: `skills/release-branch-policy/scripts/apply_ruleset.sh` + +- Applies (create/update) a repo ruleset targeting `refs/heads/release/*` +- Uses `gh api` and a JSON payload +- Does not modify branches/tags + +### 2) Sync Skill Into All Local Sub-Repos + +Script: `skills/release-branch-policy/scripts/sync_skill_to_subrepos.sh` + +- Copies this skill folder into each local repo under `/Users/shenlan/workspaces/cloud-neutral-toolkit/*` +- Skips repos without `.git` +- Keeps existing files unless overwritten explicitly + +### 3) Generate Release Manifest (Cross-Repo Association) + +Script: `skills/release-branch-policy/scripts/generate_release_manifest.sh` + +- Generates `releases/.yaml` in the current working directory (default) +- Does not push or create refs + +## Operator Checklist + +- Confirm `main` is treated as preview across repos (docs + CI naming). +- Apply ruleset to every repo that has production releases. +- Document "cherry-pick only" in release runbooks. +- Verify bypass actors (release managers) in GitHub UI if needed. diff --git a/skills/release-branch-policy/references/ruleset.release-branches.json b/skills/release-branch-policy/references/ruleset.release-branches.json new file mode 100644 index 0000000..ac7757e --- /dev/null +++ b/skills/release-branch-policy/references/ruleset.release-branches.json @@ -0,0 +1,17 @@ +{ + "name": "Release Branch Protection (release/*)", + "target": "branch", + "enforcement": "active", + "conditions": { + "ref_name": { + "include": ["refs/heads/release/*"], + "exclude": [] + } + }, + "rules": [ + { "type": "deletion" }, + { "type": "non_fast_forward" }, + { "type": "required_linear_history" } + ] +} + diff --git a/skills/release-branch-policy/scripts/apply_ruleset.sh b/skills/release-branch-policy/scripts/apply_ruleset.sh new file mode 100755 index 0000000..786aa3d --- /dev/null +++ b/skills/release-branch-policy/scripts/apply_ruleset.sh @@ -0,0 +1,57 @@ +#!/usr/bin/env bash +set -euo pipefail + +usage() { + cat <<'EOF' +Apply GitHub Ruleset to protect release/* branches. + +Usage: + apply_ruleset.sh [ ...] + +Notes: + - Requires: gh (authenticated), jq + - Does NOT create/push branches or tags. + - Ruleset payload is in: skills/release-branch-policy/references/ruleset.release-branches.json +EOF +} + +if [[ $# -lt 1 || "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then + usage + exit 0 +fi + +if ! command -v gh >/dev/null 2>&1; then + echo "missing: gh" >&2 + exit 1 +fi +if ! command -v jq >/dev/null 2>&1; then + echo "missing: jq" >&2 + exit 1 +fi + +SKILL_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +PAYLOAD_FILE="${SKILL_DIR}/references/ruleset.release-branches.json" + +if [[ ! -f "${PAYLOAD_FILE}" ]]; then + echo "payload not found: ${PAYLOAD_FILE}" >&2 + exit 1 +fi + +NAME="$(jq -r '.name' < "${PAYLOAD_FILE}")" + +for OWNER_REPO in "$@"; do + echo ">>> ${OWNER_REPO}" + + # Find existing ruleset by name. + existing_id="$( + gh api "repos/${OWNER_REPO}/rulesets" --jq ".[] | select(.name == \"${NAME}\") | .id" 2>/dev/null || true + )" + + if [[ -n "${existing_id}" ]]; then + echo "Updating ruleset id=${existing_id}" + gh api -X PUT "repos/${OWNER_REPO}/rulesets/${existing_id}" --input "${PAYLOAD_FILE}" >/dev/null + else + echo "Creating ruleset" + gh api -H "Accept: application/vnd.github+json" -X POST "repos/${OWNER_REPO}/rulesets" --input "${PAYLOAD_FILE}" >/dev/null + fi +done diff --git a/skills/release-branch-policy/scripts/generate_release_manifest.sh b/skills/release-branch-policy/scripts/generate_release_manifest.sh new file mode 100755 index 0000000..d2ca661 --- /dev/null +++ b/skills/release-branch-policy/scripts/generate_release_manifest.sh @@ -0,0 +1,116 @@ +#!/usr/bin/env bash +set -euo pipefail + +usage() { + cat <<'EOF' +Generate a cross-repo release manifest (read-only) from local git state. + +Usage: + generate_release_manifest.sh [--base ] [--out ] + +Examples: + generate_release_manifest.sh v0.1 + generate_release_manifest.sh v0.1 --out releases/v0.1.yaml + generate_release_manifest.sh v0.1 --base /Users/shenlan/workspaces/cloud-neutral-toolkit + +Notes: + - This script does NOT create/push branches or tags. + - It inspects local refs only; if your local remotes are stale, run 'git fetch --all --tags' per repo first. + - "Cross-repo association" is represented by this manifest file (repo -> release branch tip + tag tip). +EOF +} + +if [[ $# -lt 1 || "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then + usage + exit 0 +fi + +VERSION="$1" +shift || true + +BASE="/Users/shenlan/workspaces/cloud-neutral-toolkit" +OUT="" + +while [[ $# -gt 0 ]]; do + case "$1" in + --base) + BASE="${2:-}" + shift 2 + ;; + --out) + OUT="${2:-}" + shift 2 + ;; + *) + echo "unknown arg: $1" >&2 + usage >&2 + exit 2 + ;; + esac +done + +if [[ -z "${OUT}" ]]; then + mkdir -p "releases" + OUT="releases/${VERSION}.yaml" +fi + +if [[ ! -d "${BASE}" ]]; then + echo "missing base dir: ${BASE}" >&2 + exit 1 +fi + +REL_BRANCH="release/${VERSION}" + +tmp="$(mktemp)" +trap 'rm -f "$tmp"' EXIT + +{ + echo "version: ${VERSION}" + echo "generated_at_utc: \"$(date -u +%Y-%m-%dT%H:%M:%SZ)\"" + echo "base_dir: \"${BASE}\"" + echo "release_branch: \"${REL_BRANCH}\"" + echo "repos:" +} >"$tmp" + +for d in "${BASE}"/*; do + [[ -d "$d" ]] || continue + [[ -d "$d/.git" ]] || continue + + name="$(basename "$d")" + remote_url="$(cd "$d" && git config --get remote.origin.url 2>/dev/null || true)" + + rel_ref="" + rel_sha="" + if (cd "$d" && git show-ref --verify --quiet "refs/remotes/origin/${REL_BRANCH}"); then + rel_ref="refs/remotes/origin/${REL_BRANCH}" + rel_sha="$(cd "$d" && git rev-parse "refs/remotes/origin/${REL_BRANCH}")" + elif (cd "$d" && git show-ref --verify --quiet "refs/heads/${REL_BRANCH}"); then + rel_ref="refs/heads/${REL_BRANCH}" + rel_sha="$(cd "$d" && git rev-parse "refs/heads/${REL_BRANCH}")" + fi + + tag_sha="" + if (cd "$d" && git show-ref --tags --quiet --verify "refs/tags/${VERSION}"); then + tag_sha="$(cd "$d" && git rev-parse "${VERSION}^{}" 2>/dev/null || git rev-parse "${VERSION}" 2>/dev/null || true)" + fi + + { + echo " - name: \"${name}\"" + echo " path: \"${d}\"" + if [[ -n "${remote_url}" ]]; then + echo " remote: \"${remote_url}\"" + else + echo " remote: \"\"" + fi + echo " release:" + echo " branch: \"${REL_BRANCH}\"" + echo " ref: \"${rel_ref}\"" + echo " sha: \"${rel_sha}\"" + echo " tag:" + echo " name: \"${VERSION}\"" + echo " sha: \"${tag_sha}\"" + } >>"$tmp" +done + +mv "$tmp" "$OUT" +echo "wrote: ${OUT}" diff --git a/skills/release-branch-policy/scripts/sync_skill_to_subrepos.sh b/skills/release-branch-policy/scripts/sync_skill_to_subrepos.sh new file mode 100755 index 0000000..73f32e6 --- /dev/null +++ b/skills/release-branch-policy/scripts/sync_skill_to_subrepos.sh @@ -0,0 +1,55 @@ +#!/usr/bin/env bash +set -euo pipefail + +usage() { + cat <<'EOF' +Copy this skill into all local Cloud-Neutral Toolkit sub-repos. + +Usage: + sync_skill_to_subrepos.sh + +Copies: + skills/release-branch-policy -> /skills/release-branch-policy + +Notes: + - Local path root: /Users/shenlan/workspaces/cloud-neutral-toolkit + - Skips directories without .git +EOF +} + +if [[ "${1:-}" == "-h" || "${1:-}" == "--help" ]]; then + usage + exit 0 +fi + +SRC_SKILL="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +SRC_REPO_ROOT="$(cd "${SRC_SKILL}/../.." && pwd)" + +realpath_py() { + python3 - "$1" <<'PY' +import os, sys +print(os.path.realpath(sys.argv[1])) +PY +} + +BASE="/Users/shenlan/workspaces/cloud-neutral-toolkit" +if [[ ! -d "${BASE}" ]]; then + echo "missing base dir: ${BASE}" >&2 + exit 1 +fi + +for d in "${BASE}"/*; do + [[ -d "$d" ]] || continue + [[ -d "$d/.git" ]] || continue + + # Don't delete our own source while syncing. + if [[ "$(realpath_py "$d")" == "$(realpath_py "$SRC_REPO_ROOT")" ]]; then + echo ">>> skipping source repo $d" + continue + fi + + mkdir -p "$d/skills" + echo ">>> syncing to $d" + rm -rf "$d/skills/release-branch-policy" + cp -R "${SRC_SKILL}" "$d/skills/release-branch-policy" +done diff --git a/vars/platform_k3s_bootstrap.yml b/vars/platform_k3s_bootstrap.yml deleted file mode 100644 index 944cae2..0000000 --- a/vars/platform_k3s_bootstrap.yml +++ /dev/null @@ -1,39 +0,0 @@ -k3s_platform_k3s_version: "v1.30.6+k3s1" -k3s_platform_cluster_name: "svc-plus" -k3s_platform_deployment_mode: "k3s_platform" - -# Stage 2: Vault bootstrap integration. -bootstrap_vault_url: "{{ lookup('env', 'VAULT_URL') | default('', true) }}" -bootstrap_vault_namespace: "{{ lookup('env', 'VAULT_NAMESPACE') | default('', true) }}" -bootstrap_vault_token: "{{ lookup('env', 'VAULT_TOKEN') | default('', true) }}" - -# Stage 3: FluxCD bootstrap Git repository access. -bootstrap_gitops_repo: "{{ lookup('env', 'GITOPS_REPO') }}" -bootstrap_gitops_auth_mode: "{{ lookup('env', 'GITOPS_AUTH_MODE') | default('public', true) }}" - -# Internal role mapping. -k3s_platform_vault_init_phase: "{{ lookup('env', 'K3S_PLATFORM_VAULT_INIT_PHASE') | default('post_flux', true) }}" -k3s_platform_git_url: "{{ bootstrap_gitops_repo }}" -k3s_platform_git_auth_mode: "{{ bootstrap_gitops_auth_mode }}" -k3s_platform_git_branch: "main" -k3s_platform_flux_namespace: "flux-system" -k3s_platform_flux_source_name: "platform-config" -k3s_platform_flux_root_path: "./infra/clusters/prod" -k3s_platform_tls_sans: - - "{{ inventory_hostname }}" -k3s_platform_vault_bootstrap_mode: "{{ lookup('env', 'K3S_PLATFORM_VAULT_BOOTSTRAP_MODE') | default('init', true) }}" -k3s_platform_vault_allow_sensitive_output: "{{ lookup('env', 'K3S_PLATFORM_VAULT_ALLOW_SENSITIVE_OUTPUT') | default('false', true) | bool }}" -k3s_platform_vault_server_url: "{{ bootstrap_vault_url }}" -k3s_platform_vault_namespace: "{{ bootstrap_vault_namespace }}" -k3s_platform_vault_token: "{{ bootstrap_vault_token }}" -k3s_platform_git_private_key: "{{ lookup('env', 'GITOPS_FLUX_DEPLOY_KEY') }}" -k3s_platform_git_public_key: "{{ lookup('env', 'GITOPS_FLUX_DEPLOY_KEY_PUB') }}" -k3s_platform_git_http_username: "{{ lookup('env', 'GITOPS_FLUX_HTTP_USERNAME') | default('x-access-token', true) }}" -k3s_platform_git_http_password: "{{ lookup('env', 'GITOPS_FLUX_HTTP_PASSWORD') | default(lookup('env', 'GITOPS_FLUX_TOKEN'), true) }}" -k3s_platform_git_bearer_token: "{{ lookup('env', 'GITOPS_FLUX_BEARER_TOKEN') }}" - -# Secret values must come from runtime environment variables, not git. -cloudflare_api_token: "{{ lookup('env', 'CLOUDFLARE_API_TOKEN') }}" -cloudflare_zone_id: "{{ lookup('env', 'CLOUDFLARE_ZONE_ID') }}" -vault_root_token: "{{ lookup('env', 'VAULT_ROOT_TOKEN') }}" -vault_init_json: "{{ lookup('env', 'VAULT_INIT_JSON') }}"