etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into 4.0

This commit is contained in:
Edison Su 2012-09-11 23:31:26 -07:00
parent 9c7ae1eadc f93dd21602
commit c7ff8a0e56
218 changed files with 5833 additions and 5797 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -48,3 +48,7 @@ tools/devcloud/devcloudbox/.vagrant
deps/*.jar
deps/*.war
deps/*.mar
*.jar
awsapi/modules/*
!.gitignore

1
api/src/com/cloud/api/ApiConstants.java
View File

@ -294,6 +294,7 @@ public class ApiConstants {
public static final String DHCP_RANGE = "dhcprange";
public static final String UUID = "uuid";
public static final String SECURITY_GROUP_EANBLED = "securitygroupenabled";
public static final String LOCAL_STORAGE_ENABLED = "localstorageenabled";
public static final String GUEST_IP_TYPE = "guestiptype";
public static final String XEN_NETWORK_LABEL = "xennetworklabel";
public static final String KVM_NETWORK_LABEL = "kvmnetworklabel";

11
api/src/com/cloud/api/commands/CreateDiskOfferingCmd.java
View File

@ -26,6 +26,7 @@ import com.cloud.api.Parameter;
import com.cloud.api.ServerApiException;
import com.cloud.api.response.DiskOfferingResponse;
import com.cloud.offering.DiskOffering;
import com.cloud.offering.ServiceOffering;
import com.cloud.user.Account;
@Implementation(description="Creates a disk offering.", responseObject=DiskOfferingResponse.class)
@ -56,7 +57,10 @@ public class CreateDiskOfferingCmd extends BaseCmd {
@IdentityMapper(entityTableName="domain")
@Parameter(name=ApiConstants.DOMAIN_ID, type=CommandType.LONG, description="the ID of the containing domain, null for public offerings")
private Long domainId;
@Parameter(name=ApiConstants.STORAGE_TYPE, type=CommandType.STRING, description="the storage type of the disk offering. Values are local and shared.")
private String storageType = ServiceOffering.StorageType.shared.toString();
/////////////////////////////////////////////////////
/////////////////// Accessors ///////////////////////
/////////////////////////////////////////////////////
@ -84,6 +88,11 @@ public class CreateDiskOfferingCmd extends BaseCmd {
public Long getDomainId(){
return domainId;
}
public String getStorageType() {
return storageType;
}
/////////////////////////////////////////////////////
/////////////// API Implementation///////////////////
/////////////////////////////////////////////////////

13
api/src/com/cloud/api/commands/CreateZoneCmd.java
View File

@ -73,6 +73,9 @@ public class CreateZoneCmd extends BaseCmd {
@Parameter(name=ApiConstants.SECURITY_GROUP_EANBLED, type=CommandType.BOOLEAN, description="true if network is security group enabled, false otherwise")
private Boolean securitygroupenabled;
@Parameter(name=ApiConstants.LOCAL_STORAGE_ENABLED, type=CommandType.BOOLEAN, description="true if local storage offering enabled, false otherwise")
private Boolean localStorageEnabled;
/////////////////////////////////////////////////////
/////////////////// Accessors ///////////////////////
/////////////////////////////////////////////////////
@ -123,8 +126,14 @@ public class CreateZoneCmd extends BaseCmd {
}
return securitygroupenabled;
}
public Boolean getLocalStorageEnabled() {
if (localStorageEnabled == null) {
return false;
}
return localStorageEnabled;
}
/////////////////////////////////////////////////////
/////////////// API Implementation///////////////////
@Override

14
api/src/com/cloud/api/commands/DeployVMCmd.java
View File

@ -374,14 +374,24 @@ public class DeployVMCmd extends BaseAsyncCreateCmd {
if (template == null) {
throw new InvalidParameterValueException("Unable to use template " + templateId);
}
DiskOffering diskOffering = null;
if (diskOfferingId != null) {
DiskOffering diskOffering = _configService.getDiskOffering(diskOfferingId);
diskOffering = _configService.getDiskOffering(diskOfferingId);
if (diskOffering == null) {
throw new InvalidParameterValueException("Unable to find disk offering " + diskOfferingId);
}
}
if (!zone.isLocalStorageEnabled()) {
if (serviceOffering.getUseLocalStorage()) {
throw new InvalidParameterValueException("Zone is not configured to use local storage but service offering " + serviceOffering.getName() + " uses it");
}
if (diskOffering != null && diskOffering.getUseLocalStorage()) {
throw new InvalidParameterValueException("Zone is not configured to use local storage but disk offering " + diskOffering.getName() + " uses it");
}
}
UserVm vm = null;
if (getHypervisor() == HypervisorType.BareMetal) {
vm = _bareMetalVmService.createVirtualMachine(this);

10
api/src/com/cloud/api/commands/UpdateZoneCmd.java
View File

@ -81,7 +81,10 @@ public class UpdateZoneCmd extends BaseCmd {
@Parameter(name=ApiConstants.DNS_SEARCH_ORDER, type=CommandType.LIST, collectionType = CommandType.STRING, description="the dns search order list")
private List<String> dnsSearchOrder;
@Parameter(name=ApiConstants.LOCAL_STORAGE_ENABLED, type=CommandType.BOOLEAN, description="true if local storage offering enabled, false otherwise")
private Boolean localStorageEnabled;
/////////////////////////////////////////////////////
/////////////////// Accessors ///////////////////////
/////////////////////////////////////////////////////
@ -137,6 +140,11 @@ public class UpdateZoneCmd extends BaseCmd {
public List<String> getDnsSearchOrder() {
return dnsSearchOrder;
}
public Boolean getLocalStorageEnabled() {
return localStorageEnabled;
}
/////////////////////////////////////////////////////
/////////////// API Implementation///////////////////
/////////////////////////////////////////////////////

10
api/src/com/cloud/api/response/DiskOfferingResponse.java
View File

@ -51,6 +51,9 @@ public class DiskOfferingResponse extends BaseResponse {
@SerializedName(ApiConstants.TAGS) @Param(description="the tags for the disk offering")
private String tags;
@SerializedName("storagetype") @Param(description="the storage type for this disk offering")
private String storageType;
public Long getId() {
return id.getValue();
}
@ -123,4 +126,11 @@ public class DiskOfferingResponse extends BaseResponse {
this.customized = customized;
}
public String getStorageType() {
return storageType;
}
public void setStorageType(String storageType) {
this.storageType = storageType;
}
}

7
api/src/com/cloud/api/response/ZoneResponse.java
View File

@ -86,6 +86,9 @@ public class ZoneResponse extends BaseResponse {
@SerializedName("capacity") @Param(description="the capacity of the Zone", responseObject = CapacityResponse.class)
private List<CapacityResponse> capacitites;
@SerializedName(ApiConstants.LOCAL_STORAGE_ENABLED) @Param(description="true if local storage offering enabled, false otherwise")
private boolean localStorageEnabled;
public void setId(Long id) {
this.id.setValue(id);
}
@ -165,4 +168,8 @@ public class ZoneResponse extends BaseResponse {
public void setDomainName(String domainName) {
this.domainName = domainName;
}
public void setLocalStorageEnabled(boolean localStorageEnabled) {
this.localStorageEnabled = localStorageEnabled;
}
}

1
api/src/com/cloud/dc/DataCenter.java
View File

@ -75,4 +75,5 @@ public interface DataCenter extends Grouping {
String getZoneToken();
boolean isLocalStorageEnabled();
}

5
api/src/com/cloud/vm/VirtualMachineProfile.java
View File

@ -104,6 +104,11 @@ public interface VirtualMachineProfile<T extends VirtualMachine> {
*/
long getId();
/**
* @return virtual machine uuid.
*/
String getUuid();
List<NicProfile> getNics();
List<VolumeTO> getDisks();

136
awsapi/deploy-cloud-bridge.sh
View File

@ -1,136 +0,0 @@
#!/usr/bin/env bash
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
usage() {
printf "Usage: %s: -d [tomcat directory to deploy to] -z [zip file to use]\n" $(basename $0) >&2
}
dflag=
zflag=
tflag=
iflag=
deploydir=
typ=
#set -x
while getopts 'd:z:x:h:' OPTION
do
case "$OPTION" in
d) dflag=1
deploydir="$OPTARG"
;;
z) zflag=1
zipfile="$OPTARG"
;;
h) iflag="$OPTARG"
;;
?) usage
exit 2
;;
esac
done
if [ "$deploydir" == "" ]
then
if [ "$CATALINA_HOME" == "" ]
then
printf "Tomcat Directory to deploy to: "
read deploydir
else
deploydir="$CATALINA_HOME"
fi
fi
if [ "$deploydir" == "" ]
then
printf "Tomcat directory was not specified, please set CATALINA_HOME environment variable'\n";
exit 15;
fi
printf "Check to see if the Tomcat directory exist: $deploydir\n"
if [ ! -d $deploydir ]
then
printf "Tomcat directory does not exist\n";
exit 16;
fi
rm -rf $deploydir/webapps/bridge
mkdir "$CATALINA_HOME/temp"
mkdir "$CATALINA_HOME/webapps/bridge"
if ! unzip -o ./axis2-webapp-1.5.1.war -d $deploydir/webapps/bridge
then
exit 10;
fi
if ! cp -f services/* $deploydir/webapps/bridge/WEB-INF/services
then
exit 11;
fi
if ! cp -f modules/* $deploydir/webapps/bridge/WEB-INF/modules
then
exit 12;
fi
if ! cp -f rampart-lib/* $deploydir/webapps/bridge/WEB-INF/lib
then
exit 13;
fi
if ! cp -f cloud-bridge.jar $deploydir/webapps/bridge/WEB-INF/lib
then
exit 14;
fi
if ! cp -f lib/* $deploydir/lib
then
exit 17;
fi
if ! cp -n conf/* $deploydir/conf
then
exit 18;
fi
if ! cp -f classes/* $deploydir/webapps/bridge/WEB-INF/classes
then
exit 19;
fi
if ! cp -f web.xml $deploydir/webapps/bridge/WEB-INF
then
exit 20;
fi
if ! cp -f axis2.xml $deploydir/webapps/bridge/WEB-INF/conf
then
exit 21;
fi
if ! rm -rf $deploydir/webapps/bridge/WEB-INF/lib/dom4j-1.6.1.jar
then
exit 22;
fi
printf "Installation is now complete\n"
exit 0

51
awsapi/install.sh → awsapi/modules/.gitignore vendored
View File

@ -1,4 +1,3 @@
#!/bin/bash
# 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
@ -16,18 +15,40 @@
# specific language governing permissions and limitations
# under the License.
# install.sh -- deploys cloud-bridge and the corresponding DB
build/replace.properties
build/build.number
bin/
cloudstack-proprietary/
premium/
.lock-wscript
artifacts/
.waf-*
waf-*
target/
override/
.metadata
dist/
*~
*.bak
cloud-*.tar.bz2
*.log
*.pyc
build.number
api.log.*.gz
cloud.log.*.*
unittest
deps/cloud.userlibraries
deps/awsapi-lib/
.DS_Store
.idea
*.iml
git-remote-https.exe.stackdump
*.swp
tools/devcloud/devcloudbox/.vagrant
deps/*.jar
deps/*.war
deps/*.mar
*.jar
awsapi/modules/*
!.gitignore
#set -x
set -e
#### deploying cloud-bridge
echo "Installing cloud-bridge..."
sh deploy-cloud-bridge.sh -d "$CATALINA_HOME"
echo "Deploying database..."
cd db && sh deploy-db-bridge.sh
#change port to 8090 in server.xml
#change ec2-service.properties file
exit 0

12
awsapi/packages/config/debian/changelog
View File

@ -1,12 +0,0 @@
cloud (1.0.0) unstable; urgency=low
* Bumped version up to 1.0.0
-- Cloud <cloud@cloud.com> Thu, 31 Jan 2011 08:33:25 -0700
cloud (0.9.0) unstable; urgency=low
* Initial entry
-- Cloud <cloud@cloud.com> Thu, 13 Jan 2011 10:05:11 -0700

21
awsapi/packages/config/debian/cloud-bridge.install
View File

@ -1,21 +0,0 @@
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
/usr/share/cloud/bridge/*
/usr/share/cloud/setup/bridge/*
/usr/bin/*
/etc/init.d/*

40
awsapi/packages/config/debian/cloud-bridge.postinst
View File

@ -1,40 +0,0 @@
#!/bin/sh -e
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
case "$1" in
configure)
if ! id cloud > /dev/null 2>&1 ; then
adduser --system --home /usr/share/cloud --no-create-home \
--group --disabled-password --shell /bin/sh cloud
fi
for i in /usr/share/cloud/bridge
do
chmod 0775 $i
chown -R cloud.cloud $i
done
if [ "$2" = "" ] ; then # no recently configured version, this is a first install
/usr/sbin/update-rc.d cloud-bridge defaults || true
fi
;;
esac
#DEBHELPER#

13
awsapi/packages/config/debian/control
View File

@ -1,13 +0,0 @@
Source: cloud
Section: libs
Priority: extra
Maintainer: Cloud <cloud@cloud.com>
Build-Depends: debhelper (>= 7), openjdk-6-jdk, tomcat6
Package: cloud-bridge
Provides: cloud-bridge
Conflicts: cloud-bridge
Replaces: cloud-bridge
Architecture: any
Depends: openjdk-6-jre
Description: Cloud.com Bridge

119
awsapi/packages/config/debian/rules
View File

@ -1,119 +0,0 @@
#!/usr/bin/make -f
# -*- makefile -*-
# Sample debian/rules that uses debhelper.
#
# This file was originally written by Joey Hess and Craig Small.
# As a special exception, when this file is copied by dh-make into a
# dh-make output file, you may use that output file without restriction.
# This special exception was added by Craig Small in version 0.37 of dh-make.
#
# Modified to make a template file for a multi-binary package with separated
# build-arch and build-indep targets by Bill Allombert 2001
# Uncomment this to turn on verbose mode.
export DH_VERBOSE=1
# This has to be exported to make some magic below work.
export DH_OPTIONS
configure: configure-stamp
configure-stamp:
dh_testdir
(cd ../..; ./waf configure --prefix=/usr --libdir=/usr/lib --bindir=/usr/bin --javadir=/usr/share/java --sharedstatedir=/var/lib --localstatedir=/var --sysconfdir=/etc --mandir=/usr/share/man --libexecdir=/usr/bin)
(cd ../..; ./waf showconfig)
#Architecture
# build: build-arch build-indep
build: build-arch
build-arch: build-arch-stamp
build-arch-stamp: configure-stamp
# build-indep: build-indep-stamp
# build-indep-stamp: configure-stamp
#
# # Add here commands to compile the indep part of the package.
# #$(MAKE) doc
# touch $@
#
clean:
dh_testdir
dh_testroot
(cd ../..; ./waf distclean)
dh_clean
install: install-arch
# install: install-indep install-arch
# install-indep:
# dh_testdir
# dh_testroot
# dh_prep -i
# dh_installdirs -i
#
# # Add here commands to install the indep part of the package into
# # debian/<package>-doc.
# #INSTALLDOC#
#
# dh_install -i
install-arch:
dh_testdir
dh_testroot
dh_prep -s
dh_installdirs -s
(cd ../..; ant deploy-debian-install)
chmod 755 debian/tmp/etc/init.d/cloud-bridge
chmod 755 debian/tmp/usr/bin/cloud-setup-bridge
chmod 755 debian/tmp/usr/bin/cloud-bridge-register
chmod 755 debian/tmp/usr/bin/cloud-setup-bridge-db
dh_install -s
# Must not depend on anything. This is to be called by
# binary-arch/binary-indep
# in another 'make' thread.
binary-common:
dh_testdir
dh_testroot
# dh_installchangelogs
# dh_installdocs -A README.html
# dh_installexamples
# dh_installmenu
# dh_installdebconf
# dh_installlogrotate
# dh_installemacsen
# dh_installpam
# dh_installmime
# dh_python
# dh_installinit
# dh_installcron
# dh_installinfo
# dh_installman
dh_link
dh_strip
dh_compress
dh_fixperms
# dh_perl
dh_makeshlibs
dh_installdeb
# dh_shlibdeps
dh_gencontrol
dh_md5sums
dh_builddeb
# Build architecture independant packages using the common target.
# binary-indep: build-indep install-indep
# $(MAKE) -f debian/rules DH_OPTIONS=-i binary-common
# Build architecture dependant packages using the common target.
binary-arch: build-arch install-arch
$(MAKE) -f debian/rules DH_OPTIONS=-s binary-common
# binary: binary-arch binary-indep
binary: binary-arch
# .PHONY: build clean binary-indep binary-arch binary install install-indep install-arch configure
.PHONY: build clean binary-arch binary install install-arch configure

98
awsapi/packages/config/rpm/cloudbridge.spec
View File

@ -1,98 +0,0 @@
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
%define __os_install_post %{nil}
%global debug_package %{nil}
%define _rel 1
Name: cloud-bridge
Summary: CloudStack CloudBridge
Version: %{_ver}
#http://fedoraproject.org/wiki/PackageNamingGuidelines#Pre-Release_packages
%if "%{?_prerelease}" != ""
Release: 0.%{_build_number}%{_prerelease}
%else
Release: %{_rel}
%endif
License: GPLv3+ with exceptions or CSL 1.1
Vendor: Citrix Systems, Inc. <sqa@cloud.com>
Packager: Citrix Systems, Inc. <cloud@cloud.com>
Source0: cloud-bridge-%{_ver}.tar.bz2
Group: System Environment/Libraries
Requires: java >= 1.6.0
Requires: tomcat6
Obsoletes: cloud-bridge < %{version}-%{release}
BuildRoot: %(mktemp -ud %{_tmppath}/%{name}-%{version}-%{release}-XXXXXX)
%description
This is the CloudStack CloudBridge
%prep
%setup -q -n %{name}-%{_ver}
%build
%define _localstatedir /var
%define _sharedstatedir /usr/share
./waf configure --prefix=%{_prefix} --libdir=%{_libdir} --bindir=%{_bindir} --javadir=%{_javadir} --sharedstatedir=%{_sharedstatedir} --localstatedir=%{_localstatedir} --sysconfdir=%{_sysconfdir} --mandir=%{_mandir} --docdir=%{_docdir}/%{name}-%{version} --fast --package-version=%{_ver}
%install
[ ${RPM_BUILD_ROOT} != "/" ] && rm -rf ${RPM_BUILD_ROOT}
ant deploy-rpm-install -Dversion=%{version}
mv ../cloud-bridge-%{_ver}-1 ${RPM_BUILD_ROOT}
mkdir $RPM_BUILD_ROOT/usr/share/cloud/bridge/logs
mkdir $RPM_BUILD_ROOT/usr/share/cloud/bridge/work
mkdir $RPM_BUILD_ROOT/usr/share/cloud/bridge/temp
%clean
#[ ${RPM_BUILD_ROOT} != "/" ] && rm -rf ${RPM_BUILD_ROOT}
%preun
/sbin/service cloud-bridge stop || true
if [ "$1" == "0" ] ; then
/sbin/chkconfig --del cloud-bridge > /dev/null 2>&1 || true
/sbin/service cloud-bridge stop > /dev/null 2>&1 || true
fi
%pre
id cloud > /dev/null 2>&1 || /usr/sbin/useradd -M -c "CloudStack CloudBridge unprivileged user" \
-r -s /bin/sh -d %{_sharedstatedir}/cloud cloud|| true
# user harcoded here
%post
if [ "$1" == "1" ] ; then
/sbin/chkconfig --add cloud-bridge > /dev/null 2>&1 || true
/sbin/chkconfig --level 345 cloud-bridge on > /dev/null 2>&1 || true
fi
%files
%defattr(0644,cloud,cloud,0755)
/usr/share/cloud/bridge/conf/*
/usr/share/cloud/bridge/lib/*
/usr/share/cloud/bridge/webapps/*
%dir %attr(0775,cloud,cloud) /usr/share/cloud/bridge/logs
%dir %attr(0775,cloud,cloud) /usr/share/cloud/bridge/work
%dir %attr(0775,cloud,cloud) /usr/share/cloud/bridge/temp
%attr(0644,root,root) /usr/share/cloud/setup/bridge/db/*
%attr(0755,root,root) /etc/init.d/cloud-bridge
%attr(0755,root,root) /usr/bin/cloud-bridge-register
%attr(0755,root,root) /usr/bin/cloud-setup-bridge
%attr(0755,root,root) /usr/bin/cloud-setup-bridge-db

123
awsapi/release-notes.html
View File

@ -1,123 +0,0 @@
<!--
~ 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
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ 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.
-->
<html>
<head>
<meta http-equiv="content-type" content="">
<title>Welcome to Apache Axis2 version 1.6.2</title>
</head>
<body lang="en">
<h1>Welcome to Apache Axis2 version 1.6.2</h1>
<h3>April 17, 2012</h3>
<pre>Axis2 1.6.2 is a maintenance release that upgrades Axiom to version 1.2.13 and
Neethi to version 3.0.2. it contains fixes for several issues discovered
over the last six months. The complete list can be found <a href="http://s.apache.org/7lT">here</a>.
About Axis2
Downloads are available at:
http://axis.apache.org/axis2/java/core/download.cgi
Apache Axis2 is a complete re-design and re-write of the widely used
Apache Axis engine and is a more efficient, more scalable, more modular
and more XML-oriented Web services framework. It is carefully designed to
support the easy addition of plug-in "modules" that extend its
functionality for features such as security and reliability.
Modules supporting WS-Security/Secure-Conversation (Apache Rampart),
WS-Trust (Apache Rahas), WS-Reliable Messaging (Apache Sandesha) and
WS-Eventing (Apache Savan) will be available soon after the Apache Axis2
@axisVersion@ release. Please see these projects' own sites for further information.
Known Issues and Limitations in 1.6.2 Release:
- Please see JIRA
We are striving for a simple and happy first time user experience as well as a
satisfying experienced user experience with this release. We welcome any
and all feedback at:
java-user@axis.apache.org (please include "[axis2]" in the subject)
java-dev@axis.apache.org (please include "[axis2]" in the subject)
http://issues.apache.org/jira/browse/AXIS2
Thank you for your interest in Apache Axis2!
The Axis2 Development Team
http://axis.apache.org/axis2/java/core/
------------------------------------------------------------------------------------
Features of Apache Axis2:
Programming Model
- Simple XML-centric client API with full WSDL and policy support
- Support for POJO and Spring services and clients
- Support for any message exchange pattern (MEP)
- Synchronous and asynchronous programming model
- Archived service deployment model supporting full service
encapsulation with versioning support
- Archived module deployment model supporting controlled
extensibility with versioning support
- Hot deployment
- WS-Policy driven code generation extensions
- Flexible service life cycle model
- Automatic support for POX (REST) style invocation of services
- Support for querying service's WSDL (with ?wsdl), schema (with
?xsd) and policies (with ?policy)
Supported Specifications
- SOAP 1.1 and 1.2
- Message Transmission Optimization Mechanism (MTOM)
- XML Optimized Packaging (XOP)
- SOAP with Attachments
- WSDL 1.1, including both SOAP and HTTP bindings , WSDL 2.0
- WS-Addressing submission and 1.0
- WS-Policy
- SAAJ 1.1
Transports
- HTTP
- SMTP
- JMS
- TCP
- udp
- xmpp
For more details refer to the <a href="http://axis.apache.org/axis2/java/transports/">Axis2 Transports</a> project.
Supported Data Bindings
- Axis Data Binding (ADB)
- XMLBeans
- JibX
- JAXB
Tools
- WSDL2Java: Generate Java stubs and skeletons from a WSDL document.
- Java2WSDL: Generate a WSDL document from a Java class.
- Eclipse Plugins
- IntelliJ Idea Plugins
- Maven2 Plugins
- Web application for administering Apache Axis2
</pre>
</body>
</html>

23
awsapi/release-notes.txt
View File

@ -1,23 +0,0 @@
1.0.2.RC6
=========
* ec2-allocate-address and ec2-run-instances should now work with CloudStack advanced network mode.
* findNetwork improved and now used with ec2-allocate-address.
* Support for string based id's (UUIDs) for all objects. Prior to this, CB used Long's to store objectIds returned from CloudStack.
1.0.2.RC5
=========
* Fixed ec2-register/registerTemplate calls
1.0.2.RC4
=========
* Bug 14037 CloudBridge deployment would overwrite files in /usr/share/cloud/bridge/conf, is now fixed
1.0.2.RC3
=========
* Bug 14015 When using cloudStackApi, we must be sure to reset access/secret keys on each call in e
* Better error error checking for bad json responses (empty lists) from CloudStack...
* Bug 13400: CloudBridge didn't honor free-form end-points (instead expecting hostnames). This change allows for free form end-points.

BIN
awsapi/waf vendored
View File

Binary file not shown.

267
awsapi/wscript
View File

@ -1,267 +0,0 @@
#! /usr/bin/env python
# -*- coding: utf-8 -*-
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
# the following two variables are used by the target "waf dist"
# if you change 'em here, you need to change it also in cloud.spec, add a %changelog entry there, and add an entry in debian/changelog
VERSION = '1.0.8'
APPNAME = 'cloud-bridge'
import shutil,os,glob
import email,time
import optparse
import platform
import Utils,Node,Options,Logs,Scripting,Environment,Build,Configure
from subprocess import Popen as _Popen,PIPE
import os
import sys
from os import unlink as _unlink, makedirs as _makedirs, getcwd as _getcwd, chdir as _chdir
from os.path import abspath as _abspath, basename as _basename, dirname as _dirname, exists as _exists, isdir as _isdir, split as _split, join as _join, sep, pathsep, pardir, curdir
from glob import glob as _glob
import zipfile,tarfile
try:
from os import chmod as _chmod,chown as _chown
import pwd,stat,grp
except ImportError:
_chmod,_chown,pwd,stat,grp = (None,None,None,None,None)
import xml.dom.minidom
import re
# CENTOS does not have this -- we have to put this here
try:
from subprocess import check_call as _check_call
from subprocess import CalledProcessError
except ImportError:
def _check_call(*popenargs, **kwargs):
import subprocess
retcode = subprocess.call(*popenargs, **kwargs)
cmd = kwargs.get("args")
if cmd is None: cmd = popenargs[0]
if retcode: raise CalledProcessError(retcode, cmd)
return retcode
class CalledProcessError(Exception):
def __init__(self, returncode, cmd):
self.returncode = returncode ; self.cmd = cmd
def __str__(self): return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
# these variables are mandatory ('/' are converted automatically)
srcdir = '.'
blddir = 'artifacts'
Configure.autoconfig = True
# things never to consider when building or installing
for pattern in ["**/.project","**/.classpath"]: Node.exclude_regs += "\n%s"%pattern
# Support functions
# this will enforce the after= ordering constraints in the javac task generators
from TaskGen import after, feature
@feature('*')
@after('apply_core', 'apply_java', 'apply_subst')
def process_after(self):
lst = self.to_list(getattr(self, 'after', []))
for x in lst:
obj = self.bld.name_to_obj(x,self.bld.env)
if not obj: break
obj.post()
for a in obj.tasks:
for b in self.tasks:
b.set_run_after(a)
Build.BuildContext.process_after = staticmethod(process_after)
def _getbuildcontext():
ctx = Build.BuildContext()
ctx.load_dirs(_abspath(srcdir),_abspath(blddir))
ctx.load_envs()
return ctx
def set_options(opt):
"""Register command line options"""
opt.tool_options('gnu_dirs')
inst_dir = opt.get_option_group('--bindir') # get the group that contains bindir
inst_dir.add_option('--javadir', # add javadir to the group that contains bindir
help = 'Java class and jar files [Default: ${DATADIR}/java]',
default = '',
dest = 'JAVADIR')
inst_dir.add_option('--no-dep-check',
action='store_true',
help = 'Skip dependency check and assume JARs already exist',
default = False,
dest = 'NODEPCHECK')
inst_dir.add_option('--fast',
action='store_true',
help = 'does ---no-dep-check',
default = False,
dest = 'NODEPCHECK')
inst_dir.add_option('--package-version',
help = 'package version',
default = '',
dest = 'VERNUM')
def showconfig(conf):
"""prints out the current configure environment configuration"""
conf = _getbuildcontext()
Utils.pprint("WHITE","Build environment:")
for key,val in sorted(conf.env.get_merged_dict().items()):
if "CLASSPATH" in key:
Utils.pprint("BLUE"," %s:"%key)
for v in val.split(pathsep):
Utils.pprint("BLUE"," %s"%v)
continue
Utils.pprint("BLUE"," %s: %s"%(key,val))
def runant(tsk):
environ = dict(os.environ)
environ["CATALINA_HOME"] = tsk.env.TOMCATHOME
environ["AXIS2_HOME"] = "."
if tsk.generator.env.DISTRO == "Windows":
stanzas = [
"ant",
"-Dcloud-bridge.classpath=\"%s\""%(tsk.env.CLASSPATH.replace(os.pathsep,",")),
]
else:
stanzas = [
'ant',
"-Dcloud-bridge.classpath=%s"%(tsk.env.CLASSPATH.replace(os.pathsep,",")),
]
stanzas += tsk.generator.antargs + tsk.generator.anttgts
return Utils.exec_command(" ".join(stanzas),cwd=tsk.generator.bld.srcnode.abspath(),env=environ,log=True,shell=False)
Utils.runant = runant
def relpath(path, start="."):
if not path: raise ValueError("no path specified")
start_list = os.path.abspath(start).split(sep)
path_list = os.path.abspath(path).split(sep)
# Work out how much of the filepath is shared by start and path.
i = len(os.path.commonprefix([start_list, path_list]))
rel_list = [pardir] * (len(start_list)-i) + path_list[i:]
if not rel_list:
return curdir
return os.path.join(*rel_list)
Utils.relpath = relpath
def mkdir_p(directory):
if not _isdir(directory):
Utils.pprint("GREEN","Creating directory %s and necessary parents"%directory)
_makedirs(directory)
def getdebdeps():
def debdeps(fileset):
for f in fileset:
lines = file(f).readlines()
lines = [ x[len("Build-Depends: "):] for x in lines if x.startswith("Build-Depends") ]
for l in lines:
deps = [ x.strip() for x in l.split(",") ]
for d in deps:
if "%s-"%APPNAME in d: continue
yield d
yield "build-essential"
yield "devscripts"
yield "debhelper"
deps = set(debdeps(["debian/control"]))
return deps
def throws_command_errors(f):
def g(*args,**kwargs):
try: return f(*args,**kwargs)
except CalledProcessError,e:
raise Utils.WafError("system command %s failed with error value %s"%(e.cmd[0],e.returncode))
except IOError,e:
if e.errno is 32:
raise Utils.WafError("system command %s terminated abruptly, closing communications with parent's pipe"%e.cmd[0])
raise
return g
def c(cmdlist,cwd=None):
# Run a command with _check_call, pretty-printing the cmd list
Utils.pprint("BLUE"," ".join(cmdlist))
return _check_call(cmdlist,cwd=cwd)
""" """
""" Custom waf targets """
""" """
def viewdebdeps(context):
"""shows all the necessary dependencies to build the DEB packages of the Bridge"""
for dep in getdebdeps(): print dep
@throws_command_errors
def deb(context):
"""Builds DEB packages of the Bridge"""
Utils.pprint("GREEN","Building DEBs")
basedir = os.path.realpath(os.path.curdir) + "/packages/config"
checkdeps = lambda: c(["dpkg-checkbuilddeps"], basedir)
dodeb = lambda: c(["debuild", '-e','WAFCACHE','--no-lintian', "-us","-uc", "-b"], basedir)
try: checkdeps()
except (CalledProcessError,OSError),e:
Utils.pprint("YELLOW","Dependencies might be missing.")
dodeb()
@throws_command_errors
def rpm(context):
"""Builds RPM packages of the Bridge"""
Utils.pprint("GREEN","Building RPMs")
basedir = os.path.realpath(os.path.curdir) + "/packages/config/rpm"
outputdir = basedir + "/tmp"
sourcedir = _join(outputdir,"SOURCES")
specfile = basedir + "/cloudbridge.spec"
if Options.options.VERNUM:
ver = Options.options.VERNUM
else: ver = "1.0.1"
tarball = Scripting.dist('', ver)
if _exists(outputdir): shutil.rmtree(outputdir)
for a in ["RPMS/noarch","SRPMS","BUILD","SPECS","SOURCES"]: mkdir_p(_join(outputdir,a))
shutil.copy(tarball,_join(sourcedir,tarball))
packagever = ["--define", "_ver %s" % ver]
checkdeps = lambda: c(["rpmbuild", "--define", "_topdir %s"%outputdir, "--nobuild", specfile]+packagever)
dorpm = lambda: c(["rpmbuild", "--define", "_topdir %s"%outputdir, "-bb", specfile]+packagever)
try: checkdeps()
except (CalledProcessError,OSError),e:
Utils.pprint("YELLOW","Dependencies might be missing.")
dorpm()
for rpm in glob.glob(basedir + "/tmp/RPMS/*/*.rpm"):
shutil.copy(rpm, basedir + "/../..")
def uninstallrpms(context):
"""uninstalls any Cloud Bridge RPMs on this system"""
Utils.pprint("GREEN","Uninstalling any installed RPMs")
cmd = "rpm -qa | grep cloud-bridge | xargs -r sudo rpm -e"
Utils.pprint("BLUE",cmd)
os.system(cmd)
def uninstalldebs(context):
"""uninstalls any Cloud Bridge DEBs on this system"""
Utils.pprint("GREEN","Uninstalling any installed DEBs")
cmd = "dpkg -l 'cloud-bridge*' | grep ^i | awk '{ print $2 } ' | xargs aptitude purge -y"
Utils.pprint("BLUE",cmd)
os.system(cmd)

61
awsapi/wscript_build
View File

@ -1,61 +0,0 @@
#!/usr/bin/env python
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
"""builds the entire stack"""
#For every matching build change here, that produces new installable
#files, the cloud.spec file and the Debian control files must be
#revised and tested.
import shutil,os
import Utils,Node,Options,Logs,Scripting,Environment,Build,Configure
from os import unlink as _unlink, makedirs as _makedirs, getcwd as _getcwd, chdir as _chdir
from os.path import abspath as _abspath, basename as _basename, dirname as _dirname, exists as _exists, isdir as _isdir, split as _split, join as _join, sep, pathsep, pardir
from glob import glob as _glob
try: set([1,2,3])
except Exception: from Sets import set
import re
import zipfile,tarfile
try:
from os import chmod as _chmod,chown as _chown
import pwd,stat,grp
except ImportError:
_chmod,_chown,pwd,stat,grp = (None,None,None,None,None)
sourcedir = bld.srcnode.abspath()
builddir = bld.path.abspath(bld.env)
filelist = bld.path.ant_glob
# ==================== Java compilation ===========================
ant_args = [
"-Dimpl.version=%s"%bld.env.VERSION,
"-Dtarget.dir=%s"%Utils.relpath(_join(builddir,"target")),
"-Dbuildnumber.dir=%s"%Utils.relpath(_join(builddir)),
"-Ddist.dir=%s"%Utils.relpath(builddir),
]
# FIXME make this depend on appropriate variables, add support for build number command line option, and now that build number autodetection is no longer possible in cloudstack project, remove build number autodetection support altogether, making it cleaner. and so should the build number support on this project be -- no autodetection
tgen = bld(
rule=Utils.runant,
name='runant',
source=filelist('src/**',bld=0,src=1,dir=0),
target='cloud-bridge.jar cloud-auth-ec2.mar cloud-auth-s3.mar cloud-ec2.aar cloud-s3.aar',
anttgts=["build-cloud-bridge"],
antargs=ant_args)
# FIXME declare correct build outputs for installation

113
awsapi/wscript_configure
View File

@ -1,113 +0,0 @@
#!/usr/bin/env python
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
"""examines environment, then:
- configures classpath as per environment or command-line options
- detects Tomcat (on Windows)
- detects or configures directories according to command-line options"""
import platform
import Utils,Node,Options,Logs,Scripting,Environment,Build,Configure
from os import unlink as _unlink, makedirs as _makedirs, getcwd as _getcwd, chdir as _chdir
from os.path import abspath as _abspath, basename as _basename, dirname as _dirname, exists as _exists, isdir as _isdir, split as _split, join as _join, sep, pathsep, pardir
from glob import glob as _glob
conf.check_tool('misc')
conf.check_tool('java')
conf.check_tool("gnu_dirs")
conf.check_message_1('Detecting distribution')
if platform.system() == 'Windows': conf.env.DISTRO = "Windows"
elif platform.system() == 'Darwin': conf.env.DISTRO = "Mac"
elif _exists("/etc/network"): conf.env.DISTRO = "Ubuntu"
elif _exists("/etc/fedora-release"): conf.env.DISTRO = "Fedora"
elif _exists("/etc/centos-release") or _exists("/etc/redhat-release"): conf.env.DISTRO = "CentOS"
else: conf.env.DISTRO = "unknown"
if conf.env.DISTRO == "unknown": c = "YELLOW"
else: c = "GREEN"
conf.check_message_2(conf.env.DISTRO,c)
# waf uses slashes somewhere along the line in some paths. we fix them on windows.
if conf.env.DISTRO in ['Windows']:
for pth in [ x for x in conf.env.get_merged_dict().keys() if x.endswith("DIR") ]:
conf.env[pth] = conf.env[pth].replace("/","\\")
conf.check_message_1('Detecting Tomcat')
tomcathome = getattr(Options.options, 'TOMCATHOME', '')
if tomcathome:
conf.env.TOMCATHOME = tomcathome
conf.check_message_2("%s (forced through --with-tomcat)"%conf.env.TOMCATHOME,"GREEN")
else:
if "TOMCAT_HOME" in conf.environ and conf.environ['TOMCAT_HOME'].strip():
conf.env.TOMCATHOME = conf.environ["TOMCAT_HOME"]
conf.check_message_2("%s (got through environment variable %%TOMCAT_HOME%%)"%conf.env.TOMCATHOME,"GREEN")
elif "CATALINA_HOME" in conf.environ and conf.environ['CATALINA_HOME'].strip():
conf.env.TOMCATHOME = conf.environ['CATALINA_HOME']
conf.check_message_2("%s (got through environment variable %%CATALINA_HOME%%)"%conf.env.TOMCATHOME,"GREEN")
elif _isdir("/usr/share/tomcat6"):
conf.env.TOMCATHOME = "/usr/share/tomcat6"
conf.check_message_2("%s (detected existence of system directory)"%conf.env.TOMCATHOME,"GREEN")
else:
conf.env.TOMCATHOME = _join(conf.env.DATADIR,'tomcat6')
conf.check_message_2("%s (assumed presence of Tomcat there)"%conf.env.TOMCATHOME,"GREEN")
conf.env.CLOUDBRIDGEPATH = _join(conf.env.PACKAGE,"management")
if conf.env.DISTRO in ['Windows','Mac']:
conf.env.CLOUDBRIDGEENVIRON = conf.env.TOMCATHOME
conf.env.CLOUDBRIDGESYSCONFDIR = _join(conf.env.TOMCATHOME,"conf")
conf.env.CLOUDBRIDGELOGDIR = _join(conf.env.TOMCATHOME,"logs")
else:
conf.env.CLOUDBRIDGEENVIRON = _join(conf.env.DATADIR,conf.env.CLOUDBRIDGEPATH)
conf.env.CLOUDBRIDGESYSCONFDIR = _join(conf.env.SYSCONFDIR,conf.env.CLOUDBRIDGEPATH)
conf.env.CLOUDBRIDGELOGDIR = _join(conf.env.LOCALSTATEDIR,"log",conf.env.CLOUDBRIDGEPATH)
conf.check_message_1('Detecting JAVADIR')
javadir = getattr(Options.options, 'JAVADIR', '')
if javadir:
conf.env.JAVADIR = javadir
conf.check_message_2("%s (forced through --javadir)"%conf.env.JAVADIR,"GREEN")
elif conf.env.DISTRO in ['Windows','Mac']:
conf.env.JAVADIR = _join(conf.env['TOMCATHOME'],'lib')
conf.check_message_2("%s (using Tomcat's lib/ directory)"%conf.env.JAVADIR,"GREEN")
else:
conf.env.JAVADIR = _join(conf.env.DATADIR,'java')
conf.check_message_2("%s (using default ${DATADIR}/java directory)"%conf.env.JAVADIR,"GREEN")
if conf.env.DISTRO in ["Windows","Mac"]:
conf.env.SYSTEMJAVADIR = conf.env.JAVADIR
else:
conf.env.SYSTEMJAVADIR = "/usr/share/java"
in_javadir = lambda name: _join(conf.env.JAVADIR,_basename(name)) # $PREFIX/share/java
in_system_javadir = lambda name: _join(conf.env.SYSTEMJAVADIR,name) # /usr/share/java
conf.check_message_1('Building classpaths')
# == Here we build the run-time classpaths ==
compilecp = []
compilecp+= [ jar for directory in ['lib','rampart-lib'] for jar in _glob(_join(directory,"*.jar")) ]
# 3. the system classpath (system-installed JARs)
conf.env.CLASSPATH = pathsep.join(compilecp)
conf.check_message_2('Done','GREEN')
conf.env.VERSION = Utils.g_module.VERSION
Utils.pprint("WHITE","Configure finished. Use 'python waf showconfig' to show the configure-time environment.")

9
build/build-aws-api.xml
View File

@ -272,12 +272,11 @@
</fileset>
</copy>
</target>
<!--
<target name="deploy-debian-install" depends="build-awsapi-jar, build-awsapi">
<copy todir="${debian.tomcat.dir}/webapps7080/awsapi/WEB-INF/services">
<fileset dir="${dist.files.dir}">
<!--
<include name="cloud-s3.aar"/>
-->
<include name="cloud-ec2.aar" />
</fileset>
</copy>
@ -310,14 +309,14 @@
<include name="xes.keystore" />
</fileset>
</copy>
<!-- copy overwrite="true" todir="${debian.tomcat.dir}/conf">
<copy overwrite="true" todir="${debian.tomcat.dir}/conf">
<fileset dir="${base.dir}/awsapi/conf/">
<include name="**/*" />
</fileset>
<fileset dir="${base.dir}/awsapi-setup/tomcat">
<include name="**/*" />
</fileset>
</copy -->
</copy>
<copy overwrite="true" todir="${debian.tomcat.dir}/webapps7080/awsapi/WEB-INF/conf">
<fileset dir="${base.dir}/awsapi/resource/Axis2/">
<include name="axis2.xml" />
@ -345,6 +344,8 @@
</fileset>
</copy>
</target>
-->
<target name="deploy-rpm-install" depends="build-awsapi-jar, build-awsapi">
<copy todir="${rpm.tomcat.dir}/webapps7080/awsapi/WEB-INF/services">
<fileset dir="${dist.files.dir}">

2
build/build-cloud.xml
View File

@ -224,7 +224,7 @@
<path refid="deps.classpath" />
<path refid="dist.classpath" />
</path>
<target name="compile-server" depends="-init, compile-utils, compile-xenapi, compile-core, compile-agent" description="Compile the management server.">
<target name="compile-server" depends="-init, compile-utils, compile-core, compile-agent" description="Compile the management server.">
<compile-java jar.name="${server.jar}" top.dir="${server.dir}" classpath="server.classpath" />
</target>

5
build/developer.xml
View File

@ -185,6 +185,7 @@
<copy todir="${server.deploy.to.dir}/lib">
<fileset dir="${deps.dir}/">
<include name="*.jar"/>
<exclude name="servlet*.jar"/>
</fileset>
</copy>
<touch file="${server.deploy.to.dir}/webapps/client/WEB-INF/lib/scripts/vm/hypervisor/xenserver/version"/>
@ -294,8 +295,8 @@
<fileset dir="${unittest.jar.dir}">
<include name="*.jar"/>
</fileset>
<fileset dir="${tools.dir}">
<include name="**/junit-4.8.1.jar"/>
<fileset dir="${deps.dir}">
<include name="junit-*.jar"/>
</fileset>
<dirset dir="${utils.test.dir}/resources"/>
<dirset dir="${server.test.dir}/resources"/>

1
client/WEB-INF/classes/resources/messages.properties
View File

@ -1124,6 +1124,7 @@ label.linklocal.ip=Link Local IP Adddress
label.load.balancer=Load Balancer
label.loading=Loading
label.local=Local
label.local.storage.enabled=Local Storage Enabled
label.login=Login
label.logout=Logout
label.lun=LUN

2
client/distro/ubuntu/SYSCONFDIR/init.d/cloud-management.in
View File

@ -60,7 +60,7 @@ TOMCAT6_USER=tomcat6
# The first existing directory is used for JAVA_HOME (if JAVA_HOME is not
# defined in $DEFAULT)
JDK_DIRS="/usr/lib/jvm/java-1.6.0-openjdk-i386/ /usr/lib/jvm/java-6-openjdk /usr/lib/jvm/java-6-sun /usr/lib/jvm/java-1.5.0-sun /usr/lib/j2sdk1.5-sun /usr/lib/j2sdk1.5-ibm"
JDK_DIRS="/usr/lib/jvm/java-1.6.0-openjdk-amd64/ /usr/lib/jvm/java-1.6.0-openjdk-i386/ /usr/lib/jvm/java-1.6.0-openjdk/ /usr/lib/jvm/java-6-openjdk /usr/lib/jvm/java-6-sun"
# Look for the right JVM to use
for jdir in $JDK_DIRS; do

11
cloud.spec
View File

@ -288,6 +288,12 @@ Summary: CloudStack CloudBridge
Group: System Environment/Libraries
Requires: java >= 1.6.0
Requires: tomcat6
%if 0%{?fedora} > 15
Requires: apache-commons-lang
%endif
%if 0%{?rhel} >= 5
Requires: jakarta-commons-lang
%endif
Obsoletes: cloud-bridge < %{version}-%{release}
%description aws-api
This is the CloudStack CloudBridge
@ -313,7 +319,7 @@ echo Doing CloudStack build
rm $RPM_BUILD_ROOT/etc/rc.d/init.d/cloud-console-proxy
rm $RPM_BUILD_ROOT/usr/bin/cloud-setup-console-proxy
rm $RPM_BUILD_ROOT/usr/libexec/console-proxy-runner
./tools/ant/apache-ant-1.7.1/bin/ant deploy-rpm-install -Drpm.install.dir=$RPM_BUILD_ROOT
ant deploy-rpm-install -Drpm.install.dir=$RPM_BUILD_ROOT
%clean
@ -476,11 +482,9 @@ fi
%{_javadir}/xmlrpc-common-3.*.jar
%{_javadir}/xmlrpc-client-3.*.jar
%{_javadir}/wsdl4j-1.6.2.jar
%{_javadir}/bcprov-jdk16-1.46.jar
%{_javadir}/jsch-0.1.42.jar
%{_javadir}/jasypt-1.*.jar
%{_javadir}/commons-configuration-1.8.jar
%{_javadir}/commons-lang-2.6.jar
%{_javadir}/ejb-api-3.0.jar
%{_javadir}/axis2-1.5.1.jar
%{_javadir}/commons-discovery-0.5.jar
@ -574,7 +578,6 @@ fi
%files aws-api
%defattr(0644,cloud,cloud,0755)
%{_datadir}/cloud/bridge/conf/*
%{_datadir}/cloud/bridge/lib/*
%{_datadir}/cloud/bridge/webapps7080/*
%attr(0644,root,root) %{_datadir}/cloud/setup/bridge/db/*
%attr(0755,root,root) %{_bindir}/cloudstack-aws-api-register

4
console-proxy/pom.xml
View File

@ -138,7 +138,7 @@
</execution>
</executions>
</plugin>
<plugin>
<!--plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.2.1</version>
@ -163,7 +163,7 @@
<argument>authorized_keys</argument>
</arguments>
</configuration>
</plugin>
</plugin-->
</plugins>
</build>
</project>

2
debian/cloud-agent.conffiles vendored
View File

@ -1,2 +0,0 @@
/etc/cloud/agent/agent.properties
/etc/cloud/agent/log4j-cloud.xml

3
debian/cloud-client.conffiles vendored
View File

@ -1,3 +0,0 @@
/etc/cloud/management/db.properties
/etc/cloud/management/components.xml
/etc/cloud/management/log4j-cloud.xml

5
debian/cloud-deps.install vendored
View File

@ -15,19 +15,18 @@
# specific language governing permissions and limitations
# under the License.
/usr/share/java/backport-util-concurrent-3.1.jar
/usr/share/java/ehcache-1.5.0.jar
/usr/share/java/mail-1.4.jar
/usr/share/java/httpcore-4.0.jar
/usr/share/java/log4j-*.jar
/usr/share/java/apache-log4j-extras-1.1.jar
/usr/share/java/trilead-ssh2-build213-svnkit-1.3-patch.jar
/usr/share/java/cglib-2.2.jar
/usr/share/java/xmlrpc-common-3.*.jar
/usr/share/java/xmlrpc-client-3.*.jar
/usr/share/java/jstl-1.2.jar
/usr/share/java/axis2-1.5.1.jar
/usr/share/java/wsdl4j-1.6.2.jar
/usr/share/java/bcprov-jdk16-1.46.jar
/usr/share/java/jsch-0.1.42.jar
/usr/share/java/jasypt-1.*.jar
/usr/share/java/ejb-api-3.0.jar
/usr/share/java/javax.persistence-2.0.0.jar

4
debian/control vendored
View File

@ -33,7 +33,7 @@ Provides: vmops-utils
Conflicts: vmops-utils
Replaces: vmops-utils
Architecture: any
Depends: openjdk-6-jre, python
Depends: openjdk-6-jre, python, libcglib-java (>= 2.2.2), libjsch-java (>= 0.1.42), libbackport-util-concurrent-java (>= 3.1)
Description: CloudStack utility library
The CloudStack utility libraries provide a set of Java classes used
in the CloudStack environment.
@ -119,7 +119,7 @@ Provides: vmops-agent
Conflicts: vmops-agent
Replaces: vmops-agent
Architecture: any
Depends: openjdk-6-jre, cloud-utils (= ${source:Version}), cloud-core (= ${source:Version}), cloud-agent-deps (= ${source:Version}), python, cloud-python (= ${source:Version}), cloud-agent-libs (= ${source:Version}), cloud-agent-scripts (= ${source:Version}), libvirt0, sysvinit-utils, chkconfig, qemu-kvm, libvirt-bin, uuid-runtime, rsync, grep, iproute, ebtables, vlan, libcglib-java, libcommons-httpclient-java, libservlet2.5-java, liblog4j1.2-java (>= 1.2.16), libjna-java, wget, jsvc, lsb-base (>= 3.2)
Depends: openjdk-6-jre, cloud-utils (= ${source:Version}), cloud-core (= ${source:Version}), cloud-agent-deps (= ${source:Version}), python, cloud-python (= ${source:Version}), cloud-agent-libs (= ${source:Version}), cloud-agent-scripts (= ${source:Version}), libvirt0, sysvinit-utils, chkconfig, qemu-kvm, libvirt-bin, uuid-runtime, rsync, grep, iproute, ebtables, vlan, libcommons-httpclient-java, libservlet2.5-java, liblog4j1.2-java (>= 1.2.16), libjna-java, wget, jsvc, lsb-base (>= 3.2)
Description: CloudStack agent
The CloudStack agent is in charge of managing shared computing resources in
a CloudStack powered cloud. Install this package if this computer

33
docs/en-US/LDAPserver-for-user-authentication.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="LDAPserver-for-user-authentication">
<title>Using an LDAP Server for User Authentication</title>
<para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate &PRODUCT; end-users. Just map &PRODUCT; accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by &PRODUCT; for matching common values such as the user’s email address and name. &PRODUCT; will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user..</para>
@ -37,4 +36,4 @@
<xi:include href="query-filter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="search-user-bind-dn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="SSL-keystore-path-and-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</section>

2
docs/en-US/about-clusters.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

34
docs/en-US/about-hosts.xml
View File

@ -1,25 +1,25 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-hosts">
@ -28,7 +28,7 @@
<para>The host is the smallest organizational unit within a &PRODUCT; deployment. Hosts are contained within clusters, clusters are contained within pods, and pods are contained within zones.</para>
<para>Hosts in a &PRODUCT; deployment:</para>
<itemizedlist>
<listitem><para>Provde the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem>
<listitem><para>Provide the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem>
<listitem><para>Interconnect using a high bandwidth TCP/IP network and connect to the Internet</para></listitem>
<listitem><para>May reside in multiple data centers across different geographic locations</para></listitem>
<listitem><para>May have different capacities (different CPU speeds, different amounts of RAM, etc.), although the hosts within a cluster must all be homogeneous</para></listitem>

38
docs/en-US/about-physical-networks.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-physical-networks">
<title>About Physical Networks</title>
<title>About Physical Networks</title>
<para>Part of adding a zone is setting up the physical network. One or (in an advanced zone) more physical networks can be associated with each zone. The network corresponds to a NIC on the hypervisor host. Each physical network can carry one or more types of network traffic. The choices of traffic type for each network vary depending on whether you are creating a zone with basic networking or advanced networking.</para>
<para>A physical network is the actual network hardware and wiring in a zone. A zone can have multiple physical networks. An administrator can:</para>
<itemizedlist>
@ -33,8 +32,7 @@
<listitem><para>Configure the service providers (firewalls, load balancers, etc.) available on a physical network</para></listitem>
<listitem><para>Configure the IP addresses trunked to a physical network</para></listitem>
<listitem><para>Specify what type of traffic is carried on the physical network, as well as other properties like network speed</para></listitem>
</itemizedlist>
<xi:include href="physical-network-configuration-settings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</itemizedlist>
<xi:include href="basic-zone-network-traffic-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="basic-zone-guest-ip-addresses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="advanced-zone-network-traffic-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

41
docs/en-US/about-pods.xml
View File

@ -1,33 +1,34 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-pods">
<title>About Pods</title>
<para>A pod often represents a single rack. Hosts in the same pod are in the same subnet.</para>
<para>A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods.</para>
<para>Pods are not visible to the end user.</para>
<para>A pod consists of one or more clusters of hosts and one or more primary storage servers.</para>
<para>A pod often represents a single rack. Hosts in the same pod are in the same subnet.
A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods.
A pod consists of one or more clusters of hosts and one or more primary storage servers.
Pods are not visible to the end user.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/pod-overview.png" />

2
docs/en-US/about-primary-storage.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

2
docs/en-US/about-secondary-storage.xml
View File

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

39
docs/en-US/about-virtual-networks.xml
View File

@ -5,27 +5,26 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-virtual-networks">
<title>About Virtual Networks</title>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT;, a virtual network can be shared or isolated.</para>
<para><xref linkend="isolated-networks" />XenServer and Maintenance Mode</para>
<para><xref linkend="shared-networks" />Working with Usage</para>
<para><xref linkend="runtime-allocation-virtual-network-resources" />XenServer and Maintenance Mode</para>
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated.</para>
<xi:include href="isolated-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="shared-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

54
docs/en-US/about-working-with-vms.xml
View File

@ -5,35 +5,35 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-working-with-vms">
<title>About Working with Virtual Machines</title>
<para>&PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed.</para>
<para>Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user:</para>
<itemizedlist>
<listitem><para>Instance name &ndash; a unique, immutable ID that is generated by &PRODUCT; and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para></listitem>
<listitem><para>Display name &ndash; the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name.</para></listitem>
<listitem><para>Name &ndash; host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name</para></listitem>
</itemizedlist>
<para>Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on </para>
<para>Each new VM is allocated one public IP address. When the VM is started, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM.</para>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.</para>
<title>About Working with Virtual Machines</title>
<para>&PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed.</para>
<para>Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user:</para>
<itemizedlist>
<listitem><para>Instance name – a unique, immutable ID that is generated by &PRODUCT;, and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para></listitem>
<listitem><para>Display name – the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name.</para></listitem>
<listitem><para>Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name</para></listitem>
</itemizedlist>
<para>Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on </para>
<para>Each new VM is allocated one public IP address. When the VM is started, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM.</para>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.</para>
</section>

37
docs/en-US/about-zones.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="about-zones">
<title>About Zones</title>
<title>About Zones</title>
<para>A zone is the largest organizational unit within a &PRODUCT; deployment. A zone typically corresponds to a single datacenter, although it is permissible to have multiple zones in a datacenter. The benefit of organizing infrastructure into zones is to provide physical isolation and redundancy. For example, each zone can have its own power supply and network uplink, and the zones can be widely separated geographically (though this is not required).</para>
<para>A zone consists of:</para>
<itemizedlist>
@ -34,7 +33,7 @@
<imageobject>
<imagedata fileref="./images/zone-overview.png" />
</imageobject>
<textobject><phrase>zone-overview.png: Nested structure of a simple zone</phrase></textobject>
<textobject><phrase>zone-overview.png: Nested structure of a simple zone.</phrase></textobject>
</mediaobject>
<para>Zones are visible to the end user. When a user starts a guest VM, the user must select a zone for their guest. Users might also be required to copy their private templates to additional zones to enable creation of guest VMs using their templates in those zones.</para>
<para>Zones can be public or private. Public zones are visible to all users. This means that any user may create a guest in that zone. Private zones are reserved for a specific domain. Only users in that domain or its subdomains may create guests in that zone.</para>

66
docs/en-US/accessing-vms.xml
View File

@ -5,37 +5,43 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="accessing-vms">
<title>Accessing VMs</title>
<para>Any user can access their own virtual machines. The administrator can access all VMs running in the cloud.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>Click Instances, then click the name of a running VM.</para></listitem>
<listitem><para>Click the View Console button <inlinegraphic format="PNG" fileref="images/icon.png"/>.</para></listitem>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>
<listitem><para>The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling.</para></listitem>
<listitem><para>If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system.</para></listitem>
<listitem><para>If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling.</para></listitem>
</orderedlist>
<title>Accessing VMs</title>
<para>Any user can access their own virtual machines. The administrator can access all VMs running in the cloud.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>Click Instances, then click the name of a running VM.</para></listitem>
<listitem><para>Click the View Console <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/console-icon.png"/>
</imageobject>
<textobject>
<phrase>consoleicon.png: button to view the console.</phrase>
</textobject>
</inlinemediaobject></para></listitem>
</orderedlist>
<para>To access a VM directly over the network:</para>
<orderedlist>
<listitem><para>The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling.</para></listitem>
<listitem><para>If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system.</para></listitem>
<listitem><para>If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling.</para></listitem>
</orderedlist>
</section>

31
docs/en-US/accounts-users-domains.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="accounts-users-domains">
<title>Accounts, Users, and Domains</title>
<formalpara>

35
docs/en-US/accounts.xml
View File

@ -5,24 +5,25 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="accounts">
<chapter id="accounts">
<title>Accounts</title>
<xi:include href="accounts-users-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="LDAPserver-for-user-authentication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
</chapter>

70
docs/en-US/add-additional-guest-network.xml
View File

@ -5,39 +5,43 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="add-additional-guest-network">
<title>Adding an Additional Guest Network</title>
<itemizedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>Click Add guest network. Provide the following information: </para>
<itemizedlist>
<listitem><para>Name. The name of the network. This will be user-visible. </para></listitem>
<listitem><para>Description. The description of the network. This will be user-visible.</para></listitem>
<listitem><para>Network offering. If the administrator has configured multiple network offerings, select the one you want to use for this network.</para></listitem>
<listitem><para>Pod. The name of the pod this network applies to. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod. </para></listitem>
<listitem><para>VLAN ID. The VLAN tag for this network.</para></listitem>
<listitem><para>Gateway. The gateway that the guests should use.</para></listitem>
<listitem><para>Netmask. The netmask in use on the subnet the guests will use.</para></listitem>
<listitem><para>Start IP/End IP. Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. We strongly recommend the use of multiple NICs. If multiple NICs are used, they may be in a different subnet. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR.</para></listitem></itemizedlist></listitem>
<listitem><para>Click Create.</para></listitem>
</itemizedlist>
<title>Adding an Additional Guest Network</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click Add guest network. Provide the following information: </para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>: The name of the network. This will be user-visible. </para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>: The description of the network. This will be
user-visible.</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>. The name of the zone this network applies to. Each zone is a broadcast domain, and therefore each zone has a different
IP range for the guest network. The administrator must configure the IP
range for each zone.</para></listitem>
<listitem><para><emphasis role="bold">Network offering</emphasis>: If the administrator has configured
multiple network offerings, select the one you want to use for this
network.</para></listitem>
<listitem><para><emphasis role="bold">Guest Gateway</emphasis>: The gateway that the guests should use.</para></listitem>
<listitem><para><emphasis role="bold">Guest Netmask</emphasis>: The netmask in use on the subnet the guests will
use.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Create.</para></listitem>
</orderedlist>
</section>
</section>

123
docs/en-US/add-ingress-egress-rules.xml
View File

@ -5,55 +5,88 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="add-ingress-egress-rules">
<title>Adding Ingress and Egress Rules to a Security Group</title>
<itemizedlist>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>In Select view, choose Security Groups, then click the security group you want .</para></listitem>
<listitem><para>To add an ingress rule, click the Ingress Rules tab and fill out the following fields to specify what network traffic is allowed into VM instances in this security group. If no ingress rules are specified, then no traffic will be allowed in, except for responses to any traffic that has been allowed out through an egress rule.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the source of the traffic will be defined by IP address (CIDR) or an existing security group in a &PRODUCT; account (Account). Choose Account if you want to allow incoming traffic from all VMs in another security group</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that sources will use to send traffic to the security group. TCP and UDP are typically used for data exchange and end-user communications. ICMP is typically used to send error messages or network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening ports that are the destination for the incoming traffic. If you are opening a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and error code that will be accepted.</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To accept only traffic from IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To accept only traffic from another security group, enter the &PRODUCT; account and name of a security group that has already been defined in that account. To allow traffic between VMs within the security group you are editing now, enter the same name you used in step 7.</para></listitem>
</itemizedlist>
<para>The following example allows inbound HTTP access from anywhere:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/http-access.png" />
</imageobject>
<textobject><phrase>httpaccess.png: allows inbound HTTP access from anywhere</phrase></textobject>
</mediaobject>
</listitem>
<listitem><para>To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the destination of the traffic will be defined by IP address (CIDR) or an existing security group in a &PRODUCT; account (Account). Choose Account if you want to allow outgoing traffic to all VMs in another security group.</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that VMs will use to send outgoing traffic. TCP and UDP are typically used for data exchange and end-user communications. ICMP is typically used to send error messages or network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening ports that are the destination for the outgoing traffic. If you are opening a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and error code that will be sent</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To send traffic only to IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the destination. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To allow traffic to be sent to another security group, enter the &PRODUCT; account and name of a security group that has already been defined in that account. To allow traffic between VMs within the security group you are editing now, enter its name.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</itemizedlist>
<listitem><para>In Select view, choose Security Groups, then click the security group you want .</para></listitem>
<listitem><para>To add an ingress rule, click the Ingress Rules tab and fill out the following fields to specify what network traffic is allowed into VM instances in this security group. If no ingress rules are specified, then no traffic will be allowed in, except for responses to any traffic that has been allowed out through an egress rule.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the source of the
traffic will be defined by IP address (CIDR) or an existing security group
in a &PRODUCT; account (Account). Choose Account if you want to allow
incoming traffic from all VMs in another security group</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that sources will use to
send traffic to the security group. TCP and UDP are typically used for data
exchange and end-user communications. ICMP is typically used to send error
messages or network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening
ports that are the destination for the incoming traffic. If you are opening
a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and
error code that will be accepted.</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To accept only traffic from IP
addresses within a particular address block, enter a CIDR or a
comma-separated list of CIDRs. The CIDR is the base IP address of the
incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to
0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To accept only
traffic from another security group, enter the &PRODUCT; account and
name of a security group that has already been defined in that account. To
allow traffic between VMs within the security group you are editing now,
enter the same name you used in step 7.</para></listitem>
</itemizedlist>
<para>The following example allows inbound HTTP access from anywhere:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/http-access.png" />
</imageobject>
<textobject><phrase>httpaccess.png: allows inbound HTTP access from anywhere</phrase></textobject>
</mediaobject>
</listitem>
<listitem><para>To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Add by CIDR/Account</emphasis>. Indicate whether the destination of the
traffic will be defined by IP address (CIDR) or an existing security group
in a &PRODUCT; account (Account). Choose Account if you want to allow
outgoing traffic to all VMs in another security group.</para></listitem>
<listitem><para><emphasis role="bold">Protocol</emphasis>. The networking protocol that VMs will use to send
outgoing traffic. TCP and UDP are typically used for data exchange and
end-user communications. ICMP is typically used to send error messages or
network monitoring data.</para></listitem>
<listitem><para><emphasis role="bold">Start Port, End Port</emphasis>. (TCP, UDP only) A range of listening
ports that are the destination for the outgoing traffic. If you are opening
a single port, use the same number in both fields.</para></listitem>
<listitem><para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>. (ICMP only) The type of message and
error code that will be sent</para></listitem>
<listitem><para><emphasis role="bold">CIDR</emphasis>. (Add by CIDR only) To send traffic only to IP addresses
within a particular address block, enter a CIDR or a comma-separated list of
CIDRs. The CIDR is the base IP address of the destination. For example,
192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para></listitem>
<listitem><para><emphasis role="bold">Account, Security Group</emphasis>. (Add by Account only) To allow
traffic to be sent to another security group, enter the &PRODUCT;
account and name of a security group that has already been defined in that
account. To allow traffic between VMs within the security group you are
editing now, enter its name.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

178
docs/en-US/add-iso.xml
View File

@ -5,87 +5,103 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="add-iso">
<title>Adding an ISO</title>
<para>To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>In Select View, choose ISOs.</para></listitem>
<listitem><para>Click Add ISO.</para></listitem>
<listitem><para>In the Add ISO screen, provide the following:</para>
<itemizedlist>
<listitem><para>Name. Short name for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>Description. Display test for the ISO image. (E.g. CentOS 6.2 64 bit).</para></listitem>
<listitem><para>URL. The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server</para></listitem>
<listitem><para>Zone. Choose the zone where you want the ISO to be available, or All Zones to make it available throughout &PRODUCT;.</para></listitem>
<listitem><para>Bootable. Whether or not a guest could boot off this ISO image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not bootable.</para></listitem>
<listitem><para>OS Type. This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of your desired ISO image is listed, choose it.</para></listitem>
<listitem><para>If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other.</para></listitem>
<listitem><para>(XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit)</para></listitem>
<listitem><para>(KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are:</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Fedora 13</para></entry>
<entry><para>Fedora 12</para></entry>
<entry><para>Fedora 11</para></entry>
</row>
<row>
<entry><para>Fedora 10</para></entry>
<entry><para>Fedora 9</para></entry>
<entry><para>Other PV</para></entry>
</row>
<row>
<entry><para>Debian GNU/Linux</para></entry>
<entry><para>CentOS 5.3</para></entry>
<entry><para>CentOS 5.4</para></entry>
</row>
<row>
<entry><para>CentOS 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 5.3</para></entry>
<entry><para>Red Hat Enterprise Linux 5.4</para></entry>
</row>
<row>
<entry><para>Red Hat Enterprise Linux 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 6</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</itemizedlist>
<note><para>Note: It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other.</para></note>
</listitem>
<listitem><para>Extractable. Choose Yes if the ISO should be available for extraction.</para></listitem>
<listitem><para>Public. Choose Yes if this ISO should be available to other users.</para></listitem>
<listitem><para>Featured. Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click OK.</para>
<para>The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage.</para>
</listitem>
<listitem><para><emphasis role="bold">Important</emphasis>: Wait for the ISO to finish downloading. If you move on to the next task and try to use the ISO right away, it will appear to fail. The entire ISO must be available before &PRODUCT; can work with it</para></listitem>
</orderedlist>
<title>Adding an ISO</title>
<para>To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation bar, click Templates.</para></listitem>
<listitem><para>In Select View, choose ISOs.</para></listitem>
<listitem><para>Click Add ISO.</para></listitem>
<listitem><para>In the Add ISO screen, provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>: Short name for the ISO image. For example, CentOS 6.2
64-bit.</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>: Display test for the ISO image. For example,
CentOS 6.2 64-bit.</para></listitem>
<listitem><para><emphasis role="bold">URL</emphasis>: The URL that hosts the ISO image. The Management Server
must be able to access this location via HTTP. If needed you can place the
ISO image directly on the Management Server</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the ISO to be available,
or All Zones to make it available throughout &PRODUCT;.</para></listitem>
<listitem><para><emphasis role="bold">Bootable</emphasis>: Whether or not a guest could boot off this ISO
image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not
bootable.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>: This helps &PRODUCT; and the hypervisor perform
certain operations and make assumptions that improve the performance of the
guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of your desired ISO image is listed, choose it.</para></listitem>
<listitem><para>If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other.</para></listitem>
<listitem><para>(XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit)</para></listitem>
<listitem><para>(KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are:</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<tbody>
<row>
<entry><para>Fedora 13</para></entry>
<entry><para>Fedora 12</para></entry>
<entry><para>Fedora 11</para></entry>
</row>
<row>
<entry><para>Fedora 10</para></entry>
<entry><para>Fedora 9</para></entry>
<entry><para>Other PV</para></entry>
</row>
<row>
<entry><para>Debian GNU/Linux</para></entry>
<entry><para>CentOS 5.3</para></entry>
<entry><para>CentOS 5.4</para></entry>
</row>
<row>
<entry><para>CentOS 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 5.3</para></entry>
<entry><para>Red Hat Enterprise Linux 5.4</para></entry>
</row>
<row>
<entry><para>Red Hat Enterprise Linux 5.5</para></entry>
<entry><para>Red Hat Enterprise Linux 6</para></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable></listitem>
</itemizedlist>
<note><para>It is not recommended to choose an older version of the OS than the version in the image. For
example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually
not work. In these cases, choose Other.</para></note>
</listitem>
<listitem><para><emphasis role="bold">Extractable</emphasis>: Choose Yes if the ISO should be available for
extraction.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>: Choose Yes if this ISO should be available to other
users.</para></listitem>
<listitem><para><emphasis role="bold">Featured</emphasis>: Choose Yes if you would like this ISO to be more
prominent for users to select. The ISO will appear in the Featured ISOs
list. Only an administrator can make an ISO Featured.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click OK.</para>
<para>The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage.</para>
</listitem>
<listitem><para><emphasis role="bold">Important</emphasis>: Wait for the ISO to finish downloading. If you
move on to the next task and try to use the ISO right away, it will appear to fail.
The entire ISO must be available before &PRODUCT; can work with it.</para></listitem>
</orderedlist>
</section>

84
docs/en-US/add-load-balancer-rule.xml
View File

@ -5,42 +5,56 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="add-load-balancer-rule">
<title>Adding a Load Balancer Rule</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to load balance the traffic.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address for which you want to create the rule, then click the Configuration tab.</para></listitem>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para></listitem>
<listitem><para>Fill in the following:</para>
<itemizedlist>
<listitem><para>Name. A name for the load balancer rule.</para></listitem>
<listitem><para>Public Port. The port receiving incoming traffic to be balanced.</para></listitem>
<listitem><para>Private Port. The port that the VMs will use to receive the traffic.</para></listitem>
<listitem><para>Algorithm. Choose the load balancing algorithm you want &PRODUCT; to use. &PRODUCT; supports a variety of well-known algorithms. If you are not familiar with these choices, you will find plenty of information about them on the Internet.</para></listitem>
<listitem><para>Stickiness. (Optional) Click Configure and choose the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer Rules.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply.</para>
<para>The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address.</para>
</listitem>
</orderedlist>
<title>Adding a Load Balancer Rule</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to load balance the traffic.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address for which you want to create the rule, then click the Configuration tab.</para></listitem>
<listitem><para>In the Load Balancing node of the diagram, click View All.</para>
<para>In a Basic zone, you can also create a load balancing rule without acquiring or selecting an
IP address. &PRODUCT; internally assign an IP when you create the load balancing
rule, which is listed in the IP Addresses page when the rule is created. </para>
<para>To do that, select the name of the network, then click Add Load Balancer tab. Continue with
<xref linkend="config-lb"/>.</para></listitem>
<listitem id="config-lb"><para>Fill in the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>: A name for the load balancer rule.</para></listitem>
<listitem><para><emphasis role="bold">Public Port</emphasis>: The port receiving incoming traffic to be
balanced.</para></listitem>
<listitem><para><emphasis role="bold">Private Port</emphasis>: The port that the VMs will use to receive the
traffic.</para></listitem>
<listitem><para><emphasis role="bold">Algorithm</emphasis>: Choose the load balancing algorithm you want
&PRODUCT; to use. &PRODUCT; supports a variety of well-known
algorithms. If you are not familiar with these choices, you will find plenty
of information about them on the Internet.</para></listitem>
<listitem><para><emphasis role="bold">Stickiness</emphasis>: (Optional) Click Configure and choose the
algorithm for the stickiness policy. See Sticky Session Policies for Load
Balancer Rules.</para></listitem>
<listitem><para><emphasis role="bold">AutoScale</emphasis>: Click Configure and complete the AutoScale
configuration as explained in <xref linkend="autoscale"/>.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply.</para>
<para>The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address.</para>
</listitem>
</orderedlist>
</section>

54
docs/en-US/add-security-group.xml
View File

@ -5,35 +5,35 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="add-security-group">
<title>Adding a Security Group</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>In Select view, choose Security Groups.</para></listitem>
<listitem><para>Click Add Security Group.</para></listitem>
<listitem><para>Provide a name and description.</para></listitem>
<listitem><para>Click OK.</para>
<para>The new security group appears in the Security Groups Details tab.</para></listitem>
<listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
</itemizedlist>
<title>Adding a Security Group</title>
<para>A user or administrator can define a new security group.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>In Select view, choose Security Groups.</para></listitem>
<listitem><para>Click Add Security Group.</para></listitem>
<listitem><para>Provide a name and description.</para></listitem>
<listitem><para>Click OK.</para>
<para>The new security group appears in the Security Groups Details tab.</para></listitem>
<listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
</orderedlist>
</section>

437
docs/en-US/advanced-zone-configuration.xml
View File

@ -1,182 +1,277 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="advanced-zone-configuration">
<title>Advanced Zone Configuration</title>
<title>Advanced Zone Configuration</title>
<orderedlist>
<listitem><para>After you select Advanced in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> A name for the zone.</para></listitem>
<listitem><para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix.</para></listitem>
<listitem><para><emphasis role="bold">Guest CIDR.</emphasis> This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone.</para></listitem>
<listitem><para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Choose which traffic types will be carried by the physical network.</para>
<para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see <xref linkend="advanced-zone-network-traffic-types" />. This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired.</para>
</listitem>
<listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon within each physical network. A popup dialog appears where you can type the label, then click OK.</para>
<para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para>
<para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para>
</listitem>
<listitem><para>Click Next.</para>
</listitem>
<listitem><para>Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP addresses.</para></listitem>
<listitem><para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP range.</para></listitem>
<listitem><para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public traffic.</para></listitem>
<listitem><para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see <xref linkend="about-pods" />.</para>
<para>To configure the first pod, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that defines the pod's subnet. Use CIDR notation.</para></listitem>
<listitem><para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see <xref linkend="system-reserved-ip-addresses" />.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next.</para>
</listitem>
<listitem><para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see <xref linkend="about-clusters" />.</para>
<para>To configure the first cluster, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere .</para></listitem>
<listitem><para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see <xref linkend="about-hosts" />.</para>
<note><para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running.</para></note>
<para>Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see:</para>
<itemizedlist>
<listitem><para>Citrix XenServer Installation for &PRODUCT;</para></listitem>
<listitem><para>VMware vSphere Installation and Configuration</para></listitem>
<listitem><para>KVM Installation and Configuration</para></listitem>
<listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem>
</itemizedlist>
<para>To configure the first host, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the host.</para></listitem>
<listitem><para><emphasis role="bold">Username.</emphasis> Usually root.</para></listitem>
<listitem><para><emphasis role="bold">Password.</emphasis> This is the password for the user named above (from your XenServer or KVM install).</para></listitem>
<listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see <xref linkend="about-primary-storage" />.</para>
<para>To configure the first primary storage server, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here.</para>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>NFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
</itemizedlist>
</entry>
</row>
<row>
<entry><para>iSCSI</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem>
<listitem><para><emphasis role="bold">Lun.</emphasis> The LUN number. For example, 3.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
</itemizedlist>
</entry>
</row>
<row>
<entry><para>preSetup</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
</itemizedlist>
</entry>
</row>
<row>
<entry><para>SharedMountPoint</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Path.</emphasis> The path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
</itemizedlist>
</entry>
</row>
<row>
<entry><para>VMFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the vCenter server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem>
<listitem>
<para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</listitem>
</itemizedlist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see <xref linkend="about-secondary-storage" />.</para>
<para>Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage :</para>
<itemizedlist>
<listitem><para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Launch.</para>
</listitem>
<listitem><para>After you select Advanced in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> A name for the zone.</para></listitem>
<listitem><para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here.</para></listitem>
<listitem><para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix.</para></listitem>
<listitem><para><emphasis role="bold">Guest CIDR.</emphasis> This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones.</para></listitem>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone.</para></listitem>
<listitem><para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Choose which traffic types will be carried by the physical network.</para>
<para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see <xref linkend="advanced-zone-network-traffic-types" />. This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired.</para>
</listitem>
<listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon within each physical network. A popup dialog appears where you can type the label, then click OK.</para>
<para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para>
<para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para>
</listitem>
<listitem><para>Click Next.</para>
</listitem>
<listitem><para>Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP addresses.</para></listitem>
<listitem><para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP range.</para></listitem>
<listitem><para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public traffic.</para></listitem>
<listitem><para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see <xref linkend="about-pods" />.</para>
<para>To configure the first pod, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
<listitem><para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that defines the pod's subnet. Use CIDR notation.</para></listitem>
<listitem><para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see <xref linkend="system-reserved-ip-addresses" />.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next.</para>
</listitem>
<listitem><para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see <xref linkend="about-clusters" />.</para>
<para>To configure the first cluster, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere .</para></listitem>
<listitem><para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see <xref linkend="about-hosts" />.</para>
<note><para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running.</para></note>
<para>Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see:</para>
<itemizedlist>
<listitem><para>Citrix XenServer Installation for &PRODUCT;</para></listitem>
<listitem><para>VMware vSphere Installation and Configuration</para></listitem>
<listitem><para>KVM Installation and Configuration</para></listitem>
<listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem>
</itemizedlist>
<para>To configure the first host, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the host.</para></listitem>
<listitem><para><emphasis role="bold">Username.</emphasis> Usually root.</para></listitem>
<listitem><para><emphasis role="bold">Password.</emphasis> This is the password for the user named above (from your XenServer or KVM install).</para></listitem>
<listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see <xref linkend="about-primary-storage" />.</para>
<para>To configure the first primary storage server, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here.</para>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>NFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>iSCSI</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem>
<listitem><para><emphasis role="bold">Lun.</emphasis> The LUN number. For example, 3.</para></listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>preSetup</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
<listitem><para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>SharedMountPoint</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Path.</emphasis> The path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
<row>
<entry><para>VMFS</para></entry>
<entry>
<itemizedlist>
<listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the vCenter server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem>
<listitem><para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para></listitem>
</itemizedlist>
<para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see <xref linkend="about-secondary-storage" />.</para>
<para>Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage :</para>
<itemizedlist>
<listitem><para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server.</para></listitem>
<listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click Launch.</para>
</listitem>
</orderedlist>
</section>

33
docs/en-US/advanced-zone-guest-ip-addresses.xml
View File

@ -1,27 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="advanced-zone-guest-ip-addresses">
<title>Advanced Zone Guest IP Addresses</title>
<para>When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired.</para>

35
docs/en-US/advanced-zone-network-traffic-types.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="advanced-zone-network-traffic-types">
<title>Advanced Zone Network Traffic Types</title>
<title>Advanced Zone Network Traffic Types</title>
<para>When advanced networking is used, there can be multiple physical networks in the zone. Each physical network can carry one or more traffic types, and you need to let &PRODUCT; know which type of network traffic you want each network to carry. The traffic types in an advanced zone are:</para>
<itemizedlist>
<listitem><para>Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. This network can be isolated or shared. In an isolated guest network, the administrator needs to reserve VLAN ranges to provide isolation for each &PRODUCT; account’s network (potentially a large number of VLANs). In a shared guest network, all guest VMs share a single network.</para></listitem>

39
docs/en-US/advanced-zone-physical-network-configuration.xml
View File

@ -5,24 +5,25 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="advanced-zone-physical-network-configuration">
<title>Advanced Zone Physical Network Configuration</title>
<para>Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation.</para>
</section>
<title>Advanced Zone Physical Network Configuration</title>
<para>Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation.</para>
<xi:include href="configure-guest-traffic-in-advanced-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-public-traffic-in-an-advanced-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

33
docs/en-US/advanced-zone-public-ip-addresses.xml
View File

@ -1,27 +1,26 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="advanced-zone-public-ip-addresses">
<title>Advanced Zone Public IP Addresses</title>
<para>When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired.</para>

96
docs/en-US/alerts.xml
View File

@ -1,49 +1,55 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="alerts">
<title>Alerts</title>
<para>The following is the list of alert type numbers. The current alerts can be found by calling listAlerts.</para>
<programlisting>MEMORY = 0</programlisting>
<programlisting>CPU = 1</programlisting>
<programlisting>STORAGE =2</programlisting>
<programlisting>STORAGE_ALLOCATED = 3</programlisting>
<programlisting>PUBLIC_IP = 4</programlisting>
<programlisting>PRIVATE_IP = 5</programlisting>
<programlisting>HOST = 6</programlisting>
<programlisting>USERVM = 7</programlisting>
<programlisting>DOMAIN_ROUTER = 8</programlisting>
<programlisting>CONSOLE_PROXY = 9</programlisting>
<programlisting>ROUTING = 10// lost connection to default route (to the gateway)</programlisting>
<programlisting>STORAGE_MISC = 11 // lost connection to default route (to the gateway)</programlisting>
<programlisting>USAGE_SERVER = 12 // lost connection to default route (to the gateway)</programlisting>
<programlisting>MANAGMENT_NODE = 13 // lost connection to default route (to the gateway)</programlisting>
<programlisting>DOMAIN_ROUTER_MIGRATE = 14</programlisting>
<programlisting>CONSOLE_PROXY_MIGRATE = 15</programlisting>
<programlisting>USERVM_MIGRATE = 16</programlisting>
<programlisting>VLAN = 17</programlisting>
<programlisting>SSVM = 18</programlisting>
<programlisting>USAGE_SERVER_RESULT = 19</programlisting>
<programlisting>STORAGE_DELETE = 20;</programlisting>
<programlisting>UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count</programlisting>
<programlisting>USAGE_SANITY_RESULT = 22;</programlisting>
<programlisting>DIRECT_ATTACHED_PUBLIC_IP = 23;</programlisting>
<programlisting>LOCAL_STORAGE = 24;</programlisting>
<programlisting>RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting>
</section>
<appendix id="alerts">
<title>Alerts</title>
<para>The following is the list of alert type numbers. The current alerts can be found by calling listAlerts.</para>
<programlisting>MEMORY = 0</programlisting>
<programlisting>CPU = 1</programlisting>
<programlisting>STORAGE =2</programlisting>
<programlisting>STORAGE_ALLOCATED = 3</programlisting>
<programlisting>PUBLIC_IP = 4</programlisting>
<programlisting>PRIVATE_IP = 5</programlisting>
<programlisting>HOST = 6</programlisting>
<programlisting>USERVM = 7</programlisting>
<programlisting>DOMAIN_ROUTER = 8</programlisting>
<programlisting>CONSOLE_PROXY = 9</programlisting>
<programlisting>ROUTING = 10// lost connection to default route (to the gateway)</programlisting>
<programlisting>STORAGE_MISC = 11 // lost connection to default route (to the gateway)</programlisting>
<programlisting>USAGE_SERVER = 12 // lost connection to default route (to the gateway)</programlisting>
<programlisting>MANAGMENT_NODE = 13 // lost connection to default route (to the gateway)</programlisting>
<programlisting>DOMAIN_ROUTER_MIGRATE = 14</programlisting>
<programlisting>CONSOLE_PROXY_MIGRATE = 15</programlisting>
<programlisting>USERVM_MIGRATE = 16</programlisting>
<programlisting>VLAN = 17</programlisting>
<programlisting>SSVM = 18</programlisting>
<programlisting>USAGE_SERVER_RESULT = 19</programlisting>
<programlisting>STORAGE_DELETE = 20;</programlisting>
<programlisting>UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count</programlisting>
<programlisting>USAGE_SANITY_RESULT = 22;</programlisting>
<programlisting>DIRECT_ATTACHED_PUBLIC_IP = 23;</programlisting>
<programlisting>LOCAL_STORAGE = 24;</programlisting>
<programlisting>RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting>
</appendix>

59
docs/en-US/attach-iso-to-vm.xml
View File

@ -5,35 +5,36 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="attach-iso-to-vm">
<title>Attaching an ISO to a VM</title>
<orderedlist>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the virtual machine you want to work with.</para></listitem>
<listitem><para>Click the Attach ISO button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png" />
</imageobject>
<textobject><phrase>iso.png: Depicts adding an iso image</phrase></textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In the Attach ISO dialog box, select the desired ISO.</para></listitem>
<listitem><para>Click OK</para></listitem>
</orderedlist>
<title>Attaching an ISO to a VM</title>
<orderedlist>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the virtual machine you want to work with.</para></listitem>
<listitem><para>Click the Attach ISO button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/iso-icon.png"/>
</imageobject>
<textobject>
<phrase>iso.png: depicts adding an iso image</phrase>
</textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In the Attach ISO dialog box, select the desired ISO.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

47
docs/en-US/automatic-snapshot-creation-retention.xml
View File

@ -5,26 +5,33 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="automatic-snapshot-creation-retention">
<title>Automatic Snapshot Creation and Retention</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>, <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold">KVM</emphasis>)</para>
<para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
<para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be retained. Older snapshots that exceed the retention limit are automatically deleted. This user-defined limit must be equal to or lower than the global limit set by the &PRODUCT; administrator. See <xref linkend="globally-configured-limits"/>. The limit applies only to those snapshots that are taken as part of an automatic recurring snapshot policy. Additional manual snapshots can be created and retained.</para>
</section>
<title>Automatic Snapshot Creation and Retention</title>
<para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>,
<emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold"
>KVM</emphasis>)</para>
<para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
<para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be
retained. Older snapshots that exceed the retention limit are automatically deleted. This
user-defined limit must be equal to or lower than the global limit set by the &PRODUCT;
administrator. See <xref linkend="globally-configured-limits"/>. The limit applies only to
those snapshots that are taken as part of an automatic recurring snapshot policy. Additional
manual snapshots can be created and retained.</para>
</section>

39
docs/en-US/basic-zone-configuration.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="basic-zone-configuration">
<title>Basic Zone Configuration</title>
<title>Basic Zone Configuration</title>
<orderedlist>
<listitem><para>After you select Basic in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
<itemizedlist>
@ -66,7 +65,7 @@
<listitem><para>Choose which traffic types will be carried by the physical network.</para>
<para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see Basic Zone Network Traffic Types. This screen starts out with some traffic types already assigned. To add more, drag and drop traffic types onto the network. You can also change the network name if desired.</para>
</listitem>
<listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK.</para>
<listitem><para>3. (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK.</para>
<para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para>
<para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para>
</listitem>
@ -136,7 +135,7 @@
<listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set this to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In a new cluster, CloudPlatform adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage.</para>
<listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage.</para>
<para>To configure the first primary storage server, enter the following, then click Next:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem>

35
docs/en-US/basic-zone-guest-ip-addresses.xml
View File

@ -1,28 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="basic-zone-guest-ip-addresses">
<title>Basic Zone Guest IP Addresses</title>
<para>When basic networking is used, CloudPlatform will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para>
<para>When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para>
</section>

35
docs/en-US/basic-zone-network-traffic-types.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="basic-zone-network-traffic-types">
<title>Basic Zone Network Traffic Types</title>
<title>Basic Zone Network Traffic Types</title>
<para>When basic networking is used, there can be only one physical network in the zone. That physical network carries the following traffic types:</para>
<itemizedlist>
<listitem><para>Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod.</para></listitem>

38
docs/en-US/basic-zone-physical-network-configuration.xml
View File

@ -5,25 +5,23 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="basic-zone-physical-network-configuration">
<title>Basic Zone Physical Network Configuration</title>
<para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to CloudPlatform, you set up the guest network through the Add Zone screens.</para>
</section>
<title>Basic Zone Physical Network Configuration</title>
<para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to &PRODUCT;, you set up the guest network through the Add Zone screens.</para>
</section>

55
docs/en-US/best-practices-for-vms.xml
View File

@ -1,23 +1,40 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="vm-lifecycle">
<title>VM Lifecycle</title>
<para>The CloudPlatform administrator should monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are automatically redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use CloudPlatform global configuration settings to set this as the default limit. Monitor the VM activity in each cluster at all times. Keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the CloudPlatform UI to disable allocation of more VMs to the cluster..</para>
<section id="best-practices-vm">
<title>Best Practices for Virtual Machines</title>
<para>The &PRODUCT; administrator should monitor the total number of VM instances in each
cluster, and disable allocation to the cluster if the total is approaching the maximum that
the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of
one or more hosts failing, which would increase the VM load on the other hosts as the VMs
are automatically redeployed. Consult the documentation for your chosen hypervisor to find
the maximum permitted number of VMs per host, then use &PRODUCT; global configuration
settings to set this as the default limit. Monitor the VM activity in each cluster at all
times. Keep the total number of VMs below a safe level that allows for the occasional host
failure. For example, if there are N hosts in the cluster, and you want to allow for one
host in the cluster to be down at any given time, the total number of VM instances you can
permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this
number of VMs, use the &PRODUCT; UI to disable allocation of more VMs to the
cluster.</para>
</section>

77
docs/en-US/change-network-offering-on-guest-network.xml
View File

@ -5,40 +5,47 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="change-network-offering-on-guest-network">
<title>Changing the Network Offering on a Guest Network</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>If you are changing from a network offering that uses the &PRODUCT; virtual router to one that uses external devices as network service providers, you must first stop all the VMs on the network. See Stopping and Starting VMs. Then return here and continue to the next step</para></listitem>
<listitem><para>In the left navigation, choose Network</para></listitem>
<listitem><para>Click the name of the network you want to modify <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>In Network Offering, choose the new network offering, then click Apply.</para></listitem>
<listitem><para>A prompt appears asking whether you want to keep the existing CIDR. This is to let you know that if you change the network offering, the CIDR will be affected. Choose No to proceed with the change.</para></listitem>
<listitem><para>Wait for the update to complete. Don’t try to restart VMs until after the network change is complete.</para></listitem>
<listitem><para>If you stopped any VMs in step 2, restart them.</para></listitem>
</itemizedlist>
<title>Changing the Network Offering on a Guest Network</title>
<para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
<itemizedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>If you are changing from a network offering that uses the &PRODUCT; virtual router to one
that uses external devices as network service providers, you must first stop all the
VMs on the network. See <xref linkend="stopping-and-starting-vms"/>.</para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network you want to modify.</para></listitem>
<listitem><para>In the Details tab, click Edit.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject>
<phrase>EditButton.png: button to edit a network</phrase>
</textobject>
</inlinemediaobject></para></listitem>
<listitem><para>In Network Offering, choose the new network offering, then click Apply.</para></listitem>
<listitem><para>A prompt is displayed asking whether you want to keep the existing CIDR. This is to let you
know that if you change the network offering, the CIDR will be affected. Choose No
to proceed with the change.</para></listitem>
<listitem><para>Wait for the update to complete. Don’t try to restart VMs until the network change is
complete.</para></listitem>
<listitem><para>If you stopped any VMs, restart them.</para></listitem>
</itemizedlist>
</section>
</section>

37
docs/en-US/changing-root-password.xml
View File

@ -1,29 +1,28 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="changing-root-password">
<title>Changing the Root Password</title>
<title>Changing the Root Password</title>
<para>During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator.
The root administrator account manages the &PRODUCT; deployment, including physical infrastructure.
The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person.

74
docs/en-US/changing-secondary-storage-ip.xml
View File

@ -2,43 +2,43 @@
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="changing-secondary-storage-ip">
<title>Making API Requests</title>
<para>You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server:</para>
<programlisting>
# mysql -p
mysql> use cloud;
mysql> select id from host where type = 'SecondaryStorage';
mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1'
where host_id = HOSTID and name = 'orig.url';
mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
</programlisting>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>
<title>Changing the Secondary Storage IP Address</title>
<para>You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server:</para>
<programlisting>
# mysql -p
mysql> use cloud;
mysql> select id from host where type = 'SecondaryStorage';
mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1'
where host_id = HOSTID and name = 'orig.url';
mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type
= 'SecondaryStorage' and id = #;
</programlisting>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
<para>Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone.</para>
</section>

83
docs/en-US/changing-service-offering-for-vm.xml
View File

@ -5,45 +5,50 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="changing-service-offering-for-vm">
<title>Changing the Service Offering for a VM</title>
<para>To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to work with.</para></listitem>
<listitem><para>Click the Stop button to stop the VM <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png" />
</imageobject>
<textobject><phrase>ChangeServiceButton.png: button to change the service of a VM</phrase></textobject>
</inlinemediaobject>. The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>
<title>Changing the Service Offering for a VM</title>
<para>To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to work with.</para></listitem>
<listitem><para>Click the Stop button to stop the VM.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png"/>
</imageobject>
<textobject>
<phrase>StopButton.png: button to stop a VM</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click the Change Service button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/change-service-icon.png"/>
</imageobject>
<textobject>
<phrase>ChangeServiceButton.png: button to change the service of a
VM</phrase>
</textobject>
</inlinemediaobject></para>
<para>The Change service dialog box is displayed.</para></listitem>
<listitem><para>Select the offering you want to apply to the selected VM.</para></listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

95
docs/en-US/changing-vm-name-os-group.xml
View File

@ -5,50 +5,55 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="changing-vm-name-os-group">
<title>Changing the VM Name, OS, or Group</title>
<para>After a VM is created, you can modify the display name, operating system, and the group it belongs to.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Select the VM that you want to modify.</para></listitem>
<listitem><para>Click the Stop button to stop the VM <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to stop a VM</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>StopButton.png: button to edit the properties of a VM</phrase></textobject>
</inlinemediaobject>.</para></listitem>
<listitem><para>Make the desired changes to the following:</para></listitem>
<listitem><para>Display name: Enter a new display name if you want to change the name of the VM.</para></listitem>
<listitem><para>OS Type: Select the desired operating system.</para></listitem>
<listitem><para>Group: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>
<title>Changing the VM Name, OS, or Group</title>
<para>After a VM is created, you can modify the display name, operating system, and the group it belongs to.</para>
<para>To access a VM through the &PRODUCT; UI:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Select the VM that you want to modify.</para></listitem>
<listitem><para>Click the Stop button to stop the VM. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/stop-instance-icon.png"/>
</imageobject>
<textobject>
<phrase>StopButton.png: button to stop a VM</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>Click Edit. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject>
<phrase>EditButton.png: button to edit the properties of a VM</phrase>
</textobject>
</inlinemediaobject></para></listitem>
<listitem><para>Make the desired changes to the following:</para></listitem>
<listitem><para><emphasis role="bold">Display name</emphasis>: Enter a new display name if you want to change
the name of the VM.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>: Select the desired operating system.</para></listitem>
<listitem><para><emphasis role="bold">Group</emphasis>: Enter the group name for the VM.</para></listitem>
<listitem><para>Click Apply.</para></listitem>
</orderedlist>
</section>

50
docs/en-US/cloud-infrastructure-concepts.xml
View File

@ -1,34 +1,34 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="cloud-infrastructure-concepts">
<chapter id="cloud-infrastructure-concepts">
<title>Cloud Infrastructure Concepts</title>
<xi:include href="about-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-pods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-physical-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<xi:include href="about-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-pods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-physical-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

75
docs/en-US/cloud-infrastructure-overview.xml
View File

@ -1,46 +1,47 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="cloud-infrastructure-overview">
<title>Cloud Infrastructure Overview</title>
<para>
The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows:
</para>
<itemizedlist>
<listitem><para>Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage.</para></listitem>
<listitem><para>Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters.</para></listitem>
<listitem><para>Cluster: A cluster consists of one or more hosts and primary storage.</para></listitem>
<listitem><para>Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines.</para></listitem>
<listitem><para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster.</para></listitem>
<listitem><para>Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots.</para></listitem>
</itemizedlist>
<mediaobject>
<imageobject>
<imagedata fileref="./images/infrastructure-overview.png" />
</imageobject>
<textobject><phrase>infrastructure_overview.png: Nested organization of a zone</phrase></textobject>
</mediaobject>
<para><emphasis role="bold">More Information</emphasis></para>
<para>For more information, see <xref linkend="cloud-infrastructure-concepts" />.</para>
<title>Cloud Infrastructure Overview</title>
<para>
The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows:
</para>
<itemizedlist>
<listitem><para>Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage.</para></listitem>
<listitem><para>Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters.</para></listitem>
<listitem><para>Cluster: A cluster consists of one or more hosts and primary storage.</para></listitem>
<listitem><para>Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines.</para></listitem>
<listitem><para>Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster.</para></listitem>
<listitem><para>Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots.</para></listitem>
</itemizedlist>
<mediaobject>
<imageobject>
<imagedata fileref="./images/infrastructure-overview.png" />
</imageobject>
<textobject><phrase>infrastructure-overview.png: Nested organization of a zone</phrase></textobject>
</mediaobject>
<para><emphasis role="bold">More Information</emphasis></para>
<para>For more information, see <xref linkend="cloud-infrastructure-concepts" />.</para>
</section>

59
docs/en-US/cloudstack_admin.xml
View File

@ -1,31 +1,52 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Book_Info_Admin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

39
docs/en-US/cluster-add.xml
View File

@ -1,28 +1,31 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="cluster-add">
<title>Adding a Cluster</title>
<para>TODO</para>
<title>Adding a Cluster</title>
<para>You need to tell &PRODUCT; about the hosts that it will manage. Hosts exist inside clusters, so before you begin adding hosts to the cloud, you must add at least one cluster.</para>
<xi:include href="add-clusters-kvm-xenserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-clusters-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-clusters-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

40
docs/en-US/compute-disk-service-offerings.xml
View File

@ -5,33 +5,32 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="compute-disk-service-offerings">
<title>Compute and Disk Service Offerings</title>
<para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The CloudPlatform administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements:</para>
<para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The &PRODUCT; administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements:</para>
<itemizedlist>
<listitem><para>CPU, memory, and network resource guarantees</para></listitem>
<listitem><para>How resources are metered</para></listitem>
<listitem><para>How the resource usage is charged</para></listitem>
<listitem><para>How often the charges are generated</para></listitem>
</itemizedlist>
<para>For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel Core 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, CloudPlatform emits usage records that can be integrated with billing systems. CloudPlatform separates service offerings into compute offerings and disk offerings. The computing service offering specifies:</para>
<para>For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel® Core™ 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, &PRODUCT; emits usage records that can be integrated with billing systems. &PRODUCT; separates service offerings into compute offerings and disk offerings. The computing service offering specifies:</para>
<itemizedlist>
<listitem><para>Guest CPU</para></listitem>
<listitem><para>Guest RAM</para></listitem>
@ -43,4 +42,9 @@
<listitem><para>Disk size (optional). An offering without a disk size will allow users to pick their own</para></listitem>
<listitem><para>Tags on the data disk</para></listitem>
</itemizedlist>
<xi:include href="creating-compute-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-disk-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="modify-delete-service-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

41
docs/en-US/concepts.xml
View File

@ -1,30 +1,29 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<chapter id="concepts">
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feature-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deployment-architecture-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Concepts</title>
<xi:include href="whatis.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feature-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deployment-architecture-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

88
docs/en-US/configure-guest-traffic-in-advanced-zone.xml
View File

@ -5,46 +5,52 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="configure-guest-traffic-in-advanced-zone">
<title>Configure Guest Traffic in an Advanced Zone</title>
<para>These steps assume you have already logged in to the &PRODUCT; UI. To configure the base guest network:</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network.</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>Click Add network.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Name. The name of the network. This will be user-visible</para></listitem>
<listitem><para>Description: The description of the network. This will be user-visible</para></listitem>
<listitem><para>VLAN ID: Enter an administrator-configured VLAN ID so you can create different networks for use by different VM users in the zone</para></listitem>
<listitem><para>Scope: Choose account-specific or domain-specific if you would like to make the network accessible to only a single account or domain. Choose zone-wide if all accounts with access to the zone should be able to access the network.</para></listitem>
<listitem><para>Domain/Account: If Scope is account-specific, enter the domain and account name for the account</para></listitem>
<listitem><para>Network offering: If the administrator has configured multiple network offerings, select the one you want to use for this network</para></listitem>
<listitem><para>Gateway: The gateway that the guests should use</para></listitem>
<listitem><para>Netmask: The netmask in use on the subnet the guests will use</para></listitem>
<listitem><para>Start IP/End IP: Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. If multiple NICs are used, they may be in a different subnet.</para></listitem>
<listitem><para>Network Domain: (Optional) If you want to assign a special domain name to this network, specify the DNS suffix.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>
<title>Configure Guest Traffic in an Advanced Zone</title>
<para>These steps assume you have already logged in to the &PRODUCT; UI. To configure the base guest network:</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network.</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>Click Add guest network.</para>
<para>The Add guest network window is displayed:</para><mediaobject>
<imageobject>
<imagedata fileref="./images/add-guest-network.png" />
</imageobject>
<textobject>
<phrase>networksetupzone.png: Depicts network setup in a single zone</phrase>
</textobject>
</mediaobject></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name</emphasis>. The name of the network. This will be
user-visible</para></listitem>
<listitem><para><emphasis role="bold">Display Text</emphasis>: The description of the network. This will be
user-visible</para></listitem>
<listitem><para><emphasis role="bold">Zone</emphasis>: The zone in which you are configuring the guest network.</para></listitem>
<listitem><para><emphasis role="bold">Network offering</emphasis>: If the administrator has configured
multiple network offerings, select the one you want to use for this
network</para></listitem>
<listitem><para><emphasis role="bold">Guest Gateway</emphasis>: The gateway that the guests should use</para></listitem>
<listitem><para><emphasis role="bold">Guest Netmask</emphasis>: The netmask in use on the subnet the guests
will use</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

47
docs/en-US/configure-usage-server.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="configure-usage-server">
<title>Configuring the Usage Server</title>
<para>To configure the usage server:</para>
@ -54,17 +53,17 @@
<row>
<entry><para>usage.aggregation.timezone</para></entry>
<entry><para>Time zone of usage records. Set this if the usage records and daily job execution are in different time zones. For example, with the following settings, the usage job will run at PST 00:15 and generate usage records for the 24 hours from 00:00:00 GMT to 23:59:59 GMT:</para>
<programlisting>usage.stats.job.exec.time = 00:15
<programlisting>usage.stats.job.exec.time = 00:15
usage.execution.timezone = PST
usage.aggregation.timezone = GMT
</programlisting>
<para>Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<para>Valid values for the time zone are specified in <xref linkend="time-zones"/></para>
<para>Default: GMT</para>
</entry>
</row>
<row>
<entry><para>usage.execution.timezone</para></entry>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="appendix-a-time-zones"/></para>
<entry><para>The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in <xref linkend="time-zones"/></para>
<para>Default: The time zone of the management server.</para>
</entry>
</row>
@ -75,13 +74,13 @@ usage.aggregation.timezone = GMT
<row>
<entry><para>usage.stats.job.aggregation.range</para></entry>
<entry><para>The time period in minutes between Usage Server processing jobs. For example, if you set it to 1440, the Usage Server will run once per day. If you set it to 600, it will run every ten hours. In general, when a Usage Server job runs, it processes all events generated since usage was last run.</para>
<para>There is special handling for the case of 1440 (once per day). In this case the Usage Server does not necessarily process all records since Usage was last run. &PRODUCT; assumes that you require processing once per day for the previous, complete day’s records. For example, if the current day is October 7, then it is assumed you would like to process records for October 6, from midnight to midnight. &PRODUCT; assumes this "midnight to midnight" is relative to the usage.execution.timezone.</para>
<para>There is special handling for the case of 1440 (once per day). In this case the Usage Server does not necessarily process all records since Usage was last run. &PRODUCT; assumes that you require processing once per day for the previous, complete day’s records. For example, if the current day is October 7, then it is assumed you would like to process records for October 6, from midnight to midnight. &PRODUCT; assumes this “midnight to midnight” is relative to the usage.execution.timezone.</para>
<para>Default: 1440</para>
</entry>
</row>
<row>
<entry><para>usage.stats.job.exec.time</para></entry>
<entry><para>The time when the Usage Server processing will start. It is specified in 24-hour format (HH:MM) in the time zone of the server, which should be GMT. For example, to start the Usage job at 10:30 GMT, enter "10:30".</para>
<entry><para>The time when the Usage Server processing will start. It is specified in 24-hour format (HH:MM) in the time zone of the server, which should be GMT. For example, to start the Usage job at 10:30 GMT, enter “10:30”.</para>
<para>If usage.stats.job.aggregation.range is also set, and its value is not 1440, then its value will be added to usage.stats.job.exec.time to get the time to run the Usage Server job again. This is repeated until 24 hours have elapsed, and the next day's processing begins again at usage.stats.job.exec.time.</para>
<para>Default: 00:15.</para>
</entry>
@ -97,5 +96,9 @@ usage.aggregation.timezone = GMT
<listitem><para>usage.stats.job.aggregation.range = 1440</para></listitem>
</itemizedlist>
<para>With this configuration, the Usage job will run every night at 2 AM EST and will process records for the previous day’s midnight-midnight as defined by the EST (America/New_York) time zone.</para>
<note><para>Because the special value 1440 has been used for usage.stats.job.aggregation.range, the Usage Server will ignore the data between midnight and 2 AM. That data will be included in the next day's run</para></note>
<note><para>Because the special value 1440 has been used for usage.stats.job.aggregation.range, the Usage
Server will ignore the data between midnight and 2 AM. That data will be included in the
next day's run.</para>
</note>
<para></para>
</section>

87
docs/en-US/configure-vpn.xml
View File

@ -5,48 +5,49 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="configure-vpn">
<title>Configuring VPN</title>
<para>To set up VPN for the cloud:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, click Global Settings.</para></listitem>
<listitem><para>Set the following global configuration parameters.</para>
<itemizedlist>
<listitem><para>remote.access.vpn.client.ip.range – The range of IP addressess to be allocated to remote access VPN clients. The first IP in the range is used by the VPN server.</para></listitem>
<listitem><para>remote.access.vpn.psk.length – Length of the IPSec key.</para></listitem>
<listitem><para>remote.access.vpn.user.limit – Maximum number of VPN users per account.</para></listitem>
</itemizedlist></listitem></orderedlist>
<para>To enable VPN for a particular network:</para>
<orderedlist>
<listitem><para>Log in as a user or administrator to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation, click Network.</para></listitem>
<listitem><para>Click the name of the network you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click one of the displayed IP address names.</para></listitem>
<listitem><para>Click the Enable VPN button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/vpn-icon.png" />
</imageobject>
<textobject><phrase>AttachDiskButton.png: button to attach a volume</phrase></textobject>
</inlinemediaobject>.</para>
<para>The IPsec key is displayed in a popup window.</para></listitem>
</orderedlist>
<title>Configuring VPN</title>
<para>To set up VPN for the cloud:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, click Global Settings.</para></listitem>
<listitem><para>Set the following global configuration parameters.</para>
<itemizedlist>
<listitem><para>remote.access.vpn.client.ip.range – The range of IP addressess to be allocated to remote access VPN clients. The first IP in the range is used by the VPN server.</para></listitem>
<listitem><para>remote.access.vpn.psk.length – Length of the IPSec key.</para></listitem>
<listitem><para>remote.access.vpn.user.limit – Maximum number of VPN users per account.</para></listitem>
</itemizedlist></listitem></orderedlist>
<para>To enable VPN for a particular network:</para>
<orderedlist>
<listitem><para>Log in as a user or administrator to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation, click Network.</para></listitem>
<listitem><para>Click the name of the network you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click one of the displayed IP address names.</para></listitem>
<listitem><para>Click the Enable VPN button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/vpn-icon.png"/>
</imageobject>
<textobject>
<phrase>AttachDiskButton.png: button to attach a volume</phrase>
</textobject>
</inlinemediaobject></para>
<para>The IPsec key is displayed in a popup window.</para></listitem>
</orderedlist>
</section>

33
docs/en-US/console-proxy.xml
View File

@ -5,21 +5,21 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="console-proxy">
@ -32,4 +32,5 @@
<para>Assignment of guest VM to console proxy is determined by first determining if the guest VM has a previous session associated with a console proxy. If it does, the Management Server will assign the guest VM to the target Console Proxy VM regardless of the load on the proxy VM. Failing that, the first available running Console Proxy VM that has the capacity to handle new sessions is used.</para>
<para>Console proxies can be restarted by administrators but this will interrupt existing console sessions for users.</para>
<para>The console viewing functionality uses a dynamic DNS service under the domain name realhostip.com to assist in providing SSL security to console sessions. The console proxy is assigned a public IP address. In order to avoid browser warnings for mismatched SSL certificates, the URL for the new console window is set to the form of https://aaa-bbb-ccc-ddd.realhostip.com. Customers will see this URL during console session creation. &PRODUCT; includes the realhostip.com SSL certificate in the console proxy VM. Of course, &PRODUCT; cannot know about DNS A records for our customers' public IPs prior to shipping the software. &PRODUCT; therefore runs a dynamic DNS server that is authoritative for the realhostip.com domain. It maps the aaa-bbb-ccc-ddd part of the DNS name to the IP address aaa.bbb.ccc.ddd on lookups. This allows the browser to correctly connect to the console proxy's public IP, where it then expects and receives a SSL certificate for realhostip.com, and SSL is set up without browser warnings.</para>
</section>
<xi:include href="change-console-proxy-ssl-certificate-domain.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

117
docs/en-US/convert-hyperv-vm-to-template.xml
View File

@ -5,64 +5,65 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="convert-hyperv-vm-to-template">
<title>Converting a Hyper-V VM to a Template</title>
<para>To convert a Hyper-V VM to a XenServer-compatible &PRODUCT; template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with &PRODUCT;, but use XenCenter 5.6 FP1 or SP2 (it is backwards compatible to 5.6). Additionally, it may help to have an attached NFS ISO SR.</para>
<para>For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab:</para>
<orderedlist>
<listitem><para>From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files).</para></listitem>
<listitem><para>Restore the original initrd from backup in /boot/ (the backup is named *.backup0).</para></listitem>
<listitem><para>Remove the "hdX=noprobe" entries from /boot/grub/menu.lst.</para></listitem>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to mount by LABEL or UUID (get that information with the "blkid" command)..</para></listitem>
</orderedlist>
<para>The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this.</para>
<para>Option one:</para>
<orderedlist>
<listitem><para>Import the VHD using XenCenter. In XenCenter, go to Tools&gt;Virtual Appliance Tools&gt;Disk Image Import.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR.</para></listitem>
<listitem><para>Click Next, then Finish. A VM should be created.</para></listitem>
</orderedlist>
<para>Option two</para>
<orderedlist>
<listitem><para>Run XenConvert, under From choose VHD, under To choose XenServer. Click Next.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Input the XenServer host info, then click Next.</para></listitem>
<listitem><para>Name the VM, then click Next, then Convert. A VM should be created</para></listitem>
</orderedlist>
<para>Once you have a VM created from the Hyper-V VHD, prepare it using the following steps:</para>
<orderedlist>
<listitem><para>Boot the VM, uninstall Hyper-V Integration Services, and reboot.</para></listitem>
<listitem><para>Install XenServer Tools, then reboot.</para></listitem>
<listitem><para>Prepare the VM as desired. For example, run sysprep on Windows VMs. See <xref linkend="create-windows-template"/></para></listitem>
</orderedlist>
<para>Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution.</para>
<orderedlist>
<listitem><para>Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server.</para></listitem>
<listitem><para>In &PRODUCT;, create a new template using the following values:</para>
<itemizedlist>
<listitem><para>URL. Give the URL for the VHD</para></listitem>
<listitem><para>OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer.</para></listitem>
<listitem><para>Hypervisor. XenServer</para></listitem>
<listitem><para>Format. VHD</para></listitem>
</itemizedlist></listitem>
</orderedlist>
<para>The template will be created, and you can create instances from it.</para>
<title>Converting a Hyper-V VM to a Template</title>
<para>To convert a Hyper-V VM to a XenServer-compatible &PRODUCT; template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with &PRODUCT;, but use XenCenter 5.6 FP1 or SP2 (it is backwards compatible to 5.6). Additionally, it may help to have an attached NFS ISO SR.</para>
<para>For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab:</para>
<orderedlist>
<listitem><para>From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files).</para></listitem>
<listitem><para>Restore the original initrd from backup in /boot/ (the backup is named *.backup0).</para></listitem>
<listitem><para>Remove the "hdX=noprobe" entries from /boot/grub/menu.lst.</para></listitem>
<listitem><para>Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to
mount by LABEL or UUID. You can get that information with the blkid command.</para></listitem>
</orderedlist>
<para>The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this.</para>
<para>Option one:</para>
<orderedlist>
<listitem><para>Import the VHD using XenCenter. In XenCenter, go to Tools&gt;Virtual Appliance Tools&gt;Disk Image Import.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR.</para></listitem>
<listitem><para>Click Next, then Finish. A VM should be created.</para></listitem>
</orderedlist>
<para>Option two:</para>
<orderedlist>
<listitem><para>Run XenConvert, under From choose VHD, under To choose XenServer. Click Next.</para></listitem>
<listitem><para>Choose the VHD, then click Next.</para></listitem>
<listitem><para>Input the XenServer host info, then click Next.</para></listitem>
<listitem><para>Name the VM, then click Next, then Convert. A VM should be created.</para></listitem>
</orderedlist>
<para>Once you have a VM created from the Hyper-V VHD, prepare it using the following steps:</para>
<orderedlist>
<listitem><para>Boot the VM, uninstall Hyper-V Integration Services, and reboot.</para></listitem>
<listitem><para>Install XenServer Tools, then reboot.</para></listitem>
<listitem><para>Prepare the VM as desired. For example, run sysprep on Windows VMs. See <xref linkend="create-windows-template"/>.</para></listitem>
</orderedlist>
<para>Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution.</para>
<orderedlist>
<listitem><para>Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server.</para></listitem>
<listitem><para>In &PRODUCT;, create a new template using the following values:</para>
<itemizedlist>
<listitem><para>URL. Give the URL for the VHD</para></listitem>
<listitem><para>OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer.</para></listitem>
<listitem><para>Hypervisor. XenServer</para></listitem>
<listitem><para>Format. VHD</para></listitem>
</itemizedlist></listitem>
</orderedlist>
<para>The template will be created, and you can create instances from it.</para>
</section>

87
docs/en-US/create-template-from-existing-vm.xml
View File

@ -5,45 +5,52 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="create-template-from-existing-vm">
<title>Creating a Template from an Existing Virtual Machine</title>
<para>Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs.</para>
<orderedlist>
<listitem><para>Create and start a virtual machine using any of the techniques given in <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Make any desired configuration changes on the running VM, then click Stop.</para></listitem>
<listitem><para>Wait for the VM to stop. When the status shows Stopped, go to the next step.</para></listitem>
<listitem><para>Click Create Template and provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so choose something descriptive.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
<listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para></listitem>
<listitem><para>If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere:</para>
<note><para>Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all users of this &PRODUCT; installation. The template will appear in the Community Templates list. See <xref linkend="private-public-template"/>.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the &PRODUCT; password change script installed. See Adding Password Management to Your Templates.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
<para>The new template will be visible in the Templates section when the template creation process has been completed. The template is then available when creating a new VM</para>
<title>Creating a Template from an Existing Virtual Machine</title>
<para>Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs.</para>
<orderedlist>
<listitem><para>Create and start a virtual machine using any of the techniques given in <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Make any desired configuration changes on the running VM, then click Stop.</para></listitem>
<listitem><para>Wait for the VM to stop. When the status shows Stopped, go to the next step.</para></listitem>
<listitem><para>Click Create Template and provide the following:</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so
choose something descriptive.</para></listitem>
<listitem><para><emphasis role="bold">OS Type</emphasis>. This helps &PRODUCT; and the hypervisor perform
certain operations and make assumptions that improve the performance of the
guest. Select one of the following.</para>
<itemizedlist>
<listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
<listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para></listitem>
<listitem><para>If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere:</para>
<note><para>Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
users of this &PRODUCT; installation. The template will appear in the
Community Templates list. See <xref linkend="private-public-template"
/>.</para></listitem>
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the
&PRODUCT; password change script installed. See <xref linkend="add-password-management-to-templates"/>.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
<para>The new template will be visible in the Templates section when the template creation process
has been completed. The template is then available when creating a new VM.</para>
</section>

38
docs/en-US/create-template-from-snapshot.xml
View File

@ -5,25 +5,27 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="create-template-from-snapshot">
<title>Creating a Template from a Snapshot</title>
<note><para>Not supported by Oracle VM</para></note>
<para>If you do not want to stop the VM in order to use the Create Template menu item (as described in <xref linkend="create-template-from-existing-vm"/>), you can create a template directly from any snapshot through the &PRODUCT; UI.</para>
<note><para>Not supported by Oracle VM.</para></note>
<para></para>
<para>If you do not want to stop the VM to use the Create Template menu item, as described in
<xref linkend="create-template-from-existing-vm"/>), you can create a template directly
from any snapshot through the &PRODUCT; UI.</para>
</section>

52
docs/en-US/create-templates-overview.xml
View File

@ -5,31 +5,33 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="create-templates-overview">
<title>Creating Templates: Overview</title>
<para>&PRODUCT; ships with a default template for the CentOS operating system. There are a variety of ways to add more templates. Administrators and end users can add templates. The typical sequence of events is:</para>
<orderedlist>
<listitem><para>Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM.</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Convert the volume into a template.</para></listitem>
</orderedlist>
<para>There are other ways to add templates to &PRODUCT;. For example, you can take a snapshot of the VM's volume and create a template from the snapshot, or import a VHD from another system into &PRODUCT;</para>
<para>The various techniques for creating templates are described in the next few sections.</para>
<title>Creating Templates: Overview</title>
<para>&PRODUCT; ships with a default template for the CentOS operating system. There are a variety of ways to add more templates. Administrators and end users can add templates. The typical sequence of events is:</para>
<orderedlist>
<listitem><para>Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM.</para></listitem>
<listitem><para>Stop the VM.</para></listitem>
<listitem><para>Convert the volume into a template.</para></listitem>
</orderedlist>
<para>There are other ways to add templates to &PRODUCT;. For example, you can take a snapshot
of the VM's volume and create a template from the snapshot, or import a VHD from another
system into &PRODUCT;.</para>
<para>The various techniques for creating templates are described in the next few sections.</para>
</section>

58
docs/en-US/create-windows-template.xml
View File

@ -5,34 +5,36 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="create-windows-template">
<title>Creating a Windows Template</title>
<para>Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts.</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
<para>An overview of the procedure is as follows:</para>
<orderedlist>
<listitem><para>Upload your Windows ISO.</para> <para>For more information, see <xref linkend="add-iso"/></para></listitem>
<listitem><para>Create a VM Instance with this ISO.</para><para> For more information, see <xref linkend="creating-vms"/></para></listitem>
<listitem><para>Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server</para></listitem>
<listitem><para>The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template.</para></listitem>
</orderedlist>
<xi:include href="sysprep-windows-server-2008R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sysprep-for-windows-server-2003R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<title>Creating a Windows Template</title>
<para>Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts.</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para>
</note>
<para></para>
<para>An overview of the procedure is as follows:</para>
<orderedlist>
<listitem><para>Upload your Windows ISO.</para> <para>For more information, see <xref linkend="add-iso"/>.</para></listitem>
<listitem><para>Create a VM Instance with this ISO.</para><para> For more information, see <xref linkend="creating-vms"/>.</para></listitem>
<listitem><para>Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server</para></listitem>
<listitem><para>The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template.</para></listitem>
</orderedlist>
<xi:include href="sysprep-windows-server-2008R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sysprep-for-windows-server-2003R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

74
docs/en-US/creating-compute-offerings.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="creating-compute-offerings">
<title>Creating a New Compute Offering</title>
<para>To create a new compute offering:</para>
@ -32,19 +31,36 @@
<listitem><para>Click Add Compute Offering.</para></listitem>
<listitem><para>In the dialog, make the following choices:</para>
<itemizedlist>
<listitem><para>Name. Any desired name for the service offering.</para></listitem>
<listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
<listitem><para>Storage type. The type of disk that should be allocated. Local allocates from storage attached directly to the host where the system VM is running. Shared allocates from storage accessible via NFS.</para></listitem>
<listitem><para># of CPU cores. The number of cores which should be allocated to a system VM with this offering</para></listitem>
<listitem><para>CPU (in MHz). The CPU speed of the cores that the system VM is allocated. For example, "2000" would provide for a 2 GHz clock.</para></listitem>
<listitem><para>Memory (in MB). The amount of memory in megabytes that the system VM should be allocated. For example, "2048" would provide for a 2 GB RAM allocation.</para></listitem>
<listitem><para>Network Rate. Allowed data transfer rate in MB per second.</para></listitem>
<listitem><para>Offer HA. If yes, the administrator can choose to have the system VM be monitored and as highly available as possible.</para></listitem>
<listitem><para>Storage Tags. The tags that should be associated with the primary storage used by the system VM.</para></listitem>
<listitem><para>Host Tags. (Optional) Any tags that you use to organize your hosts</para></listitem>
<listitem><para>CPU cap. Whether to limit the level of CPU usage even if spare capacity is available.</para></listitem>
<listitem><para>Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for the subdomain's name.</para></listitem>
<listitem><para><emphasis role="bold">Name</emphasis>: Any desired name for the service offering.</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>: A short description of the offering that can be
displayed to users</para></listitem>
<listitem><para><emphasis role="bold">Storage type</emphasis>: The type of disk that should be allocated.
Local allocates from storage attached directly to the host where the system
VM is running. Shared allocates from storage accessible via NFS.</para></listitem>
<listitem><para><emphasis role="bold"># of CPU cores</emphasis>: The number of cores which should be allocated
to a system VM with this offering</para></listitem>
<listitem><para><emphasis role="bold">CPU (in MHz)</emphasis>: The CPU speed of the cores that the system VM
is allocated. For example, “2000” would provide for a 2 GHz clock.</para></listitem>
<listitem><para><emphasis role="bold">Memory (in MB)</emphasis>: The amount of memory in megabytes that the
system VM should be allocated. For example, “2048” would provide for a 2 GB
RAM allocation.</para></listitem>
<listitem><para><emphasis role="bold">Network Rate</emphasis>: Allowed data transfer rate in MB per
second.</para></listitem>
<listitem><para><emphasis role="bold">Offer HA</emphasis>: If yes, the administrator can choose to have the
system VM be monitored and as highly available as possible.</para></listitem>
<listitem><para><emphasis role="bold">Storage Tags</emphasis>: The tags that should be associated with the
primary storage used by the system VM.</para></listitem>
<listitem><para><emphasis role="bold">Host Tags</emphasis>: (Optional) Any tags that you use to organize your
hosts</para></listitem>
<listitem><para><emphasis role="bold">CPU cap</emphasis>: Whether to limit the level of CPU usage even if
spare capacity is available.</para></listitem>
<listitem><para><emphasis role="bold">Public</emphasis>: Indicate whether the service offering should be
available all domains or only some domains. Choose Yes to make it available
to all domains. Choose No to limit the scope to a subdomain; &PRODUCT;
will then prompt for the subdomain's name.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

122
docs/en-US/creating-network-offerings.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="creating-network-offerings">
<title>Creating a New Network Offering</title>
<para>To create a network offering:</para>
@ -32,13 +31,23 @@
<listitem><para>Click Add Network Offering.</para></listitem>
<listitem><para>In the dialog, make the following choices:</para>
<itemizedlist>
<listitem><para>Name. Any desired name for the network offering</para></listitem>
<listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
<listitem><para>Network Rate. Allowed data transfer rate in MB per second</para></listitem>
<listitem><para>Traffic Type. The type of network traffic that will be carried on the network</para></listitem>
<listitem><para>Guest Type. Choose whether the guest network is isolated or shared. For a description of these terms, see <xref linkend="about-virtual-networks"/> </para></listitem>
<listitem><para>Specify VLAN. (Isolated guest networks only) Indicate whether a VLAN should be specified when this offering is used</para></listitem>
<listitem><para>Supported Services. Select one or more of the possible network services. For some services, you must also choose the service provider; for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud. Depending on which services you choose, additional fields may appear in the rest of the dialog box.</para><para>Based on the guest network type selected, you can see the following supported services:</para><informaltable>
<listitem><para><emphasis role="bold">Name</emphasis>. Any desired name for the network offering</para></listitem>
<listitem><para><emphasis role="bold">Description</emphasis>. A short description of the offering that can be
displayed to users</para></listitem>
<listitem><para><emphasis role="bold">Network Rate</emphasis>. Allowed data transfer rate in MB per
second</para></listitem>
<listitem><para><emphasis role="bold">Guest Type</emphasis>. Choose whether the guest network is isolated or
shared. For a description of these terms, see <xref
linkend="about-virtual-networks"/>
</para></listitem>
<listitem><para><emphasis role="bold">Specify VLAN</emphasis>. (Isolated guest networks only) Indicate whether
a VLAN should be specified when this offering is used</para></listitem>
<listitem><para><emphasis role="bold">Supported Services</emphasis>. Select one or more of the possible
network services. For some services, you must also choose the service
provider; for example, if you select Load Balancer, you can choose the
&PRODUCT; virtual router or any other load balancers that have been
configured in the cloud. Depending on which services you choose, additional
fields may appear in the rest of the dialog box.</para><para>Based on the guest network type selected, you can see the following supported services:</para><informaltable>
<tgroup cols="4" align="left" colsep="1" rowsep="1">
<thead>
<row>
@ -51,55 +60,68 @@
<tbody>
<row>
<entry><para>DHCP</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>DNS</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Load Balancer</para></entry>
<entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud.</para></entry>
<entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load
balancers that have been configured in the cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Source NAT</para></entry>
<entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source NAT providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source
NAT providers that have been configured in the
cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Static NAT</para></entry>
<entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static NAT providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static
NAT providers that have been configured in the
cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Port Forwarding</para></entry>
<entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other Port Forwarding providers that have been configured in the cloud.</para></entry>
<entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other
Port Forwarding providers that have been configured in
the cloud.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>VPN</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="vpn"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>User Data</para></entry>
<entry><para></para></entry>
<entry><para>For more information, see <xref linkend="user-data-and-meta-data"/>.</para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Network ACL</para></entry>
<entry><para>For more information, see <xref linkend="configure-acl"/>.</para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>Security Groups</para></entry>
<entry><para>See <xref linkend="add-security-group"/>.</para></entry>
<entry><para>For more information, see <xref linkend="add-security-group"/>.</para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
@ -107,11 +129,39 @@
</tgroup>
</informaltable>
</listitem>
<listitem><para>System Offering. If the service provider for any of the services selected in Supported Services is a virtual router, the System Offering field appears. Choose the system service offering that you want virtual routers to use in this network. For example, if you selected Load Balancer in Supported Services and selected a virtual router to provide load balancing, the System Offering field appears so you can choose between the &PRODUCT; default system service offering and any custom system service offerings that have been defined by the &PRODUCT; root administrator. For more information, see System Service Offerings.</para></listitem>
<listitem><para>Redundant router capability. (v3.0.3 and greater) Available only when Virtual Router is selected as the Source NAT provider. Select this option if you want to use two virtual routers in the network for uninterrupted connection: one operating as the master virtual router and the other as the backup. The master virtual router receives requests from and sends responses to the user’s VM. The backup virtual router is activated only when the master is down. After the failover, the backup becomes the master virtual router. &PRODUCT; deploys the routers on different hosts to ensure reliability if one host is down.</para></listitem>
<listitem><para>Conserve mode. Indicate whether to use conserve mode. In this mode, network resources are allocated only when the first virtual machine starts in the network</para></listitem>
<listitem><para>Tags. Network tag to specify which physical network to use</para></listitem>
<listitem><para><emphasis role="bold">System Offering</emphasis>. If the service provider for any of the
services selected in Supported Services is a virtual router, the System
Offering field appears. Choose the system service offering that you want
virtual routers to use in this network. For example, if you selected Load
Balancer in Supported Services and selected a virtual router to provide load
balancing, the System Offering field appears so you can choose between the
&PRODUCT; default system service offering and any custom system service
offerings that have been defined by the &PRODUCT; root administrator.
For more information, see System Service Offerings.</para></listitem>
<listitem><para><emphasis role="bold">Redundant router capability</emphasis>. (v3.0.3 and greater) Available
only when Virtual Router is selected as the Source NAT provider. Select this
option if you want to use two virtual routers in the network for
uninterrupted connection: one operating as the master virtual router and the
other as the backup. The master virtual router receives requests from and
sends responses to the user’s VM. The backup virtual router is activated
only when the master is down. After the failover, the backup becomes the
master virtual router. &PRODUCT; deploys the routers on different hosts
to ensure reliability if one host is down.</para></listitem>
<listitem><para><emphasis role="bold">Conserve mode</emphasis>. Indicate whether to use conserve mode. In this
mode, network resources are allocated only when the first virtual machine
starts in the network. When the conservative mode is off, the public IP can
only be used for a single service. For example, a public IP used for a port
forwarding rule cannot be used for defining other services, such as SaticNAT
or load balancing. When the conserve mode is on, you can define more than
one service on the same public IP.</para>
<note><para>If StaticNAT is enabled, irrespective of the status of the conserve mode, no port forwarding
or load balancing rule can be created for the IP. However, you can add
the firewall rules by using the createFirewallRule command.</para></note></listitem>
<listitem><para><emphasis role="bold">Tags</emphasis>. Network tag to specify which physical network to
use.</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

88
docs/en-US/creating-new-volumes.xml
View File

@ -5,37 +5,59 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="creating-new-volumes">
<title>Creating a New Volume</title>
<para>You can add more data disk volumes to a guest VM at any time, up to the limits of your storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it when the first attachment is made.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>To create a new volume, click Add Volume, provide the following details, and click OK.</para>
<itemizedlist>
<listitem><para>Name. Give the volume a unique name so you can find it later.</para></listitem>
<listitem><para>Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume.</para></listitem>
<listitem><para>Disk Offering. Choose the characteristics of the storage.</para></listitem>
</itemizedlist>
<para>The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use</para></listitem>
<listitem><para>To start using the volume, continue to Attaching a Volume </para></listitem>
</orderedlist>
</section>
<title>Creating a New Volume</title>
<para>You can add more data disk volumes to a guest VM at any time, up to the limits of your storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it when the first attachment is made.</para>
<section id="local-storage-data-volumes">
<title>Using Local Storage for Data Volumes</title>
<para>You can create data volumes on local storage (supported with XenServer, KVM, and VMware).
The data volume is placed on the same
host as the VM instance that is attached to the data volume. These
local data volumes can be attached to virtual machines, detached, re-attached,
and deleted just as with the other types of data volume.</para>
<para>Local storage is ideal for scenarios where persistence of data volumes and HA
is not required. Some of the benefits include reduced disk I/O latency and cost
reduction from using inexpensive local disks.</para>
<para>In order for local volumes to be used, the feature must be enabled for the
zone.</para>
<para>You can create a data disk offering for local storage. When a user creates a
new VM, they can select this disk offering in order to cause the data disk
volume to be placed in local storage.</para>
<para>You can not migrate a VM that has a volume in local storage to a different
host, nor migrate the volume itself away to a different host. If you want to put
a host into maintenance mode, you must first stop any VMs with local data
volumes on that host.</para>
</section>
<section id="creating-new-volume-steps">
<title>To Create a New Volume</title>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
<listitem><para>In Select View, choose Volumes.</para></listitem>
<listitem><para>To create a new volume, click Add Volume, provide the following details, and click OK.</para>
<itemizedlist>
<listitem><para>Name. Give the volume a unique name so you can find it later.</para></listitem>
<listitem><para>Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume.</para></listitem>
<listitem><para>Disk Offering. Choose the characteristics of the storage.</para></listitem>
</itemizedlist>
<para>The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use</para></listitem>
<listitem><para>To start using the volume, continue to Attaching a Volume </para></listitem>
</orderedlist>
</section>
</section>

86
docs/en-US/creating-vms.xml
View File

@ -3,47 +3,53 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="creating-vms">
<title>Creating VMs</title>
<para>Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM.</para>
<para>To create a VM from a template:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem><para>Click Add Instance.</para></listitem>
<listitem><para>Select a template, then follow the steps in the wizard. (For more information about how the templates came to be in this list, see Working with Templates.</para></listitem>
<listitem><para>Be sure that the hardware you have allows starting the selected service offering.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para>
<note><para>For security reason, the internal name of the VM is visible only to the root admin.</para></note></listitem>
</orderedlist>
<note><para>Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide</para></note>
<para>To create a VM from an ISO:</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem><para>Click Add Instance.</para></listitem>
<listitem><para>Select ISO Boot, and follow the steps in the wizard.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para></listitem>
<listitem><para>(Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the &PRODUCT; UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM.</para></listitem>
</orderedlist>
<title>Creating VMs</title>
<para>Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM.</para>
<note><para>Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide</para></note>
<para>To create a VM from a template:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem>
<para>Click Add Instance.</para>
</listitem>
<listitem>
<para>Select a zone.</para>
</listitem>
<listitem><para>Select a template, then follow the steps in the wizard. For more information about how the templates came to be in this list, see <xref linkend="working-with-templates"/>.</para></listitem>
<listitem><para>Be sure that the hardware you have allows starting the selected service offering.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para>
<note><para>For security reason, the internal name of the VM is visible only to the root admin.</para></note>
</listitem>
</orderedlist>
<para>To create a VM from an ISO:</para>
<note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para></note>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user.</para></listitem>
<listitem><para>In the left navigation bar, click Instances.</para></listitem>
<listitem><para>Click Add Instance.</para></listitem>
<listitem><para>Select a zone.</para></listitem>
<listitem><para>Select ISO Boot, and follow the steps in the wizard.</para></listitem>
<listitem><para>Click Submit and your VM will be created and started.</para></listitem>
<listitem><para>(Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the &PRODUCT; UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM.</para></listitem>
</orderedlist>
</section>

53
docs/en-US/default-account-resource-limit.xml
View File

@ -5,36 +5,41 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="default-account-resource-limit">
<title>Default Account Resource Limits</title>
<para>You can limit resource use by accounts. The default limits are set using global configuration parameters, and they affect all accounts within a cloud. The relevant parameters are those beginning with max.account (max.account.snapshots, etc.)..</para>
<para>You can limit resource use by accounts. The default limits are set by using global
configuration parameters, and they affect all accounts within a cloud. The relevant
parameters are those beginning with max.account, for example: max.account.snapshots.</para>
<para>To override a default limit for a particular account, set a per-account resource limit.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation tree, click Accounts.</para></listitem>
<listitem><para>Select the account you want to modify. The current limits are displayed. A value of -1 shows that there is no limit in place</para></listitem>
<listitem><para>Click the Edit button<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png" />
</imageobject>
<textobject><phrase>editbutton.png: edits the settings.</phrase></textobject>
</inlinemediaobject></para></listitem>
<listitem><para>Select the account you want to modify. The current limits are displayed. A value of -1 shows
that there is no limit in place.</para></listitem>
<listitem><para>Click the Edit button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/edit-icon.png"/>
</imageobject>
<textobject>
<phrase>editbutton.png: edits the settings</phrase>
</textobject>
</inlinemediaobject></para></listitem>
</orderedlist>
</section>

66
docs/en-US/deleting-vms.xml
View File

@ -5,37 +5,39 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="deleting-vms">
<title>Deleting VMs</title>
<para>Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines.</para>
<para>To delete a virtual machine:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to delete.</para></listitem>
<listitem><para>Click the Destroy Instance button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/destroy-instance.png" />
</imageobject>
<textobject><phrase>Destroyinstance.png: button to destroy an instance</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</orderedlist>
</section>
<title>Deleting VMs</title>
<para>Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines.</para>
<para>To delete a virtual machine:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation, click Instances.</para></listitem>
<listitem><para>Choose the VM that you want to delete.</para></listitem>
<listitem><para>Click the Destroy Instance button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/destroy-instance.png"/>
</imageobject>
<textobject>
<phrase>Destroyinstance.png: button to destroy an instance</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
</orderedlist>
</section>

69
docs/en-US/deployment-architecture-overview.xml
View File

@ -1,44 +1,43 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="deployment-architecture-overview">
<title>Deployment Architecture Overview</title>
<para>
A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
</para>
<para>
The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor).
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/basic-deployment.png" />
</imageobject>
<textobject><phrase>basic-deployment.png: Basic two-machine deployment</phrase></textobject>
</mediaobject>
<para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
</para>
<xi:include href="management-server-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networking-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Deployment Architecture Overview</title>
<para>
A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources.
</para>
<para>
The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor).
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/basic-deployment.png" />
</imageobject>
<textobject><phrase>basic-deployment.png: Basic two-machine deployment</phrase></textobject>
</mediaobject>
<para>A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture.
</para>
<xi:include href="management-server-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="networking-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

71
docs/en-US/detach-move-volumes.xml
View File

@ -5,39 +5,42 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="detach-move-volumes">
<title>Attaching a Volume</title>
<note><para>This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration </para></note>
<para>A volume can be detached from a guest VM and attached to another guest. Both &PRODUCT; administrators and users can detach volumes from VMs and move them to other VMs.</para>
<para>If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM.</para>
<para>If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes.</para></listitem>
<listitem><para>Click the name of the volume you want to detach, then click the Detach Disk button <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/detach-disk-icon.png" />
</imageobject>
<textobject><phrase>DetachDiskButton.png: button to detach a volume</phrase></textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>To move the volume to another VM, follow the steps in Attaching a Volume <xref linkend="attaching-volume"/>.</para></listitem>
</orderedlist>
</section>
<title>Detaching and Moving Volumes</title>
<note><para>This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration </para></note>
<para>A volume can be detached from a guest VM and attached to another guest. Both &PRODUCT; administrators and users can detach volumes from VMs and move them to other VMs.</para>
<para>If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM.</para>
<para>If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem>
<listitem><para>In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes.</para></listitem>
<listitem><para>Click the name of the volume you want to detach, then click the Detach Disk button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/detach-disk-icon.png"/>
</imageobject>
<textobject>
<phrase>DetachDiskButton.png: button to detach a volume</phrase>
</textobject>
</inlinemediaobject>
</para></listitem>
<listitem><para>To move the volume to another VM, follow the steps in <xref linkend="attaching-volume"
/>.</para></listitem>
</orderedlist>
</section>

39
docs/en-US/developer-guide.xml
View File

@ -5,26 +5,25 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<chapter id="developer-guide">
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<title>Using the API</title>
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
@ -32,7 +31,5 @@
<xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="contacting-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

70
docs/en-US/enable-disable-static-nat.xml
View File

@ -5,40 +5,42 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="enable-disable-static-nat">
<title>Enabling or Disabling Static NAT</title>
<para>If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP.</para>
<para>If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address you want to work with.</para>
</listitem>
<listitem><para>Click the Static NAT button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/release-ip-icon.png" />
</imageobject>
<textobject><phrase>ReleaseIPButton.png: button to release an IP</phrase></textobject>
</inlinemediaobject>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
<listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and click Apply</para></listitem>
</orderedlist>
<title>Enabling or Disabling Static NAT</title>
<para>If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP.</para>
<para>If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
<listitem><para>In the left navigation, choose Network.</para></listitem>
<listitem><para>Click the name of the network where you want to work with.</para></listitem>
<listitem><para>Click View IP Addresses.</para></listitem>
<listitem><para>Click the IP address you want to work with.</para>
</listitem>
<listitem><para>Click the Static NAT <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/enable-disable.png"/>
</imageobject>
<textobject>
<phrase>ReleaseIPButton.png: button to release an IP</phrase>
</textobject>
</inlinemediaobject>button.</para><para>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
<listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and
click Apply.</para></listitem>
</orderedlist>
</section>

39
docs/en-US/enable-security-groups.xml
View File

@ -5,25 +5,28 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="enable-security-groups">
<title>Enabling Security Groups</title>
<para>In order for security groups to function in a zone, the security groups feature must first be enabled for the zone. The administrator can do this when creating a new zone, by selecting a network offering that includes security groups. The procedure is described in Basic Zone Configuration in the Advanced Installation Guide.</para>
<title>Enabling Security Groups</title>
<para>In order for security groups to function in a zone, the security groups feature must first be
enabled for the zone. The administrator can do this when creating a new zone, by selecting a
network offering that includes security groups. The procedure is described in Basic Zone
Configuration in the Advanced Installation Guide. The administrator can not enable security
groups for an existing zone, only when creating a new zone.</para>
</section>

37
docs/en-US/end-user-ui-overview.xml
View File

@ -1,28 +1,27 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="end-user-ui-overview">
<title>End User's UI Overview</title>
<para>The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.</para>
<title>End User's UI Overview</title>
<para>The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.</para>
</section>

33
docs/en-US/event-log-queries.xml
View File

@ -5,23 +5,22 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="event-log-queries">
<title>Event Log Queries</title>
<para>Database logs can be queried from the user interface. The list of events captured by the system includes:</para>
@ -34,4 +33,4 @@
<listitem><para>Storage volume creation and deletion</para></listitem>
<listitem><para>User login and logout</para></listitem>
</itemizedlist>
</section>
</section>

425
docs/en-US/event-types.xml
View File

@ -5,216 +5,215 @@
]>
<!-- 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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<section id="event-types">
<title>Event Types</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>VM.CREATE</para></entry>
<entry><para>TEMPLATE.EXTRACT</para></entry>
<entry><para>SG.REVOKE.INGRESS</para></entry>
</row>
<row>
<entry><para>VM.DESTROY</para></entry>
<entry><para>TEMPLATE.UPLOAD</para></entry>
<entry><para>HOST.RECONNECT</para></entry>
</row>
<row>
<entry><para>VM.START</para></entry>
<entry><para>TEMPLATE.CLEANUP</para></entry>
<entry><para>MAINT.CANCEL</para></entry>
</row>
<row>
<entry><para>VM.STOP</para></entry>
<entry><para>VOLUME.CREATE</para></entry>
<entry><para>MAINT.CANCEL.PS</para></entry>
</row>
<row>
<entry><para>VM.REBOOT</para></entry>
<entry><para>VOLUME.DELETE</para></entry>
<entry><para>MAINT.PREPARE</para></entry>
</row>
<row>
<entry><para>VM.UPGRADE</para></entry>
<entry><para>VOLUME.ATTACH</para></entry>
<entry><para>MAINT.PREPARE.PS</para></entry>
</row>
<row>
<entry><para>VM.RESETPASSWORD</para></entry>
<entry><para>VOLUME.DETACH</para></entry>
<entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
</row>
<row>
<entry><para>ROUTER.CREATE</para></entry>
<entry><para>VOLUME.UPLOAD</para></entry>
<entry><para>VPN.USER.ADD</para></entry>
</row>
<row>
<entry><para>ROUTER.DESTROY</para></entry>
<entry><para>SERVICEOFFERING.CREATE</para></entry>
<entry><para>VPN.USER.REMOVE</para></entry>
</row>
<row>
<entry><para>ROUTER.START</para></entry>
<entry><para>SERVICEOFFERING.UPDATE</para></entry>
<entry><para>NETWORK.RESTART</para></entry>
</row>
<row>
<entry><para>ROUTER.STOP</para></entry>
<entry><para>SERVICEOFFERING.DELETE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.REBOOT</para></entry>
<entry><para>DOMAIN.CREATE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.HA</para></entry>
<entry><para>DOMAIN.DELETE</para></entry>
<entry><para>STATICNAT.DISABLE</para></entry>
</row>
<row>
<entry><para>PROXY.CREATE</para></entry>
<entry><para>DOMAIN.UPDATE</para></entry>
<entry><para>SSVM.CREATE</para></entry>
</row>
<row>
<entry><para>PROXY.DESTROY</para></entry>
<entry><para>SNAPSHOT.CREATE</para></entry>
<entry><para>SSVM.DESTROY</para></entry>
</row>
<row>
<entry><para>PROXY.START</para></entry>
<entry><para>SNAPSHOT.DELETE</para></entry>
<entry><para>SSVM.START</para></entry>
</row>
<row>
<entry><para>PROXY.STOP</para></entry>
<entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
<entry><para>SSVM.STOP</para></entry>
</row>
<row>
<entry><para>PROXY.REBOOT</para></entry>
<entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
<entry><para>SSVM.REBOOT</para></entry>
</row>
<row>
<entry><para>PROXY.HA</para></entry>
<entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
<entry><para>SSVM.H</para></entry>
</row>
<row>
<entry><para>VNC.CONNECT</para></entry>
<entry><para>VNC.DISCONNECT</para></entry>
<entry><para>NET.IPASSIGN</para></entry>
</row>
<row>
<entry><para>NET.IPRELEASE</para></entry>
<entry><para>NET.RULEADD</para></entry>
<entry><para>NET.RULEDELETE</para></entry>
</row>
<row>
<entry><para>NET.RULEMODIFY</para></entry>
<entry><para>NETWORK.CREATE</para></entry>
<entry><para>NETWORK.DELETE</para></entry>
</row>
<row>
<entry><para>LB.ASSIGN.TO.RULE</para></entry>
<entry><para>LB.REMOVE.FROM.RULE</para></entry>
<entry><para>LB.CREATE</para></entry>
</row>
<row>
<entry><para>LB.DELETE</para></entry>
<entry><para>LB.UPDATE</para></entry>
<entry><para>USER.LOGIN</para></entry>
</row>
<row>
<entry><para>USER.LOGOUT</para></entry>
<entry><para>USER.CREATE</para></entry>
<entry><para>USER.DELETE</para></entry>
</row>
<row>
<entry><para>USER.UPDATE</para></entry>
<entry><para>USER.DISABLE</para></entry>
<entry><para>TEMPLATE.CREATE</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DELETE</para></entry>
<entry><para>TEMPLATE.UPDATE</para></entry>
<entry><para>TEMPLATE.COPY</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
</row>
<row>
<entry><para>ISO.CREATE</para></entry>
<entry><para>ISO.DELETE</para></entry>
<entry><para>ISO.COPY</para></entry>
</row>
<row>
<entry><para>ISO.ATTACH</para></entry>
<entry><para>ISO.DETACH</para></entry>
<entry><para>ISO.EXTRACT</para></entry>
</row>
<row>
<entry><para>ISO.UPLOAD</para></entry>
<entry><para>SERVICE.OFFERING.CREATE</para></entry>
<entry><para>SERVICE.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>SERVICE.OFFERING.DELETE</para></entry>
<entry><para>DISK.OFFERING.CREATE</para></entry>
<entry><para>DISK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>DISK.OFFERING.DELETE</para></entry>
<entry><para>NETWORK.OFFERING.CREATE</para></entry>
<entry><para>NETWORK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>NETWORK.OFFERING.DELETE</para></entry>
<entry><para>POD.CREATE</para></entry>
<entry><para>POD.EDIT</para></entry>
</row>
<row>
<entry><para>POD.DELETE</para></entry>
<entry><para>ZONE.CREATE</para></entry>
<entry><para>ZONE.EDIT</para></entry>
</row>
<row>
<entry><para>ZONE.DELETE</para></entry>
<entry><para>VLAN.IP.RANGE.CREATE</para></entry>
<entry><para>VLAN.IP.RANGE.DELETE</para></entry>
</row>
<row>
<entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
<entry><para>SG.AUTH.INGRESS</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
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
http://www.apache.org/licenses/LICENSE-2.0
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.
-->
<appendix id="event-types">
<title>Event Types</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<tbody>
<row>
<entry><para>VM.CREATE</para></entry>
<entry><para>TEMPLATE.EXTRACT</para></entry>
<entry><para>SG.REVOKE.INGRESS</para></entry>
</row>
<row>
<entry><para>VM.DESTROY</para></entry>
<entry><para>TEMPLATE.UPLOAD</para></entry>
<entry><para>HOST.RECONNECT</para></entry>
</row>
<row>
<entry><para>VM.START</para></entry>
<entry><para>TEMPLATE.CLEANUP</para></entry>
<entry><para>MAINT.CANCEL</para></entry>
</row>
<row>
<entry><para>VM.STOP</para></entry>
<entry><para>VOLUME.CREATE</para></entry>
<entry><para>MAINT.CANCEL.PS</para></entry>
</row>
<row>
<entry><para>VM.REBOOT</para></entry>
<entry><para>VOLUME.DELETE</para></entry>
<entry><para>MAINT.PREPARE</para></entry>
</row>
<row>
<entry><para>VM.UPGRADE</para></entry>
<entry><para>VOLUME.ATTACH</para></entry>
<entry><para>MAINT.PREPARE.PS</para></entry>
</row>
<row>
<entry><para>VM.RESETPASSWORD</para></entry>
<entry><para>VOLUME.DETACH</para></entry>
<entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
</row>
<row>
<entry><para>ROUTER.CREATE</para></entry>
<entry><para>VOLUME.UPLOAD</para></entry>
<entry><para>VPN.USER.ADD</para></entry>
</row>
<row>
<entry><para>ROUTER.DESTROY</para></entry>
<entry><para>SERVICEOFFERING.CREATE</para></entry>
<entry><para>VPN.USER.REMOVE</para></entry>
</row>
<row>
<entry><para>ROUTER.START</para></entry>
<entry><para>SERVICEOFFERING.UPDATE</para></entry>
<entry><para>NETWORK.RESTART</para></entry>
</row>
<row>
<entry><para>ROUTER.STOP</para></entry>
<entry><para>SERVICEOFFERING.DELETE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.REBOOT</para></entry>
<entry><para>DOMAIN.CREATE</para></entry>
<entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
</row>
<row>
<entry><para>ROUTER.HA</para></entry>
<entry><para>DOMAIN.DELETE</para></entry>
<entry><para>STATICNAT.DISABLE</para></entry>
</row>
<row>
<entry><para>PROXY.CREATE</para></entry>
<entry><para>DOMAIN.UPDATE</para></entry>
<entry><para>SSVM.CREATE</para></entry>
</row>
<row>
<entry><para>PROXY.DESTROY</para></entry>
<entry><para>SNAPSHOT.CREATE</para></entry>
<entry><para>SSVM.DESTROY</para></entry>
</row>
<row>
<entry><para>PROXY.START</para></entry>
<entry><para>SNAPSHOT.DELETE</para></entry>
<entry><para>SSVM.START</para></entry>
</row>
<row>
<entry><para>PROXY.STOP</para></entry>
<entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
<entry><para>SSVM.STOP</para></entry>
</row>
<row>
<entry><para>PROXY.REBOOT</para></entry>
<entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
<entry><para>SSVM.REBOOT</para></entry>
</row>
<row>
<entry><para>PROXY.HA</para></entry>
<entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
<entry><para>SSVM.H</para></entry>
</row>
<row>
<entry><para>VNC.CONNECT</para></entry>
<entry><para>VNC.DISCONNECT</para></entry>
<entry><para>NET.IPASSIGN</para></entry>
</row>
<row>
<entry><para>NET.IPRELEASE</para></entry>
<entry><para>NET.RULEADD</para></entry>
<entry><para>NET.RULEDELETE</para></entry>
</row>
<row>
<entry><para>NET.RULEMODIFY</para></entry>
<entry><para>NETWORK.CREATE</para></entry>
<entry><para>NETWORK.DELETE</para></entry>
</row>
<row>
<entry><para>LB.ASSIGN.TO.RULE</para></entry>
<entry><para>LB.REMOVE.FROM.RULE</para></entry>
<entry><para>LB.CREATE</para></entry>
</row>
<row>
<entry><para>LB.DELETE</para></entry>
<entry><para>LB.UPDATE</para></entry>
<entry><para>USER.LOGIN</para></entry>
</row>
<row>
<entry><para>USER.LOGOUT</para></entry>
<entry><para>USER.CREATE</para></entry>
<entry><para>USER.DELETE</para></entry>
</row>
<row>
<entry><para>USER.UPDATE</para></entry>
<entry><para>USER.DISABLE</para></entry>
<entry><para>TEMPLATE.CREATE</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DELETE</para></entry>
<entry><para>TEMPLATE.UPDATE</para></entry>
<entry><para>TEMPLATE.COPY</para></entry>
</row>
<row>
<entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
<entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
</row>
<row>
<entry><para>ISO.CREATE</para></entry>
<entry><para>ISO.DELETE</para></entry>
<entry><para>ISO.COPY</para></entry>
</row>
<row>
<entry><para>ISO.ATTACH</para></entry>
<entry><para>ISO.DETACH</para></entry>
<entry><para>ISO.EXTRACT</para></entry>
</row>
<row>
<entry><para>ISO.UPLOAD</para></entry>
<entry><para>SERVICE.OFFERING.CREATE</para></entry>
<entry><para>SERVICE.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>SERVICE.OFFERING.DELETE</para></entry>
<entry><para>DISK.OFFERING.CREATE</para></entry>
<entry><para>DISK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>DISK.OFFERING.DELETE</para></entry>
<entry><para>NETWORK.OFFERING.CREATE</para></entry>
<entry><para>NETWORK.OFFERING.EDIT</para></entry>
</row>
<row>
<entry><para>NETWORK.OFFERING.DELETE</para></entry>
<entry><para>POD.CREATE</para></entry>
<entry><para>POD.EDIT</para></entry>
</row>
<row>
<entry><para>POD.DELETE</para></entry>
<entry><para>ZONE.CREATE</para></entry>
<entry><para>ZONE.EDIT</para></entry>
</row>
<row>
<entry><para>ZONE.DELETE</para></entry>
<entry><para>VLAN.IP.RANGE.CREATE</para></entry>
<entry><para>VLAN.IP.RANGE.DELETE</para></entry>
</row>
<row>
<entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
<entry><para>SG.AUTH.INGRESS</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</appendix>

Some files were not shown because too many files have changed in this diff Show More