diff --git a/README.md b/README.md index 009df8313c3..600f78348dd 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,137 @@ -Apache CloudStack Version 4.4.1 +# Apache CloudStack -# About 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. -Apache CloudStack is 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. +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). -Apache CloudStack currently supports the most popular hypervisors: -VMware, Oracle VM, KVM, XenServer and Xen Cloud Platform. -CloudStack also offers bare metal management of servers, -using PXE to provision OS images and IPMI to manage the server. -Apache CloudStack offers three methods for managing cloud -computing environments: an easy to use Web interface, command -line tools, and a full-featured RESTful API. +CloudStack currently supports the most popular hypervisors: +VMware, KVM, XenServer, Xen Cloud Platform (XCP) and Hyper-V. -Visit us at [Apache CloudStack](http://cloudstack.apache.org). +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. -## Mailing lists -[Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org) -[Users Mailing List](mailto:users-subscribe@cloudstack.apache.org) -[Commits Mailing List](mailto:commits-subscribe@cloudstack.apache.org) -[Issues Mailing List](mailto:issues-subscribe@cloudstack.apache.org) -[Marketing Mailing List](mailto:marketing-subscribe@cloudstack.apache.org) +For more information on Apache CloudStack, please visit: +http://cloudstack.apache.org -# License +## Who Uses CloudStack? -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at +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. - http://www.apache.org/licenses/LICENSE-2.0 +For case studies highlighting successful deployments of Apache CloudStack, please +visit: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Case+Studies -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. +For the up-to-date list of current users, please visit: +http://cloudstack.apache.org/users.html -# Building CloudStack +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. -See the INSTALL file. +CloudStack survey page: http://cloudstack.apache.org/survey.html -# Notice of Cryptographic Software +## License -This distribution includes cryptographic software. The country in which you currently -reside may have restrictions on the import, possession, use, and/or re-export to another -country, of encryption software. BEFORE using any encryption software, please check your -country's laws, regulations and policies concerning the import, possession, or use, and -re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ -for more information. +Please see the LICENSE file included in the root directory of the source tree. -The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has -classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which -includes information security software using or performing cryptographic functions with -asymmetric algorithms. The form and manner of this Apache Software Foundation distribution -makes it eligible for export under the License Exception ENC Technology Software -Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section -740.13) for both object code and source code. +## Downloading -The following provides more details on the included cryptographic software: +You can download released versions from: http://cloudstack.apache.org/downloads.html - CloudStack makes use of JaSypt cryptographic libraries +## Building - CloudStack has a system requirement of MySQL, and uses native database encryption - functionality. +Please see the INSTALL.md file included in the root directory of the source tree. - CloudStack makes use of the Bouncy Castle general-purpose encryption library. +### Tooling - CloudStack can optionally interacts with and controls OpenSwan-based VPNs. +Please see the README.tools.md file included in the root directory of the source tree. - CloudStack has a dependency on Apache WSS4J as part of the AWSAPI implementation. +## Documentation - CloudStack has a dependency on and makes use of JSch - a java SSH2 implementation. +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 +`security@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 diff --git a/pom.xml b/pom.xml index 136378df41d..4f00b35a9fb 100644 --- a/pom.xml +++ b/pom.xml @@ -703,6 +703,7 @@ false CHANGES + README.md INSTALL.md .idea/ **/*.log