From 91afe0a56fefafeffb8da9a7c3bf9319a63126cd Mon Sep 17 00:00:00 2001 From: Dustin Hilgaertner Date: Mon, 9 Mar 2026 16:13:05 -0500 Subject: [PATCH 1/2] feat: audit and optimize repo settings for public launch Switch license from Apache 2.0 to MIT, add community health files (CODEOWNERS, issue/PR templates), configure Renovate for dependency updates, and add kubelinter to CI pipeline. Closes #5 Co-Authored-By: Claude Opus 4.6 --- .github/ISSUE_TEMPLATE/bug_report.yml | 51 +++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.yml | 31 +++ .github/PULL_REQUEST_TEMPLATE.md | 20 ++ .github/workflows/lint.yaml | 12 ++ CODEOWNERS | 2 + CONTRIBUTING.md | 4 - LICENSE | 211 ++------------------- README.md | 2 +- renovate.json | 4 + 10 files changed, 147 insertions(+), 195 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODEOWNERS create mode 100644 renovate.json diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..c9f3ed2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,51 @@ +name: Bug Report +description: Report a bug with the Citadel Helm chart +labels: ["bug"] +body: + - type: input + id: chart-version + attributes: + label: Chart Version + description: Output of `helm list` or the version you installed + placeholder: "0.2.1" + validations: + required: true + + - type: input + id: k8s-version + attributes: + label: Kubernetes Version + description: Output of `kubectl version --short` + placeholder: "1.28.0" + validations: + required: true + + - type: textarea + id: values-overrides + attributes: + label: Values Overrides + description: Relevant values.yaml overrides (redact any secrets) + render: yaml + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What you expected to happen + validations: + required: true + + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: What actually happened + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs / Error Output + description: Relevant logs, error messages, or kubectl output + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b0aa7f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & Discussion + url: https://github.com/radiusmethod/citadel-helm/discussions + about: Ask questions and discuss ideas in GitHub Discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..aa45f24 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest a new feature or improvement for the Citadel Helm chart +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem + description: What problem does this feature solve? + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed Solution + description: How would you like this to work? + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any alternative solutions or workarounds you've considered + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context, screenshots, or references diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..cd2f530 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## Description + + + +## Changes + +- + +## Testing + + + +- [ ] `helm lint . --set citadel.secretKey=test` passes +- [ ] `helm template citadel . --set citadel.secretKey=test` renders correctly + +## Checklist + +- [ ] Chart version bumped in `Chart.yaml` (if applicable) +- [ ] Documentation updated for new/changed values +- [ ] `CHANGELOG.md` updated under `[Unreleased]` diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index b6f379b..6c9b1d8 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -22,3 +22,15 @@ jobs: - name: Helm template run: helm template citadel . --set citadel.secretKey=test + + - name: Render templates for kubelinter + run: helm template citadel . --set citadel.secretKey=test --output-dir rendered + + - name: Install kubelinter + run: | + curl -sSLO "https://github.com/stackrox/kube-linter/releases/latest/download/kube-linter-linux" + chmod +x kube-linter-linux + sudo mv kube-linter-linux /usr/local/bin/kube-linter + + - name: Run kubelinter + run: kube-linter lint rendered/ diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..3c55865 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Default code owners for all files +* @radiusmethod/engineering diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e955868..a24f1a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,7 +57,3 @@ Open a [GitHub issue](https://github.com/radiusmethod/citadel-helm/issues/new) w - Follow existing patterns in templates and values - Add comments for non-obvious template logic - Update `CHANGELOG.md` under an `[Unreleased]` section - -## Code of Conduct - -Be respectful and constructive. We're all working toward the same goal. diff --git a/LICENSE b/LICENSE index 0d1f460..23ca49f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,190 +1,21 @@ - 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 the 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 the 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 any 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 - - Copyright 2025 Radius Method - - 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. +MIT License + +Copyright (c) 2025 Radius Method + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 28a9045..da57069 100644 --- a/README.md +++ b/README.md @@ -177,4 +177,4 @@ kubectl delete pvc data-citadel-postgresql-0 ## License -Apache License 2.0 — see [LICENSE](LICENSE) for details. +MIT License — see [LICENSE](LICENSE) for details. diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..22a9943 --- /dev/null +++ b/renovate.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:recommended"] +} From 46d2adf7dd4f8535fcff814f743ce72ee0c154b0 Mon Sep 17 00:00:00 2001 From: Dustin Hilgaertner Date: Mon, 9 Mar 2026 16:27:05 -0500 Subject: [PATCH 2/2] fix: scope kubelinter to chart templates and exclude inapplicable checks Lint only our own templates (not postgresql subchart) and exclude checks for resource limits, read-only root fs, and latest tags that don't apply to init containers and test pods in CI. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/lint.yaml | 2 +- .kube-linter.yaml | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 .kube-linter.yaml diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 6c9b1d8..e73903d 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -33,4 +33,4 @@ jobs: sudo mv kube-linter-linux /usr/local/bin/kube-linter - name: Run kubelinter - run: kube-linter lint rendered/ + run: kube-linter lint rendered/citadel-chart/templates/ diff --git a/.kube-linter.yaml b/.kube-linter.yaml new file mode 100644 index 0000000..69b5cb2 --- /dev/null +++ b/.kube-linter.yaml @@ -0,0 +1,8 @@ +checks: + exclude: + # Init containers and test pods don't need full resource/security settings + - "unset-cpu-requirements" + - "unset-memory-requirements" + - "no-read-only-root-fs" + - "run-as-non-root" + - "latest-tag"