mirror of
https://github.com/cozystack/cozystack.git
synced 2026-10-23 03:27:50 +09:00
Marian Koreniuk
b39f623338
In the v1 docs the kubernetes-distribution use-case path holds Build Your Own Platform: installing only the packages you need onto an existing cluster that already has networking and storage. The README entry still described the v0 page, Cozystack as a Kubernetes distribution for bare metal, so its label and description no longer matched the page it links to. Both now describe BYOP. Assisted-by: LLM Signed-off-by: Marian Koreniuk <moriarti@cp.if.ua>
86 lines
5.6 KiB
Markdown
86 lines
5.6 KiB
Markdown
<img src="img/cozystack-logo-black.svg#gh-light-mode-only" alt="Cozystack" width="340">
|
|
<img src="img/cozystack-logo-white.svg#gh-dark-mode-only" alt="Cozystack" width="340">
|
|
|
|
[](https://github.com/cozystack/cozystack/releases/latest)
|
|
[](https://github.com/cozystack/cozystack/blob/main/LICENSE)
|
|
[](https://github.com/cozystack/cozystack/graphs/commit-activity)
|
|
[](https://www.bestpractices.dev/projects/10177)
|
|
[](https://securityscorecards.dev/viewer/?uri=github.com/cozystack/cozystack)
|
|
[](https://clomonitor.io/projects/cncf/cozystack)
|
|
[](https://cozystack.io/support/)
|
|
|
|
# Cozystack
|
|
|
|
**Cozystack** is a free and open-source platform and framework for building clouds.
|
|
|
|
Cozystack is a [CNCF Sandbox project](https://www.cncf.io/sandbox-projects/) that was originally built and sponsored by [Ænix](https://aenix.io/).
|
|
|
|
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**](https://cozystack.io/docs/v1.6/guides/use-cases/public-cloud/)
|
|
You can use Cozystack as a backend for a public cloud
|
|
|
|
* [**Using Cozystack to build a private cloud**](https://cozystack.io/docs/v1.6/guides/use-cases/private-cloud/)
|
|
You can use Cozystack as a platform to build a private cloud powered by Infrastructure-as-Code approach
|
|
|
|
* [**Using Cozystack to build your own platform**](https://cozystack.io/docs/v1.6/guides/use-cases/kubernetes-distribution/)
|
|
You can install only the Cozystack components you need on an existing Kubernetes cluster
|
|
|
|
## Documentation
|
|
|
|
The documentation is located on the [cozystack.io](https://cozystack.io) website.
|
|
|
|
Read the [Getting Started](https://cozystack.io/docs/v1.6/getting-started/) section for a quick start.
|
|
|
|
If you encounter any difficulties, start with the [troubleshooting guide](https://cozystack.io/docs/v1.6/operations/troubleshooting/) and work your way through the process that we've outlined.
|
|
|
|
## Versioning
|
|
|
|
Versioning adheres to the [Semantic Versioning](https://semver.org/) principles.
|
|
A full list of the available releases is available in the GitHub repository's [Release](https://github.com/cozystack/cozystack/releases) 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](https://github.com/cozystack/cozystack/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 are welcome to take on the fix yourself.
|
|
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](https://github.com/cozystack/cozystack/issues/new/choose). For a **cross-cutting or architectural change**, open a [design proposal](https://github.com/cozystack/community/tree/main/design-proposals) in the [community](https://github.com/cozystack/community) repo. For **questions or early ideas**, use [GitHub Discussions](https://github.com/cozystack/cozystack/discussions). See [CONTRIBUTING.md](CONTRIBUTING.md#where-do-i-file) for the full routing.
|
|
|
|
## Community
|
|
|
|
You are welcome to join us in **#cozystack**, on either [CNCF Slack](https://cloud-native.slack.com/archives/C08BQJD95J7) ([get an invite](https://cncf-slack.netlify.app/)) or [Kubernetes Slack](https://kubernetes.slack.com/archives/C06L3CPRVN1) ([get an invite](https://slack.kubernetes.io/)), in our [Telegram group](https://t.me/cozystack), and at our community meetings.
|
|
Add them to your [Google Calendar](https://calendar.google.com/calendar?cid=ZTQzZDIxZTVjOWI0NWE5NWYyOGM1ZDY0OWMyY2IxZTFmNDMzZTJlNjUzYjU2ZGJiZGE3NGNhMzA2ZjBkMGY2OEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) or [iCal](https://calendar.google.com/calendar/ical/e43d21e5c9b45a95f28c5d649c2cb1e1f433e2e653b56dbbda74ca306f0d0f68%40group.calendar.google.com/public/basic.ics) for convenience.
|
|
|
|
## Project documents
|
|
|
|
| Document | What it covers |
|
|
|---|---|
|
|
| [Governance](GOVERNANCE.md) | How decisions are made and who makes them |
|
|
| [Contributor Ladder](CONTRIBUTOR_LADDER.md) | How to grow from contributor to maintainer |
|
|
| [Maintainers](MAINTAINERS.md) | Who maintains the project |
|
|
| [Code of Conduct](CODE_OF_CONDUCT.md) | What we expect of each other |
|
|
| [Security Policy](SECURITY.md) | Reporting a vulnerability, and which releases get fixes |
|
|
| [Adopters](ADOPTERS.md) | Who runs Cozystack in production |
|
|
| [Roadmap](ROADMAP.md) | Where the project is going |
|
|
|
|
## 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](https://cozystack.io/support/).
|