diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..711263e --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,22 @@ +--- +name: lint + +'on': + pull_request: + push: + branches: + - '**' + +jobs: + cookstyle: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.7 + bundler-cache: true + - uses: r7kamura/rubocop-problem-matchers-action@v1 # this shows the failures in the PR + - name: Run cookstyle + working-directory: ./resources + run: bundle exec cookstyle diff --git a/.github/workflows/rpm.yml b/.github/workflows/rpm.yml new file mode 100644 index 0000000..5d83b78 --- /dev/null +++ b/.github/workflows/rpm.yml @@ -0,0 +1,83 @@ +name: RPM Build and Upload + +on: + push: + branches: + - 'master' + - 'main' + +jobs: + build: + runs-on: ubuntu-latest + + env: + ACTIONS_ALLOW_UNSECURE_COMMANDS: true + + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Create tag based on metadata.rb + id: create_tag + run: | + TAG=$(grep -o 'version\s*["'\''][^"'\'']*' ./resources/metadata.rb | sed 's/version\s*["'\'']//;s/["'\'']//') + echo "TAG=$TAG" >> $GITHUB_ENV + shell: bash + + - name: Check if Tag Exists + id: check_tag + run: | + if git rev-parse "refs/tags/${{ env.TAG }}" >/dev/null 2>&1; then + echo "Tag ${{ env.TAG }} already exists, exiting." + exit 1 + fi + shell: bash + + - name: Set Version + if: success() + run: echo "VERSION=${{ env.TAG }}" >> $GITHUB_ENV + + - name: Run Docker Container + if: success() + run: docker run --privileged -d --name builder --network host rockylinux:9 /bin/sleep infinity + + - name: Install build tools RPM + if: success() + run: | + docker cp ./ builder:/build + docker exec builder bash -c "yum install -y epel-release && yum install -y make git mock" + docker exec builder bash -c "rm -rf /etc/mock/default.cfg" + + - name: Setup SDK + if: success() + run: | + docker exec builder bash -c "curl https://raw.githubusercontent.com/redBorder/repoinit/master/sdk9.cfg > /build/sdk9.cfg" + docker exec builder bash -c "echo \"config_opts['use_host_resolv'] = True\" >> /build/sdk9.cfg" + docker exec builder bash -c "ln -s /build/sdk9.cfg /etc/mock/default.cfg" + + - name: Build RPM using mock + if: success() + run: | + docker exec builder bash -c "git config --global --add safe.directory /build" + docker exec builder bash -c "cd /build/ && VERSION=${{ env.TAG }} make rpm" + + - name: Copy RPMS + if: success() + run: | + docker cp builder:/build/packaging/rpm/pkgs/. ./rpms + + - name: Delete non-.rpm files + if: success() + run: | + find ./rpms -type f -not -name '*.rpm' -exec rm {} \; + + - name: Release + if: success() + uses: softprops/action-gh-release@v1 + with: + files: ./rpms/* + tag_name: ${{ env.TAG }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 0000000..7c5dcfd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +cookbook-rb-secor CHANGELOG +========================= + +This file is used to list changes made in each version of the rsyslog cookbook. + +0.0.1 +----- +- [malvarez] - First cookbook version diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..9734e78 --- /dev/null +++ b/Gemfile @@ -0,0 +1,5 @@ +source 'https://rubygems.org' + +gem 'cookstyle', '= 7.32.1' +gem 'rspec', '= 3.11' +gem 'rubocop', '= 1.25.1' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5dcae70 --- /dev/null +++ b/LICENSE @@ -0,0 +1,663 @@ +Copyright (c) 2023 Eneo Tecnología SL. + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d70fde0 --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +all: rpm + +rpm: + $(MAKE) -C packaging/rpm + +rpmtest: + $(MAKE) LATEST=`git stash create` -C packaging/rpm \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..177e501 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# cookbook-rb-secor +[![Build Status][build-shield]][build-url] +[![Linters][linters-shield]][linters-url] +[![License][license-shield]][license-url] + + +[build-shield]: https://github.com/redBorder/cookbook-rb-secor/actions/workflows/rpm.yml/badge.svg?branch=master +[build-url]: https://github.com/redBorder/cookbook-rb-secor/actions/workflows/rpm.yml?query=branch%3Amaster +[linters-shield]: https://github.com/redBorder/cookbook-rb-secor/actions/workflows/lint.yml/badge.svg?event=push +[linters-url]: https://github.com/redBorder/cookbook-rb-secor/actions/workflows/lint.yml +[license-shield]: https://img.shields.io/badge/license-AGPLv3-blue.svg +[license-url]: https://github.com/cookbook-rb-secor/blob/HEAD/LICENSE + +Chef cookbook to install and configure redborder syslog + +### Platforms + +- Rocky Linux 9 + +### Chef + +- Chef 15.7.0 or later + +## Contributing + +1. Fork the repository on Github +2. Create a named feature branch (like `add_component_x`) +3. Write your change +4. Write tests for your change (if applicable) +5. Run the tests, ensuring they all pass +6. Submit a Pull Request using Github + +## License + +GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 diff --git a/packaging/rpm/Makefile b/packaging/rpm/Makefile new file mode 100644 index 0000000..eaaaff8 --- /dev/null +++ b/packaging/rpm/Makefile @@ -0,0 +1,55 @@ +PACKAGE_NAME?= cookbook-rb-secor + +VERSION?= $(shell git describe --abbrev=6 --tags HEAD --always | sed 's/-/_/g') + +BUILD_NUMBER?= 1 + +MOCK_CONFIG?=default + +RESULT_DIR?=pkgs + +LATEST?=HEAD + +all: rpm + + +SOURCES: + mkdir -p SOURCES + +archive: SOURCES + cd ../../ && \ + git archive --prefix=$(PACKAGE_NAME)-$(VERSION)/ \ + -o packaging/rpm/SOURCES/$(PACKAGE_NAME)-$(VERSION).tar.gz $(LATEST) + + +build_prepare: archive + mkdir -p $(RESULT_DIR) + rm -f $(RESULT_DIR)/$(PACKAGE_NAME)*.rpm + + +srpm: build_prepare + /usr/bin/mock \ + -r $(MOCK_CONFIG) \ + --define "__version $(VERSION)" \ + --define "__release $(BUILD_NUMBER)" \ + --resultdir=$(RESULT_DIR) \ + --buildsrpm \ + --spec=${PACKAGE_NAME}.spec \ + --sources=SOURCES + @echo "======= Source RPM now available in $(RESULT_DIR) =======" + +rpm: srpm + /usr/bin/mock \ + -r $(MOCK_CONFIG) \ + --define "__version $(VERSION)"\ + --define "__release $(BUILD_NUMBER)"\ + --resultdir=$(RESULT_DIR) \ + --rebuild $(RESULT_DIR)/$(PACKAGE_NAME)*.src.rpm + @echo "======= Binary RPMs now available in $(RESULT_DIR) =======" + +clean: + rm -rf SOURCES pkgs + +distclean: clean + rm -f build.log root.log state.log available_pkgs installed_pkgs \ + *.rpm *.tar.gz diff --git a/packaging/rpm/cookbook-rb-secor.spec b/packaging/rpm/cookbook-rb-secor.spec new file mode 100644 index 0000000..a81733f --- /dev/null +++ b/packaging/rpm/cookbook-rb-secor.spec @@ -0,0 +1,49 @@ +Name: cookbook-rb-secor +Version: %{__version} +Release: %{__release}%{?dist} +BuildArch: noarch +Summary: Secor service to store kafka data and send to s3 + +License: AGPL 3.0 +URL: https://github.com/redBorder/cookbook-rb-secor +Source0: %{name}-%{version}.tar.gz + +%description +%{summary} + +%prep +%setup -qn %{name}-%{version} + +%build + +%install +mkdir -p %{buildroot}/var/chef/cookbooks/secor +cp -f -r resources/* %{buildroot}/var/chef/cookbooks/secor/ +chmod -R 0755 %{buildroot}/var/chef/cookbooks/secor +install -D -m 0644 README.md %{buildroot}/var/chef/cookbooks/secor/README.md + +%pre + +%post +case "$1" in + 1) + # This is an initial install. + : + ;; + 2) + # This is an upgrade. + su - -s /bin/bash -c 'source /etc/profile && rvm gemset use default && env knife cookbook upload secor' + ;; +esac + +%files +%defattr(0755,root,root) +/var/chef/cookbooks/secor +%defattr(0644,root,root) +/var/chef/cookbooks/secor/README.md + +%doc + +%changelog +* Tue Jan 21 2025 Miguel Álvarez - 0.0.1 +- first spec version diff --git a/resources/attributes/default.rb b/resources/attributes/default.rb new file mode 100755 index 0000000..492f798 --- /dev/null +++ b/resources/attributes/default.rb @@ -0,0 +1,16 @@ +default['secor']['registered'] = false +default['secor-vault']['registered'] = false + +default['redborder']['secor']['user'] = 'root' +default['redborder']['secor']['group'] = 'root' +default['redborder']['secor']['s3_bucket'] = 'bucket' +default['redborder']['secor']['s3_user'] = 'redborder' +default['redborder']['secor']['s3_pass'] = 'redborder' +default['redborder']['secor']['s3_port'] = 9000 +default['redborder']['secor']['kafka_hosts'] = ['kafka.service'] +default['redborder']['secor']['zk_hosts'] = ['zookeeper.service:2181'] +default['redborder']['secor']['s3_hostname'] = 's3.service' +default['redborder']['secor']['s3_server'] = 's3.service' + + + diff --git a/resources/libraries/helper.rb b/resources/libraries/helper.rb new file mode 100755 index 0000000..8cad50c --- /dev/null +++ b/resources/libraries/helper.rb @@ -0,0 +1,4 @@ +module Secor + module Helper + end +end diff --git a/resources/metadata.rb b/resources/metadata.rb new file mode 100755 index 0000000..be6734a --- /dev/null +++ b/resources/metadata.rb @@ -0,0 +1,6 @@ +name 'secor' +maintainer 'Eneo Tecnología S.L.' +maintainer_email 'git@redborder.com' +license 'AGPL-3.0' +description 'Installs/Configures secor in redborder manager' +version '0.0.1' diff --git a/resources/providers/config.rb b/resources/providers/config.rb new file mode 100755 index 0000000..9440d4e --- /dev/null +++ b/resources/providers/config.rb @@ -0,0 +1,208 @@ +# Cookbook:: Secor +# Provider:: configure + +include Secor::Helper + +action :add do + begin + + dnf_package 'rb-secor' do + action :install + flush_cache [:before] + end + + s3_hostname = new_resource.s3_hostname + s3_user = new_resource.s3_user + s3_pass = new_resource.s3_pass + s3_bucket = new_resource.s3_bucket + zk_hosts = new_resource.zk_hosts + kafka_hosts = new_resource.kafka_hosts + s3_port = new_resource.s3_port + manager_services = new_resource.manager_services + s3_server = new_resource.s3_server + + service 'rb-secor' do + supports start: true, enable: true + action [:start, :enable] + end + + service 'rb-secor-vault' do + supports start: true, enable: true + action [:start, :enable] + end + + group 'secor' do + action :create + end + + execute 'create_secor_user' do + command 'useradd -m -r -g secor secor' + not_if 'id -u secor' + end + + directory "/var/secor" do + owner "secor" + group "secor" + mode 0770 + action :create + end + + directory "/mnt/secor_data" do + owner "secor" + group "secor" + mode 0770 + recursive true + action :create + end + + execute 'create_logs_symlink' do + command 'ln -s /var/log/secor /mnt/secor_data/logs' + not_if 'test -L /mnt/secor_data/logs' + end + + directory "/tmp/secor_data" do + owner "secor" + group "secor" + mode 0770 + action :create + end + + directory "/mnt/secor_vault_data" do + owner "secor" + group "secor" + mode 0770 + recursive true + action :create + end + + execute 'create_logs_symlink' do + command 'ln -s /var/log/secor-vault /mnt/secor_vault_data/logs' + not_if 'test -L /mnt/secor_vault_data/logs' + end + + directory "/tmp/secor_vault_data" do + owner "secor" + group "secor" + mode 0770 + action :create + end + + template "/var/secor/secor.common.properties" do + source "secor.common.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + variables(:s3_hostname => s3_hostname, :s3_user => s3_user, :s3_pass => s3_pass, :s3_bucket => s3_bucket) + notifies :restart, "service[rb-secor]", :delayed if manager_services["secor"] + end + + template "/var/secor/log4j.prod.properties" do + source "secor_log4j.prod.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + notifies :restart, "service[rb-secor]", :delayed if manager_services["secor"] + end + + template "/var/secor/secor.prod.properties" do + source "secor.prod.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + variables(:zk_hosts => zk_hosts, :kafka_hosts => kafka_hosts, :s3_bucket => s3_bucket) + notifies :restart, "service[rb-secor]", :delayed if manager_services["secor"] + end + + template "/var/secor/secor.prod.partition.properties" do + source "secor.prod.partition.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + notifies :restart, "service[rb-secor]", :delayed if manager_services["secor"] + end + + template "/var/secor/jets3t.properties" do + source "jets3t.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + variables(:s3_bucket => s3_bucket, :s3_server => s3_server, :s3_port => s3_port) + notifies :restart, "service[rb-secor]", :delayed if manager_services["secor"] + notifies :restart, "service[rb-secor-vault]", :delayed if manager_services["secor-vault"] + end + + template "/var/secor/secor-vault.common.properties" do + source "secor-vault.common.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + variables(:s3_hostname => s3_hostname, :s3_user => s3_user, :s3_pass => s3_pass) + notifies :restart, "service[rb-secor-vault]", :delayed if manager_services["secor-vault"] + end + + template "/var/secor/log4j-vault.prod.properties" do + source "secor-vault_log4j.prod.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + notifies :restart, "service[rb-secor-vault]", :delayed if manager_services["secor-vault"] + end + + template "/var/secor/secor-vault.prod.properties" do + source "secor-vault.prod.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + variables(:zk_hosts => zk_hosts, :kafka_hosts => kafka_hosts, :s3_bucket => s3_bucket) + notifies :restart, "service[rb-secor-vault]", :delayed if manager_services["secor-vault"] + end + + template "/var/secor/secor-vault.prod.partition.properties" do + source "secor-vault.prod.partition.properties.erb" + cookbook 'secor' + owner "secor" + group "secor" + mode 0644 + retries 2 + notifies :restart, "service[rb-secor-vault]", :delayed if manager_services["secor-vault"] + end + + Chef::Log.info('rbsecor has been configured correctly.') + rescue => e + Chef::Log.error(e.message) + end +end + +action :remove do + begin + service 'secor' do + supports stop: true, disable: true + action [:stop, :disable] + end + + service 'secor-vault' do + supports stop: true, disable: true + action [:stop, :disable] + end + + Chef::Log.info('rbsecor cookbook has been processed') + rescue => e + Chef::Log.error(e.message) + end +end \ No newline at end of file diff --git a/resources/recipes/default.rb b/resources/recipes/default.rb new file mode 100755 index 0000000..c6b32e9 --- /dev/null +++ b/resources/recipes/default.rb @@ -0,0 +1,18 @@ +# Cookbook:: secor +# Recipe:: default +# Copyright:: 2024, redborder +# License:: Affero General Public License, Version 3 + +secor_config 'add' do + user node['redborder']['secor']['user'] + group node['redborder']['secor']['group'] + kafka_hosts node['redborder']['secor']['kafka_hosts'] + zk_hosts node['redborder']['secor']['zk_hosts'] + manager_services node['redborder']['secor']['manager_services'] + s3_server node['redborder']['secor']['s3_hostname'] + s3_user node['redborder']['secor']['s3_user'] + s3_pass node['redborder']['secor']['s3_pass'] + s3_bucket node['redborder']['secor']['s3_bucket'] + s3_port node['redborder']['secor']['s3_port'] + action :add +end \ No newline at end of file diff --git a/resources/resources/config.rb b/resources/resources/config.rb new file mode 100755 index 0000000..09657ca --- /dev/null +++ b/resources/resources/config.rb @@ -0,0 +1,17 @@ +# Cookbook:: rsyslog +# Resource:: configure + +actions :add, :remove +default_action :add + +attribute :user, kind_of: String, default: 'root' +attribute :group, kind_of: String, default: 'root' +attribute :kafka_hosts, kind_of: Array +attribute :s3_server, kind_of: String, default: 's3.service' +attribute :s3_hostname, kind_of: String, default: 's3.service' +attribute :s3_user, kind_of: String, default: 'redborder' +attribute :s3_pass, kind_of: String, default: 'redborder' +attribute :s3_port, kind_of: Integer, default: 9000 +attribute :s3_bucket, kind_of: String, default: 'bucket' +attribute :manager_services, kind_of: Hash +attribute :zk_hosts, kind_of: String diff --git a/resources/templates/default/jets3t.properties.erb b/resources/templates/default/jets3t.properties.erb new file mode 100644 index 0000000..5ce2044 --- /dev/null +++ b/resources/templates/default/jets3t.properties.erb @@ -0,0 +1,6 @@ +<% if @s3_bucket %> + s3service.s3-endpoint=<%= @s3_server %> + s3service.s3-endpoint-http-port=<%= @s3_port %> + s3service.disable-dns-buckets=true + s3service.https-only=false +<% end %> diff --git a/resources/templates/default/secor-vault.common.properties.erb b/resources/templates/default/secor-vault.common.properties.erb new file mode 100644 index 0000000..bdc0a1a --- /dev/null +++ b/resources/templates/default/secor-vault.common.properties.erb @@ -0,0 +1,294 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +############ +# MUST SET # +############ + +# Regular expression matching names of consumed topics. +secor.kafka.topic_filter=rb_vault_post.* + +# Choose what to fill according to the service you are using +# in the choice option you can fill S3, GS, Swift or Azure +cloud.service=S3 + +# AWS authentication credentials. +# Leave empty if using IAM role-based authentication with s3a filesystem. + +#AWS +aws.access.key=<%= @s3_user %> +aws.secret.key=<%= @s3_pass %> + +# Optional Proxy Setting. Set to true to enable proxy +# Only applicable to S3UploadManager +aws.proxy.isEnabled=false +aws.proxy.http.host= +aws.proxy.http.port= + +################ +# END MUST SET # +################ + +# AWS region or endpoint. region should be a known region name (eg. +# us-east-1). endpoint should be a known S3 endpoint url. If neither +# are specified, then the default region (us-east-1) is used. If both +# are specified then endpoint is used. +# +# Only apply if the the S3UploadManager is used - see +# secor.upload.manager.class. +# +# http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region +aws.region=<%= @s3_hostname %> + +########################### +# START AWS S3 ENCRYPTION # +########################### + +# AWS specify type of server-side encryption, if any +# set to S3 to enable S3-managed encryption +# set to KMS to enable AWS KMS-managed encryption (see aws.sse.kms.key) +# set to customer to enable customer-managed encryption (see aws.sse.customer.key) +# set empty to disable encryption +aws.sse.type= + +# Key to use for S3 server-side encryption, base64-encoded +# Note: requires aws.sse.type to be set to customer to be used +aws.sse.customer.key= + +# KMS Key to use for S3 server-side encryption, base64-encoded +# Leave empty to use default generated key +# Note: requires aws.sse.type to be set to KMS to be used +aws.sse.kms.key= + +######################### +# END AWS S3 ENCRYPTION # +######################### + +# Hadoop filesystem to use. Choices are s3n or s3a. +# See https://wiki.apache.org/hadoop/AmazonS3 for details. +secor.s3.filesystem=s3n + +# Swift config, MUST configure if cloud.service=Swift + +# Swift Login Details: +swift.use.get.auth=true +swift.auth.url= +swift.tenant= +swift.username= +swift.port=8080 +swift.public=true + +# only needed if "swift.use.get.auth" = false +swift.password= + +# only needed if "swift.use.get.auth" = true +swift.api.key= + +# GS config, MUST configure if gcloud.service=GS + +# Name of the Google cloud storage bucket where log files are stored. +secor.gs.bucket=secor_gs + +# Google cloud storage path where files are stored within the bucket. +secor.gs.path=data + +# Use direct uploads +# WARNING: disables resumable uploads, files are uploaded in a single request +# This may help prevent IOException: insufficient data written, +# see https://github.com/pinterest/secor/issues/177 +# https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload +secor.gs.upload.direct=false + +# Zookeeper config. +zookeeper.session.timeout.ms=3000 +zookeeper.sync.time.ms=200 + +# Zookeeper path (chroot) under which secor data will be placed. +secor.zookeeper.path=/ + +# Impacts how frequently the upload logic is triggered if no messages are delivered. +kafka.consumer.timeout.ms=10000 + +# Choose between range and roundrobin partition assignment strategy for kafka +# high level consumers. Check PartitionAssignor.scala in kafa 821 module for +# the differences between the two. +# In kafka 811, only range strategy is supported. +kafka.partition.assignment.strategy=range + +# Max number of retries during rebalance. +kafka.rebalance.max.retries= + +# Rebalance backoff. +kafka.rebalance.backoff.ms= + +# Kafka consumer receive buffer size (socket.receive.buffer.bytes) +kafka.socket.receive.buffer.bytes= + +# Kafka fetch max size (fetch.message.max.bytes) +kafka.fetch.message.max.bytes= + +# Kafka fetch min bytes (fetch.fetch.min.bytes) +kafka.fetch.min.bytes= + +# Kafka fetch max wait ms (fetch.max.wait.ms) +kafka.fetch.wait.max.ms= + +# Port of the broker serving topic partition metadata. +kafka.seed.broker.port=9092 + +# Zookeeper path at which kafka is registered. In Zookeeper parlance, this is referred +# to as the chroot. +kafka.zookeeper.path=/ + +# Store offset in zookeeper and kafka consumer topic. +# Only used if kafka.offsets.storage is set to "kafka" +# http://kafka.apache.org/documentation.html#oldconsumerconfigs +# Possible values: true or false +kafka.dual.commit.enabled=true + +# Storage offset. +# Possible values: "zookeeper" to read offset from zookeeper or "kafka" to read offset from kafka consumer topic +kafka.offsets.storage=zookeeper + +# Secor generation is a version that should be incremented during non-backwards-compabile +# Secor releases. Generation number is one of the components of generated log file names. +# Generation number makes sure that outputs of different Secor versions are isolated. +secor.generation=1 + +# Number of consumer threads per Secor process. +secor.consumer.threads=<%= [ node["cpu"]["total"].to_i-1, 1 ].max %> + +# Consumption rate limit enforced at the process level (not a consumer-thread level). +secor.messages.per.second=10000 + +# Used by the "backup" consumer group only. +# Number of continous message offsets that constitute a single offset= partition on s3. +# Example: +# if set to 10, +# messages with offsets 0 to 9 will be written to s3 path s3n://.../offset=0/... +# messages with offsets 10 to 19 will be written to s3 path s3n://.../offset=10/... +# ... +secor.offsets.per.partition=10000000 + +# How long does it take for secor to forget a topic partition. Applies to stats generation only. +secor.topic_partition.forget.seconds=600 + +# Setting the partitioner to use hourly partition +# By default, the partitioner will do daily partition, so the data will be +# written into +# s3n://.../topic/dt=2015-07-07/ +# If this parameter is set to true, the data will be written into +# s3n://.../topic/dt=2015-07-07/hr=02 +# The hour folder ranges from 00 to 23 +partitioner.granularity.hour=true +partitioner.granularity.minute=true +# how many seconds should the finalizer wait to finalize a partition +partitioner.finalizer.delay.seconds=60 + +# During partition finalization, the finalizer will start from the last +# time partition (e.g. dt=2015-07-17) and traverse backwards for n +# partition periods (e.g. dt=2015-07-16, dt=2015-07-15 ...) +# This parameter controls how many partition periods to traverse back +# The default is 10 +# secor.finalizer.lookback.periods=48 + +# If greater than 0, upon starup Secor will clean up directories and files under secor.local.path +# that are older than this value. +secor.local.log.delete.age.hours=-1 + +# Secor comes with a tool that adds Hive partitions for finalized topics. Currently, we support +# only Hive clusters accessible through Qubole. The token gives access to the Qubole API. +# It is available at https://api.qubole.com/users/edit +qubole.api.token= + +# hive tables are generally named after the topics. For instance if the topic +# is request_log the hive table is also called request_log. If you want this +# to be pinlog_request_log you can set this config to "pinlog_". This affects +# all topics. +hive.table.prefix= + +# You can also name your hive table directly if your hive table doesn't +# follow the pattern of +# E.g. hive.table.name.topic1=table1 to indicate that hive table for +# kafka topic will be named + +# Secor can export stats such as consumption lag (in seconds and offsets) per topic partition. +# Leave empty to disable this functionality. +tsdb.hostport= + +# Regex of topics that are not exported to TSDB. +monitoring.blacklist.topics= + +# Prefix of exported statss. +monitoring.prefix=secor + +# Secor can export stats to statsd such as consumption lag (in seconds and offsets) per topic partition. +# Leave empty to disable this functionality. +statsd.hostport= + +# Name of field that contains timestamp for JSON, MessagePack, or Thrift message parser. (1405970352123) +message.timestamp.name=timestamp + +# Separator for defining message.timestamp.name in a nested structure. E.g. +# {"meta_data": {"created": "1405911096123", "last_modified": "1405912096123"}, "data": "test"} +# message.timestamp.name=meta_data.created +# message.timestamp.name.separator=. +message.timestamp.name.separator= + +# Field ID of the field that contains timestamp for Thrift message parser. +# N.B. setting this past 1 will come with a performance penalty +message.timestamp.id=1 + +# Data type of the timestamp field for thrift message parser. +# Supports i64 and i32. +message.timestamp.type=i64 + +# Name of field that contains a timestamp, as a date Format, for JSON. (2014-08-07, Jul 23 02:16:57 2005, etc...) +# Should be used when there is no timestamp in a Long format. Also ignore time zones. +message.timestamp.input.pattern= + +# whether timestamp field is required, it should always be required. But +# for historical reason, we didn't enforce this check, there might exist some +# installations with messages missing timestamp field +message.timestamp.required=true + +# To enable compression, set this to a valid compression codec implementing +# org.apache.hadoop.io.compress.CompressionCodec interface, such as +# 'org.apache.hadoop.io.compress.GzipCodec'. +secor.compression.codec=org.apache.hadoop.io.compress.GzipCodec + +# To set a custom file extension set this to a valid file suffix, such as +# '.gz', '.part', etc. +secor.file.extension= + +# The secor file reader/writer used to read/write the data, by default we write sequence files +#secor.file.reader.writer.factory=com.pinterest.secor.io.impl.SequenceFileReaderWriterFactory +secor.file.reader.writer.factory=com.pinterest.secor.io.impl.DelimitedTextFileReaderWriterFactory + +# Max message size in bytes to retrieve via KafkaClient. This is used by ProgressMonitor and PartitionFinalizer. +# This should be set large enough to accept the max message size configured in your kafka broker +# Default is 0.1 MB +secor.max.message.size.bytes=100000 + +# Class that will manage uploads. Default is to use the hadoop +# interface to S3. +#secor.upload.manager.class=com.pinterest.secor.uploader.HadoopS3UploadManager +secor.upload.manager.class=com.redborder.secor.uploader.JetS3tUploadManager + +#Set below property to your timezone, and partitions in s3 will be created as per timezone provided +secor.parser.timezone=UTC + +# Transformer class that transform message accordingly. +secor.message.transformer.class=com.pinterest.secor.transformer.IdentityMessageTransformer diff --git a/resources/templates/default/secor-vault.prod.partition.properties.erb b/resources/templates/default/secor-vault.prod.partition.properties.erb new file mode 100644 index 0000000..c2cb06d --- /dev/null +++ b/resources/templates/default/secor-vault.prod.partition.properties.erb @@ -0,0 +1,34 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +include=secor-vault.prod.properties + +# Name of the Kafka consumer group. +secor.kafka.group=secor_vault_partition + +# Parser class that extracts s3 partitions from consumed messages. +secor.message.parser.class=com.redborder.secor.parser.MessageRbParser + +# S3 path where sequence files are stored. +secor.s3.path=<%= node["redborder"]["manager"]["s3rawpath"] %> + +# Swift path where sequence files are stored. +secor.swift.path= + +# Local path where sequence files are stored before they are uploaded to s3. +secor.local.path=/tmp/secor_vault_data/message_logs/partition + +# Port of the Ostrich server. +ostrich.port=9997 \ No newline at end of file diff --git a/resources/templates/default/secor-vault.prod.properties.erb b/resources/templates/default/secor-vault.prod.properties.erb new file mode 100644 index 0000000..ab83087 --- /dev/null +++ b/resources/templates/default/secor-vault.prod.properties.erb @@ -0,0 +1,55 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +include=secor-vault.common.properties + +############ +# MUST SET # +############ + +# Name of one (random) Kafka broker host that is used to retrieve metadata. +# TODO(pawel): use a list of nodes or even better, extract active brokers from zookeeper. +kafka.seed.broker.host=<%= @kafka_hosts.sample %>.node + +# List of Kafka Zookeeper servers. +zookeeper.quorum=<%= @zk_hosts %> + +# Fill the section which fits your needs +############### +# Using S3 # +############### + +# Name of the s3 bucket where log files are stored. +secor.s3.bucket=<%= @s3_bucket %> + +############### +# Using Swift # +############### + +# Boolean variable which determines if each topic will be uploaded to different container +# (Created automatic) - if true the next setting will be ignored +secor.swift.containers.for.each.topic=false + +# Name of swift container where log files are stored. +secor.swift.container=logsContainer + +################ +# END MUST SET # +################ + +# Upload policies. +secor.max.file.size.bytes=500000000 + +secor.max.file.age.seconds=30 \ No newline at end of file diff --git a/resources/templates/default/secor-vault_log4j.prod.properties.erb b/resources/templates/default/secor-vault_log4j.prod.properties.erb new file mode 100644 index 0000000..44dc6de --- /dev/null +++ b/resources/templates/default/secor-vault_log4j.prod.properties.erb @@ -0,0 +1,19 @@ +# log4j logging configuration. + +# root logger. +log4j.rootLogger=DEBUG, CONSOLE, ROLLINGFILE + +log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender +log4j.appender.CONSOLE.Threshold=WARN +log4j.appender.CONSOLE.Target=System.err +log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout +log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} [%t] (%C:%L) %-5p %m%n + +log4j.appender.ROLLINGFILE=org.apache.log4j.RollingFileAppender +log4j.appender.ROLLINGFILE.Threshold=INFO +log4j.appender.ROLLINGFILE.File=/var/log/secor-vault/secor-${secor_group}.log + +log4j.appender.ROLLINGFILE.MaxFileSize=20MB +log4j.appender.ROLLINGFILE.MaxBackupIndex=10 +log4j.appender.ROLLINGFILE.layout=org.apache.log4j.PatternLayout +log4j.appender.ROLLINGFILE.layout.ConversionPattern=%d{ISO8601} [%t] (%C:%L) %-5p %m%n \ No newline at end of file diff --git a/resources/templates/default/secor.common.properties.erb b/resources/templates/default/secor.common.properties.erb new file mode 100644 index 0000000..bde3445 --- /dev/null +++ b/resources/templates/default/secor.common.properties.erb @@ -0,0 +1,307 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +############ +# MUST SET # +############ + +# Regular expression matching names of consumed topics. +<% +topics=[] +[ "rb_event", "rb_flow", "rb_monitor", "rb_state", "rb_iot" ].each do |topic| + unless (!node["redborder"]["manager"]["topics"].nil? and node["redborder"]["manager"]["topics"][topic]=="none") + if topic != "rb_mail" and topic != "rb_endpoint" and topic != "rb_malware" + real_topic= ((!node["redborder"]["manager"]["topics"].nil? and ( node["redborder"]["manager"]["topics"][topic]=="both" or node["redborder"]["manager"]["topics"][topic]=="rb-enrich" or node["redBorder"]["manager"]["topics"][topic]=="samza") and topic!="rb_monitor" and topic!="rb_iot" ) ? "#{topic}_post" : topic ) + else + real_topic = topic + end + topics< +secor.kafka.topic_filter=<%= topics.join("|") %> + +# Choose what to fill according to the service you are using +# in the choice option you can fill S3, GS, Swift or Azure +cloud.service=S3 + +# AWS authentication credentials. +# Leave empty if using IAM role-based authentication with s3a filesystem. + +#AWS +aws.access.key=<%= @s3_user %> +aws.secret.key=<%= @s3_pass %> + +# Optional Proxy Setting. Set to true to enable proxy +# Only applicable to S3UploadManager +aws.proxy.isEnabled=false +aws.proxy.http.host= +aws.proxy.http.port= + +################ +# END MUST SET # +################ + +# AWS region or endpoint. region should be a known region name (eg. +# us-east-1). endpoint should be a known S3 endpoint url. If neither +# are specified, then the default region (us-east-1) is used. If both +# are specified then endpoint is used. +# +# Only apply if the the S3UploadManager is used - see +# secor.upload.manager.class. +# +# http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region +aws.region=<%= @s3_hostname %> + +########################### +# START AWS S3 ENCRYPTION # +########################### + +# AWS specify type of server-side encryption, if any +# set to S3 to enable S3-managed encryption +# set to KMS to enable AWS KMS-managed encryption (see aws.sse.kms.key) +# set to customer to enable customer-managed encryption (see aws.sse.customer.key) +# set empty to disable encryption +aws.sse.type= + +# Key to use for S3 server-side encryption, base64-encoded +# Note: requires aws.sse.type to be set to customer to be used +aws.sse.customer.key= + +# KMS Key to use for S3 server-side encryption, base64-encoded +# Leave empty to use default generated key +# Note: requires aws.sse.type to be set to KMS to be used +aws.sse.kms.key= + +######################### +# END AWS S3 ENCRYPTION # +######################### + +# Hadoop filesystem to use. Choices are s3n or s3a. +# See https://wiki.apache.org/hadoop/AmazonS3 for details. +secor.s3.filesystem=s3n + +# Swift config, MUST configure if cloud.service=Swift + +# Swift Login Details: +swift.use.get.auth=true +swift.auth.url= +swift.tenant= +swift.username= +swift.port=8080 +swift.public=true + +# only needed if "swift.use.get.auth" = false +swift.password= + +# only needed if "swift.use.get.auth" = true +swift.api.key= + +# GS config, MUST configure if gcloud.service=GS + +# Name of the Google cloud storage bucket where log files are stored. +secor.gs.bucket=secor_gs + +# Google cloud storage path where files are stored within the bucket. +secor.gs.path=data + +# Use direct uploads +# WARNING: disables resumable uploads, files are uploaded in a single request +# This may help prevent IOException: insufficient data written, +# see https://github.com/pinterest/secor/issues/177 +# https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload +secor.gs.upload.direct=false + +# Zookeeper config. +zookeeper.session.timeout.ms=3000 +zookeeper.sync.time.ms=200 + +# Zookeeper path (chroot) under which secor data will be placed. +secor.zookeeper.path=/ + +# Impacts how frequently the upload logic is triggered if no messages are delivered. +kafka.consumer.timeout.ms=10000 + +# Choose between range and roundrobin partition assignment strategy for kafka +# high level consumers. Check PartitionAssignor.scala in kafa 821 module for +# the differences between the two. +# In kafka 811, only range strategy is supported. +kafka.partition.assignment.strategy=range + +# Max number of retries during rebalance. +kafka.rebalance.max.retries= + +# Rebalance backoff. +kafka.rebalance.backoff.ms= + +# Kafka consumer receive buffer size (socket.receive.buffer.bytes) +kafka.socket.receive.buffer.bytes= + +# Kafka fetch max size (fetch.message.max.bytes) +kafka.fetch.message.max.bytes= + +# Kafka fetch min bytes (fetch.fetch.min.bytes) +kafka.fetch.min.bytes= + +# Kafka fetch max wait ms (fetch.max.wait.ms) +kafka.fetch.wait.max.ms= + +# Port of the broker serving topic partition metadata. +kafka.seed.broker.port=9092 + +# Zookeeper path at which kafka is registered. In Zookeeper parlance, this is referred +# to as the chroot. +kafka.zookeeper.path=/ + +# Store offset in zookeeper and kafka consumer topic. +# Only used if kafka.offsets.storage is set to "kafka" +# http://kafka.apache.org/documentation.html#oldconsumerconfigs +# Possible values: true or false +kafka.dual.commit.enabled=true + +# Storage offset. +# Possible values: "zookeeper" to read offset from zookeeper or "kafka" to read offset from kafka consumer topic +kafka.offsets.storage=zookeeper + +# Secor generation is a version that should be incremented during non-backwards-compabile +# Secor releases. Generation number is one of the components of generated log file names. +# Generation number makes sure that outputs of different Secor versions are isolated. +secor.generation=1 + +# Number of consumer threads per Secor process. +secor.consumer.threads=<%= [ node["cpu"]["total"].to_i-1, 1 ].max %> + +# Consumption rate limit enforced at the process level (not a consumer-thread level). +secor.messages.per.second=10000 + +# Used by the "backup" consumer group only. +# Number of continous message offsets that constitute a single offset= partition on s3. +# Example: +# if set to 10, +# messages with offsets 0 to 9 will be written to s3 path s3n://.../offset=0/... +# messages with offsets 10 to 19 will be written to s3 path s3n://.../offset=10/... +# ... +secor.offsets.per.partition=10000000 + +# How long does it take for secor to forget a topic partition. Applies to stats generation only. +secor.topic_partition.forget.seconds=600 + +# Setting the partitioner to use hourly partition +# By default, the partitioner will do daily partition, so the data will be +# written into +# s3n://.../topic/dt=2015-07-07/ +# If this parameter is set to true, the data will be written into +# s3n://.../topic/dt=2015-07-07/hr=02 +# The hour folder ranges from 00 to 23 +partitioner.granularity.hour=true +# partitioner.granularity.minute=true +# how many seconds should the finalizer wait to finalize a partition +partitioner.finalizer.delay.seconds=3600 + +# During partition finalization, the finalizer will start from the last +# time partition (e.g. dt=2015-07-17) and traverse backwards for n +# partition periods (e.g. dt=2015-07-16, dt=2015-07-15 ...) +# This parameter controls how many partition periods to traverse back +# The default is 10 +# secor.finalizer.lookback.periods=48 + +# If greater than 0, upon starup Secor will clean up directories and files under secor.local.path +# that are older than this value. +secor.local.log.delete.age.hours=-1 + +# Secor comes with a tool that adds Hive partitions for finalized topics. Currently, we support +# only Hive clusters accessible through Qubole. The token gives access to the Qubole API. +# It is available at https://api.qubole.com/users/edit +qubole.api.token= + +# hive tables are generally named after the topics. For instance if the topic +# is request_log the hive table is also called request_log. If you want this +# to be pinlog_request_log you can set this config to "pinlog_". This affects +# all topics. +hive.table.prefix= + +# You can also name your hive table directly if your hive table doesn't +# follow the pattern of +# E.g. hive.table.name.topic1=table1 to indicate that hive table for +# kafka topic will be named + +# Secor can export stats such as consumption lag (in seconds and offsets) per topic partition. +# Leave empty to disable this functionality. +tsdb.hostport= + +# Regex of topics that are not exported to TSDB. +monitoring.blacklist.topics= + +# Prefix of exported statss. +monitoring.prefix=secor + +# Secor can export stats to statsd such as consumption lag (in seconds and offsets) per topic partition. +# Leave empty to disable this functionality. +statsd.hostport= + +# Name of field that contains timestamp for JSON, MessagePack, or Thrift message parser. (1405970352123) +message.timestamp.name=timestamp + +# Separator for defining message.timestamp.name in a nested structure. E.g. +# {"meta_data": {"created": "1405911096123", "last_modified": "1405912096123"}, "data": "test"} +# message.timestamp.name=meta_data.created +# message.timestamp.name.separator=. +message.timestamp.name.separator= + +# Field ID of the field that contains timestamp for Thrift message parser. +# N.B. setting this past 1 will come with a performance penalty +message.timestamp.id=1 + +# Data type of the timestamp field for thrift message parser. +# Supports i64 and i32. +message.timestamp.type=i64 + +# Name of field that contains a timestamp, as a date Format, for JSON. (2014-08-07, Jul 23 02:16:57 2005, etc...) +# Should be used when there is no timestamp in a Long format. Also ignore time zones. +message.timestamp.input.pattern= + +# whether timestamp field is required, it should always be required. But +# for historical reason, we didn't enforce this check, there might exist some +# installations with messages missing timestamp field +message.timestamp.required=true + +# To enable compression, set this to a valid compression codec implementing +# org.apache.hadoop.io.compress.CompressionCodec interface, such as +# 'org.apache.hadoop.io.compress.GzipCodec'. +secor.compression.codec=org.apache.hadoop.io.compress.GzipCodec + +# To set a custom file extension set this to a valid file suffix, such as +# '.gz', '.part', etc. +secor.file.extension= + +# The secor file reader/writer used to read/write the data, by default we write sequence files +#secor.file.reader.writer.factory=com.pinterest.secor.io.impl.SequenceFileReaderWriterFactory +secor.file.reader.writer.factory=com.pinterest.secor.io.impl.DelimitedTextFileReaderWriterFactory + +# Max message size in bytes to retrieve via KafkaClient. This is used by ProgressMonitor and PartitionFinalizer. +# This should be set large enough to accept the max message size configured in your kafka broker +# Default is 0.1 MB +secor.max.message.size.bytes=100000 + +# Class that will manage uploads. Default is to use the hadoop +# interface to S3. +#secor.upload.manager.class=com.pinterest.secor.uploader.HadoopS3UploadManager +secor.upload.manager.class=com.redborder.secor.uploader.JetS3tUploadManager + +#Set below property to your timezone, and partitions in s3 will be created as per timezone provided +secor.parser.timezone=UTC + +# Transformer class that transform message accordingly. +secor.message.transformer.class=com.pinterest.secor.transformer.IdentityMessageTransformer \ No newline at end of file diff --git a/resources/templates/default/secor.prod.partition.properties.erb b/resources/templates/default/secor.prod.partition.properties.erb new file mode 100644 index 0000000..6d9d37a --- /dev/null +++ b/resources/templates/default/secor.prod.partition.properties.erb @@ -0,0 +1,34 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +include=secor.prod.properties + +# Name of the Kafka consumer group. +secor.kafka.group=secor_partition + +# Parser class that extracts s3 partitions from consumed messages. +secor.message.parser.class=com.redborder.secor.parser.MessageRbParser + +# S3 path where sequence files are stored. +secor.s3.path=<%= node["redborder"]["manager"]["s3rawpath"] %> + +# Swift path where sequence files are stored. +secor.swift.path= + +# Local path where sequence files are stored before they are uploaded to s3. +secor.local.path=/tmp/secor_data/message_logs/partition + +# Port of the Ostrich server. +ostrich.port=9998 \ No newline at end of file diff --git a/resources/templates/default/secor.prod.properties.erb b/resources/templates/default/secor.prod.properties.erb new file mode 100644 index 0000000..e309482 --- /dev/null +++ b/resources/templates/default/secor.prod.properties.erb @@ -0,0 +1,55 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +include=secor.common.properties + +############ +# MUST SET # +############ + +# Name of one (random) Kafka broker host that is used to retrieve metadata. +# TODO(pawel): use a list of nodes or even better, extract active brokers from zookeeper. +kafka.seed.broker.host=<%= @kafka_hosts.sample %>.node + +# List of Kafka Zookeeper servers. +zookeeper.quorum=<%= @zk_hosts %> + +# Fill the section which fits your needs +############### +# Using S3 # +############### + +# Name of the s3 bucket where log files are stored. +secor.s3.bucket=<%= @s3_bucket %> + +############### +# Using Swift # +############### + +# Boolean variable which determines if each topic will be uploaded to different container +# (Created automatic) - if true the next setting will be ignored +secor.swift.containers.for.each.topic=false + +# Name of swift container where log files are stored. +secor.swift.container=logsContainer + +################ +# END MUST SET # +################ + +# Upload policies. +secor.max.file.size.bytes=500000000 + +secor.max.file.age.seconds=1800 \ No newline at end of file diff --git a/resources/templates/default/secor_log4j.prod.properties.erb b/resources/templates/default/secor_log4j.prod.properties.erb new file mode 100644 index 0000000..261e3a1 --- /dev/null +++ b/resources/templates/default/secor_log4j.prod.properties.erb @@ -0,0 +1,19 @@ +# log4j logging configuration. + +# root logger. +log4j.rootLogger=DEBUG, CONSOLE, ROLLINGFILE + +log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender +log4j.appender.CONSOLE.Threshold=WARN +log4j.appender.CONSOLE.Target=System.err +log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout +log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} [%t] (%C:%L) %-5p %m%n + +log4j.appender.ROLLINGFILE=org.apache.log4j.RollingFileAppender +log4j.appender.ROLLINGFILE.Threshold=INFO +log4j.appender.ROLLINGFILE.File=/var/log/secor/secor-${secor_group}.log + +log4j.appender.ROLLINGFILE.MaxFileSize=20MB +log4j.appender.ROLLINGFILE.MaxBackupIndex=10 +log4j.appender.ROLLINGFILE.layout=org.apache.log4j.PatternLayout +log4j.appender.ROLLINGFILE.layout.ConversionPattern=%d{ISO8601} [%t] (%C:%L) %-5p %m%n