Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/build-and-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ jobs:
- name: Set up Helm
uses: azure/setup-helm@v4

- name: Update chart dependencies
run: |
set -euo pipefail
for chart in charts/*; do
helm dependency update "${chart}" 2>/dev/null || true
done

- name: Lint charts
run: |
set -euo pipefail
Expand All @@ -42,7 +49,6 @@ jobs:
mkdir -p dist
for chart in charts/*; do
echo "Packaging ${chart}"
helm dependency update "${chart}" || true
helm package "${chart}" --destination dist
done

Expand Down
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Repository Guidelines

## Project Structure & Module Organization
- `charts/` contains all Helm packages; each chart lives in its own directory (e.g., `charts/clustercost-dashboard`, `charts/clustercost-agent-k8s`).
- `charts/` contains all Helm packages; each chart lives in its own directory (e.g., `charts/recon`, `charts/recon-agent`, `charts/warden`).
- Each chart follows the Helm layout: `Chart.yaml`, `values.yaml`, and `templates/` with Kubernetes manifests (Deployment, Service, ConfigMap, etc.).
- Keep chart-specific assets (helpers, notes) inside their chart directory; avoid cross-chart imports.

## Build, Test, and Development Commands
- `helm lint charts/<chart-name>`: static validation for a chart; run before every PR.
- `helm template charts/<chart-name>`: render manifests locally for inspection, e.g., `helm template charts/clustercost-dashboard`.
- `helm template charts/<chart-name>`: render manifests locally for inspection, e.g., `helm template charts/recon`.
- `helm install <release> charts/<chart-name> --namespace <ns>`: deploy to a cluster; use a sandbox namespace when testing new changes.

## Coding Style & Naming Conventions
Expand All @@ -27,5 +27,5 @@

## Security & Configuration Tips
- Never commit secrets; leverage Kubernetes Secrets and reference them via `values.yaml`.
- Default images should point to trusted registries (`ghcr.io/clustercost/...`). Bump tags intentionally and document breaking changes.
- Default images should point to trusted registries (`ghcr.io/projecthelena/...`). Bump tags intentionally and document breaking changes.
- Provide configuration examples for connecting agents (e.g., `values.yaml` `config.agents`) so operators can mirror recommended settings.
47 changes: 47 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

Helm charts for deploying the Project Helena ecosystem — a Kubernetes cost visibility and FinOps platform. Three charts live under `charts/`:

- **recon**: Web dashboard that aggregates cost metrics from distributed agents. Includes optional VictoriaMetrics StatefulSet for time-series storage.
- **recon-agent**: DaemonSet agent that collects cluster cost data via eBPF and reports to the dashboard over gRPC.
- **warden**: Policy engine for enforcing cost and operational policies.

## Commands

```bash
helm lint charts/<chart-name> # Validate chart (run before every PR)
helm template charts/<chart-name> # Render manifests locally
helm template charts/<chart-name> | kubectl apply --dry-run=client -f - # Smoke test
helm install <release> charts/<chart-name> --namespace <ns> --create-namespace
```

No npm, Makefile, or test framework — validation is `helm lint` + `helm template` only.

## Architecture

```
Agent (DaemonSet, per cluster) --gRPC:9091--> Recon (Deployment) --> VictoriaMetrics (StatefulSet)
```

- **Recon** exposes HTTP (:9090) and gRPC (:9091). Config is rendered into a Secret with a checksum annotation to trigger rollouts on change.
- **Agent** runs privileged (`hostNetwork`, `hostPID`, eBPF caps: `SYS_ADMIN`, `BPF`, `PERFMON`). Configured entirely via environment variables — no config files.
- **VictoriaMetrics** is an optional sub-component of the recon chart with configurable PVC storage (default 10Gi).
- **Warden** runs as a standard Deployment with a single HTTP port (:8080).

## Conventions

- YAML: 2-space indentation, lowercase keys
- Helm helpers in `_helpers.tpl`; parameterize values with sane defaults; no hardcoded namespaces
- All charts include `values.schema.json` (JSON Schema Draft 7) for validation
- Commits: conventional imperative style (`feat: add dashboard values`, `fix: correct agent RBAC`)
- Default images from `ghcr.io/projecthelena/...`

## CI/CD

GitHub Actions (`.github/workflows/build-and-deploy.yaml`):
1. **Build** (all PRs + main): `helm lint` → `helm template` → `helm package` → generate repo index
2. **Deploy** (main only): publish to Cloudflare Pages at `charts.projecthelena.com`
223 changes: 190 additions & 33 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,33 +1,190 @@
ClusterCost Non-Commercial License 1.0
Copyright (c) 2025 ClusterCost

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to use,
copy, modify, merge, publish, and distribute the Software, subject to the
following conditions:

1. Non-Commercial Use Only. The Software may not be used, copied, modified,
or distributed for any Commercial Purpose without the express, written
permission of ClusterCost. "Commercial Purpose" means any use that is
intended for, or directed toward, commercial advantage or monetary
compensation, including providing the Software or derivative works as part
of a commercial service or product.

2. No Impersonation. You may not use the Software, its name, or any branding,
logos, or trademarks of ClusterCost in a way that suggests endorsement by
or affiliation with ClusterCost without prior written consent. Derivative
works must not be presented as official ClusterCost software.

3. Preservation of License Notices. All copies of the Software must include
this license text and the above copyright notice.

4. No Additional Restrictions. You may not impose further restrictions on
recipients that would conflict with the terms of this License.

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.
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 Project Helena

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.
75 changes: 51 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,51 @@
# ClusterCost Helm Charts

This repository hosts Helm charts for deploying the ClusterCost ecosystem. It currently includes:

- `charts/clustercost-dashboard`: renders the web dashboard that aggregates agent data.
- `charts/clustercost-agent-k8s`: publishes metrics from Kubernetes clusters to the dashboard.

## Getting Started

1. Inspect chart values to understand defaults:
```sh
helm show values charts/clustercost-dashboard
```
2. Validate templates locally:
```sh
helm lint charts/clustercost-dashboard
helm template charts/clustercost-dashboard
```
3. Install into a test namespace:
```sh
helm install dashboard charts/clustercost-dashboard --namespace clustercost --create-namespace
```

Refer to `AGENTS.md` for contribution guidelines, release expectations, and security notes.
# Project Helena Helm Charts

Helm charts for deploying the [Project Helena](https://github.com/projecthelena) ecosystem — Kubernetes cost visibility and FinOps.

## Charts

| Chart | Description |
| --- | --- |
| [recon](charts/recon) | Web dashboard that aggregates cost metrics from distributed agents. Includes optional VictoriaMetrics for time-series storage. |
| [recon-agent](charts/recon-agent) | DaemonSet agent that collects cluster cost data via eBPF and reports to recon over gRPC. |
| [warden](charts/warden) | Policy engine for enforcing cost and operational policies. Supports SQLite and PostgreSQL backends. |

## Usage

Add the Helm repository:

```sh
helm repo add projecthelena https://charts.projecthelena.com
helm repo update
```

Install a chart:

```sh
helm install recon projecthelena/recon --namespace recon --create-namespace
```

Or install directly from source:

```sh
helm install recon charts/recon --namespace recon --create-namespace
```

## Development

```sh
# Lint a chart
helm lint charts/<chart-name>

# Render templates locally
helm template charts/<chart-name>

# For charts with dependencies (e.g. warden with PostgreSQL)
helm dependency update charts/<chart-name>
```

Refer to `AGENTS.md` for contribution guidelines and security notes.

## License

Apache License 2.0 — see [LICENSE](LICENSE) for details.
Binary file modified assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading