This is an automated email from the ASF dual-hosted git repository. luigidemasi pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kit.git
commit b2458d08728a0e4a222b568099234bd16aa244d5 Author: Jinal Sarvaiya <[email protected]> AuthorDate: Wed Nov 18 17:48:49 2026 +0000 Refs #131: Security model registration tracking and PR templates --- docs/SECURITY-REGISTRATION.md | 167 ++++++++++++++++++++++++++++++++++++++++++ docs/security-model.md | 3 +- 2 files changed, 169 insertions(+), 1 deletion(-) diff --git a/docs/SECURITY-REGISTRATION.md b/docs/SECURITY-REGISTRATION.md new file mode 100644 index 00000000..1eae4a57 --- /dev/null +++ b/docs/SECURITY-REGISTRATION.md @@ -0,0 +1,167 @@ +# Security Model Registration Guide + +**Issue:** [#131](https://github.com/apache/camel-kit/issues/131) +**Status:** Pending External Registration +**Purpose:** Register the Camel Kit security model on security.apache.org and camel.apache.org/security/ + +## Overview + +The Camel Kit security model exists in [`docs/security-model.md`](security-model.md) and is referenced in +[`SECURITY.md`](../SECURITY.md). To complete the registration per Q10 of the security model, it must be added to two +external Apache sites. + +## Required External Changes + +### 1. Apache Security Site Registration + +**Repository:** https://github.com/apache/security-site +**File:** `scripts/project-coordinates.json` +**Action:** Add Camel Kit entry under Apache Camel section + +#### JSON Entry to Add + +Add this entry to the `camel.projects` array in `scripts/project-coordinates.json`: + +```json +{ + "name": "Apache Camel Kit", + "security_model_link": "https://github.com/apache/camel-kit/blob/main/docs/security-model.md", + "security_model_source": "https://raw.githubusercontent.com/apache/camel-kit/main/docs/security-model.md" +} +``` + +**Note:** Use `"name"` (not `"product"` or `"bughunter"`). The PMC entry already supplies the reporting contact. +Validate the entry against `scripts/project-coordinates.schema.json` before submitting. + +#### Expected Result + +Camel Kit will appear on https://security.apache.org/projects/ alongside: +- Apache Camel K +- Apache Camel Quarkus +- Apache Camel Karaf +- Apache Camel Kamelets +- Apache Camel Kafka Connector + +#### PR Template for apache/security-site + +**Title:** `Register Apache Camel Kit security model` + +**Description:** +```markdown +Add Apache Camel Kit to the security projects registry. + +Camel Kit is a sub-project of Apache Camel that provides AI-assisted workflows for designing, +implementing, and verifying Apache Camel integrations. The security model covers both Kit +(CLI, skills, graph) and Knowledge (MCP server and index). + +**Security Model:** https://github.com/apache/camel-kit/blob/main/docs/security-model.md +**Tracking Issue:** https://github.com/apache/camel-kit/issues/131 + +This registration completes the ASF registry step of Q10 of the Camel Kit security model and aligns +with other Camel sub-projects that maintain their own security models (Camel K, Camel Quarkus, Camel +Karaf, Camel Kamelets, Camel Kafka Connector). + +Refs apache/camel-kit#131 +``` + +--- + +### 2. Camel Security Page Update + +**Repository:** https://github.com/apache/camel-website +**File:** `content/security/_index.md` +**Action:** Add Camel Kit link to the security card's `read_first.body` field + +#### Content to Add + +In the `read_first.body` field of `content/security/_index.md`, append the following sentence after the existing +paragraph that lists sub-projects with their own security models: + +``` +Camel Kit also publishes its own [security model](https://github.com/apache/camel-kit/blob/main/docs/security-model.md). +``` + +**Note:** Preserve the existing wording that explains which projects inherit the umbrella model. Adding the link to the +regular Markdown body will not make it appear on the rendered security card. + +#### PR Template for apache/camel-website + +**Title:** `Add Apache Camel Kit to security page` + +**Description:** +```markdown +Add Apache Camel Kit to the list of Camel sub-projects with their own security models. + +Camel Kit provides AI-assisted workflows for the full Apache Camel integration lifecycle and +maintains its own security model covering development-time surfaces not covered by the umbrella +Apache Camel Security Model. + +**Security Model:** https://github.com/apache/camel-kit/blob/main/docs/security-model.md +**Tracking Issue:** https://github.com/apache/camel-kit/issues/131 + +This aligns the security page with other Camel sub-projects (Quarkus, Spring Boot, Karaf, +Kamelets, Kafka Connector, Camel K) that maintain their own models. + +Refs apache/camel-kit#131 +``` + +--- + +## Implementation Checklist + +- [ ] **1. Create PR for apache/security-site** + - [ ] Fork apache/security-site + - [ ] Add the entry to `camel.projects` in `scripts/project-coordinates.json` and validate it against `scripts/project-coordinates.schema.json`. + - [ ] Regenerate and include `content/projects/_index.md` and `content/projects/camel/_index.md`. Verify both contain the Camel Kit model link. + - [ ] Submit PR with template description above + - [ ] Record PR link: _________________ + +- [ ] **2. Create PR for apache/camel-website** + - [ ] Fork apache/camel-website + - [ ] Edit `content/security/_index.md` + - [ ] Add Camel Kit link to the `read_first.body` field (not the regular Markdown body) + - [ ] Submit PR with template description above + - [ ] Record PR link: _________________ + +- [ ] **3. After both PRs are merged:** + - [ ] Verify Camel Kit appears on https://security.apache.org/projects/ + - [ ] Verify Camel Kit appears on https://camel.apache.org/security/ + - [ ] Update Q10 in `docs/security-model.md` to mark as complete + - [ ] Close issue #131 + +--- + +## Verification + +Once registered, confirm: + +1. **security.apache.org/projects/** + - [ ] Camel Kit is listed + - [ ] Link to security model works + - [ ] Appears under Apache Camel section + +2. **camel.apache.org/security/** + - [ ] Camel Kit is mentioned + - [ ] Link to security model works + - [ ] Listed alongside other sub-projects + +--- + +## Background + +- **Issue #5:** Create the security model +- **PR #6:** Added `docs/security-model.md` and `docs/security-model.yaml` +- **Q10 (security-model.md):** Publication requirement - register on ASF security site and Camel security page +- **Issue #131:** This tracking issue for external registration + +The security model was merged in PR #6. This registration work makes it discoverable to downstream users +and automated triage systems. + +--- + +## Notes + +- The security model covers both **Kit** (0.4.x releases) and **Knowledge** (0.0.x releases) +- Reports should go to `[email protected]` per Apache Camel process +- The model is additive to the umbrella Apache Camel Security Model +- Ship remains covered despite Technology Preview status diff --git a/docs/security-model.md b/docs/security-model.md index 865c65c8..49678ef6 100644 --- a/docs/security-model.md +++ b/docs/security-model.md @@ -1064,7 +1064,8 @@ tags read *(maintainer, 2026-10-27 — Qn)*. authorized; distinguish that from an unintended escape (V5). - **Q10 — Publication → §4.1.** Retain this as an additive Camel sub-project security model, linked from `SECURITY.md`. Register it on the ASF security site and the Camel security page after acceptance, with - [apache/camel-kit#131](https://github.com/apache/camel-kit/issues/131) tracking that work. + [apache/camel-kit#131](https://github.com/apache/camel-kit/issues/131) tracking that work. See + [SECURITY-REGISTRATION.md](SECURITY-REGISTRATION.md) for external PR templates and registration checklist. - **Q11 — Knowledge → §4.2, §4.3, §4.4a, §4.12.** Include its server and index in this same security model, with a dedicated Knowledge section. The monorepo move has happened. Missing coverage remains work to complete (V6), and reports use the same private reporting process.
