diff --git a/.github/workflows/axosyslog-collector.yml b/.github/workflows/axosyslog-collector.yml new file mode 100644 index 0000000000..3cb81ad766 --- /dev/null +++ b/.github/workflows/axosyslog-collector.yml @@ -0,0 +1,20 @@ +name: AxoSyslog Collector + +on: + push: + pull_request: + +defaults: + run: + working-directory: charts/axosyslog-collector + +jobs: + axosyslog-collector: + runs-on: ubuntu-latest + steps: + - name: Checkout source + uses: actions/checkout@v3 + + - name: Linter + run: | + docker run -v${PWD}:${PWD} alpine/helm lint ${PWD} diff --git a/.github/workflows/release-charts.yml b/.github/workflows/release-charts.yml new file mode 100644 index 0000000000..baabbd78ce --- /dev/null +++ b/.github/workflows/release-charts.yml @@ -0,0 +1,25 @@ +name: Release Charts + +on: + push: + branches: + - main + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.5.0 + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/LICENSE b/LICENSE index f288702d2f..261eeb9e9f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,201 @@ - 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 [yyyy] [name of copyright owner] + + 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/README.md b/README.md index 0d21b72dff..e587e16849 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -

@@ -9,7 +8,14 @@ # AxoSyslog - a cloud-native distribution of syslog-ng by Axoflow -This repository contains the cloud-ready syslog-ng images created and maintained by [Axoflow](https://axoflow.com). Our images are different from the [upstream syslog-ng images](https://hub.docker.com/r/balabit/syslog-ng/) in a number of ways: +This repository contains the cloud-ready syslog-ng images and Helm charts +created and maintained by [Axoflow](https://axoflow.com). + +## Container images + +Our images are +different from the [upstream syslog-ng +images](https://hub.docker.com/r/balabit/syslog-ng/) in a number of ways: - They are based on Alpine Linux, instead of Debian testing for reliability and smaller size (thus smaller attack surface). - They incorporate cloud-native features and settings (such as the Kubernetes source). @@ -22,7 +28,7 @@ Our images are available for the following architectures: - arm/v7 - arm64 -## How to use +### How to use You can find the list of tagged versions at [https://github.com/axoflow/axosyslog-docker/pkgs/container/axosyslog](https://github.com/axoflow/axosyslog-docker/pkgs/container/axosyslog). @@ -52,24 +58,42 @@ docker pull ghcr.io/axoflow/axosyslog:nightly > docker pull ghcr.io/axoflow/axosyslog:4.5.0 > ``` +## Helm Charts + +This repository contains various [Helm charts](https://helm.sh/docs/topics/charts/) for syslog-ng. You can use these charts to install the [AxoSyslog - cloud-ready syslog-ng images](https://github.com/axoflow/axosyslog-docker) created and maintained by [Axoflow](https://axoflow.com). + +### How to use + +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. + +Once Helm has been set up correctly, add the repo as follows: + + helm repo add axosyslog https://axoflow.github.io/axosyslog-charts + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +axosyslog` to see the charts. + +To install the axosyslog-collector chart: + + helm install my-axosyslog-collector axosyslog/axosyslog-collector + +To uninstall the chart: + + helm delete my-axosyslog-collector + ## Contact and support In case you need help or want to contact us, open a [GitHub issue](https://github.com/axoflow/axosyslog-docker/issues), or come chat with us in the [syslog-ng channel of the Axoflow Discord server](https://discord.gg/4Fzy7D66Qq). ## Contribution -If you have fixed a bug or would like to contribute your improvements to these images, [open a pull request](https://github.com/axoflow/axosyslog-docker/pulls). We truly appreciate your help. +If you have fixed a bug or would like to contribute your improvements to +AxoSyslog, [open a pull request](https://github.com/axoflow/axosyslog-docker/pulls). We truly appreciate your help. ## About Axoflow The [Axoflow](https://axoflow.com) founder team consists of successful entrepreneurs with a vast knowledge and hands-on experience about observability, log management, and how to apply these technologies in the enterprise security context. We also happen to be the creators of wide-spread open source technologies in this area, like syslog-ng and the [Logging operator for Kubernetes](https://github.com/kube-logging/logging-operator). To learn more about our products and our open-source projects, visit the [Axoflow blog](https://axoflow.com/blog/), or [subscribe to the Axoflow newsletter](https://axoflow.com/#newsletter-subscription). - -

- - - - Axoflow - -

diff --git a/charts/axosyslog-collector/.helmignore b/charts/axosyslog-collector/.helmignore new file mode 100644 index 0000000000..0e8a0eb36f --- /dev/null +++ b/charts/axosyslog-collector/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/axosyslog-collector/Chart.yaml b/charts/axosyslog-collector/Chart.yaml new file mode 100644 index 0000000000..9f5f1eef46 --- /dev/null +++ b/charts/axosyslog-collector/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +name: axosyslog-collector +description: AxoSyslog Kubernetes log collector +type: application +version: 0.8.0 +appVersion: "4.5.0" diff --git a/charts/axosyslog-collector/README.md b/charts/axosyslog-collector/README.md new file mode 100644 index 0000000000..56d2987193 --- /dev/null +++ b/charts/axosyslog-collector/README.md @@ -0,0 +1,55 @@ +# AxoSyslog Collector + +AxoSyslog Kubernetes log collector. + +## Prerequisites + +- Kubernetes 1.16+ +- Helm 3.0+ + + +## Configuration +The following table lists the configurable parameters of the AxoSyslog Collector chart and their default values: + + +| Parameter | Description | Default | +| --------- | ----------- | ------- | +| image.repository | The container image repository | ghcr.io/axoflow/axosyslog | +| image.pullPolicy | The container image pull policy | IfNotPresent | +| image.tag | The container image tag | 4.1.1 | +| imagePullSecrets | The names of secrets containing private registry credentials | [] | +| nameOverride | Override the chart name | "" | +| fullnameOverride | Override the full chart name | "" | +| daemonset.enabled | Deploy AxoSyslog as a DaemonSet | true | +| daemonset.labels | Additional labels to apply to the DaemonSet | {} | +| daemonset.annotations | Additional annotations to apply to the DaemonSet | {} | +| daemonset.affinity | Pod affinity | {} | +| daemonset.nodeSelector | Node labels for pod assignment | {} | +| daemonset.resources | Resource requests and limits | {} | +| daemonset.tolerations | Tolerations for pod assignment | [] | +| daemonset.hostAliases | Add host aliases | [] | +| daemonset.secretMounts | Mount additional secrets as volumes | [] | +| daemonset.extraVolumes | Additional volumes to mount | [] | +| daemonset.securityContext | Security context for the pod | {} | +| daemonset.maxUnavailable | The maximum number of unavailable pods during a rolling update | 1 | +| daemonset.hostNetworking | Whether to enable host networking | false | +| rbac.create | Whether to create RBAC resources | false | +| rbac.extraRules | Additional RBAC rules | [] | +| openShift.enabled | Whether to deploy on OpenShift | false | +| openShift.securityContextConstraints.create | Whether to create SecurityContextConstraints on OpenShift | true | +| openShift.securityContextConstraints.annotations | Annotations to apply to SecurityContextConstraints | {} | +| serviceAccount.create | Whether to create a service account | false | +| serviceAccount.annotations | Annotations to apply to the service account | {} | +| namespace | The Kubernetes namespace to deploy to | "" | +| podAnnotations | Additional annotations to apply to the pod | {} | +| podSecurityContext | Security context for the pod | {} | +| securityContext | Security context for the container | {} | +| resources | Resource requests and limits for the container | {} | +| nodeSelector | Node labels for pod assignment | {} | +| tolerations | Tolerations for pod assignment | [] | +| affinity | Pod affinity | {} | +| updateStrategy | Update strategy for the DaemonSet | RollingUpdate | +| kubernetes.enabled | Enable kubernetes log collection | true | +| kubernetes.prefix | Set JSON prefix for logs collected from the k8s cluster | "" | +| kubernetes.keyDelimiter | Set JSON key delimiter for logs collected from the k8s cluster | "" | + diff --git a/charts/axosyslog-collector/templates/NOTES.txt b/charts/axosyslog-collector/templates/NOTES.txt new file mode 100644 index 0000000000..c04d7116c6 --- /dev/null +++ b/charts/axosyslog-collector/templates/NOTES.txt @@ -0,0 +1,2 @@ +1. Watch the {{ template "axosyslog-collector.fullname" . }} container start. + $ kubectl get pods --namespace={{ .Release.Namespace }} -l app={{ template "axosyslog-collector.fullname" . }} -w diff --git a/charts/axosyslog-collector/templates/_helpers.tpl b/charts/axosyslog-collector/templates/_helpers.tpl new file mode 100644 index 0000000000..1867d83496 --- /dev/null +++ b/charts/axosyslog-collector/templates/_helpers.tpl @@ -0,0 +1,66 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "axosyslog-collector.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "axosyslog-collector.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "axosyslog-collector.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "axosyslog-collector.labels" -}} +helm.sh/chart: {{ include "axosyslog-collector.chart" . }} +{{ include "axosyslog-collector.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "axosyslog-collector.selectorLabels" -}} +app.kubernetes.io/name: {{ include "axosyslog-collector.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "axosyslog-collector.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "axosyslog-collector.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "axosyslog-collector.namespace" -}} +{{ .Values.namespace | default .Release.Namespace }} +{{- end -}} diff --git a/charts/axosyslog-collector/templates/clusterrole.yaml b/charts/axosyslog-collector/templates/clusterrole.yaml new file mode 100644 index 0000000000..3e54a11614 --- /dev/null +++ b/charts/axosyslog-collector/templates/clusterrole.yaml @@ -0,0 +1,23 @@ +{{- if .Values.rbac.create -}} +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: {{ include "axosyslog-collector.serviceAccountName" . }} +rules: + - apiGroups: [""] + resources: ["pods"] + verbs: ["get", "watch", "list"] + {{- if .Values.rbac.extraRules }} +{{ toYaml ( .Values.rbac.extraRules ) | indent 2 }} + {{- end }} + {{- if and .Values.openShift.enabled .Values.openShift.securityContextConstraints.create }} + - apiGroups: + - security.openshift.io + resources: + - securitycontextconstraints + resourceNames: + - {{ template "axosyslog-collector.fullname" . }} + verbs: + - use + {{- end }} +{{- end -}} diff --git a/charts/axosyslog-collector/templates/clusterrolebinding.yaml b/charts/axosyslog-collector/templates/clusterrolebinding.yaml new file mode 100644 index 0000000000..f22447e5f5 --- /dev/null +++ b/charts/axosyslog-collector/templates/clusterrolebinding.yaml @@ -0,0 +1,13 @@ +{{- if .Values.rbac.create -}} +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: {{ include "axosyslog-collector.serviceAccountName" . }} +subjects: + - kind: ServiceAccount + name: {{ include "axosyslog-collector.serviceAccountName" . }} + namespace: {{ include "axosyslog-collector.namespace" . }} +roleRef: + kind: ClusterRole + name: {{ include "axosyslog-collector.serviceAccountName" . }} +{{- end -}} diff --git a/charts/axosyslog-collector/templates/config.yaml b/charts/axosyslog-collector/templates/config.yaml new file mode 100644 index 0000000000..70a7368083 --- /dev/null +++ b/charts/axosyslog-collector/templates/config.yaml @@ -0,0 +1,134 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + labels: + {{- include "axosyslog-collector.labels" . | nindent 4 }} + name: {{ include "axosyslog-collector.fullname" . }} +data: +{{- if .Values.config.raw }} + syslog-ng.conf: {{ tpl (toYaml .Values.config.raw) . | indent 4 }} +{{- else }} + syslog-ng.conf: | + @version: {{ regexFind "^[0-9]+\\.[0-9]+" .Values.config.version | default "current" }} + @include "scl.conf" + + options { + stats( + level({{ .Values.config.stats.level }}) + ); + }; + + log { +{{- if .Values.config.sources.kubernetes.enabled }} + source { kubernetes( + {{- if .Values.config.sources.kubernetes.prefix }} + prefix({{ .Values.config.sources.kubernetes.prefix | quote }}) + {{- end }} + {{- if .Values.config.sources.kubernetes.keyDelimiter }} + key-delimiter({{ .Values.config.sources.kubernetes.keyDelimiter | quote }}) + {{- end }} + ); }; +{{- end }} +{{- range .Values.config.sources.opentelemetry }} + source { + opentelemetry( + {{- if .port }} + port({{ .port }}) + {{- end }} + ); + }; +{{- end }} +{{- if .Values.config.parsers.opentelemetry.enabled }} + parser { + opentelemetry(); + }; +{{- end }} +{{- with .Values.config.rewrites.set }} + rewrite { +{{- range $k, $v := . }} + set({{ $v | quote }} value({{ $k | quote }})); +{{- end }} + }; +{{- end }} +{{- range .Values.config.destinations.file }} + destination { + file( + {{ .path | quote }} + {{- if .template }} + template({{ .template | quote }}) + {{- end }} + {{- if .extraOptionsRaw }} + {{ .extraOptionsRaw }} + {{- end }} + ); + }; +{{- end }} +{{- range .Values.config.destinations.network }} + destination { + network( + {{ .address | quote }} + port({{ .port }}) + transport({{ .transport }}) + {{- if .template }} + template({{ .template | quote }}) + {{- end }} + {{- if .extraOptionsRaw }} + {{ .extraOptionsRaw }} + {{- end }} + ); + }; +{{- end }} +{{- range .Values.config.destinations.opensearch }} + destination { + elasticsearch-http( + url("https://{{ .address }}:9200/_bulk") + index({{ .index | quote }}) + type("") + {{- if .template }} + template({{ .template | quote }}) + {{- end }} + {{- if .user }} + user({{ .user | quote }}) + {{- end }} + {{- if .password }} + password({{ .password | quote }}) + {{- end }} + {{- if .tls }} + tls( + {{- if .tls.CAFile }} + ca-file({{ .tls.CAFile }}) + {{- end }} + {{- if .tls.CADir }} + ca-dir({{ .tls.CADir }}) + {{- end }} + {{- if .tls.Cert }} + cert-file({{ .tls.Cert }}) + {{- end }} + {{- if .tls.Key }} + key-file({{ .tls.Key }}) + {{- end }} + {{- if .tls.peerVerify }} + peer-verify(yes) + {{- else }} + peer-verify(no) + {{- end }} + ) + {{- end }} + {{- if .extraOptionsRaw }} + {{ .extraOptionsRaw }} + {{- end }} + ); + }; +{{- end }} +{{- range .Values.config.destinations.opentelemetry }} + destination { + opentelemetry( + url({{ tpl .url $ | quote }}) + {{- if .extraOptionsRaw }} + {{ .extraOptionsRaw }} + {{- end }} + ); + }; +{{- end }} + }; +{{- end }} diff --git a/charts/axosyslog-collector/templates/daemonset.yaml b/charts/axosyslog-collector/templates/daemonset.yaml new file mode 100644 index 0000000000..8c67b43fee --- /dev/null +++ b/charts/axosyslog-collector/templates/daemonset.yaml @@ -0,0 +1,158 @@ +{{- if .Values.daemonset.enabled }} +--- +apiVersion: apps/v1 +kind: DaemonSet +metadata: + name: {{ template "axosyslog-collector.fullname" . }} + namespace: {{ include "axosyslog-collector.namespace" . }} + labels: + app: "{{ template "axosyslog-collector.fullname" . }}" + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + heritage: {{ .Release.Service | quote }} + release: {{ .Release.Name | quote }} + {{- if .Values.daemonset.labels }} + {{- range $key, $value := .Values.daemonset.labels }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + {{- if .Values.daemonset.annotations }} + annotations: + {{- range $key, $value := .Values.daemonset.annotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} +spec: + selector: + matchLabels: + app: "{{ template "axosyslog-collector.fullname" . }}" + release: {{ .Release.Name | quote }} + updateStrategy: + {{- if eq .Values.updateStrategy "RollingUpdate" }} + rollingUpdate: + maxUnavailable: {{ .Values.daemonset.maxUnavailable }} + {{- end }} + type: {{ .Values.updateStrategy }} + template: + metadata: + {{- if .Values.podAnnotation }} + annotations: + {{- range $key, $value := .Values.podAnnotations }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + name: "{{ template "axosyslog-collector.fullname" . }}" + labels: + app: "{{ template "axosyslog-collector.fullname" . }}" + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + heritage: {{ .Release.Service | quote }} + release: {{ .Release.Name | quote }} + {{- if .Values.daemonset.labels }} + {{- range $key, $value := .Values.daemonset.labels }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + spec: + {{- if .Values.serviceAccount.create }} + serviceAccountName: {{ template "axosyslog-collector.serviceAccountName" . }} + {{- end}} + tolerations: {{ toYaml ( .Values.tolerations | default .Values.daemonset.tolerations ) | nindent 8 }} + nodeSelector: {{ toYaml ( .Values.nodeSelector | default .Values.daemonset.nodeSelector ) | nindent 8 }} + {{- if .Values.priorityClassName }} + priorityClassName: {{ .Values.priorityClassName }} + {{- end }} + affinity: {{ toYaml ( .Values.affinity | default .Values.daemonset.affinity ) | nindent 8 }} + terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }} + {{- if .Values.daemonset.hostNetworking }} + hostNetwork: true + dnsPolicy: ClusterFirstWithHostNet + {{- end }} + {{- if .Values.dnsConfig }} + dnsConfig: {{ toYaml .Values.dnsConfig | nindent 8 }} + {{- end }} + {{- if .Values.hostAliases | default .Values.daemonset.hostAliases }} + hostAliases: {{ toYaml ( .Values.hostAliases | default .Values.daemonset.hostAliases ) | nindent 8 }} + {{- end }} + volumes: + {{- range .Values.secretMounts | default .Values.daemonset.secretMounts }} + - name: {{ .name }} + secret: + secretName: {{ .secretName }} + {{- end }} + - name: config + configMap: + name: {{ include "axosyslog-collector.fullname" . }} + - name: var-log + hostPath: + path: /var/log + - name: var-lib-docker-containers + hostPath: + path: /var/lib/docker/containers + - name: var-run-docker-sock + hostPath: + path: /var/run/docker.sock + - name: var-lib-syslog-ng + emptyDir: {} + {{- if .Values.extraVolumes | default .Values.daemonset.extraVolumes }} +{{ toYaml ( .Values.extraVolumes | default .Values.daemonset.extraVolumes ) | indent 8 }} + {{- end }} + {{- if .Values.imagePullSecrets }} + imagePullSecrets: +{{ toYaml .Values.imagePullSecrets | indent 8 }} + {{- end }} + containers: + - name: "axosyslog-collector" + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: "{{ .Values.image.pullPolicy }}" + {{- if .Values.image.extraArgs }} + args: +{{ toYaml .Values.image.extraArgs | indent 12 }} + {{- end }} + resources: +{{ toYaml ( .Values.resources | default .Values.daemonset.resources ) | indent 12 }} + securityContext: {{ toYaml ( .Values.podSecurityContext | default .Values.daemonset.securityContext ) | nindent 12 }} + volumeMounts: + {{- range .Values.secretMounts | default .Values.daemonset.secretMounts }} + - name: {{ .name }} + mountPath: {{ .path }} + {{- if .subPath }} + subPath: {{ .subPath }} + {{- end }} + {{- end }} + - name: config + mountPath: /etc/syslog-ng/syslog-ng.conf + subPath: syslog-ng.conf + - name: var-log + mountPath: /var/log + - name: var-lib-docker-containers + mountPath: /var/lib/docker/containers + - name: var-run-docker-sock + mountPath: /var/run/docker.sock + - name: var-lib-syslog-ng + mountPath: /var/lib/syslog-ng + {{- if .Values.extraVolumeMounts | default .Values.daemonset.extraVolumeMounts }} +{{ toYaml (.Values.extraVolumeMounts | default .Values.daemonset.extraVolumeMounts ) | indent 12 }} + {{- end }} + livenessProbe: + initialDelaySeconds: 5 + periodSeconds: 30 + timeoutSeconds: 5 + failureThreshold: 3 + exec: + command: ["syslog-ng-ctl", "healthcheck", "--timeout", "5"] + {{- if .Values.metricsExporter.enabled }} + - name: "metrics-exporter" + image: "{{ .Values.metricsExporter.image.repository }}:{{ .Values.metricsExporter.image.tag }}" + imagePullPolicy: "{{ .Values.metricsExporter.image.pullPolicy }}" + args: + - --socket.path=/var/lib/syslog-ng/syslog-ng.ctl + volumeMounts: + - name: var-lib-syslog-ng + mountPath: /var/lib/syslog-ng + ports: + - containerPort: 9577 + name: exporter + protocol: TCP + resources: {{ toYaml ( .Values.metricsExporter.resources ) | nindent 12 }} + securityContext: {{ toYaml ( .Values.metricsExporter.securityContext | default .Values.daemonset.securityContext ) | nindent 12 }} + {{- end }} +{{- end }} diff --git a/charts/axosyslog-collector/templates/podmonitor.yaml b/charts/axosyslog-collector/templates/podmonitor.yaml new file mode 100644 index 0000000000..7663042103 --- /dev/null +++ b/charts/axosyslog-collector/templates/podmonitor.yaml @@ -0,0 +1,30 @@ +{{- if .Values.podMonitor.enabled }} +apiVersion: monitoring.coreos.com/v1 +kind: PodMonitor +metadata: + name: {{ template "axosyslog-collector.fullname" . }} + namespace: {{ include "axosyslog-collector.namespace" . }} + labels: + app: "{{ template "axosyslog-collector.fullname" . }}" + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + heritage: {{ .Release.Service | quote }} + release: {{ .Release.Name | quote }} + {{- with .Values.podMonitor.labels }} + {{- range $key, $value := . }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} + {{- with .Values.podMonitor.annotations }} + annotations: + {{- range $key, $value := . }} + {{ $key }}: {{ $value | quote }} + {{- end }} + {{- end }} +spec: + selector: + matchLabels: + app: "{{ template "axosyslog-collector.fullname" . }}" + release: {{ .Release.Name | quote }} + podMetricsEndpoints: + - port: exporter +{{- end }} diff --git a/charts/axosyslog-collector/templates/scc.yaml b/charts/axosyslog-collector/templates/scc.yaml new file mode 100644 index 0000000000..140d53442d --- /dev/null +++ b/charts/axosyslog-collector/templates/scc.yaml @@ -0,0 +1,37 @@ +{{- if and .Values.openShift.enabled .Values.openShift.securityContextConstraints.create }} +apiVersion: security.openshift.io/v1 +kind: SecurityContextConstraints +metadata: + name: {{ template "axosyslog-collector.fullname" . }} +{{- if .Values.openShift.securityContextConstraints.annotations }} + annotations: + {{- toYaml .Values.openShift.securityContextConstraints.annotations | nindent 4 }} +{{- end }} +allowPrivilegedContainer: true +allowPrivilegeEscalation: true +allowHostDirVolumePlugin: true +defaultAllowPrivilegeEscalation: false +# forbid host namespaces +allowHostNetwork: false +allowHostIPC: false +allowHostPorts: false +allowHostPID: false +allowedCapabilities: [] +forbiddenSysctls: +- "*" +readOnlyRootFilesystem: false +requiredDropCapabilities: +- MKNOD +runAsUser: + type: RunAsAny +seLinuxContext: + type: MustRunAs +supplementalGroups: + type: RunAsAny +volumes: + - configMap + - emptyDir + - hostPath + - persistentVolumeClaim + - secret +{{- end }} \ No newline at end of file diff --git a/charts/axosyslog-collector/templates/service.yaml b/charts/axosyslog-collector/templates/service.yaml new file mode 100644 index 0000000000..434e9cc223 --- /dev/null +++ b/charts/axosyslog-collector/templates/service.yaml @@ -0,0 +1,19 @@ +{{- if .Values.service.create }} +--- +apiVersion: v1 +kind: Service +metadata: + name: "{{ template "axosyslog-collector.fullname" . }}" +spec: + selector: + app: "{{ template "axosyslog-collector.fullname" . }}" + release: {{ .Release.Name | quote }} + ports: +{{ if .Values.service.extraPorts }} +{{ toYaml ( .Values.service.extraPorts ) | nindent 4 }} +{{ end }} +{{ range .Values.config.sources.opentelemetry }} + - protocol: TCP + port: {{ .port | default 4317 }} +{{ end }} +{{- end }} diff --git a/charts/axosyslog-collector/templates/serviceaccount.yaml b/charts/axosyslog-collector/templates/serviceaccount.yaml new file mode 100644 index 0000000000..6d52ac7ffc --- /dev/null +++ b/charts/axosyslog-collector/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "axosyslog-collector.serviceAccountName" . }} + namespace: {{ include "axosyslog-collector.namespace" . }} + labels: + {{- include "axosyslog-collector.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/axosyslog-collector/values.yaml b/charts/axosyslog-collector/values.yaml new file mode 100644 index 0000000000..8d983b6e89 --- /dev/null +++ b/charts/axosyslog-collector/values.yaml @@ -0,0 +1,135 @@ +image: + repository: ghcr.io/axoflow/axosyslog + pullPolicy: IfNotPresent + tag: "" + extraArgs: [] + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +daemonset: + enabled: true + labels: {} + annotations: {} + affinity: {} + nodeSelector: {} + resources: {} + tolerations: [] + hostAliases: [] + secretMounts: [] + extraVolumes: [] + securityContext: {} + maxUnavailable: 1 + hostNetworking: false + +metricsExporter: + enabled: false # deploy the axosyslog Deamonset with the axosyslog-metrics-exporter sidecar + image: + repository: ghcr.io/axoflow/axosyslog-metrics-exporter + tag: latest + pullPolicy: ~ # use k8s default behavior (Always for :latest, IfNotPresent otherwise) + resources: {} + securityContext: {} + +podMonitor: + enabled: false # deploy the PodMonitor CR for Prometheus Operator (requires metricsExporter.enabled) + labels: {} + annotations: {} + +config: + raw: "" # Use this to manually set the contents of the syslog-ng.conf file. + version: "" + stats: + level: 2 + sources: + kubernetes: + enabled: true +# E.g.: +# prefix: "k8s~" +# keyDelimiter: "~" + opentelemetry: [] +# E.g.: +# - port: 4317 + parsers: + opentelemetry: + enabled: false + rewrites: + set: {} +# E.g.: +# foo: "${foovalue}" +# bar: "${barvalue}" + destinations: + file: [] +# E.g.: +# - path: "/dev/stdout" +# template: "$(format-json .*)" +# extraOptionsRaw: "create-dirs(yes)" + network: [] +# E.g.: +# - transport: tcp +# address: localhost +# port: 12345 +# template: "$(format-json .*)" +# extraOptionsRaw: "time-reopen(10)" + opensearch: [] +# E.g.: +# - address: 10.104.232.94 +# index: "test-axoflow-index" +# user: "admin" +# password: "admin" +# tls: +# CAFile: "/path/to/CAFile.pem" +# CADir: "/path/to/CADir/" +# Cert: "/path/to/Cert.pem" +# Key: "/path/to/Key.pem" +# peerVerify: false +# template: "$(format-json .*)" +# extraOptionsRaw: "time-reopen(10)" + opentelemetry: [] +# E.g.: +# - url: "10.104.232.95:4317" +# extraOptionsRaw: "time-reopen(10)" + +rbac: + create: true + extraRules: [] + +openShift: + enabled: false + securityContextConstraints: + create: true + annotations: {} + +service: + create: false + extraPorts: [] + +serviceAccount: + create: true + annotations: {} + +namespace: "" +podAnnotations: {} +podSecurityContext: {} +# fsGroup: 2000 +securityContext: {} +resources: {} +# limits: +# cpu: 100m +# memory: 128Mi +# requests: +# cpu: 100m +# memory: 128Mi +nodeSelector: {} +tolerations: [] +affinity: {} +updateStrategy: RollingUpdate +priorityClassName: "" +dnsConfig: {} +hostAliases: [] +secretMounts: [] +extraVolumes: [] +## How long (in seconds) a pod may take to exit (useful with lifecycle hooks to ensure lb deregistration is done) +## +terminationGracePeriodSeconds: 30