diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..f218907 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,41 @@ +name: Bug report +description: Report incorrect behavior with a reproducible example. +body: + - type: markdown + attributes: + value: | + For security vulnerabilities, use [private reporting](https://github.com/batchstream/weir-charts/security/advisories/new). + Remove credentials, private endpoints and document data from logs and configuration. + - type: input + id: version + attributes: + label: Chart version + description: Chart version from `helm list`, or commit SHA. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Kubernetes and Helm versions, Weir image digest, backend and version, and relevant values. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Include the smallest request, script or test case that reproduces the problem. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected and actual behavior + validations: + required: true + - type: textarea + id: diagnostics + attributes: + label: Logs and configuration + description: Relevant, redacted diagnostics. For performance issues, include the workload and resource limits. + render: text diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..5362aa2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Documentation + url: https://github.com/batchstream/weir-charts#readme + about: Usage and development guide for this repository. + - name: Weir server issues + url: https://github.com/batchstream/weir/issues + about: Report problems specific to the Weir server. + - name: Security vulnerability + url: https://github.com/batchstream/weir-charts/security/advisories/new + about: Report a vulnerability privately. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1f04aab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,22 @@ +name: Feature request +description: Propose an improvement to the Weir Helm chart. +body: + - type: textarea + id: problem + attributes: + label: Problem or use case + description: What are you trying to achieve, and what is difficult today? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed behavior + description: Describe the desired API or user experience, with an example if possible. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives and constraints + description: Existing workarounds, affected backends and operational constraints. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..17c254e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..56dc8d5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to the Weir Helm chart + +Focused bug fixes, documentation improvements, tests and feature proposals are +welcome. Open an [issue](https://github.com/batchstream/weir-charts/issues/new/choose) first for a change +that depends on new [server](https://github.com/batchstream/weir) behavior. + +## Report a problem + +Use the issue forms and include the chart version, the Weir image digest, the +Kubernetes and Helm versions, the relevant values, the expected result and a minimal +reproduction. Remove credentials and private data from logs and values. + +For vulnerabilities, follow [SECURITY.md](SECURITY.md). + +## Work locally + +Install Helm, Python 3 and the Go version the chart's workflows use, then follow +[Develop and release](README.md#develop-and-release): + +```sh +python3 -m venv .venv +.venv/bin/pip install -r requirements-dev.txt +GOBIN="$PWD/.bin" go install github.com/batchstream/weir/cmd/weir@SOURCE_REVISION +make test PYTHON=.venv/bin/python WEIR_BIN="$PWD/.bin/weir" +``` + +`SOURCE_REVISION` is the `weir.batchstream.io/source-revision` annotation in +`Chart.yaml`. With `promtool` on `PATH` or in `PROMTOOL`, `make test` also checks the +rendered alerts and the autoscaling query; without it, that test is skipped. + +## Prepare a pull request + +- Keep the change focused and explain the observed problem and resulting behavior. +- Add a regression test when fixing behavior. +- Update `values.schema.json`, the [examples](examples) and the README when values change. +- When pinning a new server, pin it in [weir-tests](https://github.com/batchstream/weir-tests) first, then change the source annotation, `appVersion`, image digest, workflow pins, the README's references and the values in `tests/test_chart.py` together. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6e5a0e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Randy + +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 b765d81..848d215 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Weir Helm charts +[![CI](https://github.com/batchstream/weir-charts/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/batchstream/weir-charts/actions/workflows/ci.yaml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + Deploy [Weir](https://github.com/batchstream/weir), a synchronous MongoDB and Search data plane, on Kubernetes. Helm 3.17+ and Kubernetes 1.30+ are required. Chart `0.20.0-rc.1` targets server source [commit `5107986b882d`](https://github.com/batchstream/weir/commit/5107986b882da60751403c7e05bbbebdb12b3cdb). `Chart.yaml` records that source contract and `values.yaml` pins the immutable image `ghcr.io/batchstream/weir@sha256:b5d949cefb0ba01e18cff2b5210cef954bc387c20cffa87784466e793e0e088e`; both validation and release workflows install that exact source with `go install`. One Helm release is one Store group. Every replica hosts the same Store definitions; a group can host several Stores, and each group is released and scaled independently. Replicas share nothing with each other. Each Pod runs one Weir process with Lua inside that process. Backends, collections, indices, credentials and backups are provisioned separately. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..721b173 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security policy + +## Report a vulnerability + +Use GitHub's private +[Report a vulnerability](https://github.com/batchstream/weir-charts/security/advisories/new) +form. Include the affected chart version or commit, reproduction steps, impact, +and relevant deployment settings with credentials and private data removed. +Please keep exploit details out of public issues while a report is being +investigated. + +## Versions + +Check whether an issue is still present in the chart on `main`. Older chart +versions do not have a guaranteed security backport schedule. Report suspected +vulnerabilities even if you cannot reproduce them on `main`. + +## Deployment guidance + +Application traffic uses plaintext HTTP/2 inside a trusted, isolated network. See +[Network and operations](README.md#network-and-operations). diff --git a/charts/weir/LICENSE b/charts/weir/LICENSE new file mode 100644 index 0000000..6e5a0e7 --- /dev/null +++ b/charts/weir/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Randy + +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.