Skip to content

docs(charts): add matomo and clickhouse docs#368

Merged
mberlofa merged 2 commits into
mainfrom
docs/matomo-clickhouse-new-charts
Jul 7, 2026
Merged

docs(charts): add matomo and clickhouse docs#368
mberlofa merged 2 commits into
mainfrom
docs/matomo-clickhouse-new-charts

Conversation

@mberlofa

@mberlofa mberlofa commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds Matomo and ClickHouse chart documentation pages.
  • Adds catalog, navigation, and playground entries for both charts.
  • Adds Matomo and ClickHouse icons.
  • Normalizes existing chart icons that were blocking the HelmForge icon audit.

Validation

  • npm run format:check
  • npm run lint
  • npm run build
  • make site-sync-check CHART=matomo
  • make site-sync-check CHART=clickhouse
  • make org-check

Companion charts PR: helmforgedev/charts#706.
Companion profile PR: helmforgedev/.github#13.

Summary by CodeRabbit

  • New Features

    • Added support for two new charts: ClickHouse and Matomo.
    • Expanded the playground with setup options for both charts.
    • Updated navigation so both charts appear in the appropriate categories.
  • Documentation

    • Added detailed documentation pages for ClickHouse and Matomo, including installation, configuration examples, troubleshooting, and values references.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f3734de4-6b8e-433f-bb89-8df21ab22f1b

📥 Commits

Reviewing files that changed from the base of the PR and between 712da41 and c4b84dd.

📒 Files selected for processing (2)
  • src/pages/docs/charts/clickhouse.mdx
  • src/pages/docs/charts/matomo.mdx
✅ Files skipped from review due to trivial changes (2)
  • src/pages/docs/charts/matomo.mdx
  • src/pages/docs/charts/clickhouse.mdx

📝 Walkthrough

Walkthrough

Adds ClickHouse and Matomo chart entries to the charts registry, navigation categories, and playground sync configuration, along with dedicated playground field configurations and chart documentation pages for each chart.

Changes

ClickHouse and Matomo chart additions

Layer / File(s) Summary
Chart metadata, navigation, and playground registration
src/data/charts.ts, src/data/navigation.ts, src/pages/playground.astro
Adds ClickHouse and Matomo entries to the charts list, chart navigation categories, and playground siteSyncPlaygroundConfigs.
Playground field configurations
src/data/playground-configs.ts
Adds chart-specific playground field groups for ClickHouse and Matomo covering credentials, persistence, observability, network policy, database mode, archiving, and ingress settings.
ClickHouse documentation page
src/pages/docs/charts/clickhouse.mdx
Adds the ClickHouse chart documentation page with overview, installation, configuration, authentication, observability, networking, validation, troubleshooting, values reference, and links.
Matomo documentation page
src/pages/docs/charts/matomo.mdx
Adds the Matomo chart documentation page with overview, installation, configuration, archiving, backups, External Secrets, networking, validation, troubleshooting, values reference, and links.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

  • helmforgedev/site#322: Both PRs extend siteSyncPlaygroundConfigs in src/pages/playground.astro to register additional chart slugs for playground filtering.
  • helmforgedev/site#341: Both PRs update the same siteSyncPlaygroundConfigs allowlist to pull chart playground configs from src/data/playground-configs.ts.
  • helmforgedev/site#352: Both PRs modify src/pages/playground.astro to register additional chart slugs in siteSyncPlaygroundConfigs.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding Matomo and ClickHouse documentation.
Description check ✅ Passed The description covers the summary and validation steps, though it omits the template's Quality Gates checklist and Related Issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/matomo-clickhouse-new-charts

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
src/pages/playground.astro (1)

58-59: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Out-of-order insertion in siteSyncPlaygroundConfigs.

The map is otherwise alphabetically sorted; clickhouse and matomo are inserted after langflow instead of in their alphabetical positions (before cloudflared and dolibarr respectively).

♻️ Suggested reordering
-  langflow: 'src/data/playground-configs.ts',
-  clickhouse: 'src/data/playground-configs.ts',
-  matomo: 'src/data/playground-configs.ts',
+  clickhouse: 'src/data/playground-configs.ts',
+  ...
+  langflow: 'src/data/playground-configs.ts',
+  ...
+  matomo: 'src/data/playground-configs.ts',
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/playground.astro` around lines 58 - 59, The
siteSyncPlaygroundConfigs map is no longer alphabetically ordered because the
clickhouse and matomo entries were inserted in the wrong positions. Reorder
these entries within the siteSyncPlaygroundConfigs object in playground.astro so
clickhouse appears before cloudflared and matomo appears before dolibarr,
keeping the rest of the map sorted consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/pages/docs/charts/clickhouse.mdx`:
- Around line 82-87: The ClickHouse values reference table is missing settings
that are already used in the docs examples. Update the values table near the
ClickHouse configuration section to include clickhouse.existingSecretPasswordKey
and clickhouse.defaultAccessManagement, matching the usage shown in the
Installation/Production/Auth/External Secrets examples and the Production Values
example. Keep the entries aligned with the existing ClickHouse keys so readers
can discover all required companion options in the same reference table.

In `@src/pages/docs/charts/matomo.mdx`:
- Around line 257-274: The values table in the Matomo docs is missing the
documented `matomo.trustedHost` setting, even though it is referenced in the
examples and Common Issues guidance. Update the parameters table in `matomo.mdx`
to add `matomo.trustedHost` with its default and a brief description, keeping it
aligned with the existing `matomo.siteUrl` entry and the related deployment
examples.

---

Nitpick comments:
In `@src/pages/playground.astro`:
- Around line 58-59: The siteSyncPlaygroundConfigs map is no longer
alphabetically ordered because the clickhouse and matomo entries were inserted
in the wrong positions. Reorder these entries within the
siteSyncPlaygroundConfigs object in playground.astro so clickhouse appears
before cloudflared and matomo appears before dolibarr, keeping the rest of the
map sorted consistently.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e9677c09-54b9-482b-bd60-ac23b6e0f033

📥 Commits

Reviewing files that changed from the base of the PR and between 4780cf0 and 712da41.

⛔ Files ignored due to path filters (13)
  • public/icons/charts/alfio.png is excluded by !**/*.png
  • public/icons/charts/booklore.png is excluded by !**/*.png
  • public/icons/charts/clickhouse.png is excluded by !**/*.png
  • public/icons/charts/cronicle.png is excluded by !**/*.png
  • public/icons/charts/dolibarr.png is excluded by !**/*.png
  • public/icons/charts/fastmcp-server.png is excluded by !**/*.png
  • public/icons/charts/ghost.png is excluded by !**/*.png
  • public/icons/charts/kafka.png is excluded by !**/*.png
  • public/icons/charts/matomo.png is excluded by !**/*.png
  • public/icons/charts/metabase.png is excluded by !**/*.png
  • public/icons/charts/ntfy.png is excluded by !**/*.png
  • public/icons/charts/strava-statistics.png is excluded by !**/*.png
  • public/icons/charts/umami.png is excluded by !**/*.png
📒 Files selected for processing (6)
  • src/data/charts.ts
  • src/data/navigation.ts
  • src/data/playground-configs.ts
  • src/pages/docs/charts/clickhouse.mdx
  • src/pages/docs/charts/matomo.mdx
  • src/pages/playground.astro

Comment thread src/pages/docs/charts/clickhouse.mdx
Comment thread src/pages/docs/charts/matomo.mdx
@mberlofa mberlofa merged commit 24e68e4 into main Jul 7, 2026
6 checks passed
@mberlofa mberlofa deleted the docs/matomo-clickhouse-new-charts branch July 7, 2026 10:42
mberlofa added a commit to helmforgedev/charts that referenced this pull request Jul 7, 2026
## Summary

- Adds a production-ready Matomo chart using the official
`docker.io/library/matomo:5.11.2-apache` image.
- Adds a production-safe standalone ClickHouse chart using the official
`docker.io/clickhouse/clickhouse-server:25.8.28.1` image.
- Includes values schemas, README/DESIGN/docs, examples, CI values,
helm-unittest coverage, External Secrets, NetworkPolicy, dual-stack,
ServiceMonitor where applicable, and operational guardrails.

## Issues

Resolves #654.
Resolves #705.

## Companion PRs

- Site PR: helmforgedev/site#368
- Org profile PR: helmforgedev/.github#13

## Validation

Chart image verification:

- `make image-verify IMAGE=docker.io/library/matomo:5.11.2-apache`
- `make image-verify
IMAGE=docker.io/clickhouse/clickhouse-server:25.8.28.1`

Matomo:

- `make validate-chart CHART=matomo` -> `matomo: FULLY VALIDATED (18
layers)`
- Includes k3d behavioral validation for default, default-values,
dual-stack, external-db, external-secrets, gateway-api, ingress,
network-policy, and production scenarios.
- Kubescape Security Scan: MITRE + NSA + SOC2 score 84.78%, 0 critical
failed resources.

ClickHouse:

- `make validate-chart CHART=clickhouse` -> `clickhouse: FULLY VALIDATED
(18 layers)`
- Includes k3d behavioral validation for default, auth, default-values,
dual-stack, ephemeral, external-secrets, metrics, network-policy, and
production scenarios.
- Kubescape Security Scan: MITRE + NSA + SOC2 score 89.39%, 0 critical
failed resources.

Repository gates:

- `make preflight`
- `make standards-check CHART=matomo`
- `make standards-check CHART=clickhouse`
- `node scripts/charts/template-standards-check.js --chart matomo`
- `node scripts/charts/template-standards-check.js --chart clickhouse`
- `make deps-check CHART=matomo`
- `make deps-check CHART=clickhouse`
- Markdown lint for new chart docs
- `make site-sync-check CHART=matomo`
- `make site-sync-check CHART=clickhouse`
- `make org-check`

## Notes

ClickHouse intentionally blocks `replicaCount > 1`; replicated or
sharded deployments should use ClickHouse Operator or Altinity operator
workflows.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added two new Helm charts: **ClickHouse** and **Matomo**, with
standalone defaults, health/connection test hooks, and ready-to-use
examples.
* Included persistence, optional **ServiceMonitor** metrics,
**NetworkPolicy** support, and **External Secrets**-based credential
provisioning (plus MySQL/external DB + archiver support for Matomo).
* **Documentation**
* Added production, observability/metrics, external secrets, and
networking guides, plus values schema validation for both charts.
* **Tests**
* Added Helm/unit rendering tests for metrics, network policies,
secrets, PodDisruptionBudget behavior, connection checks, validation
failures, and archiver security/behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: MergeCheck <mergecheck@example.invalid>
mberlofa added a commit to helmforgedev/.github that referenced this pull request Jul 8, 2026
## Summary

- Updates the organization profile chart count from 87 to 89.
- Keeps the profile aligned with the new Matomo and ClickHouse charts.

## Validation

- make release-check REPO=.github
- make attribution-check REPO=.github
- make md-lint REPO=.github
- make org-check

Companion charts PR: helmforgedev/charts#706.
Companion site PR: helmforgedev/site#368.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant