Skip to content

Commit 8857798

Browse files
committed
#11312 Issue: Update README.md
1 parent 1f1e38f commit 8857798

1 file changed

Lines changed: 172 additions & 68 deletions

File tree

README.md

Lines changed: 172 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,62 @@
1-
# Apache CloudStack [![Build Status](https://github.com/apache/cloudstack/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/build.yml) [![UI Build](https://github.com/apache/cloudstack/actions/workflows/ui.yml/badge.svg)](https://github.com/apache/cloudstack/actions/workflows/ui.yml) [![License Check](https://github.com/apache/cloudstack/actions/workflows/rat.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/rat.yml) [![Simulator CI](https://github.com/apache/cloudstack/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/ci.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=apache_cloudstack&metric=alert_status)](https://sonarcloud.io/dashboard?id=apache_cloudstack) [![codecov](https://codecov.io/gh/apache/cloudstack/branch/main/graph/badge.svg)](https://codecov.io/gh/apache/cloudstack)
21

3-
[![Apache CloudStack](tools/logo/apache_cloudstack.png)](https://cloudstack.apache.org/)
2+
# Apache CloudStack: Effortless Cloud Management at Scale
3+
4+
[![Build Status](https://github.com/apache/cloudstack/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/build.yml) [![UI Build](https://github.com/apache/cloudstack/actions/workflows/ui.yml/badge.svg)](https://github.com/apache/cloudstack/actions/workflows/ui.yml) [![License Check](https://github.com/apache/cloudstack/actions/workflows/rat.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/rat.yml) [![Simulator CI](https://github.com/apache/cloudstack/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/ci.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=apache_cloudstack&metric=alert_status)](https://sonarcloud.io/dashboard?id=apache_cloudstack) [![codecov](https://codecov.io/gh/apache/cloudstack/branch/main/graph/badge.svg)](https://codecov.io/gh/apache/cloudstack)
45

5-
Apache CloudStack is open source software designed to deploy and manage large
6-
networks of virtual machines, as a highly available, highly scalable
7-
Infrastructure as a Service (IaaS) cloud computing platform. CloudStack is used
8-
by a number of service providers to offer public cloud services, and by many
9-
companies to provide an on-premises (private) cloud offering, or as part of a
10-
hybrid cloud solution.
6+
[![Apache CloudStack](tools/logo/apache_cloudstack.png)](https://cloudstack.apache.org/)
117

12-
CloudStack is a turnkey solution that includes the entire "stack" of features
13-
most organizations want with an IaaS cloud: compute orchestration,
14-
Network-as-a-Service, user and account management, a full and open native API,
15-
resource accounting, and a first-class User Interface (UI).
8+
**Apache CloudStack is an open-source, production-ready platform to build, deploy, and manage highly available, scalable, and secure private, public, or hybrid cloud infrastructure.**
169

17-
CloudStack currently supports the most popular hypervisors:
18-
VMware vSphere, KVM, XenServer, XenProject and Hyper-V as well as
19-
OVM and LXC containers.
10+
Designed for simplicity without sacrificing power, CloudStack delivers a comprehensive Infrastructure-as-a-Service (IaaS) solution. Its intuitive UI, rich API, and seamless multi-hypervisor support put complete cloud control in your hands.
2011

21-
Users can manage their cloud with an easy to use Web interface, command line
22-
tools, and/or a full-featured query based API.
12+
Whether you're a cloud service provider or an enterprise modernizing infrastructure, CloudStack empowers you to run your cloud your way—faster, safer, and smarter.
2313

2414
For more information on Apache CloudStack, please visit the [website](http://cloudstack.apache.org)
15+
---
16+
17+
18+
## Table of Contents
19+
20+
1. [Key Features at a Glance](#key-features-at-a-glance)
21+
2. [Who Uses CloudStack?](#who-uses-cloudstack)
22+
3. [Demo](#demo)
23+
4. [Try CloudStack in Minutes](#try-cloudstack-in-minutes)
24+
25+
5. [Source Code](#source-code)
26+
6. [Getting Source Repository](#getting-source-repository)
27+
7. [Documentation](#documentation)
28+
8. [Ecosystem & Integrations](#ecosystem--integrations)
29+
9. [Project Status & Release Cycle](#project-status--release-cycle)
30+
10. [News and Events](#news-and-events)
31+
11. [Getting Involved & Contributing](#getting-involved--contributing)
32+
- [How to Contribute](#how-to-contribute)
33+
- [Mailing Lists](#mailing-lists)
34+
- [Issue Tracker](#issue-tracker)
35+
12. [License & Security Policy](#license--security-policy)
36+
37+
13. [Notice of Cryptographic Software](#notice-of-cryptographic-software)
38+
14. [Star History](#star-history)
39+
15. [Contributors](#contributors)
40+
41+
42+
---
43+
44+
## Key Features at a Glance
45+
46+
* **Multi-Hypervisor Management**
47+
Control VMs across KVM, VMware vSphere, XenServer, and Hyper-V — all from one UI.
48+
* **Built-in Network-as-a-Service (NaaS)**
49+
Automate virtual networks, firewalls, VPNs, and load balancers without vendor lock-in.
50+
* **Powerful API & Intuitive UI**
51+
Seamlessly integrate via RESTful API or manage everything visually through a clean web interface.
52+
* **Flexible Storage Architecture**
53+
Supports primary/secondary storage, snapshots, volume management, and disaster recovery.
54+
* **Granular User & Account Controls**
55+
Fine-tuned multi-tenant access control for service providers and enterprise clouds.
56+
* **Real-Time Resource Usage & Accounting**
57+
Built-in metering for chargeback, quota management, and capacity planning.
58+
59+
---
2560

2661
## Who Uses CloudStack?
2762

@@ -40,10 +75,61 @@ For more information on Apache CloudStack, please visit the [website](http://clo
4075
See the project user-interface QA website that runs CloudStack against simulator hypervisor:
4176
https://qa.cloudstack.cloud/simulator/ (admin:password)
4277

43-
## Getting Started
78+
---
79+
80+
## Try CloudStack in Minutes
81+
82+
Spin up a working CloudStack instance with zero hassle. Perfect for demos, dev, or quick evaluations.
83+
84+
### Quick Install (All-in-One)
85+
86+
Get a full CloudStack environment running fast:
87+
88+
```bash
89+
git clone [https://github.com/apache/cloudstack-installer.git](https://github.com/apache/cloudstack-installer.git)
90+
cd cloudstack-installer
91+
sudo ./cloudstack-installer.sh -i
92+
93+
```
94+
95+
Access UI: http://<your-ip>:8080/client
96+
97+
This setup is for testing only — not production-ready.
98+
99+
44100

45-
* Download a released [version](https://cloudstack.apache.org/downloads.html)
46-
* Build from source with the instructions in the [INSTALL.md](INSTALL.md) file.
101+
### Docker Sandbox (Community)
102+
103+
104+
Explore the UI and APIs in a lightweight, local Docker environment:
105+
106+
```Bash
107+
git clone [https://github.com/apache/cloudstack-docker.git](https://github.com/apache/cloudstack-docker.git)
108+
cd cloudstack-docker
109+
docker-compose up
110+
```
111+
112+
113+
### Full Setup
114+
115+
116+
For production-ready deployments and detailed configurations, refer to our:
117+
118+
Installation Guide
119+
Ansible Deployment Guide
120+
121+
122+
123+
## Source Code
124+
125+
126+
Join our open-source journey! Apache CloudStack's official Git repository:
127+
128+
https://gitbox.apache.org/repos/asf/cloudstack.git
129+
130+
A convenient, read-only mirror on GitHub, perfect for exploring code and submitting contributions:
131+
132+
https://github.com/apache/cloudstack
47133

48134
## Getting Source Repository
49135

@@ -59,6 +145,7 @@ The GitHub mirror is strictly read only and provides convenience to users and
59145
developers to explore the code and for the community to accept contributions
60146
via GitHub pull requests.
61147

148+
62149
## Documentation
63150

64151
* [Project Documentation](https://docs.cloudstack.apache.org)
@@ -68,73 +155,90 @@ via GitHub pull requests.
68155
* API [documentation](https://cloudstack.apache.org/api.html)
69156
* How to [contribute](CONTRIBUTING.md)
70157

158+
159+
## Ecosystem & Integrations
160+
161+
Apache CloudStack is built to fit into your existing infrastructure — not replace it. Its modular architecture ensures seamless integration across your IT ecosystem:
162+
163+
- **Hypervisors**: Native support for KVM, VMware vSphere, and XenServer.
164+
- **Authentication**: Integrates with LDAP, Active Directory, and SAML-based SSO providers.
165+
- **Storage**: Supports NFS, iSCSI, Ceph, and S3-compatible object storage for secondary storage.
166+
- **Networking**: Compatible with industry-leading appliances like Cisco, Juniper, and Open vSwitch.
167+
- **Monitoring & Observability**: Works with Prometheus, Nagios, Zabbix, and other external tools.
168+
- **Billing & Usage**: Rich APIs and metering to connect with billing, CRM, and provisioning systems.
169+
- **DevOps-Ready**: Exposes REST APIs, Python bindings, and CLI tools to support CI/CD pipelines and automation frameworks.
170+
171+
> **Why it matters**: CloudStack doesn’t require you to rip and replace. It works with the technologies you already use, helping you build a future-ready, fully interoperable cloud.
172+
173+
## Project Status & Release Cycle
174+
175+
Apache CloudStack is a **mature and actively maintained open-source project** governed by the Apache Software Foundation. With over a decade of development, it powers mission-critical cloud infrastructure for service providers, enterprises, and governments worldwide.
176+
177+
- **Actively Maintained**: Backed by a global community of developers and users.
178+
- **Predictable Releases**: CloudStack follows a regular release cadence — typically **every 4–6 months**, delivering new features, enhancements, and bug fixes.
179+
- **Production-Grade Stability**: Battle-tested in diverse environments, from private enterprise clouds to large-scale public cloud deployments.
180+
181+
> **Why it matters**: CloudStack’s proven track record, transparent development process, and consistent release cycle provide long-term confidence for operators and developers alike.
182+
183+
71184
## News and Events
72185

73186
* [Blog](https://blogs.apache.org/cloudstack)
74187
* [Twitter](https://twitter.com/cloudstack)
75188
* [Events and meetup](http://cloudstackcollab.org/)
76189
* [YouTube channel](https://www.youtube.com/ApacheCloudStack)
77190

78-
## Getting Involved and Contributing
191+
## Getting Involved & Contributing
192+
193+
Apache CloudStack thrives on community collaboration — and we welcome contributions of all kinds!
194+
195+
### How to Contribute
196+
197+
Want to help improve CloudStack? Whether you're writing code, fixing bugs, improving documentation, or translating content — we’d love your support.
198+
199+
- [Read our CONTRIBUTING.md](https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md) for guidelines and best practices.
200+
- Fork the repo, make your changes, and open a pull request. All contributions go through community review.
201+
202+
### Mailing Lists
203+
204+
Stay connected with the community and get involved in discussions:
205+
206+
- **Development Discussions**: [dev@cloudstack.apache.org](mailto:dev@cloudstack.apache.org)
207+
- **User Support**: [users@cloudstack.apache.org](mailto:users@cloudstack.apache.org)
208+
- **Commits & Updates**: [commits@cloudstack.apache.org](mailto:commits@cloudstack.apache.org)
209+
210+
### Issue Tracker
211+
212+
Report bugs, suggest features, or track project progress through the official issue tracker:
213+
214+
- [CloudStack Jira Tracker](https://issues.apache.org/jira/projects/CLOUDSTACK)
215+
216+
> **Note**: If you're unsure where to start, check the mailing lists or open issues — there's always something to help with!
79217
80-
Interested in helping out with Apache CloudStack? Great! We welcome
81-
participation from anybody willing to work [The Apache Way](http://theapacheway.com) and make a
82-
contribution. Note that you do not have to be a developer in order to contribute
83-
to Apache CloudStack. We need folks to help with documentation, translation,
84-
promotion etc. See our contribution [page](http://cloudstack.apache.org/contribute.html).
85218

86-
If you are a frequent contributors, you can request to be added as collaborators
87-
(see https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features#Git.asf.yamlfeatures-AssigningexternalcollaboratorswiththetriageroleonGitHub)
88-
to our GitHub repos. This allows you to use project GitHub with ability to report
89-
issue with tags, and be assigned to issues and PRs. This is done via the .asf.yaml
90-
file in this repo.
91-
You may do so by sharing your GitHub users ID or raise a GitHub issue.
219+
## License & Security Policy
92220

93-
If you're interested in learning more or participating in the Apache CloudStack
94-
project, the mailing lists are the best way to do that. While the project has
95-
several communications channels, the [mailing lists](http://cloudstack.apache.org/mailing-lists.html) are the most active and the
96-
official channels for making decisions about the project itself.
221+
### License
97222

98-
Mailing lists:
99-
- [Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org)
100-
- [Users Mailing List](mailto:users-subscribe@cloudstack.apache.org)
101-
- [Commits Mailing List](mailto:commits-subscribe@cloudstack.apache.org)
102-
- [Issues Mailing List](mailto:issues-subscribe@cloudstack.apache.org)
103-
- [Marketing Mailing List](mailto:marketing-subscribe@cloudstack.apache.org)
223+
Apache CloudStack is released under the **[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)**.
104224

105-
Report and/or check bugs on [GitHub](https://github.com/apache/cloudstack/issues) and check our
106-
developer [page](https://cloudstack.apache.org/developers.html) for contributing code.
225+
For full details, see the [LICENSE](./LICENSE) file in the repository.
107226

108-
## Reporting Security Vulnerabilities
227+
---
109228

110-
If you've found an issue that you believe is a security vulnerability in a
111-
released version of CloudStack, please report it to `security@apache.org` with
112-
details about the vulnerability, how it might be exploited, and any additional
113-
information that might be useful.
229+
### Security
114230

115-
For more details, please visit our security [page](http://cloudstack.apache.org/security.html).
231+
We take security seriously. If you discover a potential vulnerability in a released version of CloudStack:
116232

117-
## License
233+
- **Report it confidentially** by emailing: [security@apache.org](mailto:security@apache.org)
234+
- Include details of the issue, how it might be exploited, and any relevant supporting information.
118235

119-
Licensed to the Apache Software Foundation (ASF) under one
120-
or more contributor license agreements. See the NOTICE file
121-
distributed with this work for additional information
122-
regarding copyright ownership. The ASF licenses this file
123-
to you under the Apache License, Version 2.0 (the
124-
"License"); you may not use this file except in compliance
125-
with the License. You may obtain a copy of the License at
236+
Please review our full [Security Policy](https://cloudstack.apache.org/security.html) for responsible disclosure guidelines.
126237

127-
http://www.apache.org/licenses/LICENSE-2.0
238+
---
128239

129-
Unless required by applicable law or agreed to in writing,
130-
software distributed under the License is distributed on an
131-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
132-
KIND, either express or implied. See the License for the
133-
specific language governing permissions and limitations
134-
under the License.
240+
Your feedback and cooperation help us keep CloudStack safe and reliable for everyone.
135241

136-
Please see the [LICENSE](LICENSE) file included in the root directory
137-
of the source tree for extended license details.
138242

139243
## Notice of Cryptographic Software
140244

@@ -167,4 +271,4 @@ The following provides more details on the included cryptographic software:
167271

168272
## Contributors
169273

170-
[![Apache CloudStack Contributors](https://contrib.rocks/image?repo=apache/cloudstack&anon=0&max=500)](https://github.com/apache/cloudstack/graphs/contributors)
274+
[![Apache CloudStack Contributors](https://contrib.rocks/image?repo=apache/cloudstack&anon=0&max=500)](https://github.com/apache/cloudstack/graphs/contributors)

0 commit comments

Comments
 (0)