Skip to content

docs(certimate): document writable temporary storage - #502

Open
mberlofa wants to merge 2 commits into
mainfrom
docs/certimate-writable-tmp-sync
Open

docs(certimate): document writable temporary storage#502
mberlofa wants to merge 2 commits into
mainfrom
docs/certimate-writable-tmp-sync

Conversation

@mberlofa

@mberlofa mberlofa commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document Certimate's dedicated ephemeral /tmp storage
  • clarify that the writable mount preserves the read-only root filesystem default

Companion documentation for helmforgedev/charts#973 and helmforgedev/charts#970.

Validation

  • npm run lint
  • npm run format:check
  • npm run build
  • make release-check REPO=site
  • make attribution-check REPO=site

Summary by CodeRabbit

  • New Features

    • Added an optional playground setting for configuring temporary /tmp storage size.
    • The configured value is applied to ephemeral-storage requests and limits.
  • Documentation

    • Documented the dedicated writable temporary volume used by certificate workflows, including read-only container compatibility.

@coderabbitai

coderabbitai Bot commented Aug 11, 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: 4aa64dfb-3ac6-4f49-a6ab-0e3434f7a02c

📥 Commits

Reviewing files that changed from the base of the PR and between 353dbc8 and 9c3af0e.

📒 Files selected for processing (2)
  • src/data/playground-configs.ts
  • src/pages/docs/charts/certimate.mdx

📝 Walkthrough

Walkthrough

Certimate now includes an optional temporary storage size field. Its chart documentation describes the dedicated /tmp volume and the application of tmpStorage.sizeLimit to ephemeral-storage requests and limits.

Changes

Certimate temporary storage

Layer / File(s) Summary
Temporary storage configuration and documentation
src/data/playground-configs.ts, src/pages/docs/charts/certimate.mdx
The playground adds an optional Temporary Storage Limit field for tmpStorage.size. The documentation describes the /tmp emptyDir volume and tmpStorage.sizeLimit behavior.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change: writable temporary storage for Certimate.
Description check ✅ Passed The description explains the change, identifies related chart issues, and lists validation commands; the non-applicable blog section is correctly omitted.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/certimate-writable-tmp-sync

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: dependency version conflict. Check your lock file or package.json.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

mberlofa added a commit to helmforgedev/charts that referenced this pull request Aug 12, 2026
## Summary

- mount an ephemeral writable `emptyDir` at `/tmp` for Certimate
certificate workflows
- keep the container root filesystem read-only
- cover the storage and security contract in unit tests and chart
documentation

## Validation

- `make validate-chart CHART=certimate` — PASS, 17 layers including all
8 k3d scenarios
- `make standards-check CHART=certimate` — PASS
- `make preflight` — PASS

Site PR: helmforgedev/site#502

Resolves #970


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

## Summary by CodeRabbit

* **New Features**
* Added writable temporary storage at `/tmp` for certificate workflows.
* Preserved read-only container root filesystems for improved runtime
security.

* **Documentation**
* Documented the temporary storage configuration and production
defaults.

* **Tests**
* Added coverage verifying read-only root filesystems and writable
`/tmp` storage.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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