Skip to content

Commit 18af8e4

Browse files
committed
docs(gtr): refresh markers stale after #4223/#4296 and re-verify CI claim
Addresses @IvanHunters round-2 review: - governance description at :20 now agrees with GOVERNANCE.md: the Directors removal (#4296) has merged, so three roles / one vote per Maintainer matches main. - drop the SECURITY.md rotation-publication item from the status banner and the :151 marker: #4223 merged and the rotation cadence + diversity statement are now in the published SECURITY.md; link to it instead. - re-verify the nightly-CI claim re-dated by the Date Updated bump: 1 of the last 24 scheduled runs passed (isolated passes 2026-08-17 and 2026-09-03), not six, and it has not 'failed every run since 2026-08-02'. - banner now says attribution-notice markers 'are to be resolved in place' (intent, not state), since :144-:145 still carry [maintainers: confirm]. Signed-off-by: Timur Tukaev <[email protected]>
1 parent cc1160e commit 18af8e4

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎GENERAL_TECHNICAL_REVIEW.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
- **Project:** Cozystack
44
- **Project Version:** v1.6.3 (latest stable at the time of submission, released 2026-09-04). The authoritative list of releases is the [GitHub Releases page](https://github.com/cozystack/cozystack/releases); which release lines receive security fixes is defined in [SECURITY.md](https://github.com/cozystack/cozystack/blob/main/SECURITY.md).
55
- **Website:** https://cozystack.io
6-
- **Date Updated:** 2026-09-11
6+
- **Date Updated:** 2026-09-17
77
- **Template Version:** v1.0
88
- **Description:** Cozystack is a free, Apache-2.0 open-source platform and framework for building clouds. It turns a set of bare-metal servers into a system with a native Kubernetes REST API for spawning Kubernetes clusters, Databases-as-a-Service, virtual machines, load balancers, HTTP-caching and other services. It is a CNCF Sandbox project and a Certified Kubernetes distribution.
99

10-
> **Status: DRAFT — the remaining items are open due-diligence work, not unwritten answers.** Every answer that repository or documentation evidence can settle has been written and verified against the tree. Most items still marked `[maintainers: …]` fall into four kinds that cannot be closed by editing this document alone: **measurements** — load/scale test results and tested maximums (nodes, tenants, VMs, PVs) with methodology, measured baseline resource overhead of the platform components, and the upgrade→downgrade→upgrade CI matrix and its results; **maintainer confirmations of runtime behavior** — whether platform upgrades trigger Talos node reboots, whether any core-component change requires a control-plane restart, CRD cleanup on full uninstall, and any explicit circuit-breaker usage; **a governance/publication step** — surfacing the security-response-team rotation and diversity policy into the public `SECURITY.md` (a rotating Security Champion role with a fixed term and handoff overlap is defined in the CVE-scanning pipeline's own governance document, which is unpublished; the role itself is now held by @tym83, so surfacing the cadence into `SECURITY.md` is the remaining step); and **organization actions** — closing the SCA write-back loop and publishing the CVE-scanning pipeline's policy documents and scanning scripts from the private `cozystack/security-scanner` repository so the method is auditable independently of the numbers. The aggregate security reporting itself is already published at [`docs/security/reports/`](https://github.com/cozystack/cozystack/tree/main/docs/security/reports). A few remaining `[maintainers: confirm]` markers — notably the third-party attribution-notice details in the Compliance section — are editorial and are resolved in place.
10+
> **Status: DRAFT — the remaining items are open due-diligence work, not unwritten answers.** Every answer that repository or documentation evidence can settle has been written and verified against the tree. Most items still marked `[maintainers: …]` fall into three kinds that cannot be closed by editing this document alone: **measurements** — load/scale test results and tested maximums (nodes, tenants, VMs, PVs) with methodology, measured baseline resource overhead of the platform components, and the upgrade→downgrade→upgrade CI matrix and its results; **maintainer confirmations of runtime behavior** — whether platform upgrades trigger Talos node reboots, whether any core-component change requires a control-plane restart, CRD cleanup on full uninstall, and any explicit circuit-breaker usage; and **organization actions** — closing the SCA write-back loop and publishing the CVE-scanning pipeline's policy documents and scanning scripts from the private `cozystack/security-scanner` repository so the method is auditable independently of the numbers. The security-response-team rotation and diversity statement have since been surfaced into the public [`SECURITY.md`](https://github.com/cozystack/cozystack/blob/main/SECURITY.md), and the aggregate security reporting is published at [`docs/security/reports/`](https://github.com/cozystack/cozystack/tree/main/docs/security/reports). A few remaining `[maintainers: confirm]` markers — notably the third-party attribution-notice details in the Compliance section — are editorial and are to be resolved in place.
1111
>
1212
> Notes for reviewers: answers cover **Day 0** and **Day 1** (required for Incubation, cumulative) plus **Day 2** where it already applies. Doc links are pinned to the versioned `/docs/v1.6/` tree; repo links are on `main` and should be pinned to the submitted tag before final submission. Version numbers are deliberately not restated in prose where a canonical source exists — the [Releases page](https://github.com/cozystack/cozystack/releases) and [SECURITY.md](https://github.com/cozystack/cozystack/blob/main/SECURITY.md) are cited instead, so the document does not drift with each release.
1313
@@ -83,7 +83,7 @@
8383

8484
* **Enable/disable in a live cluster.** On the Talos and generic-Linux paths Cozystack is the distribution that owns the cluster, so "enablement" = installing the operator bundle on the management cluster; on the bring-your-own-Kubernetes path it is installed onto an existing cluster instead. Individual bundles/components and each tenant application are enabled/removed independently (create/delete the corresponding resource); removing a tenant application affects only that tenant, with no downtime to unrelated workloads. `[maintainers: confirm whether any core component change requires control-plane restart]`
8585
* **How enablement changes default cluster behavior.** Installing Cozystack sets the CNI (Cilium/Kube-OVN), default StorageClass (LINSTOR), ingress, cert-manager, and the aggregated API as cluster defaults for subsequently created workloads. Cozystack expects to own the cluster, so a clean install does not disturb pre-existing unrelated workloads.
86-
* **Testing enablement/disablement.** CI installs Cozystack end-to-end in ephemeral environments and provisions/destroys sample tenants and applications to validate create→ready→delete flows. Workflows: [`pull-requests.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/pull-requests.yaml) (per-PR checks), [`e2e-tag.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/e2e-tag.yaml) (tag/release e2e), [`nightly.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/nightly.yaml) (scheduled full run) and [`ui-test.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/ui-test.yaml) (dashboard). Test conventions are documented in [`docs/agents/e2e-testing.md`](https://github.com/cozystack/cozystack/blob/main/docs/agents/e2e-testing.md). **Current health of these workflows:** the gating checks are the per-PR ones — `pre-commit` and `E2E Tests` are the two required status checks on `main`, and a change cannot merge without them passing. The scheduled runs are another matter. `nightly.yaml` is **flapping rather than simply broken**, and has been for a month: the first scheduled run after the fix in [cozystack#3332](https://github.com/cozystack/cozystack/pull/3332) still failed, then it passed for three days, went red for five, passed for three more ending 2026-08-01, and has failed every scheduled run since 2026-08-02. Six of its last twenty-four scheduled runs passed. The current failure has **not been triaged to an issue** — several e2e failures from the same window are open and may share a cause, and the older nightly item in [cozystack#3278](https://github.com/cozystack/cozystack/issues/3278) describes the earlier never-completing failure rather than this one — so the honest statement is that the scheduled full-matrix run is unreliable and its current failure is not yet attributed. The tag-triggered `e2e-tag.yaml` also failed around the v1.6.1 release. Enablement and disablement coverage therefore rests on the per-PR e2e job today, and restoring the scheduled full-matrix run is outstanding work.
86+
* **Testing enablement/disablement.** CI installs Cozystack end-to-end in ephemeral environments and provisions/destroys sample tenants and applications to validate create→ready→delete flows. Workflows: [`pull-requests.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/pull-requests.yaml) (per-PR checks), [`e2e-tag.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/e2e-tag.yaml) (tag/release e2e), [`nightly.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/nightly.yaml) (scheduled full run) and [`ui-test.yaml`](https://github.com/cozystack/cozystack/blob/main/.github/workflows/ui-test.yaml) (dashboard). Test conventions are documented in [`docs/agents/e2e-testing.md`](https://github.com/cozystack/cozystack/blob/main/docs/agents/e2e-testing.md). **Current health of these workflows:** the gating checks are the per-PR ones — `pre-commit` and `E2E Tests` are the two required status checks on `main`, and a change cannot merge without them passing. The scheduled runs are another matter. `nightly.yaml` is **flapping rather than simply broken**, and has been for a month: the first scheduled run after the fix in [cozystack#3332](https://github.com/cozystack/cozystack/pull/3332) still failed, then it passed for three days, went red for five, passed for three more ending 2026-08-01, and has failed nearly every scheduled run since, with only isolated passes on 2026-08-17 and 2026-09-03. One of its last twenty-four scheduled runs passed, and every scheduled run since 2026-09-03 has failed. The current failure has **not been triaged to an issue** — several e2e failures from the same window are open and may share a cause, and the older nightly item in [cozystack#3278](https://github.com/cozystack/cozystack/issues/3278) describes the earlier never-completing failure rather than this one — so the honest statement is that the scheduled full-matrix run is unreliable and its current failure is not yet attributed. The tag-triggered `e2e-tag.yaml` also failed around the v1.6.1 release. Enablement and disablement coverage therefore rests on the per-PR e2e job today, and restoring the scheduled full-matrix run is outstanding work.
8787
* **Resource cleanup incl. CRDs.** Deleting an application resource triggers Flux/Helm to remove its HelmRelease and owned objects; finalizers ensure dependent resources (PVCs, VM disks, LB IPs) are released. `[maintainers: confirm CRD-cleanup behavior on full uninstall and any manual steps]`
8888

8989
### Rollout, Upgrade and Rollback Planning
@@ -148,7 +148,7 @@
148148
### Security
149149

150150
* **Access control execution.** Kubernetes RBAC end-to-end; per-tenant namespaces, RoleBindings, quotas and NetworkPolicies; isolated tenant API servers (Kamaji + dedicated etcd); Keycloak OIDC/SAML for federated auth; secrets via External Secrets Operator / OpenBao.
151-
* **Security reporting team & rotation.** Reporting via **GitHub Private Vulnerability Reporting** ([advisories/new](https://github.com/cozystack/cozystack/security/advisories/new)) or a private maintainer contact; any maintainer can receive and route a report. Current security response team: **@kvaps, @lexfrei, @tym83, @matthieu-robin, @mattia-eleuteri** — spanning more than one organization (Ænix, HIDORA) and more than one country, rather than a single employer. A rotating **Security Champion** role (a fixed term with a handoff overlap) owns the CVE-triage clock; the role is **currently held by @tym83**, who runs a weekly triage pass over scanner findings, while technical reachability of a given CVE in bundled components is assessed together with the security team. `[maintainers: surface the rotation cadence and diversity statement into the public SECURITY.md — requires review from a CODEOWNER for that path]`
151+
* **Security reporting team & rotation.** Reporting via **GitHub Private Vulnerability Reporting** ([advisories/new](https://github.com/cozystack/cozystack/security/advisories/new)) or a private maintainer contact; any maintainer can receive and route a report. Current security response team: **@kvaps, @lexfrei, @tym83, @matthieu-robin, @mattia-eleuteri** — spanning more than one organization (Ænix, HIDORA) and more than one country, rather than a single employer. A rotating **Security Champion** role (a fixed term with a handoff overlap) owns the CVE-triage clock; the role is **currently held by @tym83**, who runs a weekly triage pass over scanner findings, while technical reachability of a given CVE in bundled components is assessed together with the security team. This rotation cadence and the team's diversity statement are published in the project's [`SECURITY.md`](https://github.com/cozystack/cozystack/blob/main/SECURITY.md).
152152

153153
---
154154

0 commit comments

Comments
 (0)