mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
Updates to the root readme file to include a more
accurate description of the project, the crypto notice (with some TODOs), and clearer build instructions for the OSS vs non-OSS build options.
This commit is contained in:
parent
29271a6c84
commit
0c2a1e48d0
120
README.md
120
README.md
@ -1,3 +1,29 @@
|
|||||||
|
Apache CloudStack (Incubating) Version 4.0.0
|
||||||
|
|
||||||
|
# About Apache CloudStack (Incubating)
|
||||||
|
|
||||||
|
Apache CloudStack (Incubating) 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Visit us at [cloudstack.org](http://incubator.apache.org/cloudstack).
|
||||||
|
|
||||||
|
## Mailing lists
|
||||||
|
[Development Mailing List](mailto:cloudstack-dev-subscribe@incubator.apache.org)
|
||||||
|
[Users Mailing list](mailto:cloudstack-users-subscribe@incubator.apache.org)
|
||||||
|
[Commits mailing list](mailto:cloudstack-commits-subscribe@incubator.apache.org)
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
Licensed to the Apache Software Foundation (ASF) under one
|
Licensed to the Apache Software Foundation (ASF) under one
|
||||||
@ -17,42 +43,88 @@ KIND, either express or implied. See the License for the
|
|||||||
specific language governing permissions and limitations
|
specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
# Apache CloudStack
|
# Building CloudStack
|
||||||
|
|
||||||
Apache CloudStack is a massively scalable free/libre open source Infrastructure as a Service cloud platform.
|
By default, CloudStack will only build with supporting packages
|
||||||
|
that are appropved by the ASF as being compatible with the Apache
|
||||||
|
Software License Version 2.
|
||||||
|
|
||||||
Visit us at [cloudstack.org](http://cloudstack.org) or join #cloudstack on irc.freenode.net
|
## Default build
|
||||||
|
|
||||||
## Binary Downloads
|
To build the default build target, use maven3 and execute:
|
||||||
|
|
||||||
Downloads are available from:
|
maven install
|
||||||
http://cloudstack.org/download.html
|
|
||||||
|
|
||||||
## Supported Hypervisors
|
## Including optional third party libraries in your build
|
||||||
|
|
||||||
* XenServer
|
If you want to build this software against one of the optional
|
||||||
* KVM
|
third party libraries, follow the instructions below:
|
||||||
* VMware ESX/ESXi (via vCenter)
|
|
||||||
* Oracle VM
|
|
||||||
* XCP
|
|
||||||
|
|
||||||
## Mailing lists
|
These third parties jars are non available in Maven central, and
|
||||||
[Development Mailing List](mailto:cloudstack-dev-subscribe@incubator.apache.org)
|
need to be located and downloaded by the developer themselves.
|
||||||
[Users Mailing list](mailto:cloudstack-users-subscribe@incubator.apache.org)
|
The libraries to download are listed below, by the feature that
|
||||||
[Commits mailing list](mailto:cloudstack-commits-subscribe@incubator.apache.org)
|
they support.
|
||||||
|
|
||||||
#Maven build
|
For F5 load balancing support:
|
||||||
Some third parties jars are non available in Maven central.
|
cloud-iControl.jar
|
||||||
So install it with: cd deps&&sh ./install-non-oss.sh
|
|
||||||
Now you are able to activate nonoss build with adding -Dnonoss to maven cli.
|
For Netscaler support:
|
||||||
|
cloud-netscaler.jar
|
||||||
|
cloud-netscaler-sdx.jar
|
||||||
|
|
||||||
|
For NetApp Storage Support:
|
||||||
|
cloud-manageontap.jar
|
||||||
|
|
||||||
|
For VMware Support:
|
||||||
|
vmware-vim.jar
|
||||||
|
vmware-vim25.jar
|
||||||
|
vmware-apputils.jar
|
||||||
|
|
||||||
|
Once downloaded (and named the same as listed above), they can be
|
||||||
|
installed into your local maven repository with the following command:
|
||||||
|
|
||||||
|
cd deps&&sh ./install-non-oss.sh
|
||||||
|
|
||||||
|
To perform the build, run the following command:
|
||||||
|
|
||||||
|
mvn -Dnonoss install
|
||||||
|
|
||||||
|
## Running a developer environment
|
||||||
|
|
||||||
|
To run the webapp client:
|
||||||
|
|
||||||
|
mvn org.apache.tomcat.maven:tomcat7-maven-plugin:2.0-beta-1:run -pl :cloud-client-ui -am -Pclient
|
||||||
|
|
||||||
|
Then hit: http://localhost:8080/cloud-client-ui/
|
||||||
|
|
||||||
to run webapp client:
|
|
||||||
mvn org.apache.tomcat.maven:tomcat7-maven-plugin:2.0-beta-1:run -pl :cloud-client-ui -am -Pclient -Dnonoss
|
|
||||||
then hit: http://localhost:8080/cloud-client-ui/
|
|
||||||
or add in your ~/.m2/settings.xml
|
or add in your ~/.m2/settings.xml
|
||||||
<pluginGroups>
|
<pluginGroups>
|
||||||
<pluginGroup>org.apache.tomcat.maven</pluginGroup>
|
<pluginGroup>org.apache.tomcat.maven</pluginGroup>
|
||||||
</pluginGroups>
|
</pluginGroups>
|
||||||
and save your fingers with mvn tomcat7:run -pl :cloud-client-ui -am -Pclient -Dnonoss
|
and save your fingers with mvn tomcat7:run -pl :cloud-client-ui -am -Pclient
|
||||||
|
|
||||||
|
Optionally add -Dnonoss to either of the commands above.
|
||||||
|
|
||||||
If you want to use ide debug: replace mvn with mvnDebug and attach your ide debugger to port 8000
|
If you want to use ide debug: replace mvn with mvnDebug and attach your ide debugger to port 8000
|
||||||
|
|
||||||
|
# Notice of Cryptographic Software
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
The following provides more details on the included cryptographic software:
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user