diff --git a/.drone.star b/.drone.star new file mode 100644 index 0000000..0506248 --- /dev/null +++ b/.drone.star @@ -0,0 +1,85 @@ +def main(ctx): + return [ + testing(ctx), + notify(ctx), + ] + +def testing(ctx): + return { + 'kind': 'pipeline', + 'type': 'docker', + 'name': 'testing', + 'platform': { + 'os': 'linux', + 'arch': 'amd64', + }, + 'steps': [ + { + 'name': 'lint', + 'image': 'toolhippie/yamllint:latest', + 'pull': 'always', + 'commands': [ + 'yamllint .', + ], + }, + { + 'name': 'kustomize', + 'image': 'toolhippie/kubectl:latest', + 'pull': 'always', + 'commands': [ + 'kustomize build .', + ], + }, + ], + 'trigger': { + 'ref': [ + 'refs/heads/master', + 'refs/tags/**', + 'refs/pull/**', + ], + }, + } + +def notify(ctx): + return { + 'kind': 'pipeline', + 'type': 'docker', + 'name': 'notify', + 'platform': { + 'os': 'linux', + 'arch': 'amd64', + }, + 'clone': { + 'disable': True, + }, + 'steps': [ + { + 'name': 'execute', + 'image': 'plugins/matrix:1', + 'pull': 'always', + 'settings': { + 'username': { + 'from_secret': 'matrix_username', + }, + 'password': { + 'from_secret': 'matrix_password', + }, + 'roomid': { + 'from_secret': 'matrix_roomid', + }, + }, + }, + ], + 'depends_on': [ + 'testing', + ], + 'trigger': { + 'ref': [ + 'refs/heads/master', + 'refs/tags/**', + ], + 'status': [ + 'failure', + ], + }, + } diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..872bfc9 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,11 @@ +# http://editorconfig.org +root = true + +[*] +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.yml] +indent_style = space +indent_size = 2 diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..83819ce --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1,11 @@ +{ + "extends": [ + "config:base" + ], + "enabledManagers": [ + "kustomize" + ], + "labels": [ + "renovate" + ] +} \ No newline at end of file diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..f66ea2f --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,88 @@ +--- +repository: + name: clamav + description: Reusable Kustomize manifests for clamav + topics: kustomize, manifest, kubernetes + + private: false + has_issues: true + has_wiki: false + has_downloads: false + + default_branch: master + + allow_squash_merge: true + allow_merge_commit: true + allow_rebase_merge: true + +labels: + - name: bug + color: fc2929 + description: Something isn't working + - name: duplicate + color: cccccc + description: This issue or pull request already exists + - name: enhancement + color: 84b6eb + description: New feature or request + - name: good first issue + color: 7057ff + description: Good for newcomers + - name: help wanted + color: 159818 + description: Extra attention is needed + - name: invalid + color: e6e6e6 + description: This doesn't seem right + - name: question + color: cc317c + description: Further information is requested + - name: renovate + color: 1d76db + description: Automated action from Renovate + - name: wontfix + color: 5319e7 + description: This will not be worked on + - name: hacktoberfest + color: d4c5f9 + description: Contribution at Hacktoberfest appreciated + - name: ready + color: ededed + description: This is ready to be worked on + - name: in progress + color: ededed + description: This is currently worked on + - name: infra + color: 006b75 + description: Related to the infrastructure + - name: lint + color: fbca04 + description: Related to linting tools + - name: poc + color: c2e0c6 + description: Proof of concept for new feature + - name: rebase + color: ffa8a5 + description: Branch requires a rebase + - name: third-party + color: e99695 + description: Depends on third-party tool or library + - name: translation + color: b60205 + description: Change or issue related to translations + +branches: + - name: master + protection: + required_status_checks: + strict: true + contexts: + - continuous-integration/drone/pr + enforce_admins: false + restrictions: + apps: + - renovate + users: [] + teams: [] + +... diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..eef18b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.drone.yml diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..e75fe1a --- /dev/null +++ b/.yamllint @@ -0,0 +1,12 @@ +--- +extends: default + +rules: + line-length: disable + + document-end: + level: error + document-start: + level: error + +... diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8f71f43 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + 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 new file mode 100644 index 0000000..b4df8c3 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# clamav + +[![Build Status](http://drone.webhippie.de/api/badges/kustomhippie/clamav/status.svg)](http://drone.webhippie.de/kustomhippie/clamav) +[![Join the Matrix chat at https://matrix.to/#/#webhippie:matrix.org](https://img.shields.io/badge/matrix-%23webhippie%3Amatrix.org-7bc9a4.svg)](https://matrix.to/#/#webhippie:matrix.org) + +This repository defines a [Kustomize](https://kustomize.io/) manifest which could be used by other repositories to generate a [Kubernetes](https://kubernetes.io/) manifest for the installation of [clamav](https://github.com/Cisco-Talos/clamav). + +## Usage + +TBD + +## Security + +If you find a security issue please contact thomas@webhippie.de first. + +## Contributing + +Fork -> Patch -> Push -> Pull Request + +## Authors + +* [Thomas Boerger](https://github.com/tboerger) + +## License + +Apache-2.0 + +## Copyright + +``` +Copyright (c) 2021 Thomas Boerger +``` diff --git a/kustomization.yml b/kustomization.yml new file mode 100644 index 0000000..2f6fd1a --- /dev/null +++ b/kustomization.yml @@ -0,0 +1,16 @@ +--- +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +resources: + - server/ + +commonLabels: + app.kubernetes.io/name: clamav + +images: + - name: clamav-server + newName: docker.io/clamav/clamav + newTag: "unstable" + +... diff --git a/server/deployment.yml b/server/deployment.yml new file mode 100644 index 0000000..fb5a14e --- /dev/null +++ b/server/deployment.yml @@ -0,0 +1,49 @@ +--- +apiVersion: apps/v1 +kind: Deployment + +metadata: + name: clamav-server + +spec: + replicas: 1 + + template: + spec: + serviceAccountName: clamav-server + + containers: + - name: server + image: clamav-server + imagePullPolicy: IfNotPresent + + envFrom: + - configMapRef: + name: clamav-server + + ports: + - name: clamd + containerPort: 3310 + protocol: TCP + - name: milter + containerPort: 7357 + protocol: TCP + + # resources: + # requests: + # cpu: "0.1" + # memory: "64Mi" + # limits: + # cpu: "0.5" + # memory: "512Mi" + + volumeMounts: + - name: data + mountPath: /var/lib/clamav + + volumes: + - name: data + persistentVolumeClaim: + claimName: clamav + +... diff --git a/server/kustomization.yml b/server/kustomization.yml new file mode 100644 index 0000000..717b1d0 --- /dev/null +++ b/server/kustomization.yml @@ -0,0 +1,18 @@ +--- +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +resources: + - serviceaccount.yml + - service.yml + - pvc.yml + - deployment.yml + +commonLabels: + app.kubernetes.io/component: server + +configMapGenerator: + - name: clamav-server + literals: [] + +... diff --git a/server/pvc.yml b/server/pvc.yml new file mode 100644 index 0000000..361fd1a --- /dev/null +++ b/server/pvc.yml @@ -0,0 +1,15 @@ +--- +apiVersion: v1 +kind: PersistentVolumeClaim + +metadata: + name: clamav + +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 5Gi + +... diff --git a/server/service.yml b/server/service.yml new file mode 100644 index 0000000..eff9e49 --- /dev/null +++ b/server/service.yml @@ -0,0 +1,15 @@ +--- +apiVersion: v1 +kind: Service + +metadata: + name: clamav-server + +spec: + ports: + - name: clamd + port: 3310 + - name: milter + port: 7357 + +... diff --git a/server/serviceaccount.yml b/server/serviceaccount.yml new file mode 100644 index 0000000..2b1ed83 --- /dev/null +++ b/server/serviceaccount.yml @@ -0,0 +1,8 @@ +--- +apiVersion: v1 +kind: ServiceAccount + +metadata: + name: clamav-server + +...