Repository: cloudstack Updated Branches: refs/heads/feature/readme [created] d753e765f
README: Give CloudStack its much deserved readme file Signed-off-by: Rohit Yadav <rohit.ya...@shapeblue.com> Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/d753e765 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/d753e765 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/d753e765 Branch: refs/heads/feature/readme Commit: d753e765f7ca848e4cc79d25ba5fa986b8b63522 Parents: fce2880 Author: Rohit Yadav <rohit.ya...@shapeblue.com> Authored: Tue Aug 5 15:54:40 2014 +0200 Committer: Rohit Yadav <rohit.ya...@shapeblue.com> Committed: Tue Aug 5 15:54:40 2014 +0200 ---------------------------------------------------------------------- README.md | 138 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ pom.xml | 1 + 2 files changed, 139 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack/blob/d753e765/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..836bc17 --- /dev/null +++ b/README.md @@ -0,0 +1,138 @@ +# Apache CloudStack + +Apache CloudStack is open source software designed to deploy and manage large +networks of virtual machines, as a highly available, highly scalable +Infrastructure as a Service (IaaS) cloud computing platform. CloudStack is used +by a number of service providers to offer public cloud services, and by many +companies to provide an on-premises (private) cloud offering, or as part of a +hybrid cloud solution. + +CloudStack is a turnkey solution that includes the entire "stack" of features +most organizations want with an IaaS cloud: compute orchestration, +Network-as-a-Service, user and account management, a full and open native API, +resource accounting, and a first-class User Interface (UI). + +CloudStack currently supports the most popular hypervisors: +VMware, KVM, XenServer, Xen Cloud Platform (XCP) and Hyper-V. + +Users can manage their cloud with an easy to use Web interface, command line +tools, and/or a full-featured RESTful API. In addition, CloudStack provides an +API that's compatible with AWS EC2 and S3 for organizations that wish to deploy +hybrid clouds. + +For more information on Apache CloudStack, please visit: +http://cloudstack.apache.org + +## Who Uses CloudStack? + +There are more than 150 known organisations using Apache CloudStack (or a +commercial distribution of CloudStack). Our users include many major service +providers running CloudStack to offer public cloud services, product vendors who +incorporate or integrate with Cloudstack in their own products, organisations +who have used Cloudstack to build their own private clouds, and systems +integrators that offer CloudStack related services. + +For case studies highlighting successful deployments of Apache CloudStack, please +visit: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Case+Studies + +For the up-to-date list of current users, please visit: +http://cloudstack.apache.org/users.html + +If you are using CloudStack in your organisation and your company isn't listed +above, please complete our brief adoption survey. We're happy to keep your +company name anonymous if you require. + +CloudStack survey page: http://cloudstack.apache.org/survey.html + +## License + +Please see the LICENSE file included in the root directory of the source tree. + +## Downloading + +You can download released versions from: http://cloudstack.apache.org/downloads.html + +## Building + +Please see the INSTALL.md file included in the root directory of the source tree. + +### Tooling + +Please see the README.tools.md file included in the root directory of the source tree. + +## Documentation + +Project wiki: +https://cwiki.apache.org/confluence/display/CLOUDSTACK/Home + +Getting started documentation: +http://docs.cloudstack.apache.org/en/master + +Installation documentation: +http://docs.cloudstack.apache.org/projects/cloudstack-installation + +Administration documentation: +http://docs.cloudstack.apache.org/projects/cloudstack-administration + +Latest release notes: +http://docs.cloudstack.apache.org/projects/cloudstack-release-notes + +Design documents:: +https://cwiki.apache.org/confluence/display/CLOUDSTACK/Design + +API documentation: +http://cloudstack.apache.org/docs/api + +## Getting Involved and Contributing + +Interested in helping out with Apache CloudStack? Great! We welcome +participation from anybody willing to work The Apache Way and make a +contribution. Note that you do not have to be a developer in order to contribute +to Apache CloudStack. We need folks to help with documentation, translation, +promotion etc. + +If you're interested in learning more or participating in the Apache CloudStack +project, the mailing lists are the best way to do that. While the project has +several communications channels, the mailing lists are the most active and the +official channels for making decisions about the project itself. + +Mailing lists: +http://cloudstack.apache.org/mailing-lists.html + +IRC, join us on irc.freenode.net on: +- `#cloudstack`: General Apache CloudStack conversation and end user support +- `#cloudstack-dev`: Development discussions +- `#cloudstack-meeting`: Weekly and ad-hoc meeting room for the CloudStack community + +Bug reporting: +https://issues.apache.org/jira/browse/CLOUDSTACK + +Developer resources: +http://cloudstack.apache.org/developers.html + +For more details please see our contributing page: +http://cloudstack.apache.org/contribute.html + +### News and Events + +Blog: +https://blogs.apache.org/cloudstack + +Twitter: +https://twitter.com/cloudstack + +Planet CloudStack: +http://planet.apache.org/cloudstack + +Events and meetup: +http://lanyrd.com/topics/apache-cloudstack + +### Reporting Security Vulnerabilities + +If you've found an issue that you believe is a security vulnerability in a +released version of CloudStack, please report it to +`secur...@cloudstack.apache.org` with details about the vulnerability, how it +might be exploited, and any additional information that might be useful. + +For more details, please visit: http://cloudstack.apache.org/security.html + http://git-wip-us.apache.org/repos/asf/cloudstack/blob/d753e765/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 0b3b56e..2186f83 100644 --- a/pom.xml +++ b/pom.xml @@ -702,6 +702,7 @@ <excludeSubProjects>false</excludeSubProjects> <excludes> <exclude>CHANGES</exclude> + <exclude>README.md</exclude> <exclude>INSTALL.md</exclude> <exclude>.idea/</exclude> <exclude>**/*.log</exclude>
