Aleksei Sviridkin
3bf8fec399
## What this PR does Adds `docs/security/threat-model.md`, a design-level threat model for Cozystack. It documents the actors, the actions that cross trust boundaries, and the security goals and non-goals, organized by trust boundary (T0–T4) following the CNCF TAG-Security Actors/Actions model. It records the usage and multitenancy model (managed-services backend vs direct dashboard/API access; combined hard multitenancy for tenant VMs and Kubernetes clusters, soft multitenancy for managed data services), the primary trust-boundary invariant (tenant RBAC grants no HelmRelease or arbitrary core writes; the aggregated API server fixes the chart reference server-side), and the two admission enforcement points (core kube-apiserver vs `cozystack-api`). Hostname integrity covers both the Gateway API path and the default legacy-Ingress path (`cozystack-ingress-hostname-policy`, #3200). Every architectural claim cites a source file so the model can be re-verified as the code evolves. This is the in-repo companion to the project's CNCF TAG-Security self-assessment, which references it. ### Screenshots N/A — documentation only. ### Release note ```release-note docs(security): add a design-level threat model (docs/security/threat-model.md) ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a security threat model for the platform. * Clarified system boundaries, trust tiers, and the main actors involved. * Documented key security goals, non-goals, and important enforcement points. * Described expected behavior for tenant actions, hostname handling, and cross-boundary access. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Cozystack
Cozystack is a free platform and framework for building clouds.
Cozystack is a CNCF Sandbox Level Project that was originally built and sponsored by Ænix.
With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.
Use Cozystack to build your own cloud or provide a cost-effective development environment.
Use-Cases
-
Using Cozystack to build a public cloud
You can use Cozystack as a backend for a public cloud -
Using Cozystack to build a private cloud
You can use Cozystack as a platform to build a private cloud powered by Infrastructure-as-Code approach -
Using Cozystack as a Kubernetes distribution
You can use Cozystack as a Kubernetes distribution for Bare Metal
Documentation
The documentation is located on the cozystack.io website.
Read the Getting Started section for a quick start.
If you encounter any difficulties, start with the troubleshooting guide and work your way through the process that we've outlined.
Versioning
Versioning adheres to the Semantic Versioning principles.
A full list of the available releases is available in the GitHub repository's Release section.
Contributions
Contributions are highly appreciated and very welcomed!
In case of bugs, please check if the issue has already been opened by checking the GitHub Issues section. If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix.
You can express your intention to on the fix on your own. Commits are used to generate the changelog, and their author will be referenced in it.
If you have a concrete feature request, open an issue. For a cross-cutting or architectural change, open a design proposal in the community repo. For questions or early ideas, use GitHub Discussions. See CONTRIBUTING.md for the full routing.
Community
You are welcome to join our Telegram group and come to our weekly community meetings. Add them to your Google Calendar or iCal for convenience.
License
Cozystack is licensed under Apache 2.0.
The code is provided as-is with no warranties.
Commercial Support
A list of companies providing commercial support for this project can be found on official site.