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

Removing docs from master

This commit is contained in:
David Nalley 2013-10-08 15:24:31 -04:00
parent 3f1aba894f
commit 5586a221fc
1279 changed files with 0 additions and 97002 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

325
docs/README.txt
View File

@ -1,325 +0,0 @@
Author: Jessica Tomechak
Updated: August 8, 2012
-------------------------------------------
WHAT'S IN THIS REPOSITORY: WORK IN PROGRESS
-------------------------------------------
This repository contains the source files for CloudStack documentation. The files are currently incomplete as we are in the process of converting documentation from an outdated file format into XML files for this repo.
The complete documentation can be seen at docs.cloudstack.org.
----------------------------------
DOCUMENTATION SUBDIRECTORIES
----------------------------------
United States English language source files are in the en-US subdirectory.
Additional language subdirectories can be added.
Each file in a language subdirectory contains one chunk of information that may be termed a section, module, or topic. The files are written in Docbook XML, using the Docbook version and tag supported by the Publican open-source documentation tool.
----------------------------------
VALID XML TAGS
----------------------------------
Certain tags are disallowed by Publican. Please consult their documentation for more details.
http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/
Your best bet is to copy an existing XML file and fill in your own content between the tags.
At the bottom of this README, there is a fill-in-the-blanks XML template that you can go from. It shows the commonly used tags and explains a bit about how to use them.
----------------------------------
SECTIONS, CHAPTERS, AND BOOK FILES
----------------------------------
The files for every topic and audience are in a single directory. The content is not divided into separate subdirectories for each book, or separate repositories for each book. Therefore, the content can be flexibly and easily re-used. In most cases, a file contains a single section that can be assembled with other sections to build any desired set of information. These files contain <section> ... </section> tags.
Some of the XML files contain only a series of include tags to pull in content from other files. Such an "include file" is either a major section, a chapter in a book, or the master book file. A chapter contains <chapter> ... </chapter> tags.
The master book file contains <book> ... </book> tags. This file is referred to in the Publican configuration file, and is used as the controlling file when building the book.
Document names are derived from the docname setting in the appropriate .cfg file.
This should not have CloudStack in the name (which is redundant because of
the CloudStack brand that the documentation is built with. The docname variable
sets the name in the doc site table of contents. This name also needs to exist
as .xml and .ent in the en-US directory. Examples of appropriate docnames:
Admin_Guide
API_Developers_Guide
Installation_Guide
A Publican book file must also have certain other tags that are expected by
Publican when it builds the project. Copy an existing master book file to
get these tags.
----------------------------------
CONFIG FILES
----------------------------------
For each book file, there must be a corresponding publican.cfg (or
<other_name>.cfg) file in order to build the book with Publican. The
docname: attribute in the config file matches the name of the master book file;
for example, docname: cloudstack corresponds to the master book file
cloudstack.xml.
The .cfg files reside in the main directory, docs. To build a different book,
just use the Publican command line flag --config=<filename>.cfg. (We also
need per-book entities, Book_Info, Author_Info, and other Publican files.
The technique for pulling these in is TBD.)
----------------------------------
TO BUILD A BOOK
----------------------------------
We will set up an automatic Publican job that generates new output whenever we
check in changes to this repository. You can also build a book locally as
follows.
First, install Publican, and get a local copy of the book source files.
Put the desired publican.cfg in the docs directory. Go to the command line, cd
to that directory, and run the publican build command. Specify what output
format(s) and what language(s) you want to build. Always start with a test
run. For example:
publican build --formats test --langs en-US
...followed by this command if the test is successful:
publican build --formats html,pdf --langs en-US
Output will be found in the tmp subdirectory of the docs directory.
----------------------------------
LOCALIZATION
----------------------------------
Localized versions of the documentation files can be stored in appropriately
named subdirectories parallel to en-US. The language code names to use for
these directories are listed in Publican documentation,
http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/appe-Users_Guide-Language_codes.html.
For example, Japanese XML files would be stored in the docs/ja-JP directory.
Localization currently happens using Transifex and you can find the strings
to be translated at this location:
https://www.transifex.com/projects/p/ACS_DOCS/
In preparation for l10n, authors and docs folks must take not of a number of
things.
All .xml files must contain a translatable string. <xi:include> tags are not enough.
All new .xml files must have a corresponding entry in docs/.tx/config
Filenames should be less than 50 characters long.
To generate new POT files and upload source do the following:
publican update_pot --config=./publican-all.cfg
tx push -s
To receive translated files from publican, run the following command:
tx pull
----------------------------------
CONTRIBUTING
----------------------------------
Contributors can create new section, chapter, book, publican.cfg, or localized
.xml files at any time. Submit them following the same patch approval procedure
that is used for contributing to CloudStack code. More information for
contributors is available at
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Team.
----------------------------------
TAGS FOR A SECTION
----------------------------------
<!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.
-->
<!-- Please keep the doctype and license declarations above intact in each doc file. -->
<!-- Make your modifications below this line. -->
<section id="INSERT A UNIQUE SECTION ID HERE, PROBABLY MATCHING THE TITLE BELOW. KEEP THE QUOTE MARKS.">
<title>Text of the section title</title>
<para>Here's the text of a paragraph in this section.</para>
<para>Always use &PRODUCT; rather than typing CloudStack.</para>
<para>Indent with 4 spaces, not with tab characters.</para>
<para>To hyperlink to a URL outside this document: <ulink url="http://external URL here">Display text of the link here</ulink></para>
<para>To hyperlink to another section in this document: <xref linkend="SECTION ID OF THE OTHER SECTION GOES HERE." />
The publication tools will automatically insert the display text of the link for you.</para>
<note><para>Use this for all tips and asides. Don't use other tags such as tip.
Our publication tool (publican) prefers the note tag. The tool will
automatically insert the text NOTE: for you, so please don't type it.</para></note>
<warning><para>Use this for anything that is vital to avoid runtime errors. Don't use
other tags such as caution. Our publication tool (publican) prefers the warning tag. The tool will automatically insert the text WARNING: for you, so please don't type it.</para></warning>
<para>Here's how to do a bulleted list:</para>
<itemizedlist>
<listitem><para>Bulleted list item text.</para></listitem>
</itemizedlist>
<para>Here's how to do a numbered list. These are used for step by step instructions
or to describe a sequence of events in time. For everything else, use a bulleted list.</para>
<orderedlist>
<listitem><para>Text of the step</para></listitem>
<listitem><para>You might also want a sub-list within one of the list items. Like this:</para>
<orderedlist numeration="loweralpha">
<listitem><para>Inner list item text.</para></listitem>
</orderedlist>
</listitem>
</orderedlist>
<para>Here's how to insert an image. Put the graphic file in images/, a subdirectory of the directory where this XML file is.
Refer to it using this tag. The tag is admittedly complex, but it's the one we need to use with publican:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/YOUR_FILENAME_HERE.png" />
</imageobject>
<textobject><phrase>YOUR_FILENAME_HERE.png: Alt text describing this image, such as
“structure of a zone.” Required for accessibility.</phrase></textobject>
</mediaobject>
<para>A section can contain sub-sections. Please make each sub-section a separate file to enable reuse.
Then include the sub-section like this:</para>
<xi:include href="SUBSECTION_FILE_NAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
----------------------------------
TAGS FOR A CHAPTER
----------------------------------
<!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.
-->
<!-- Please keep the doctype and license declarations above intact in each doc file. -->
<!-- Make your modifications below this line. -->
<chapter id="INSERT A UNIQUE SECTION ID HERE, PROBABLY MATCHING THE TITLE BELOW. KEEP THE QUOTE MARKS.">
<title>Text of the chapter title</title>
<xi:include href="SECTION_ONE_FILENAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="SECTION_TWO_FILENAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
----------------------------------
TAGS FOR A BOOK
----------------------------------
<!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.
-->
<!-- Please keep the doctype and license declarations above intact in each doc file. -->
<!-- Make your modifications below this line. -->
<book>
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="CHAPTER_ONE_FILENAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="CHAPTER_TWO_FILENAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
----------------------------------
BASIC RULES FOR INCLUDE STATEMENTS
----------------------------------
A book file must include chapter files.
A chapter file must include section files.
A section file can include other section files, but it doesn't have to.

22
docs/en-US/Admin_Guide.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Apache Software Foundation">

74
docs/en-US/Admin_Guide.xml
View File

@ -1,74 +0,0 @@
<?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" [
<!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.
-->
<book>
<bookinfo id="cloudstack_admin">
<title>&PRODUCT; Administrator's Guide</title>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Administration Guide for &PRODUCT;.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="concepts.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="global-config.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" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

32
docs/en-US/Author_Group.xml
View File

@ -1,32 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Runbook.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.
-->
<authorgroup>
<author>
<firstname>Apache</firstname>
<surname>CloudStack</surname>
</author>
</authorgroup>

47
docs/en-US/Book_Info.xml
View File

@ -1,47 +0,0 @@
<?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" [
<!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.
-->
<bookinfo id="book-release-notes-3.0.4">
<title>&PRODUCT; Guide</title>
<subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Complete technical documentation of &PRODUCT;.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>

38
docs/en-US/Book_Info_Release_Notes_4.xml
View File

@ -1,38 +0,0 @@
<?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" [
<!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.
-->
<bookinfo id="book-release-notes-4.2">
<title>Version 4.2.0 Release Notes</title>
<productname>Apache &PRODUCT;</productname>
<productnumber/>
<pubsnumber/>
<abstract>
<para>Release notes for the Apache &PRODUCT; 4.2.0 release.</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"/>
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</bookinfo>

22
docs/en-US/CloudStack_GSoC_Guide.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2013">
<!ENTITY HOLDER "Apache Software Foundation">

52
docs/en-US/CloudStack_GSoC_Guide.xml
View File

@ -1,52 +0,0 @@
<?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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "CloudStack_GSoC_Guide.ent">
%BOOK_ENTITIES;
<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
%xinclude;
]>
<!-- 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.
-->
<book>
<bookinfo id="cloudstack_gsoc_2013">
<title>&PRODUCT; Guide for the 2013 Google Summer of Code</title>
<productname>Apache CloudStack</productname>
<productnumber>4.3.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Guide for 2013 Google Summer of Code Projects.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="gsoc-proposals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="gsoc-midsummer.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

22
docs/en-US/CloudStack_Nicira_NVP_Guide.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Apache Software Foundation">

55
docs/en-US/CloudStack_Nicira_NVP_Guide.xml
View File

@ -1,55 +0,0 @@
<?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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
%xinclude;
]>
<!-- 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.
-->
<book>
<bookinfo id="cloudstack_plugin_niciranvp">
<title>&PRODUCT; Plugin Guide for the Nicira NVP Plugin</title>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Plugin Guide for the Nicira NVP Plugin.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="plugin-niciranvp-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-niciranvp-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-niciranvp-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-niciranvp-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

15
docs/en-US/Common_Content/Legal_Notice.xml
View File

@ -1,15 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
]>
<legalnotice>
<para>
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
</para>
<para>
http://www.apache.org/licenses/LICENSE-2.0
</para>
<para>
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.
</para>
</legalnotice>

24
docs/en-US/Common_Content/feedback.xml
View File

@ -1,24 +0,0 @@
<?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.
-->
<section id="feedback">
<title>Feedback</title>
<para>to-do</para>
</section>

21
docs/en-US/Developers_Guide.ent
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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Apache Software Foundation">

61
docs/en-US/Developers_Guide.xml
View File

@ -1,61 +0,0 @@
<?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" [
<!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.
-->
<book>
<bookinfo id="cloudstack_developers">
<title>&PRODUCT; Developer's Guide</title>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition></edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
This guide shows how to develop &PRODUCT;, use the API for operation and integration, access the usage data and use &PRODUCT; specific tools to ease development, testing and integration.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="building-with-maven.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<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="api-calls.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="storage-plugins.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="third-party-ui-plugin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="tools.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="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

22
docs/en-US/Installation_Guide.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Apache Software Foundation">

62
docs/en-US/Installation_Guide.xml
View File

@ -1,62 +0,0 @@
<?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" [
<!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.
-->
<book>
<bookinfo id="book-installation">
<title>&PRODUCT; Installation Guide</title>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition>1</edition>
<pubsnumber/>
<abstract>
<para> Installation Guide for &PRODUCT;. </para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"/>
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</bookinfo>
<xi:include href="concepts.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="source.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="installation.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="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="additional-installation-options.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="choosing-a-deployment-architecture.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="choosing-a-hypervisor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="aws-interface-compatibility.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="network-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="storage-setup.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="best-practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</book>

51
docs/en-US/LDAP-for-user-authentication.xml
View File

@ -1,51 +0,0 @@
<?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.
-->
<section id="LDAP-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 OpenLDAP to authenticate &PRODUCT; end-users.</para>
<para>In order to do this you must:</para>
<itemizedlist>
<listitem><para>Set your LDAP configuration within &PRODUCT;</para></listitem>
<listitem><para>Create &PRODUCT; accounts for LDAP users</para></listitem>
</itemizedlist>
<para>To set up LDAP authentication in &PRODUCT;, open the global settings page and search for LDAP</para>
<para>Set ldap.basedn to match your sever's base directory.</para>
<para>Review the defaults for the following, ensure that they match your schema.</para>
<itemizedlist>
<listitem><para>ldap.email.attribute</para></listitem>
<listitem><para>ldap.firstname.attribute</para></listitem>
<listitem><para>ldap.lastname.attribute</para></listitem>
<listitem><para>ldap.username.attribute</para></listitem>
<listitem><para>ldap.user.object</para></listitem>
</itemizedlist>
<para>Optionally you can set the following:</para>
<itemizedlist>
<listitem><para>If you do not want to use anonymous binding you can set ldap.bind.principle and ldap.bind.password as credentials for your LDAP server that will grant &PRODUCT; permission to perform a search on the LDAP server.</para></listitem>
<listitem><para>For SSL support set ldap.truststore to a path on the file system where your trusted store is located. Along with this set ldap.truststore.password as the password that unlocks the truststore.</para></listitem>
<listitem><para>If you wish to filter down the user set that is granted access to &PRODUCT; via the LDAP attribute memberof you can do so using ldap.search.group.principle.</para></listitem>
</itemizedlist>
<para>Finally, you can add your LDAP server. To do so select LDAP Configuration from the views section within global settings. Click on "Configure LDAP" and fill in your server's hostname and port.</para>
<xi:include href="example-activedirectory-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="example-openldap-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

22
docs/en-US/MidoNet_Plugin_Guide.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2013">
<!ENTITY HOLDER "Apache Software Foundation">

52
docs/en-US/MidoNet_Plugin_Guide.xml
View File

@ -1,52 +0,0 @@
<?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" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
%xinclude;
]>
<!-- 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.
-->
<book>
<bookinfo id="midonet_plugin">
<title>&PRODUCT; Plugin Guide for the MidoNet Plugin</title>
<productname>Apache CloudStack</productname>
<productnumber>4.2.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
<para>
Plugin Guide for the MidoNet Plugin.
</para>
</abstract>
<corpauthor>
<inlinemediaobject>
<imageobject>
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="plugin-midonet-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-midonet-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-midonet-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>

31
docs/en-US/Preface.xml
View File

@ -1,31 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE preface 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.
-->
<preface id="pref-cloudstack-Preface">
<title>Preface</title>
<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</xi:fallback>
</xi:include>
</preface>

22
docs/en-US/Release_Notes.ent
View File

@ -1,22 +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.
-->
<!ENTITY PRODUCT "CloudStack">
<!ENTITY BOOKID "Technical Documentation">
<!ENTITY YEAR "2012">
<!ENTITY HOLDER "Apache Software Foundation">

4625
docs/en-US/Release_Notes.xml
View File

File diff suppressed because it is too large Load Diff

45
docs/en-US/Revision_History.xml
View File

@ -1,45 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix 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.
-->
<appendix id="appe-cloudstack-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>0-0</revnumber>
<date>Tue May 29 2012</date>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<email/>
</author>
<revdescription>
<simplelist>
<member>Initial creation of book by publican</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>

55
docs/en-US/Revision_History_Install_Guide.xml
View File

@ -1,55 +0,0 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix 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.
-->
<appendix id="appe-cloudstack-Revision_History">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>1-0</revnumber>
<date>October 5 2012</date>
<author>
<firstname>Jessica</firstname>
<surname>Tomechak</surname>
<email/>
</author>
<author>
<firstname>Radhika</firstname>
<surname>PC</surname>
<email/>
</author>
<author>
<firstname>Wido</firstname>
<surname>den Hollander</surname>
<email/>
</author>
<revdescription>
<simplelist>
<member>Initial publication</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>

28
docs/en-US/SSL-keystore-path-and-password.xml
View File

@ -1,28 +0,0 @@
<?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.
-->
<section id="SSL-keystore-path-and-password">
<title>SSL Keystore Path and Password</title>
<para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
</section>

40
docs/en-US/VPN-user-usage-record-format.xml
View File

@ -1,40 +0,0 @@
<?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.
-->
<section id="VPN-user-usage-record-format">
<title>VPN User Usage Record Format</title>
<itemizedlist>
<listitem><para>account – name of the account</para></listitem>
<listitem><para>accountid – ID of the account</para></listitem>
<listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid – Zone where the usage occurred</para></listitem>
<listitem><para>description – A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid – VPN user ID</para></listitem>
<listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
</itemizedlist>
</section>

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

@ -1,63 +0,0 @@
<?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.
-->
<section id="about-clusters">
<title>About Clusters</title>
<para>
A cluster provides a way to group hosts. To be precise, a cluster is a
XenServer server pool, a set of KVM servers, <!-- a set of OVM hosts -->, or a
VMware cluster preconfigured in vCenter. The hosts in a cluster all
have identical hardware, run the same hypervisor, are on the same subnet,
and access the same shared primary storage. Virtual machine instances
(VMs) can be live-migrated from one host to another within the same
cluster, without interrupting service to the user.
</para>
<para>
A cluster is the third-largest organizational unit within a &PRODUCT;
deployment. Clusters are contained within pods, and pods are contained
within zones. Size of the cluster is limited by the underlying hypervisor,
although the &PRODUCT; recommends less in most cases; see Best Practices.
</para>
<para>
A cluster consists of one or more hosts and one or more primary storage
servers.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/cluster-overview.png" />
</imageobject>
<textobject><phrase>cluster-overview.png: Structure of a simple cluster</phrase></textobject>
</mediaobject>
<para>&PRODUCT; allows multiple clusters in a cloud deployment.</para>
<para>
Even when local storage is used exclusively, clusters are still required
organizationally, even if there is just one host per cluster.
</para>
<para>
When VMware is used, every VMware cluster is managed by a vCenter server.
Administrator must register the vCenter server with &PRODUCT;. There may
be multiple vCenter servers per zone. Each vCenter server may manage
multiple VMware clusters.
</para>
</section>

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

@ -1,46 +0,0 @@
<?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.
-->
<section id="about-hosts">
<title>About Hosts</title>
<para>A host is a single computer. Hosts provide the computing resources that run the guest virtual machines. Each host has hypervisor software installed on it to manage the guest VMs. For example, a Linux KVM-enabled server, a Citrix XenServer server, and an ESXi server are hosts.</para>
<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>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>
</itemizedlist>
<para>Additional hosts can be added at any time to provide more capacity for guest VMs.</para>
<para>&PRODUCT; automatically detects the amount of CPU and memory resources provided by the Hosts.</para>
<para>Hosts are not visible to the end user. An end user cannot determine which host their guest has been assigned to.</para>
<para>For a host to function in &PRODUCT;, you must do the following:</para>
<itemizedlist>
<listitem><para>Install hypervisor software on the host</para></listitem>
<listitem><para>Assign an IP address to the host</para></listitem>
<listitem><para>Ensure the host is connected to the &PRODUCT; Management Server</para></listitem>
</itemizedlist>
</section>

65
docs/en-US/about-password-encryption.xml
View File

@ -1,65 +0,0 @@
<?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.
-->
<section id="about-password-encryption">
<title>About Password and Key Encryption</title>
<para>&PRODUCT; stores several sensitive passwords and secret keys that are used to provide
security. These values are always automatically encrypted:</para>
<itemizedlist>
<listitem>
<para>Database secret key</para>
</listitem>
<listitem>
<para>Database password</para>
</listitem>
<listitem>
<para>SSH keys</para>
</listitem>
<listitem>
<para>Compute node root password</para>
</listitem>
<listitem>
<para> VPN password</para>
</listitem>
<listitem>
<para>User API secret key</para>
</listitem>
<listitem>
<para>VNC password</para>
</listitem>
</itemizedlist>
<para>&PRODUCT; uses the Java Simplified Encryption (JASYPT) library. The data values are
encrypted and decrypted using a database secret key, which is stored in one of &PRODUCT;’s
internal properties files along with the database password. The other encrypted values listed
above, such as SSH keys, are in the &PRODUCT; internal database.</para>
<para>Of course, the database secret key itself can not be stored in the open – it must be
encrypted. How then does &PRODUCT; read it? A second secret key must be provided from an
external source during Management Server startup. This key can be provided in one of two ways:
loaded from a file or provided by the &PRODUCT; administrator. The &PRODUCT; database has a
configuration setting that lets it know which of these methods will be used. If the encryption
type is set to "file," the key must be in a file in a known location. If the encryption type is
set to "web," the administrator runs the utility
com.cloud.utils.crypt.EncryptionSecretKeySender, which relays the key to the Management Server
over a known port.</para>
<para>The encryption type, database secret key, and Management Server secret key are set during
&PRODUCT; installation. They are all parameters to the &PRODUCT; database setup script
(cloudstack-setup-databases). The default values are file, password, and password. It is, of course,
highly recommended that you change these to more secure keys.</para>
</section>

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

@ -1,42 +0,0 @@
<?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.
-->
<section id="about-physical-networks">
<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>
<listitem><para>Add/Remove/Update physical networks in a zone</para></listitem>
<listitem><para>Configure VLANs on the physical network</para></listitem>
<listitem><para>Configure a name so the network can be recognized by hypervisors</para></listitem>
<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="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" />
<xi:include href="advanced-zone-guest-ip-addresses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="advanced-zone-public-ip-addresses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="system-reserved-ip-addresses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -1,38 +0,0 @@
<?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.
-->
<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.
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" />
</imageobject>
<textobject><phrase>pod-overview.png: Nested structure of a simple pod</phrase></textobject>
</mediaobject>
</section>

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

@ -1,38 +0,0 @@
<?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.
-->
<section id="about-primary-storage">
<title>About Primary Storage</title>
<para>Primary storage is associated with a cluster and/or a zone. It stores the disk volumes for all of the VMs running on hosts in that cluster. You can add multiple primary storage servers to a cluster or a zone (at least one is required at the cluster level). Primary storage is typically located close to the hosts for increased performance. &PRODUCT; manages the allocation of guest virtual disks to particular primary storage devices.</para>
<para>Primary storage uses the concept of a storage tag. A storage tag is a label that is used to identify the primary storage. Each primary storage can be associated with zero, one, or more storage tags. When a VM is spun up or a data disk attached to a VM for the first time, these tags, if supplied, are used to determine which primary storage can support the VM or data disk (ex. say you need to guarantee a certain number of IOPS to a particular volume).</para>
<para>Primary storage can be either static or dynamic. Static primary storage is what CloudStack has traditionally supported. In this model, the administrator must present CloudStack with a certain amount of preallocated storage (ex. a volume from a SAN) and CloudStack can place many of its volumes on this storage. In the newer, dynamic model, the administrator can present CloudStack with a storage system itself (ex. a SAN). CloudStack, working in concert with a plug-in developed for that storage system, can dynamically create volumes on the storage system. A valuable use for this ability is Quality of Service (QoS). If a volume created in CloudStack can be backed by a dedicated volume on a SAN (i.e. a one-to-one mapping between a SAN volume and a CloudStack volume) and the SAN provides QoS, then CloudStack can provide QoS.</para>
<para>&PRODUCT; is designed to work with all standards-compliant iSCSI and NFS servers that are supported by the underlying hypervisor, including, for example:</para>
<itemizedlist>
<listitem><para>SolidFire for iSCSI</para></listitem>
<listitem><para>Dell EqualLogic™ for iSCSI</para></listitem>
<listitem><para>Network Appliances filers for NFS and iSCSI</para></listitem>
<listitem><para>Scale Computing for NFS</para></listitem>
</itemizedlist>
<para>If you intend to use only local disk for your installation, you can skip to Add Secondary Storage.</para>
</section>

50
docs/en-US/about-regions.xml
View File

@ -1,50 +0,0 @@
<?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.
-->
<section id="about-regions">
<title>About Regions</title>
<para>To increase reliability of the cloud, you can optionally group resources into multiple geographic regions.
A region is the largest available organizational unit within a &PRODUCT; deployment.
A region is made up of several availability zones, where each zone is roughly equivalent to a datacenter.
Each region is controlled by its own cluster of Management Servers, running in one of the zones.
The zones in a region are typically located in close geographical proximity.
Regions are a useful technique for providing fault tolerance and disaster recovery.</para>
<para>By grouping zones into regions, the cloud can achieve higher availability and scalability.
User accounts can span regions, so that users can deploy VMs in multiple, widely-dispersed regions.
Even if one of the regions becomes unavailable, the services are still available to the end-user through VMs deployed in another region.
And by grouping communities of zones under their own nearby Management Servers, the latency of communications within the cloud is reduced
compared to managing widely-dispersed zones from a single central Management Server.
</para>
<para>
Usage records can also be consolidated and tracked at the region level, creating reports or invoices for each geographic region.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/region-overview.png" />
</imageobject>
<textobject><phrase>region-overview.png: Nested structure of a region.</phrase></textobject>
</mediaobject>
<para>Regions are visible to the end user. When a user starts a guest VM on a particular &PRODUCT; Management Server,
the user is implicitly selecting that region for their guest.
Users might also be required to copy their private templates to additional regions to enable creation of guest VMs using their templates in those regions.</para>
</section>

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

@ -1,51 +0,0 @@
<?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.
-->
<section id="about-secondary-storage">
<title>About Secondary Storage</title>
<para>Secondary storage stores the following:</para>
<itemizedlist>
<listitem><para>Templates &mdash; OS images that can be used to boot VMs and can include additional configuration information, such as installed applications</para></listitem>
<listitem><para>ISO images &mdash; disc images containing data or bootable media for operating systems</para></listitem>
<listitem><para>Disk volume snapshots &mdash; saved copies of VM data which can be used for data recovery or to create new templates</para></listitem>
</itemizedlist>
<para>The items in secondary storage are available to all hosts in the scope of
the secondary storage, which may be defined as per zone or per region.</para>
<para>To make items in secondary storage available to all hosts throughout the cloud, you can
add object storage in addition to the
zone-based NFS Secondary Staging Store.
It is not necessary to
copy templates and snapshots from one zone to another, as would be required when using zone
NFS alone. Everything is available everywhere.</para>
<para>&PRODUCT; provides plugins that enable both
OpenStack Object Storage (Swift,
<ulink url="http://swift.openstack.org">swift.openstack.org</ulink>)
and Amazon Simple Storage Service (S3) object storage.
When using one of these storage plugins, you configure Swift or S3 storage for
the entire &PRODUCT;, then set up the NFS Secondary Staging Store for each zone. The NFS
storage in each zone acts as a staging area through which all templates and other secondary
storage data pass before being forwarded to Swoft or S3.
The backing object storage acts as a cloud-wide
resource, making templates and other data available to any zone in the cloud.</para>
</section>

40
docs/en-US/about-security-groups.xml
View File

@ -1,40 +0,0 @@
<?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.
-->
<section id="about-security-groups">
<title>About Security Groups</title>
<para>Security groups provide a way to isolate traffic to VMs. A security group is a group of
VMs that filter their incoming and outgoing traffic according to a set of rules, called
ingress and egress rules. These rules filter network traffic according to the IP address
that is attempting to communicate with the VM. Security groups are particularly useful in
zones that use basic networking, because there is a single guest network for all guest VMs.
In advanced zones, security groups are supported only on the KVM hypervisor.</para>
<note><para>In a zone that uses advanced networking, you can instead define multiple guest networks to isolate traffic to VMs.</para>
</note>
<para></para>
<para>Each &PRODUCT; account comes with a default security group that denies all inbound traffic and allows all outbound traffic. The default security group can be modified so that all new VMs inherit some other desired set of rules.</para>
<para>Any &PRODUCT; user can set up any number of additional security groups. When a new VM is launched, it is assigned to the default security group unless another user-defined security group is specified. A VM can be a member of any number of security groups. Once a VM is assigned to a security group, it remains in that group for its entire lifetime; you can not move a running VM from one security group to another.</para>
<para>You can modify a security group by deleting or adding any number of ingress and egress rules. When you do, the new rules apply to all VMs in the group, whether running or stopped.</para>
<para>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>
</section>

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

@ -1,30 +0,0 @@
<?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.
-->
<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>
<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>

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

@ -1,64 +0,0 @@
<?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.
-->
<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>
<note>
<para>You can append the display name of a guest VM to its internal name. For more information,
see <xref linkend="append-displayname-vms"/>.</para>
</note>
<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. Optionally, you can also decide not to allocate a
public IP to a VM in an EIP-enabled Basic zone. For more information on Elastic IP, see <xref
linkend="elastic-ip"/>.</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>

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

@ -1,74 +0,0 @@
<?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.
-->
<section id="about-zones">
<title>About Zones</title>
<para>A zone is the second 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>
<listitem><para>One or more pods. Each pod contains one or more clusters of hosts and one or more primary storage servers.</para></listitem>
<listitem><para>A zone may contain one or more primary storage servers, which are shared by all the pods in the zone.</para></listitem>
<listitem><para>Secondary storage, which is shared by all the pods in the zone.</para></listitem>
</itemizedlist>
<mediaobject>
<imageobject>
<imagedata fileref="./images/zone-overview.png" />
</imageobject>
<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>
<para>Hosts in the same zone are directly accessible to each other without having to go through a firewall. Hosts in different zones can access each other through statically configured VPN tunnels.</para>
<para>For each zone, the administrator must decide the following.</para>
<itemizedlist>
<listitem><para>How many pods to place in each zone.</para></listitem>
<listitem><para>How many clusters to place in each pod.</para></listitem>
<listitem><para>How many hosts to place in each cluster.</para></listitem>
<listitem><para>(Optional) How many primary storage servers to place in each zone and total capacity for these storage servers.</para></listitem>
<listitem><para>How many primary storage servers to place in each cluster and total capacity for these storage servers.</para></listitem>
<listitem><para>How much secondary storage to deploy in a zone.</para></listitem>
</itemizedlist>
<para>When you add a new zone using the &PRODUCT; UI, you will be prompted to configure the zone’s physical network
and add the first pod, cluster, host, primary storage, and secondary storage.</para>
<para>In order to support zone-wide functions for VMware, &PRODUCT; is aware of VMware Datacenters and can map each Datacenter to a
&PRODUCT; zone. To enable features like storage live migration and zone-wide
primary storage for VMware hosts, &PRODUCT; has to make sure that a zone
contains only a single VMware Datacenter. Therefore, when you are creating a new
&PRODUCT; zone, you can select a VMware Datacenter for the zone. If you
are provisioning multiple VMware Datacenters, each one will be set up as a single zone
in &PRODUCT;. </para>
<note>
<para>If you are upgrading from a previous &PRODUCT; version, and your existing
deployment contains a zone with clusters from multiple VMware Datacenters, that zone
will not be forcibly migrated to the new model. It will continue to function as
before. However, any new zone-wide operations, such as zone-wide primary storage
and live storage migration, will
not be available in that zone.</para>
</note>
<para/>
</section>

36
docs/en-US/accept-membership-invite.xml
View File

@ -1,36 +0,0 @@
<?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.
-->
<section id="accept-membership-invite">
<title>Accepting a Membership Invitation</title>
<para>If you have received an invitation to join a &PRODUCT; project, and you want to accept the invitation, follow these steps:</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation, click Projects.</para></listitem>
<listitem><para>In Select View, choose Invitations.</para></listitem>
<listitem><para>If you see the invitation listed onscreen, click the Accept button.</para> <para>Invitations listed on screen were sent to you using your &PRODUCT; account name.</para></listitem>
<listitem><para>If you received an email invitation, click the Enter Token button, and provide the project ID and unique ID code (token) from the email.</para></listitem>
</orderedlist>
</section>

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

@ -1,66 +0,0 @@
<?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.
-->
<section id="accessing-system-vms">
<title>Accessing System VMs</title>
<para>It may sometimes be necessary to access System VMs for diagnostics of certain issues, for example if you are experiencing SSVM (Secondary Storage VM) connection issues. Use the steps below in order to connect to the SSH console of a running System VM.</para>
<para>
Accessing System VMs over the network requires the use of private keys and connecting to System VMs SSH Daemon on port 3922.
XenServer/KVM Hypervisors store this key at /root/.ssh/id_rsa.cloud on each &PRODUCT; agent.
To access System VMs running on ESXi, the key is stored on the management server at /var/lib/cloudstack/management/.ssh/id_rsa.
</para>
<orderedlist>
<listitem>
<para>Find the details of the System VM</para>
<orderedlist numeration="loweralpha">
<listitem><para>Log in with admin privileges to the &PRODUCT; UI.</para></listitem>
<listitem><para>Click Infrastructure, then System VMs, and then click the name of a running VM.</para></listitem>
<listitem><para>Take a note of the 'Host', 'Private IP Address' and 'Link Local IP Address' of the System VM you wish to access.</para></listitem>
</orderedlist>
<para><inlinegraphic format="PNG" fileref="images/view-systemvm-details.png"/></para>
</listitem>
<listitem>
<para>XenServer/KVM Hypervisors</para>
<orderedlist numeration="loweralpha">
<listitem><para>Connect to the Host of which the System VM is running.</para></listitem>
<listitem><para>SSH the 'Link Local IP Address' of the System VM from the Host on which the VM is running.</para></listitem>
<listitem><para>Format: ssh -i &lt;path-to-private-key&gt; &lt;link-local-ip&gt; -p 3922</para></listitem>
<listitem><para>Example: root@faith:~# ssh -i /root/.ssh/id_rsa.cloud 169.254.3.93 -p 3922</para></listitem>
</orderedlist>
</listitem>
<listitem>
<para>ESXi Hypervisors</para>
<orderedlist numeration="loweralpha">
<listitem><para>Connect to your &PRODUCT; Management Server.</para></listitem>
<listitem><para>ESXi users should SSH to the private IP address of the System VM.</para></listitem>
<listitem><para>Format: ssh -i &lt;path-to-private-key&gt; &lt;vm-private-ip&gt; -p 3922</para></listitem>
<listitem><para>Example: root@management:~# ssh -i /var/lib/cloudstack/management/.ssh/id_rsa 172.16.0.250 -p 3922</para></listitem>
</orderedlist>
</listitem>
</orderedlist>
</section>

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

@ -1,40 +0,0 @@
<?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.
-->
<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/view-console-button.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 <xref linkend="ip-forwarding-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 <xref linkend="ip-forwarding-firewalling"/>.</para></listitem>
</orderedlist>
</section>

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

@ -1,133 +0,0 @@
<?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.
-->
<section id="accounts-users-domains">
<title>Accounts, Users, and Domains</title>
<formalpara>
<title>Accounts</title>
<para>An account typically represents a customer of the service provider or a department in a large organization. Multiple users can exist in an account.</para>
</formalpara>
<formalpara>
<title>Domains</title>
<para>Accounts are grouped by domains. Domains usually contain multiple accounts that have some logical relationship to each other and a set of delegated administrators with some authority over the domain and its subdomains. For example, a service provider with several resellers could create a domain for each reseller.</para>
</formalpara>
<para>For each account created, the Cloud installation creates three different types of user accounts: root administrator, domain administrator, and user.</para>
<formalpara>
<title>Users</title>
<para>Users are like aliases in the account. Users in the same account are not isolated from each other, but they are isolated from users in other accounts. Most installations need not surface the notion of users; they just have one user per account. The same user cannot belong to multiple accounts.</para>
</formalpara>
<para>Username is unique in a domain across accounts in that domain. The same username can exist in other domains, including sub-domains. Domain name can repeat only if the full pathname from root is unique. For example, you can create root/d1, as well as root/foo/d1, and root/sales/d1.</para>
<para>Administrators are accounts with special privileges in the system. There may be multiple administrators in the system. Administrators can create or delete other administrators, and change the password for any user in the system.</para>
<formalpara>
<title>Domain Administrators</title>
<para>Domain administrators can perform administrative operations for users who belong to that domain. Domain administrators do not have visibility into physical servers or other domains.</para>
</formalpara>
<formalpara>
<title>Root Administrator</title>
<para>Root administrators have complete access to the system, including managing templates, service offerings, customer care administrators, and domains</para>
</formalpara>
<formalpara>
<title>Resource Ownership</title>
<para>Resources belong to the account, not individual users in that account. For example,
billing, resource limits, and so on are maintained by the account, not the users. A user
can operate on any resource in the account provided the user has privileges for that
operation. The privileges are determined by the role. A root administrator can change
the ownership of any virtual machine from one account to any other account by using the
assignVirtualMachine API. A domain or sub-domain administrator can do the same for VMs
within the domain from one account to any other account in the domain or any of its
sub-domains.</para>
</formalpara>
<section id="dedicated-host-cluster-pod">
<title>Dedicating Resources to Accounts and Domains</title>
<para>The root administrator can dedicate resources to a specific domain or account
that needs private infrastructure for additional security or performance guarantees.
A zone, pod, cluster, or host can be reserved by the root administrator for a specific domain or account.
Only users in that domain or its subdomain may use the infrastructure.
For example, only users in a given domain can create guests in a zone dedicated to that domain.</para>
<para>There are several types of dedication available:</para>
<itemizedlist>
<listitem>
<para>Explicit dedication. A zone, pod, cluster, or host is dedicated to an account or
domain by the root administrator during initial deployment and
configuration.</para></listitem>
<listitem><para>Strict implicit dedication. A host will not be shared across multiple accounts. For example,
strict implicit dedication is useful for deployment of certain types of
applications, such as desktops, where no host can be shared
between different accounts without violating the desktop software's terms of license.</para></listitem>
<listitem><para>Preferred implicit dedication. The VM will be deployed in dedicated infrastructure if
possible. Otherwise, the VM can be deployed in shared
infrastructure.</para></listitem>
</itemizedlist>
<section id="dedication-how-to">
<title>How to Dedicate a Zone, Cluster, Pod, or Host to an Account or Domain</title>
<para>For explicit dedication: When deploying a new zone, pod, cluster, or host, the
root administrator can click the Dedicated checkbox, then choose a domain or account
to own the resource.</para>
<para>To explicitly dedicate an existing zone, pod, cluster, or host: log in as the root admin,
find the resource in the UI, and click the Dedicate button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/dedicate-resource-button.png"/>
</imageobject>
<textobject>
<phrase>dedicate-resource-button.png: button to dedicate a zone, pod, cluster, or host</phrase>
</textobject>
</inlinemediaobject></para>
<para>For implicit dedication: The administrator creates a compute service offering and
in the Deployment Planner field, chooses ImplicitDedicationPlanner. Then in Planner
Mode, the administrator specifies either Strict or Preferred, depending on whether
it is permissible to allow some use of shared resources when dedicated resources are
not available. Whenever a user creates a VM based on this service offering, it is
allocated on one of the dedicated hosts.</para>
</section>
<section id="using-dedication-how-to">
<title>How to Use Dedicated Hosts</title>
<para>To use an explicitly dedicated host, use the explicit-dedicated type of affinity
group (see <xref linkend="affinity-groups"/>). For example, when creating a new VM,
an end user can choose to place it on dedicated infrastructure. This operation will
succeed only if some infrastructure has already been assigned as dedicated to the
user's account or domain.</para>
</section>
<section id="dedicated-infrastructure-behavior">
<title>Behavior of Dedicated Hosts, Clusters, Pods, and Zones</title>
<para>The administrator can live migrate VMs away from dedicated hosts if desired, whether the destination
is a host reserved for a different account/domain or a host that is shared (not dedicated to any particular account or domain).
&PRODUCT; will generate an alert, but the operation is allowed.</para>
<para>Dedicated hosts can be used in conjunction with host tags. If both a host tag and dedication are requested,
the VM will be placed only on a host that meets both requirements. If there is no dedicated resource available
to that user that also has the host tag requested by the user, then the VM will not deploy.</para>
<para>If you delete an account or domain, any hosts, clusters, pods, and zones that were
dedicated to it are freed up. They will now be available to be shared by any account
or domain, or the administrator may choose to re-dedicate them to a different
account or domain.</para>
<para>System VMs and virtual routers affect the behavior of host dedication.
System VMs and virtual routers are owned by the &PRODUCT; system account,
and they can be deployed on any host. They do not adhere to explicit dedication.
The presence of system vms and virtual routers on a host makes it unsuitable for strict implicit dedication.
The host can not be used for strict implicit dedication,
because the host already has VMs of a specific account (the default system account).
However, a host with system VMs or virtual routers can be used
for preferred implicit dedication.
</para>
</section>
</section>
</section>

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

@ -1,29 +0,0 @@
<?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.
-->
<chapter id="accounts">
<title>Accounts</title>
<xi:include href="accounts-users-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="LDAP-for-user-authentication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

52
docs/en-US/acquire-new-ip-address.xml
View File

@ -1,52 +0,0 @@
<?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.
-->
<section id="acquire-new-ip-address">
<title>Acquiring a New IP Address</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 work with.</para>
</listitem>
<listitem>
<para>Click View IP Addresses.</para>
</listitem>
<listitem>
<para>Click Acquire New IP.</para>
<para>The Acquire New IP window is displayed.</para>
</listitem>
<listitem>
<para>Specify whether you want cross-zone IP or not.</para>
<para>If you want Portable IP click Yes in the confirmation dialog. If you want a normal
Public IP click No.</para>
<para>For more information on Portable IP, see <xref linkend="portable-ip"/>.</para>
<para>Within a few moments, the new IP address should appear with the state Allocated. You can
now use the IP address in port forwarding or static NAT rules.</para>
</listitem>
</orderedlist>
</section>

88
docs/en-US/acquire-new-ip-for-vpc.xml
View File

@ -1,88 +0,0 @@
<?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.
-->
<section id="acquire-new-ip-for-vpc">
<title>Acquiring a New IP Address for a VPC</title>
<para>When you acquire an IP address, all IP addresses are allocated to VPC, not to the guest
networks within the VPC. The IPs are associated to the guest network only when the first
port-forwarding, load balancing, or Static NAT rule is created for the IP or the network. IP
can't be associated to more than one network at a time.</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 the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
<para>The VPC page is displayed where all the tiers you created are listed in a
diagram.</para>
<para>The following options are displayed.</para>
<itemizedlist>
<listitem>
<para>Internal LB</para>
</listitem>
<listitem>
<para>Public LB IP</para>
</listitem>
<listitem>
<para>Static NAT</para>
</listitem>
<listitem>
<para>Virtual Machines</para>
</listitem>
<listitem>
<para>CIDR</para>
</listitem>
</itemizedlist>
<para>The following router information is displayed:</para>
<itemizedlist>
<listitem>
<para>Private Gateways</para>
</listitem>
<listitem>
<para>Public IP Addresses</para>
</listitem>
<listitem>
<para>Site-to-Site VPNs</para>
</listitem>
<listitem>
<para>Network ACL Lists</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select IP Addresses.</para>
<para>The Public IP Addresses page is displayed.</para>
</listitem>
<listitem>
<para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
<para>You are prompted for confirmation because, typically, IP addresses are a limited
resource. Within a few moments, the new IP address should appear with the state Allocated.
You can now use the IP address in port forwarding, load balancing, and static NAT
rules.</para>
</listitem>
</orderedlist>
</section>

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

@ -1,65 +0,0 @@
<?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.
-->
<section id="add-additional-guest-network">
<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>

53
docs/en-US/add-clusters-kvm-xenserver.xml
View File

@ -1,53 +0,0 @@
<?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.
-->
<section id="add-clusters-kvm-xenserver">
<title>Add Cluster: KVM or XenServer</title>
<para>These steps assume you have already installed the hypervisor on the hosts and logged in to
the &PRODUCT; UI.</para>
<orderedlist>
<listitem>
<para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the
zone in which you want to add the cluster.</para>
</listitem>
<listitem>
<para>Click the Compute tab.</para>
</listitem>
<listitem>
<para>In the Clusters node of the diagram, click View All.</para>
</listitem>
<listitem>
<para>Click Add Cluster.</para>
</listitem>
<listitem>
<para>Choose the hypervisor type for this cluster.</para>
</listitem>
<listitem>
<para>Choose the pod in which you want to create the cluster.</para>
</listitem>
<listitem>
<para>Enter a name for the cluster. This can be text of your choosing and is not used by
&PRODUCT;.</para>
</listitem>
<listitem>
<para>Click OK.</para>
</listitem>
</orderedlist>
</section>

43
docs/en-US/add-clusters-ovm.xml
View File

@ -1,43 +0,0 @@
<?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.
-->
<section id="add-clusters-ovm">
<title>Add Cluster: OVM</title>
<para>To add a Cluster of hosts that run Oracle VM (OVM):</para>
<orderedlist>
<listitem><para>Add a companion non-OVM cluster to the Pod. This cluster provides an environment where the &PRODUCT; System VMs can run. You should have already installed a non-OVM hypervisor on at least one Host to prepare for this step. Depending on which hypervisor you used:</para>
<itemizedlist>
<listitem><para>For VMWare, follow the steps in <xref linkend="add-clusters-vsphere"/>. When finished, return here and continue with the next step.</para></listitem>
<listitem><para>For KVM or XenServer, follow the steps in <xref linkend="add-clusters-kvm-xenserver"/>. When finished, return here and continue with the next step</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View All, then click the zone in which you want to add the cluster.</para></listitem>
<listitem><para>Click the Compute and Storage tab. In the Pods node, click View All.</para></listitem>
<listitem><para>Click View Clusters, then click Add Cluster.</para>
<para>The Add Cluster dialog is displayed.</para></listitem>
<listitem><para>In Hypervisor, choose OVM.</para></listitem>
<listitem><para>In Cluster, enter a name for the cluster.</para></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
</section>

178
docs/en-US/add-clusters-vsphere.xml
View File

@ -1,178 +0,0 @@
<?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.
-->
<section id="add-clusters-vsphere">
<title>Add Cluster: vSphere</title>
<para>Host management for vSphere is done through a combination of vCenter and the &PRODUCT; admin
UI. &PRODUCT; requires that all hosts be in a &PRODUCT; cluster, but the cluster may consist of
a single host. As an administrator you must decide if you would like to use clusters of one host
or of multiple hosts. Clusters of multiple hosts allow for features like live migration.
Clusters also require shared storage such as NFS or iSCSI.</para>
<para>For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding
the entire cluster to &PRODUCT;. Follow these requirements:</para>
<itemizedlist>
<listitem>
<para>Do not put more than 8 hosts in a vSphere cluster</para>
</listitem>
<listitem>
<para>Make sure the hypervisor hosts do not have any VMs already running before you add them
to &PRODUCT;.</para>
</listitem>
</itemizedlist>
<para>To add a vSphere cluster to &PRODUCT;:</para>
<orderedlist>
<listitem>
<para>Create the cluster of hosts in vCenter. Follow the vCenter instructions to do this. You
will create a cluster that looks something like this in vCenter.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/vsphere-client.png"/>
</imageobject>
<textobject>
<phrase>vsphereclient.png: vSphere client</phrase>
</textobject>
</mediaobject>
</listitem>
<listitem>
<para>Log in to the UI.</para>
</listitem>
<listitem>
<para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the
zone in which you want to add the cluster.</para>
</listitem>
<listitem>
<para>Click the Compute tab, and click View All on Pods. Choose the pod to which you want to
add the cluster.</para>
</listitem>
<listitem>
<para>Click View Clusters.</para>
</listitem>
<listitem>
<para>Click Add Cluster.</para>
</listitem>
<listitem>
<para>In Hypervisor, choose VMware.</para>
</listitem>
<listitem>
<para>Provide the following information in the dialog. The fields below make reference to the
values from vCenter.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-cluster.png"/>
</imageobject>
<textobject>
<phrase>addcluster.png: add a cluster</phrase>
</textobject>
</mediaobject>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Cluster Name</emphasis>: Enter the name of the cluster you
created in vCenter. For example, "cloud.cluster.2.2.1"</para>
</listitem>
<listitem>
<para><emphasis role="bold">vCenter Username</emphasis>: Enter the username that &PRODUCT;
should use to connect to vCenter. This user must have all the administrative
privileges.</para>
</listitem>
<listitem>
<para><emphasis role="bold">CPU overcommit ratio</emphasis>: Enter the CPU overcommit
ratio for the cluster. The value you enter determines the CPU consumption of each VM in
the selected cluster. By increasing the over-provisioning ratio, more resource capacity
will be used. If no value is specified, the value is defaulted to 1, which implies no
over-provisioning is done.</para>
</listitem>
<listitem>
<para><emphasis role="bold">RAM overcommit ratio</emphasis>: Enter the RAM overcommit
ratio for the cluster. The value you enter determines the memory consumption of each VM
in the selected cluster. By increasing the over-provisioning ratio, more resource
capacity will be used. If no value is specified, the value is defaulted to 1, which
implies no over-provisioning is done.</para>
</listitem>
<listitem>
<para><emphasis role="bold">vCenter Host</emphasis>: Enter the hostname or IP address of
the vCenter server.</para>
</listitem>
<listitem>
<para><emphasis role="bold">vCenter Password</emphasis>: Enter the password for the user
named above.</para>
</listitem>
<listitem>
<para><emphasis role="bold">vCenter Datacenter</emphasis>: Enter the vCenter datacenter
that the cluster is in. For example, "cloud.dc.VM".</para>
</listitem>
<listitem>
<para><emphasis role="bold">Override Public Traffic</emphasis>: Enable this option to
override the zone-wide public traffic for the cluster you are creating.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Public Traffic vSwitch Type</emphasis>: This option is
displayed only if you enable the Override Public Traffic option. Select a desirable
switch. If the vmware.use.dvswitch global parameter is true, the default option will be
VMware vNetwork Distributed Virtual Switch.</para>
<para>If you have enabled Nexus dvSwitch in the environment, the following parameters for
dvSwitch configuration are displayed:</para>
<itemizedlist>
<listitem>
<para>Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance.</para>
</listitem>
<listitem>
<para>Nexus dvSwitch Username: The username required to access the Nexus VSM
appliance.</para>
</listitem>
<listitem>
<para>Nexus dvSwitch Password: The password associated with the username specified
above.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><emphasis role="bold">Override Guest Traffic</emphasis>: Enable this option to
override the zone-wide guest traffic for the cluster you are creating.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Guest Traffic vSwitch Type</emphasis>: This option is
displayed only if you enable the Override Guest Traffic option. Select a desirable
switch. </para>
<para>If the vmware.use.dvswitch global parameter is true, the default option will be
VMware vNetwork Distributed Virtual Switch.</para>
<para>If you have enabled Nexus dvSwitch in the environment, the following parameters for
dvSwitch configuration are displayed:</para>
<itemizedlist>
<listitem>
<para>Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance.</para>
</listitem>
<listitem>
<para>Nexus dvSwitch Username: The username required to access the Nexus VSM
appliance.</para>
</listitem>
<listitem>
<para>Nexus dvSwitch Password: The password associated with the username specified
above.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>There might be a slight delay while the cluster is provisioned. It will
automatically display in the UI.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>

227
docs/en-US/add-gateway-vpc.xml
View File

@ -1,227 +0,0 @@
<?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.
-->
<section id="add-gateway-vpc">
<title>Adding a Private Gateway to a VPC</title>
<para>A private gateway can be added by the root admin only. The VPC private network has 1:1
relationship with the NIC of the physical network. You can configure multiple private gateways
to a single VPC. No gateways with duplicated VLAN and IP are allowed in the same data
center.</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 the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Click the Configure button of the VPC to which you want to configure load balancing
rules.</para>
<para>The VPC page is displayed where all the tiers you created are listed in a
diagram.</para>
</listitem>
<listitem>
<para>Click the Settings icon.</para>
<para>The following options are displayed.</para>
<itemizedlist>
<listitem>
<para>Internal LB</para>
</listitem>
<listitem>
<para>Public LB IP</para>
</listitem>
<listitem>
<para>Static NAT</para>
</listitem>
<listitem>
<para>Virtual Machines</para>
</listitem>
<listitem>
<para>CIDR</para>
</listitem>
</itemizedlist>
<para>The following router information is displayed:</para>
<itemizedlist>
<listitem>
<para>Private Gateways</para>
</listitem>
<listitem>
<para>Public IP Addresses</para>
</listitem>
<listitem>
<para>Site-to-Site VPNs</para>
</listitem>
<listitem>
<para>Network ACL Lists</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Select Private Gateways.</para>
<para>The Gateways page is displayed.</para>
</listitem>
<listitem>
<para>Click Add new gateway:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-new-gateway-vpc.png"/>
</imageobject>
<textobject>
<phrase>add-new-gateway-vpc.png: adding a private gateway for the VPC.</phrase>
</textobject>
</mediaobject>
</listitem>
<listitem>
<para>Specify the following:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Physical Network</emphasis>: The physical network you have
created in the zone.</para>
</listitem>
<listitem>
<para><emphasis role="bold">IP Address</emphasis>: The IP address associated with the VPC
gateway.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Gateway</emphasis>: The gateway through which the traffic is
routed to and from the VPC.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Netmask</emphasis>: The netmask associated with the VPC
gateway.</para>
</listitem>
<listitem>
<para><emphasis role="bold">VLAN</emphasis>: The VLAN associated with the VPC
gateway.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Source NAT</emphasis>: Select this option to enable the source
NAT service on the VPC private gateway.</para>
<para>See <xref linkend="sourcenat-private-gateway"/>.</para>
</listitem>
<listitem>
<para><emphasis role="bold">ACL</emphasis>: Controls both ingress and egress traffic on a
VPC private gateway. By default, all the traffic is blocked.</para>
<para>See <xref linkend="acl-private-gateway"/>.</para>
</listitem>
</itemizedlist>
<para>The new gateway appears in the list. You can repeat these steps to add more gateway for
this VPC.</para>
</listitem>
</orderedlist>
<section id="sourcenat-private-gateway">
<title>Source NAT on Private Gateway</title>
<para>You might want to deploy multiple VPCs with the same super CIDR and guest tier CIDR.
Therefore, multiple guest VMs from different VPCs can have the same IPs to reach a enterprise
data center through the private gateway. In such cases, a NAT service need to be configured on
the private gateway to avoid IP conflicts. If Source NAT is enabled, the guest VMs in VPC
reaches the enterprise network via private gateway IP address by using the NAT service. </para>
<para>The Source NAT service on a private gateway can be enabled while adding the private
gateway. On deletion of a private gateway, source NAT rules specific to the private gateway
are deleted.</para>
<para>To enable source NAT on existing private gateways, delete them and create afresh with
source NAT. </para>
</section>
<section id="acl-private-gateway">
<title>ACL on Private Gateway</title>
<para>The traffic on the VPC private gateway is controlled by creating both ingress and egress
network ACL rules. The ACLs contains both allow and deny rules. As per the rule, all the
ingress traffic to the private gateway interface and all the egress traffic out from the
private gateway interface are blocked. </para>
<para>You can change this default behaviour while creating a private gateway. Alternatively, you
can do the following:</para>
<orderedlist>
<listitem>
<para>In a VPC, identify the Private Gateway you want to work with.</para>
</listitem>
<listitem>
<para>In the Private Gateway page, do either of the following:</para>
<itemizedlist>
<listitem>
<para>Use the Quickview. See <xref linkend="quickview"/>.</para>
</listitem>
<listitem>
<para>Use the Details tab. See <xref linkend="details-tab"/> through .</para>
</listitem>
</itemizedlist>
</listitem>
<listitem id="quickview">
<para>In the Quickview of the selected Private Gateway, click Replace ACL, select the ACL
rule, then click OK</para>
</listitem>
<listitem id="details-tab">
<para>Click the IP address of the Private Gateway you want to work with.</para>
</listitem>
<listitem>
<para>In the Detail tab, click the Replace ACL button. <inlinemediaobject>
<imageobject>
<imagedata fileref="./images/replace-acl-icon.png"/>
</imageobject>
<textobject>
<phrase>replace-acl-icon.png: button to replace the default ACL behaviour.</phrase>
</textobject>
</inlinemediaobject></para>
<para>The Replace ACL dialog is displayed.</para>
</listitem>
<listitem>
<para>select the ACL rule, then click OK.</para>
<para>Wait for few seconds. You can see that the new ACL rule is displayed in the Details
page.</para>
</listitem>
</orderedlist>
</section>
<section id="static-route">
<title>Creating a Static Route</title>
<para>&PRODUCT; enables you to specify routing for the VPN connection you create. You can enter
one or CIDR addresses to indicate which traffic is to be routed back to the gateway.</para>
<orderedlist>
<listitem>
<para>In a VPC, identify the Private Gateway you want to work with.</para>
</listitem>
<listitem>
<para>In the Private Gateway page, click the IP address of the Private Gateway you want to
work with.</para>
</listitem>
<listitem>
<para>Select the Static Routes tab.</para>
</listitem>
<listitem>
<para>Specify the CIDR of destination network.</para>
</listitem>
<listitem>
<para>Click Add.</para>
<para>Wait for few seconds until the new route is created.</para>
</listitem>
</orderedlist>
</section>
<section id="blacklist-route">
<title>Blacklisting Routes</title>
<para>&PRODUCT; enables you to block a list of routes so that they are not assigned to any of
the VPC private gateways. Specify the list of routes that you want to blacklist in the
<code>blacklisted.routes</code> global parameter. Note that the parameter update affects
only new static route creations. If you block an existing static route, it remains intact and
continue functioning. You cannot add a static route if the route is blacklisted for the zone.
</para>
</section>
</section>

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

@ -1,131 +0,0 @@
<?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.
-->
<section id="add-ingress-egress-rules">
<title>Adding Ingress and Egress Rules to a Security Group</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>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>

124
docs/en-US/add-ip-range.xml
View File

@ -1,124 +0,0 @@
<?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.
-->
<section id="add-ip-range">
<title>Multiple Subnets in Shared Network</title>
<para>&PRODUCT; provides you with the flexibility to add guest IP ranges from different subnets in
Basic zones and security groups-enabled Advanced zones. For security groups-enabled Advanced
zones, it implies multiple subnets can be added to the same VLAN. With the addition of this
feature, you will be able to add IP address ranges from the same subnet or from a different one
when IP address are exhausted. This would in turn allows you to employ higher number of subnets
and thus reduce the address management overhead. You can delete the IP ranges you have
added.</para>
<section id="guidelines-multiplesubnet">
<title>Prerequisites and Guidelines</title>
<itemizedlist>
<listitem>
<para>This feature can only be implemented:</para>
<itemizedlist>
<listitem>
<para>on IPv4 addresses</para>
</listitem>
<listitem>
<para>if virtual router is the DHCP provider</para>
</listitem>
<listitem>
<para>on KVM, xenServer, and VMware hypervisors</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Manually configure the gateway of the new subnet before adding the IP range. </para>
</listitem>
<listitem>
<para>&PRODUCT; supports only one gateway for a subnet; overlapping subnets are not
currently supported</para>
</listitem>
</itemizedlist>
</section>
<section id="how-to-add-ip">
<title>Adding Multiple Subnets to a Shared 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 Infrastructure. </para>
</listitem>
<listitem>
<para>On Zones, click View More, then click the zone to which you want to work with..</para>
</listitem>
<listitem>
<para>Click Physical Network.</para>
</listitem>
<listitem>
<para>In the Guest node of the diagram, click Configure.</para>
</listitem>
<listitem>
<para>Click Networks.</para>
</listitem>
<listitem>
<para>Select the networks you want to work with.</para>
</listitem>
<listitem>
<para>Click View IP Ranges.</para>
</listitem>
<listitem>
<para>Click Add IP Range.</para>
<para>The Add IP Range dialog is displayed, as follows:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-ip-range.png"/>
</imageobject>
<textobject>
<phrase>add-ip-range.png: adding an IP range to a network.</phrase>
</textobject>
</mediaobject>
</listitem>
<listitem>
<para>Specify the following:</para>
<para>All the fields are mandatory.</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Gateway</emphasis>: The gateway for the tier you create.
Ensure that the gateway is within the Super CIDR range that you specified while
creating the VPC, and is not overlapped with the CIDR of any existing tier within the
VPC.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Netmask</emphasis>: The netmask for the tier you create. </para>
<para>For example, if the VPC CIDR is 10.0.0.0/16 and the network tier CIDR is
10.0.1.0/24, the gateway of the tier is 10.0.1.1, and the netmask of the tier is
255.255.255.0.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Start IP/ End IP</emphasis>: A range of IP addresses that
are accessible from the Internet and will be allocated to guest VMs. Enter the first
and last IP addresses that define a range that &PRODUCT; can assign to guest VMs
.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click OK.</para>
</listitem>
</orderedlist>
</section>
</section>

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

@ -1,151 +0,0 @@
<?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.
-->
<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><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/>
</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>

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

@ -1,102 +0,0 @@
<?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.
-->
<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>
<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 <xref
linkend="sticky-session-policies-for-lb-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>
<listitem><para><emphasis role="bold">Health Check</emphasis>: (Optional; NetScaler load balancers only) Click
Configure and fill in the characteristics of the health check policy. See <xref
linkend="health-checks-for-lb-rules"/>.</para>
<itemizedlist>
<listitem><para><emphasis role="bold">Ping path (Optional)</emphasis>: Sequence of destinations to which to send health check queries.
Default: / (all).</para></listitem>
<listitem><para><emphasis role="bold">Response time (Optional)</emphasis>: How long to wait for a response from the health check (2 - 60 seconds).
Default: 5 seconds.</para></listitem>
<listitem><para><emphasis role="bold">Interval time (Optional)</emphasis>: Amount of time between health checks (1 second - 5 minutes).
Default value is set in the global configuration parameter lbrule_health check_time_interval.</para></listitem>
<listitem><para><emphasis role="bold">Healthy threshold (Optional)</emphasis>: Number of consecutive health check successes
that are required before declaring an instance healthy.
Default: 2.</para></listitem>
<listitem><para><emphasis role="bold">Unhealthy threshold (Optional)</emphasis>: Number of consecutive health check failures that are required before declaring an instance unhealthy.
Default: 10.</para></listitem>
</itemizedlist></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>

462
docs/en-US/add-loadbalancer-rule-vpc.xml
View File

@ -1,462 +0,0 @@
<?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.
-->
<section id="add-loadbalancer-rule-vpc">
<title>Adding Load Balancing Rules on a VPC</title>
<para>In a VPC, you can configure two types of load balancing&mdash;external LB and internal LB.
External LB is nothing but a LB rule created to redirect the traffic received at a public IP of
the VPC virtual router. The traffic is load balanced within a tier based on your configuration.
Citrix NetScaler and VPC virtual router are supported for external LB. When you use internal LB
service, traffic received at a tier is load balanced across different VMs within that tier. For
example, traffic reached at Web tier is redirected to another VM in that tier. External load
balancing devices are not supported for internal LB. The service is provided by a internal LB VM
configured on the target tier.</para>
<section id="curent-lb-vpc">
<title>Load Balancing Within a Tier (External LB)</title>
<para>A &PRODUCT; user or administrator may create load balancing rules that balance traffic
received at a public IP to one or more VMs that belong to a network tier that provides load
balancing service in a VPC. A user creates a rule, specifies an algorithm, and assigns the
rule to a set of VMs within a tier.</para>
<section id="enable-vpc-public-lb">
<title>Enabling NetScaler as the LB Provider on a VPC Tier</title>
<orderedlist>
<listitem>
<para>Add and enable Netscaler VPX in dedicated mode.</para>
<para>Netscaler can be used in a VPC environment only if it is in dedicated mode.</para>
</listitem>
<listitem>
<para>Create a network offering, as given in <xref linkend="ext-lb-offering"/>.</para>
</listitem>
<listitem>
<para>Create a VPC with Netscaler as the Public LB provider.</para>
<para>For more information, see <xref linkend="add-vpc"/>.</para>
</listitem>
<listitem>
<para>For the VPC, acquire an IP.</para>
</listitem>
<listitem>
<para>Create an external load balancing rule and apply, as given in <xref
linkend="ext-lb-vpc"/>.</para>
</listitem>
</orderedlist>
</section>
<section id="ext-lb-offering">
<title>Creating a Network Offering for External LB</title>
<para>To have external LB support on VPC, create a network offering as follows: </para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI as a user or admin.</para>
</listitem>
<listitem>
<para>From the Select Offering drop-down, choose Network Offering.</para>
</listitem>
<listitem>
<para>Click Add Network Offering.</para>
</listitem>
<listitem>
<para>In the dialog, make the following choices:</para>
<itemizedlist>
<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">Traffic Type</emphasis>: The type of network traffic that
will be carried on the network.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Guest Type</emphasis>: Choose whether the guest network is
isolated or shared.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Persistent</emphasis>: Indicate whether the guest network
is persistent or not. The network that you can provision without having to deploy a
VM on it is termed persistent network. </para>
</listitem>
<listitem>
<para><emphasis role="bold">VPC</emphasis>: This option indicate whether the guest
network is Virtual Private Cloud-enabled. A Virtual Private Cloud (VPC) is a
private, isolated part of &PRODUCT;. A VPC can have its own virtual network topology
that resembles a traditional physical network. For more information on VPCs, see
<xref linkend="vpc"/>.</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 Load Balancer. Use
Netscaler or VpcVirtualRouter.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Load Balancer Type</emphasis>: Select Public LB from the
drop-down.</para>
</listitem>
<listitem>
<para><emphasis role="bold">LB Isolation</emphasis>: Select Dedicated if Netscaler is
used as the external LB provider.</para>
</listitem>
<listitem>
<para><emphasis role="bold">System Offering</emphasis>: Choose the system service
offering that you want virtual routers to use in this network.</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.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click OK and the network offering is created.</para>
</listitem>
</orderedlist>
</section>
<section id="ext-lb-vpc">
<title>Creating an External LB 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>In the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Click the Configure button of the VPC, for which you want to configure load
balancing rules.</para>
<para>The VPC page is displayed where all the tiers you created listed in a
diagram.</para>
<para>For each tier, the following options are displayed:</para>
<itemizedlist>
<listitem>
<para>Internal LB</para>
</listitem>
<listitem>
<para>Public LB IP</para>
</listitem>
<listitem>
<para>Static NAT</para>
</listitem>
<listitem>
<para>Virtual Machines</para>
</listitem>
<listitem>
<para>CIDR</para>
</listitem>
</itemizedlist>
<para>The following router information is displayed:</para>
<itemizedlist>
<listitem>
<para>Private Gateways</para>
</listitem>
<listitem>
<para>Public IP Addresses</para>
</listitem>
<listitem>
<para>Site-to-Site VPNs</para>
</listitem>
<listitem>
<para>Network ACL Lists</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the Router node, select Public IP Addresses.</para>
<para>The IP Addresses page is displayed.</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>Select the tier to which you want to apply the rule.</para>
</listitem>
<listitem>
<para>Specify 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 that receives the
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 the following well-known
algorithms:</para>
<itemizedlist>
<listitem>
<para>Round-robin</para>
</listitem>
<listitem>
<para>Least connections</para>
</listitem>
<listitem>
<para>Source</para>
</listitem>
</itemizedlist>
</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">Add VMs</emphasis>: Click Add VMs, then select two or more
VMs that will divide the load of incoming traffic, and click Apply.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
<para>The new load balancing rule appears in the list. You can repeat these steps to add more
load balancing rules for this IP address.</para>
</section>
</section>
<section id="acros-tiers-lb">
<title>Load Balancing Across Tiers</title>
<para>&PRODUCT; supports sharing workload across different tiers within your VPC. Assume that
multiple tiers are set up in your environment, such as Web tier and Application tier. Traffic
to each tier is balanced on the VPC virtual router on the public side, as explained in <xref
linkend="add-loadbalancer-rule-vpc"/>. If you want the traffic coming from the Web tier to
the Application tier to be balanced, use the internal load balancing feature offered by
&PRODUCT;.</para>
<section id="vpc-pic">
<title>How Does Internal LB Work in VPC?</title>
<para>In this figure, a public LB rule is created for the public IP 72.52.125.10 with public
port 80 and private port 81. The LB rule, created on the VPC virtual router, is applied on
the traffic coming from the Internet to the VMs on the Web tier. On the Application tier two
internal load balancing rules are created. An internal LB rule for the guest IP 10.10.10.4
with load balancer port 23 and instance port 25 is configured on the VM, InternalLBVM1.
Another internal LB rule for the guest IP 10.10.10.4 with load balancer port 45 and instance
port 46 is configured on the VM, InternalLBVM1. Another internal LB rule for the guest IP
10.10.10.6, with load balancer port 23 and instance port 25 is configured on the VM,
InternalLBVM2.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/vpc-lb.png"/>
</imageobject>
<textobject>
<phrase>vpc-lb.png: Configuring internal LB for VPC</phrase>
</textobject>
</mediaobject>
</section>
<section id="internallb-notes">
<title>Guidelines</title>
<itemizedlist>
<listitem><para>Internal LB and Public LB are mutually exclusive on a tier. If the tier has LB on the public
side, then it can't have the Internal LB.</para></listitem>
<listitem><para>Internal LB is supported just on VPC networks in &PRODUCT; 4.2 release.</para></listitem>
<listitem><para>Only Internal LB VM can act as the Internal LB provider in &PRODUCT; 4.2 release.</para></listitem>
<listitem><para>Network upgrade is not supported from the network offering with Internal LB to the network
offering with Public LB.</para></listitem>
<listitem><para>Multiple tiers can have internal LB support in a VPC.</para></listitem>
<listitem><para>Only one tier can have Public LB support in a VPC.</para></listitem>
</itemizedlist>
</section>
<section id="enable-vpc-lb">
<title>Enabling Internal LB on a VPC Tier</title>
<orderedlist>
<listitem>
<para>Create a network offering, as given in <xref linkend="int-lb-vpc"/>.</para>
</listitem>
<listitem>
<para>Create an internal load balancing rule and apply, as given in <xref
linkend="int-lb-vpc"/>.</para>
</listitem>
</orderedlist>
</section>
<section id="int-lb-offering">
<title>Creating a Network Offering for Internal LB</title>
<para>To have internal LB support on VPC, either use the default offering,
DefaultIsolatedNetworkOfferingForVpcNetworksWithInternalLB, or create a network offering as
follows: </para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI as a user or admin.</para>
</listitem>
<listitem>
<para>From the Select Offering drop-down, choose Network Offering.</para>
</listitem>
<listitem>
<para>Click Add Network Offering.</para>
</listitem>
<listitem>
<para>In the dialog, make the following choices:</para>
<itemizedlist>
<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">Traffic Type</emphasis>: The type of network traffic that
will be carried on the network.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Guest Type</emphasis>: Choose whether the guest network is
isolated or shared.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Persistent</emphasis>: Indicate whether the guest network
is persistent or not. The network that you can provision without having to deploy a
VM on it is termed persistent network. </para>
</listitem>
<listitem>
<para><emphasis role="bold">VPC</emphasis>: This option indicate whether the guest
network is Virtual Private Cloud-enabled. A Virtual Private Cloud (VPC) is a
private, isolated part of &PRODUCT;. A VPC can have its own virtual network topology
that resembles a traditional physical network. For more information on VPCs, see
<xref linkend="vpc"/>.</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 Load Balancer.
Select <code>InternalLbVM</code> from the provider list.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Load Balancer Type</emphasis>: Select Internal LB from the
drop-down.</para>
</listitem>
<listitem>
<para><emphasis role="bold">System Offering</emphasis>: Choose the system service
offering that you want virtual routers to use in this network.</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.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click OK and the network offering is created.</para>
</listitem>
</orderedlist>
</section>
<section id="int-lb-vpc">
<title>Creating an Internal LB Rule</title>
<para>When you create the Internal LB rule and applies to a VM, an Internal LB VM, which is
responsible for load balancing, is created. </para>
<para>You can view the created Internal LB VM in the Instances page if you navigate to
<emphasis role="bold">Infrastructure</emphasis> > <emphasis role="bold">Zones</emphasis> >
&lt;<emphasis role="italic">zone_ name</emphasis>&gt; > &lt;<emphasis role="italic"
>physical_network_name</emphasis>&gt; > <emphasis role="bold">Network Service
Providers</emphasis> > <emphasis role="bold">Internal LB VM</emphasis>. You can manage the
Internal LB VMs as and when required from the location.</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 the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Locate the VPC for which you want to configure internal LB, then click
Configure.</para>
<para>The VPC page is displayed where all the tiers you created listed in a
diagram.</para>
</listitem>
<listitem>
<para>Locate the Tier for which you want to configure an internal LB rule, click Internal
LB.</para>
<para>In the Internal LB page, click Add Internal LB.</para>
</listitem>
<listitem>
<para>In the dialog, specify 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">Description</emphasis>: A short description of the rule
that can be displayed to users.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Source IP Address</emphasis>: (Optional) The source IP
from which traffic originates. The IP is acquired from the CIDR of that particular
tier on which you want to create the Internal LB rule. If not specified, the IP
address is automatically allocated from the network CIDR.</para>
<para>For every Source IP, a new Internal LB VM is created for load balancing.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Source Port</emphasis>: The port associated with the
source IP. Traffic on this port is load balanced. </para>
</listitem>
<listitem>
<para><emphasis role="bold">Instance Port</emphasis>: The port of the internal LB
VM.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Algorithm</emphasis>. Choose the load balancing algorithm
you want &PRODUCT; to use. &PRODUCT; supports the following well-known
algorithms:</para>
<itemizedlist>
<listitem>
<para>Round-robin</para>
</listitem>
<listitem>
<para>Least connections</para>
</listitem>
<listitem>
<para>Source</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
</section>
</section>

35
docs/en-US/add-members-to-projects.xml
View File

@ -1,35 +0,0 @@
<?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.
-->
<section id="add-members-to-projects">
<title>Adding Members to a Project</title>
<para>New members can be added to a project by the project’s administrator, the domain administrator of the domain where the project resides or any parent domain, or the &PRODUCT; root administrator. There are two ways to add members in &PRODUCT;, but only one way is enabled at a time:</para>
<itemizedlist>
<listitem><para>If invitations have been enabled, you can send invitations to new members.</para></listitem>
<listitem><para>If invitations are not enabled, you can add members directly through the UI.</para></listitem>
</itemizedlist>
<xi:include href="send-projects-membership-invitation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-projects-members-from-ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

29
docs/en-US/add-more-clusters.xml
View File

@ -1,29 +0,0 @@
<?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.
-->
<section id="add-more-clusters">
<title>Add More Clusters (Optional)</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="about-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<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>

42
docs/en-US/add-password-management-to-templates.xml
View File

@ -1,42 +0,0 @@
<?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.
-->
<section id="add-password-management-to-templates">
<title>Adding Password Management to Your Templates</title>
<para>&PRODUCT; provides an optional password reset feature that allows users to set a temporary
admin or root password as well as reset the existing admin or root password from the &PRODUCT;
UI.</para>
<para>To enable the Reset Password feature, you will need to download an additional script to
patch your template. When you later upload the template into &PRODUCT;, you can specify whether
reset admin/root password feature should be enabled for this template.</para>
<para>The password management feature works always resets the account password on instance boot.
The script does an HTTP call to the virtual router to retrieve the account password that should
be set. As long as the virtual router is accessible the guest will have access to the account
password that should be used. When the user requests a password reset the management server
generates and sends a new password to the virtual router for the account. Thus an instance
reboot is necessary to effect any password changes.</para>
<para>If the script is unable to contact the virtual router during instance boot it will not set
the password but boot will continue normally.</para>
<xi:include href="linux-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="windows-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>

117
docs/en-US/add-portforward-rule-vpc.xml
View File

@ -1,117 +0,0 @@
<?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.
-->
<section id="add-portforward-vpc">
<title>Adding a Port Forwarding Rule on a VPC</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>In the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
<para>The VPC page is displayed where all the tiers you created are listed in a
diagram.</para>
<para>For each tier, the following options are displayed:</para>
<itemizedlist>
<listitem>
<para>Internal LB</para>
</listitem>
<listitem>
<para>Public LB IP</para>
</listitem>
<listitem>
<para>Static NAT</para>
</listitem>
<listitem>
<para>Virtual Machines</para>
</listitem>
<listitem>
<para>CIDR</para>
</listitem>
</itemizedlist>
<para>The following router information is displayed:</para>
<itemizedlist>
<listitem>
<para>Private Gateways</para>
</listitem>
<listitem>
<para>Public IP Addresses</para>
</listitem>
<listitem>
<para>Site-to-Site VPNs</para>
</listitem>
<listitem>
<para>Network ACL Lists</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In the Router node, select Public IP Addresses.</para>
<para>The IP Addresses page is displayed.</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 Port Forwarding node of the diagram, click View All.</para>
</listitem>
<listitem>
<para>Select the tier to which you want to apply the rule.</para>
</listitem>
<listitem>
<para>Specify the following:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Public Port</emphasis>: The port to which public traffic will
be addressed on the IP address you acquired in the previous step.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Private Port</emphasis>: The port on which the instance is
listening for forwarded public traffic.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Protocol</emphasis>: The communication protocol in use between
the two ports.</para>
<itemizedlist>
<listitem>
<para>TCP</para>
</listitem>
<listitem>
<para>UDP</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><emphasis role="bold">Add VM</emphasis>: Click Add VM. Select the name of the
instance to which this rule applies, and click Apply.</para>
<para>You can test the rule by opening an SSH session to the instance.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>

108
docs/en-US/add-primary-storage.xml
View File

@ -1,108 +0,0 @@
<?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.
-->
<section id="add-primary-storage">
<title>Adding Primary Storage</title>
<note>
<para>Ensure that nothing stored on the server. Adding the server to CloudStack will destroy any
existing data.</para>
</note>
<para>When you create a new zone, the first primary storage is added as part of that procedure.
You can add primary storage servers at any time, such as when adding a new cluster or adding
more servers to an existing cluster.</para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI.</para>
</listitem>
<listitem>
<para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the
zone in which you want to add the primary storage.</para>
</listitem>
<listitem>
<para>Click the Compute tab.</para>
</listitem>
<listitem>
<para>In the Primary Storage node of the diagram, click View All.</para>
</listitem>
<listitem>
<para>Click Add Primary Storage.</para>
</listitem>
<listitem>
<para>Provide the following information in the dialog. The information required varies
depending on your choice in Protocol.</para>
<itemizedlist>
<listitem>
<para>Pod. The pod for the storage device.</para>
</listitem>
<listitem>
<para>Cluster. The cluster for the storage device.</para>
</listitem>
<listitem>
<para>Name. The name of the storage device</para>
</listitem>
<listitem>
<para>Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS
or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or
NFS</para>
</listitem>
<listitem>
<para>Server (for NFS, iSCSI, or PreSetup). The IP address or DNS name of the storage
device</para>
</listitem>
<listitem>
<para>Server (for VMFS). The IP address or DNS name of the vCenter server.</para>
</listitem>
<listitem>
<para>Path (for NFS). In NFS this is the exported path from the server.</para>
</listitem>
<listitem>
<para>Path (for VMFS). In vSphere this is 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>Path (for SharedMountPoint). With KVM this is the path on each host that is where
this primary storage is mounted. For example, "/mnt/primary".</para>
</listitem>
<listitem>
<para>SR Name-Label (for PreSetup). Enter the name-label of the SR that has been set up
outside &PRODUCT;.</para>
</listitem>
<listitem>
<para>Target IQN (for iSCSI). In iSCSI this is the IQN of the target. For example,
iqn.1986-03.com.sun:02:01ec9bb549-1271378984</para>
</listitem>
<listitem>
<para>Lun # (for iSCSI). In iSCSI this is the LUN number. For example, 3.</para>
</listitem>
<listitem>
<para>Tags (optional). 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>
</listitem>
<listitem>
<para>Click OK.</para>
</listitem>
</orderedlist>
</section>

37
docs/en-US/add-projects-members-from-ui.xml
View File

@ -1,37 +0,0 @@
<?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.
-->
<section id="add-projects-members-from-ui">
<title>Adding Project Members From the UI</title>
<para>The steps below tell how to add a new member to a project if the invitations feature is not enabled in the cloud. If the invitations feature is enabled cloud,as described in <xref linkend="set-up-invitations"/>, use the procedure in <xref linkend="send-projects-membership-invitation"/>.</para>
<orderedlist>
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
<listitem><para>In the left navigation, click Projects.</para></listitem>
<listitem><para>In Select View, choose Projects.</para></listitem>
<listitem><para>Click the name of the project you want to work with.</para></listitem>
<listitem><para>Click the Accounts tab. The current members of the project are listed.</para></listitem>
<listitem><para>Type the account name of the new member you want to add, and click Add Account. You can add only people who have an account in this cloud and within the same domain as the project.</para></listitem>
</orderedlist>
</section>

152
docs/en-US/add-remove-nic-ui.xml
View File

@ -1,152 +0,0 @@
<?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.
-->
<section id="add-remove-nic-ui">
<title>Reconfiguring Networks in VMs</title>
<para>&PRODUCT; provides you the ability to move VMs between networks and reconfigure a VM's
network. You can remove a VM from a network and add to a new network. You can also change the
default network of a virtual machine. With this functionality, hybrid or traditional server
loads can be accommodated with ease. </para>
<para>This feature is supported on XenServer, VMware, and KVM hypervisors.</para>
<section id="prereq-addnic">
<title>Prerequisites</title>
<para>Ensure that vm-tools are running on guest VMs for adding or removing networks to work on
VMware hypervisor.</para>
</section>
<section id="add-nic">
<title>Adding a 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, click Instances.</para>
</listitem>
<listitem>
<para>Choose the VM that you want to work with.</para>
</listitem>
<listitem>
<para>Click the NICs tab.</para>
</listitem>
<listitem>
<para>Click Add network to VM.</para>
<para>The Add network to VM dialog is displayed.</para>
</listitem>
<listitem>
<para>In the drop-down list, select the network that you would like to add this VM
to.</para>
<para> A new NIC is added for this network. You can view the following details in the NICs
page:</para>
<itemizedlist>
<listitem>
<para>ID</para>
</listitem>
<listitem>
<para>Network Name</para>
</listitem>
<listitem>
<para>Type</para>
</listitem>
<listitem>
<para>IP Address</para>
</listitem>
<listitem>
<para>Gateway</para>
</listitem>
<listitem>
<para>Netmask</para>
</listitem>
<listitem>
<para>Is default</para>
</listitem>
<listitem>
<para>CIDR (for IPv6)</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
<section id="remove-nic">
<title>Removing a 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, click Instances.</para>
</listitem>
<listitem>
<para>Choose the VM that you want to work with.</para>
</listitem>
<listitem>
<para>Click the NICs tab.</para>
</listitem>
<listitem>
<para>Locate the NIC you want to remove.</para>
</listitem>
<listitem>
<para>Click Remove NIC button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/remove-nic.png"/>
</imageobject>
<textobject>
<phrase>remove-nic.png: button to remove a NIC</phrase>
</textobject>
</inlinemediaobject></para>
</listitem>
<listitem>
<para>Click Yes to confirm.</para>
</listitem>
</orderedlist>
</section>
<section id="default-nic">
<title>Selecting the Default 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, click Instances.</para>
</listitem>
<listitem>
<para>Choose the VM that you want to work with.</para>
</listitem>
<listitem>
<para>Click the NICs tab.</para>
</listitem>
<listitem>
<para>Locate the NIC you want to work with.</para>
</listitem>
<listitem>
<para>Click the Set default NIC button.<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/set-default-nic.png"/>
</imageobject>
<textobject>
<phrase>set-default-nic.png: button to set a NIC as default one.</phrase>
</textobject>
</inlinemediaobject></para>
</listitem>
<listitem>
<para>Click Yes to confirm.</para>
</listitem>
</orderedlist>
</section>
</section>

133
docs/en-US/add-remove-nic.xml
View File

@ -1,133 +0,0 @@
<?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.
-->
<section id="add-remove-nic">
<title>Reconfiguring Networks in VMs</title>
<para>&PRODUCT; provides you the ability to move VMs between networks and reconfigure a VM's
network. You can remove a VM from a network and add to a new network. You can
also change the default network of a virtual machine. With this functionality, hybrid
or traditional server loads can be accommodated with ease. </para>
<para>This feature is supported on XenServer and KVM hypervisors.</para>
<para>The following APIs have been added to support this feature. These API calls can function
only while the VM is in running or stopped state.</para>
<section id="prereq-addnic">
<title>Prerequisites</title>
<para>Ensure that vm-tools are running on guest VMs for adding or removing networks to work on VMware hypervisor.</para>
</section>
<section id="addnic">
<title>addNicToVirtualMachine</title>
<para>The addNicToVirtualMachine API adds a new NIC to the specified VM on a selected
network.</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>parameter</para></entry>
<entry><para>description</para></entry>
<entry><para>Value</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>virtualmachineid</para></entry>
<entry><para>The unique ID of the VM to which the NIC is to be added. </para></entry>
<entry><para>true</para></entry>
</row>
<row>
<entry><para>networkid</para></entry>
<entry><para>The unique ID of the network the NIC that you add should apply
to.</para></entry>
<entry><para>true</para></entry>
</row>
<row>
<entry><para>ipaddress</para></entry>
<entry><para>The IP address of the VM on the network.</para></entry>
<entry><para>false</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>The network and VM must reside in the same zone. Two VMs with the same name cannot reside
in the same network. Therefore, adding a second VM that duplicates a name on a network will
fail.</para>
</section>
<section id="removenic">
<title>removeNicFromVirtualMachine</title>
<para>The removeNicFromVirtualMachine API removes a NIC from the specified VM on a selected
network.</para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>parameter</para></entry>
<entry><para>description</para></entry>
<entry><para>Value</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>virtualmachineid</para></entry>
<entry><para>The unique ID of the VM from which the NIC is to be removed.
</para></entry>
<entry><para>true</para></entry>
</row>
<row>
<entry><para>nicid</para></entry>
<entry><para>The unique ID of the NIC that you want to remove.</para></entry>
<entry><para>true</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Removing the default NIC is not allowed.</para>
</section>
<section id="defaultnic">
<title>updateDefaultNicForVirtualMachine</title>
<para>The updateDefaultNicForVirtualMachine API updates the specified NIC to be the default one
for a selected VM.</para>
<para>The NIC is only updated in the database. You must manually update the default NIC on the
VM. You get an alert to manually update the NIC. </para>
<informaltable>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry><para>parameter</para></entry>
<entry><para>description</para></entry>
<entry><para>Value</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>virtualmachineid</para></entry>
<entry><para>The unique ID of the VM for which you want to specify the default NIC.
</para></entry>
<entry><para>true</para></entry>
</row>
<row>
<entry><para>nicid</para></entry>
<entry><para>The unique ID of the NIC that you want to set as the default
one.</para></entry>
<entry><para>true</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>

48
docs/en-US/add-secondary-storage.xml
View File

@ -1,48 +0,0 @@
<?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.
-->
<section id="add-secondary-storage">
<title>Adding Secondary Storage</title>
<note>
<para>Be sure there is nothing stored on the server. Adding the server to CloudStack will
destroy any existing data.</para>
</note>
<para>When you create a new zone, the first secondary storage is added as part of that procedure.
You can add secondary storage servers at any time to add more servers to an existing
zone.</para>
<orderedlist>
<listitem>
<para>If you are going to use Swift for cloud-wide secondary storage, you must add the Swift
storage to &PRODUCT; before you add the local zone secondary storage servers.</para>
</listitem>
<listitem>
<para>To prepare for local zone secondary storage, you should have created and mounted an NFS
share during Management Server installation.</para>
</listitem>
<listitem>
<para>Make sure you prepared the system VM template during Management Server
installation.</para>
</listitem>
<listitem>
<para>4. Now that the secondary storage server for per-zone storage is prepared, add it to
&PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone.</para>
</listitem>
</orderedlist>
</section>

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

@ -1,49 +0,0 @@
<?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.
-->
<section id="add-security-group">
<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>

102
docs/en-US/add-tier.xml
View File

@ -1,102 +0,0 @@
<?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.
-->
<section id="add-tier">
<title>Adding Tiers</title>
<para>Tiers are distinct locations within a VPC that act as isolated networks, which do not have
access to other tiers by default. Tiers are set up on different VLANs that can communicate with
each other by using a virtual router. Tiers provide inexpensive, low latency network
connectivity to other tiers within the VPC.</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 the Select view, select VPC.</para>
<para>All the VPC that you have created for the account is listed in the page.</para>
<note>
<para>The end users can see their own VPCs, while root and domain admin can see any VPC they
are authorized to see.</para>
</note>
</listitem>
<listitem>
<para>Click the Configure button of the VPC for which you want to set up tiers.</para>
</listitem>
<listitem>
<para>Click Create network.</para>
<para>The Add new tier dialog is displayed, as follows:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-tier.png"/>
</imageobject>
<textobject>
<phrase>add-tier.png: adding a tier to a vpc.</phrase>
</textobject>
</mediaobject>
<para>If you have already created tiers, the VPC diagram is displayed. Click Create Tier to
add a new tier.</para>
</listitem>
<listitem>
<para>Specify the following:</para>
<para>All the fields are mandatory.</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Name</emphasis>: A unique name for the tier you create.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Network Offering</emphasis>: The following default network
offerings are listed: Internal LB, DefaultIsolatedNetworkOfferingForVpcNetworksNoLB,
DefaultIsolatedNetworkOfferingForVpcNetworks</para>
<para>In a VPC, only one tier can be created by using LB-enabled network offering.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Gateway</emphasis>: The gateway for the tier you create.
Ensure that the gateway is within the Super CIDR range that you specified while creating
the VPC, and is not overlapped with the CIDR of any existing tier within the VPC.</para>
</listitem>
<listitem>
<para><emphasis role="bold">VLAN</emphasis>: The VLAN ID for the tier that the root admin
creates. </para>
<para>This option is only visible if the network offering you selected is
VLAN-enabled.</para>
<para condition="install">For more information, see the Assigning VLANs to Isolated
Networks section in the &PRODUCT; Administration Guide.</para>
<para condition="admin">For more information, see <xref linkend="vlan-assign-isolated-nw"
/>.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Netmask</emphasis>: The netmask for the tier you create. </para>
<para>For example, if the VPC CIDR is 10.0.0.0/16 and the network tier CIDR is
10.0.1.0/24, the gateway of the tier is 10.0.1.1, and the netmask of the tier is
255.255.255.0.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click OK.</para>
</listitem>
<listitem>
<para>Continue with configuring access control list for the tier.</para>
</listitem>
</orderedlist>
</section>

62
docs/en-US/add-vm-tier-sharednw.xml
View File

@ -1,62 +0,0 @@
<?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.
-->
<section id="add-vm-tier-sharednw">
<title>Deploying VMs to VPC Tier and Shared Networks</title>
<para>&PRODUCT; allows you deploy VMs on a VPC tier and one or more shared networks. With this
feature, VMs deployed in a multi-tier application can receive monitoring services via a shared
network provided by a service provider.</para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI as an administrator.</para>
</listitem>
<listitem>
<para>In the left navigation, choose Instances.</para>
</listitem>
<listitem>
<para>Click Add Instance.</para>
</listitem>
<listitem>
<para>Select a zone.</para>
</listitem>
<listitem>
<para>Select a template or ISO, then follow the steps in the wizard. </para>
</listitem>
<listitem>
<para>Ensure that the hardware you have allows starting the selected service offering.</para>
</listitem>
<listitem>
<para>Under Networks, select the desired networks for the VM you are launching.</para>
<para>You can deploy a VM to a VPC tier and multiple shared networks.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/addvm-tier-sharednw.png"/>
</imageobject>
<textobject>
<phrase>addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.</phrase>
</textobject>
</mediaobject>
</listitem>
<listitem>
<para>Click Next, review the configuration and click Launch.</para>
<para>Your VM will be deployed to the selected VPC tier and shared network.</para>
</listitem>
</orderedlist>
</section>

53
docs/en-US/add-vm-to-tier.xml
View File

@ -1,53 +0,0 @@
<?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.
-->
<section id="add-vm-to-tier">
<title>Deploying VMs to the Tier</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>In the Select view, select VPC.</para>
<para>All the VPCs that you have created for the account is listed in the page.</para>
</listitem>
<listitem>
<para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
<para>The VPC page is displayed where all the tiers you have created are listed.</para>
</listitem>
<listitem>
<para>Click Virtual Machines tab of the tier to which you want to add a VM.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-vm-vpc.png"/>
</imageobject>
<textobject>
<phrase>add-vm-vpc.png: adding a VM to a vpc.</phrase>
</textobject>
</mediaobject>
<para>The Add Instance page is displayed.</para>
<para>Follow the on-screen instruction to add an instance. For information on adding an
instance, see the Installation Guide.</para>
</listitem>
</orderedlist>
</section>

80
docs/en-US/add-vpc.xml
View File

@ -1,80 +0,0 @@
<?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.
-->
<section id="add-vpc">
<title>Adding a Virtual Private Cloud</title>
<para>When creating the VPC, you simply provide the zone and a set of IP addresses for the VPC
network address space. You specify this set of addresses in the form of a Classless Inter-Domain
Routing (CIDR) block.</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 the Select view, select VPC.</para>
</listitem>
<listitem>
<para>Click Add VPC. The Add VPC page is displayed as follows:</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-vpc.png"/>
</imageobject>
<textobject>
<phrase>add-vpc.png: adding a vpc.</phrase>
</textobject>
</mediaobject>
<para>Provide the following information:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Name</emphasis>: A short name for the VPC that you are
creating.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Description</emphasis>: A brief description of the VPC.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the VPC to be
available.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Super CIDR for Guest Networks</emphasis>: Defines the CIDR
range for all the tiers (guest networks) within a VPC. When you create a tier, ensure
that its CIDR is within the Super CIDR value you enter. The CIDR must be RFC1918
compliant.</para>
</listitem>
<listitem>
<para><emphasis role="bold">DNS domain for Guest Networks</emphasis>: If you want to
assign a special domain name, specify the DNS suffix. This parameter is applied to all
the tiers within the VPC. That implies, all the tiers you create in the VPC belong to
the same DNS domain. If the parameter is not specified, a DNS domain name is generated
automatically.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Public Load Balancer Provider</emphasis>: You have two
options: VPC Virtual Router and Netscaler.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>Click OK.</para></listitem>
</orderedlist>
</section>

164
docs/en-US/added-API-commands-4-0.xml
View File

@ -1,164 +0,0 @@
<?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.
-->
<section id="added-API-commands-4.0">
<title>Added API Commands in 4.0.0-incubating</title>
<itemizedlist>
<listitem>
<para>createCounter (Adds metric counter)</para>
</listitem>
<listitem>
<para>deleteCounter (Deletes a counter)</para>
</listitem>
<listitem>
<para>listCounters (List the counters)</para>
</listitem>
<listitem>
<para>createCondition (Creates a condition)</para>
</listitem>
<listitem>
<para>deleteCondition (Removes a condition)</para>
</listitem>
<listitem>
<para>listConditions (List Conditions for the specific user)</para>
</listitem>
<listitem>
<para>createTags. Add tags to one or more resources. Example:
<programlisting>command=createTags
&amp;resourceIds=1,10,12
&amp;resourceType=userVm
&amp;tags[0].key=region
&amp;tags[0].value=canada
&amp;tags[1].key=city
&amp;tags[1].value=Toronto </programlisting></para>
</listitem>
<listitem>
<para>deleteTags. Remove tags from one or more resources. Example:
<programlisting>command=deleteTags
&amp;resourceIds=1,12
&amp;resourceType=Snapshot
&amp;tags[0].key=city </programlisting></para>
</listitem>
<listitem>
<para>listTags (Show currently defined resource tags)</para>
</listitem>
<listitem>
<para>createVPC (Creates a VPC)</para>
</listitem>
<listitem>
<para>listVPCs (Lists VPCs)</para>
</listitem>
<listitem>
<para>deleteVPC (Deletes a VPC)</para>
</listitem>
<listitem>
<para>updateVPC (Updates a VPC)</para>
</listitem>
<listitem>
<para>restartVPC (Restarts a VPC)</para>
</listitem>
<listitem>
<para>createVPCOffering (Creates VPC offering)</para>
</listitem>
<listitem>
<para>updateVPCOffering (Updates VPC offering)</para>
</listitem>
<listitem>
<para>deleteVPCOffering (Deletes VPC offering)</para>
</listitem>
<listitem>
<para>listVPCOfferings (Lists VPC offerings)</para>
</listitem>
<listitem>
<para>createPrivateGateway (Creates a private gateway)</para>
</listitem>
<listitem>
<para>listPrivateGateways (List private gateways)</para>
</listitem>
<listitem>
<para>deletePrivateGateway (Deletes a Private gateway)</para>
</listitem>
<listitem>
<para>createNetworkACL (Creates a ACL rule the given network (the network has to belong to
VPC))</para>
</listitem>
<listitem>
<para>deleteNetworkACL (Deletes a Network ACL)</para>
</listitem>
<listitem>
<para>listNetworkACLs (Lists all network ACLs)</para>
</listitem>
<listitem>
<para>createStaticRoute (Creates a static route)</para>
</listitem>
<listitem>
<para>deleteStaticRoute (Deletes a static route)</para>
</listitem>
<listitem>
<para>listStaticRoutes (Lists all static routes)</para>
</listitem>
<listitem>
<para>createVpnCustomerGateway (Creates site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>createVpnGateway (Creates site to site vpn local gateway)</para>
</listitem>
<listitem>
<para>createVpnConnection (Create site to site vpn connection)</para>
</listitem>
<listitem>
<para>deleteVpnCustomerGateway (Delete site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>deleteVpnGateway (Delete site to site vpn gateway)</para>
</listitem>
<listitem>
<para>deleteVpnConnection (Delete site to site vpn connection)</para>
</listitem>
<listitem>
<para>updateVpnCustomerGateway (Update site to site vpn customer gateway)</para>
</listitem>
<listitem>
<para>resetVpnConnection (Reset site to site vpn connection)</para>
</listitem>
<listitem>
<para>listVpnCustomerGateways (Lists site to site vpn customer gateways)</para>
</listitem>
<listitem>
<para>listVpnGateways (Lists site 2 site vpn gateways)</para>
</listitem>
<listitem>
<para>listVpnConnections (Lists site to site vpn connection gateways)</para>
</listitem>
<listitem>
<para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in &PRODUCT;.)</para>
</listitem>
<listitem>
<para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well
as the IP address of the Nexus 1000v dvSwitch.)</para>
</listitem>
</itemizedlist>
</section>

73
docs/en-US/added-API-commands-4-1.xml
View File

@ -1,73 +0,0 @@
<?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.
-->
<section id="added-API-commands-4.1">
<title>Added API Commands in 4.1</title>
<itemizedlist>
<listitem>
<para>createEgressFirewallRules (creates an egress firewall rule on the guest network.)</para>
</listitem>
<listitem>
<para>deleteEgressFirewallRules (deletes a egress firewall rule on the guest network.)</para>
</listitem>
<listitem>
<para>listEgressFirewallRules (lists the egress firewall rules configured for a guest
network.)</para>
</listitem>
<listitem>
<para>resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)</para>
</listitem>
<listitem>
<para>addBaremetalHost (Adds a new host.)</para>
</listitem>
<listitem>
<para>addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected
network.)</para>
</listitem>
<listitem>
<para>removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.)</para>
</listitem>
<listitem>
<para>updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a
selected VM.)</para>
</listitem>
<listitem>
<para>addRegion (Registers a Region into another Region.)</para>
</listitem>
<listitem>
<para>updateRegion (Updates Region details: ID, Name, Endpoint, User API Key, and User Secret
Key.)</para>
</listitem>
<listitem>
<para>removeRegion (Removes a Region from current Region.)</para>
</listitem>
<listitem>
<para>listRegions (Get all the Regions. They can be filtered by using the ID or Name.)</para>
</listitem>
<listitem>
<para>getUser (This API can only be used by the Admin. Get user details by using the API Key.)
</para>
</listitem>
<listitem><para>addRegion (Add a region)</para></listitem>
<listitem><para>removeRegion (Delete a region)</para></listitem>
<listitem><para>updateRegion (Modify attributes of a region)</para></listitem>
<listitem><para>listRegions (List regions)</para></listitem>
</itemizedlist>
</section>

554
docs/en-US/added-API-commands-4.2.xml
View File

@ -1,554 +0,0 @@
<?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.
-->
<section id="added-API-commands-4.2">
<title>Added API Commands in 4.2</title>
<itemizedlist>
<listitem>
<para>addImageStore</para>
<para>Adds all types of secondary storage providers, S3/Swift/NFS.</para>
</listitem>
<listitem>
<para>createSecondaryStagingStore</para>
<para>Adds a staging secondary storage in each zone.</para>
</listitem>
<listitem>
<para>listImageStores</para>
<para>Lists all secondary storages, S3/Swift/NFS.</para>
</listitem>
<listitem>
<para>listSecondaryStagingStores</para>
<para>Lists all staging secondary storages.</para>
</listitem>
<listitem>
<para>addIpToNic </para>
<para>Adds an IP address to the NIC from the guest subnet. The request parameters are: nicid,
ipaddress.</para>
<para>The response parameters are: nicid, ipaddress, networkid </para>
</listitem>
<listitem>
<para>removeIpFromNic</para>
<para> Removes the reserved IP for the NIC. The request parameters is: id.</para>
<para>The response parameters are: true, false</para>
</listitem>
<listitem>
<para>listNics</para>
<para>Lists the NIC details of the user VM; the API response also contains the Secondary IP
addresses of the NIC. The request parameters are: nicid, virtualmachineid.</para>
<para>The response parameters are: id, ipaddress, secondaryips, gateway, netmask, macaddr,
broadcasturi, isolationuri, isdefault,</para>
</listitem>
<listitem>
<para>deleteAlerts </para>
<para>Deletes the specified alerts. The request parameters are: ids (allowed to pass one or
more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
<para>The response parameters are: true, false </para>
</listitem>
<listitem>
<para>archiveAlerts</para>
<para>Archives the specified alerts. The request parameters are: ids (allowed to pass one or
more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
<para>The response parameters are: true, false </para>
</listitem>
<listitem>
<para>deleteEvents </para>
<para>Deletes the specified events. The request parameters are: ids (allowed to pass one or
more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
<para>The response parameters are: true, false</para>
</listitem>
<listitem>
<para>archiveEvents</para>
<para>Archives the specified events. The request parameters are: ids (allowed to pass one or
more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
<para>The response parameters are: true, false </para>
</listitem>
<listitem>
<para>createGlobalLoadBalancerRule</para>
<para>Creates a GSLB rule. The request parameters are name (the name of the global load
balancer rule); domain name ( the preferred domain name for the service); lb algorithm (the
algorithm used to load balance the traffic across the zones); session persistence (source IP
and HTTP cookie); account name; and domain Id.</para>
</listitem>
<listitem>
<para>assignToGlobalLoadBalancerRule</para>
<para>Assigns a load balancing rule or list of load balancing rules to GSLB. The request
parameters are: id (the UUID of global load balancer rule); loadbalancerrulelist (the list
load balancer rules that will be assigned to global load balancer rule. These are second
tier load balancing rules created with createLoadBalancerRule API. Weight is optional, the
default is 1).</para>
</listitem>
<listitem>
<para>removeFromGlobalLoadBalancerRule</para>
<para>Removes a load balancer rule association with global load balancer rule. The request
parameters are id (the UUID of global load balancer rule); loadbalancerrulelist (the list
load balancer rules that will be assigned to global load balancer rule).</para>
</listitem>
<listitem>
<para>deleteGlobalLoadBalancerRule</para>
<para>Deletes a global load balancer rule. The request parameters is: id (the unique ID of the
global load balancer rule).</para>
</listitem>
<listitem>
<para>listGlobalLoadBalancerRule</para>
<para>Lists load balancer rules.</para>
<para>The request parameters are: account (lists resources by account. Use with the domainid
parameter); domainid (lists only resources belonging to the domain specified); id (the
unique ID of the global load balancer rule); isrecursive (defaults to false; but if true,
lists all the resources from the parent specified by the domainid); keyword (lists by
keyword); listall (if set to false, lists only resources belonging to the command's caller;
if set to true, lists resources that the caller is authorized to see. Default value is
false); page; pagesize; projectid (lists objects by project); regionid ; tags (lists
resources by tags: key/value pairs). </para>
</listitem>
<listitem>
<para>updateGlobalLoadBalancerRule</para>
<para>Updates global load balancer rules.</para>
<para>The request parameters are: id (the unique ID of the global load balancer rule); account
(lists resources by account. Use with the domainid parameter); description (the description
of the load balancer rule); domainid (lists only resources belonging to the domain
specified); gslblbmethod (the load balancer algorithm that is used to distributed traffic
across the zones participating in global server load balancing, if not specified defaults to
round robin); gslbstickysessionmethodname (the session sticky method; if not specified
defaults to sourceip); isrecursive (defaults to false, but if true, lists all resources from
the parent specified by the domainid till leaves); keyword (lists by keyword); listall (if
set to false, list only those resources belonging to the command's caller; if set to true,
lists resources that the caller is authorized to see. Default value is false); page;
pagesize; projectid (lists objects by project); regionid; tags (lists resources by tags:
key/value pairs)</para>
</listitem>
<listitem>
<para>createPortableIpRange</para>
<para>Creates portable IP addresses in the portable public IP address pool.</para>
<para>The request parameters are region id, start ip, end ip, netmask, gateway, and
vlan.</para>
</listitem>
<listitem>
<para>deletePortableIpRange</para>
<para>Deletes portable IP addresses from the portable public IP address pool.</para>
<para>The request parameters is portable ip address range id.</para>
</listitem>
<listitem>
<para>listPortableIpRange</para>
<para>Lists portable IP addresses in the portable public IP address pool associated with a
Region.</para>
<para>The request parameters are elastic ip id and region id.</para>
</listitem>
<listitem>
<para>createVMSnapshot</para>
<para>Creates a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>deleteVMSnapshot </para>
<para>Deletes a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>listVMSnapshot</para>
<para>Shows a virtual machine snapshot.</para>
</listitem>
<listitem>
<para>revertToVMSnapshot </para>
<para>Returns a virtual machine to the state and data saved in a given snapshot.</para>
</listitem>
<listitem>
<para>createLBHealthCheckPolicy </para>
<para>Creates a new health check policy for a load balancer rule.</para>
</listitem>
<listitem>
<para>deleteLBHealthCheckPolicy</para>
<para>Deletes an existing health check policy from a load balancer rule.</para>
</listitem>
<listitem>
<para>listLBHealthCheckPolicies</para>
<para>Displays the health check policy for a load balancer rule.</para>
</listitem>
<listitem>
<para>createEgressFirewallRules </para>
<para>Creates an egress firewall rule on the guest network.</para>
</listitem>
<listitem>
<para>deleteEgressFirewallRules </para>
<para>Deletes a egress firewall rule on the guest network.</para>
</listitem>
<listitem>
<para>listEgressFirewallRules </para>
<para>Lists the egress firewall rules configured for a guest network.</para>
</listitem>
<listitem>
<para>resetSSHKeyForVirtualMachine </para>
<para>Resets the SSHkey for virtual machine.</para>
</listitem>
<listitem>
<para>addBaremetalHost </para>
<para>Adds a new host. Technically, this API command was present in v3.0.6, but its
functionality was disabled.</para>
</listitem>
<listitem>
<para>addBaremetalDhcp </para>
<para>Adds a DHCP server for bare metal hosts.</para>
</listitem>
<listitem>
<para> addBaremetalPxePingServer </para>
<para>Adds a PXE PING server for bare metal hosts.</para>
</listitem>
<listitem>
<para> addBaremetalPxeKickStartServer (Adds a PXE server for bare metal hosts)</para>
</listitem>
<listitem>
<para> listBaremetalDhcp </para>
<para>Shows the DHCP servers currently defined for bare metal hosts.</para>
</listitem>
<listitem>
<para> listBaremetalPxePingServer </para>
<para>Shows the PXE PING servers currently defined for bare metal hosts.</para>
</listitem>
<listitem>
<para>addNicToVirtualMachine </para>
<para>Adds a new NIC to the specified VM on a selected network.</para>
</listitem>
<listitem>
<para>removeNicFromVirtualMachine </para>
<para>Removes the specified NIC from a selected VM.</para>
</listitem>
<listitem>
<para>updateDefaultNicForVirtualMachine </para>
<para>Updates the specified NIC to be the default one for a selected VM.</para>
</listitem>
<listitem>
<para>addRegion </para>
<para>Registers a Region into another Region.</para>
</listitem>
<listitem>
<para>updateRegion </para>
<para>Updates Region details: ID, Name, Endpoint, User API Key, and User Secret Key.</para>
</listitem>
<listitem>
<para>removeRegion </para>
<para>Removes a Region from current Region.</para>
</listitem>
<listitem>
<para>listRegions </para>
<para>Get all the Regions. They can be filtered by using the ID or Name.</para>
</listitem>
<listitem>
<para>getUser </para>
<para>This API can only be used by the Admin. Get user account details by using the API
Key.</para>
</listitem>
<listitem>
<para>getApiLimit </para>
<para>Shows number of remaining APIs for the invoking user in current window.</para>
</listitem>
<listitem>
<para>resetApiLimit </para>
<para>For root admin, if account ID parameter is passed, it will reset count for that
particular account, otherwise it will reset all counters.</para>
</listitem>
<listitem>
<para>lockAccount </para>
<para>Locks an account.</para>
</listitem>
<listitem>
<para>lockUser </para>
<para>Locks a user account.</para>
</listitem>
<listitem>
<para>scaleVirtualMachine </para>
<para>Scales the virtual machine to a new service offering.</para>
</listitem>
<listitem>
<para>migrateVirtualMachineWithVolume </para>
<para>Attempts migrating VM with its volumes to a different host. </para>
</listitem>
<listitem>
<para>dedicatePublicIpRange </para>
<para>Dedicates a Public IP range to an account.</para>
</listitem>
<listitem>
<para>releasePublicIpRange </para>
<para>Releases a Public IP range back to the system pool. </para>
</listitem>
<listitem>
<para>dedicateGuestVlanRange </para>
<para>Dedicates a guest VLAN range to an account. </para>
</listitem>
<listitem>
<para>releaseDedicatedGuestVlanRange </para>
<para>Releases a dedicated guest VLAN range to the system.</para>
</listitem>
<listitem>
<para>listDedicatedGuestVlanRanges </para>
<para>Lists dedicated guest VLAN ranges.</para>
</listitem>
<listitem>
<para>updatePortForwardingRule </para>
<para>Updates a port forwarding rule. Only the private port and the VM can be updated. </para>
</listitem>
<listitem>
<para>scaleSystemVm </para>
<para>Scales the service offering for a systemVM, console proxy, or secondary storage.</para>
</listitem>
<listitem>
<para>listDeploymentPlanners </para>
<para>Lists all the deployment planners available.</para>
</listitem>
<listitem>
<para>addS3 </para>
<para>Adds a Amazon Simple Storage Service instance.</para>
</listitem>
<listitem>
<para>listS3s </para>
<para>Lists all the Amazon Simple Storage Service instances. </para>
</listitem>
<listitem>
<para>findHostsForMigration </para>
<para>Finds hosts suitable for migrating a VM to.</para>
</listitem>
<listitem>
<para>releaseHostReservation </para>
<para>Releases host reservation.</para>
</listitem>
<listitem>
<para>resizeVolume </para>
<para>Resizes a volume.</para>
</listitem>
<listitem>
<para>updateVolume </para>
<para>Updates the volume.</para>
</listitem>
<listitem>
<para>listStorageProviders </para>
<para>Lists storage providers. </para>
</listitem>
<listitem>
<para>findStoragePoolsForMigration </para>
<para>Lists storage pools available for migrating a volume. </para>
</listitem>
<listitem>
<para>createEgressFirewallRule </para>
<para>Creates a egress firewall rule for a given network. </para>
</listitem>
<listitem>
<para>deleteEgressFirewallRule </para>
<para>Deletes an egress firewall rule.</para>
</listitem>
<listitem>
<para>listEgressFirewallRules </para>
<para>Lists all egress firewall rules for network.</para>
</listitem>
<listitem>
<para>updateNetworkACLItem </para>
<para>Updates ACL item with specified ID.</para>
</listitem>
<listitem>
<para>createNetworkACLList </para>
<para>Creates a Network ACL for the given VPC. </para>
</listitem>
<listitem>
<para>deleteNetworkACLList </para>
<para>Deletes a Network ACL. </para>
</listitem>
<listitem>
<para>replaceNetworkACLList </para>
<para>Replaces ACL associated with a Network or private gateway.</para>
</listitem>
<listitem>
<para>listNetworkACLLists </para>
<para>Lists all network ACLs.</para>
</listitem>
<listitem>
<para>addResourceDetail </para>
<para>Adds detail for the Resource. </para>
</listitem>
<listitem>
<para>removeResourceDetail </para>
<para>Removes details of the resource.</para>
</listitem>
<listitem>
<para>listResourceDetails </para>
<para>Lists resource details. </para>
</listitem>
<listitem>
<para>addNiciraNvpDevice </para>
<para>Adds a Nicira NVP device.</para>
</listitem>
<listitem>
<para>deleteNiciraNvpDevice </para>
<para>Deletes a Nicira NVP device.</para>
</listitem>
<listitem>
<para>listNiciraNvpDevices </para>
<para>Lists Nicira NVP devices.</para>
</listitem>
<listitem>
<para>listNiciraNvpDeviceNetworks </para>
<para>Lists network that are using a Nicira NVP device.</para>
</listitem>
<listitem>
<para>addBigSwitchVnsDevice </para>
<para>Adds a BigSwitch VNS device.</para>
</listitem>
<listitem>
<para>deleteBigSwitchVnsDevice </para>
<para>Deletes a BigSwitch VNS device.</para>
</listitem>
<listitem>
<para>listBigSwitchVnsDevices </para>
<para>Lists BigSwitch VNS devices.</para>
</listitem>
<listitem>
<para>configureSimulator </para>
<para>Configures a simulator.</para>
</listitem>
<listitem>
<para>listApis </para>
<para>Lists all the available APIs on the server, provided by the API Discovery plugin. </para>
</listitem>
<listitem>
<para>getApiLimit </para>
<para>Gets the API limit count for the caller. </para>
</listitem>
<listitem>
<para>resetApiLimit </para>
<para>Resets the API count.</para>
</listitem>
<listitem>
<para>assignToGlobalLoadBalancerRule </para>
<para>Assigns load balancer rule or list of load balancer rules to a global load balancer
rules.</para>
</listitem>
<listitem>
<para>removeFromGlobalLoadBalancerRule </para>
<para>Removes a load balancer rule association with global load balancer rule.</para>
</listitem>
<listitem>
<para>listVMSnapshot </para>
<para>Lists virtual machine snapshot by conditions.</para>
</listitem>
<listitem>
<para>createLoadBalancer </para>
<para>Creates a load balancer.</para>
</listitem>
<listitem>
<para>listLoadBalancers </para>
<para>Lists load balancers.</para>
</listitem>
<listitem>
<para>deleteLoadBalancer </para>
<para>Deletes a load balancer. </para>
</listitem>
<listitem>
<para>configureInternalLoadBalancerElement </para>
<para>Configures an Internal Load Balancer element.</para>
</listitem>
<listitem>
<para>createInternalLoadBalancerElement </para>
<para>Creates an Internal Load Balancer element.</para>
</listitem>
<listitem>
<para>listInternalLoadBalancerElements </para>
<para>Lists all available Internal Load Balancer elements.</para>
</listitem>
<listitem>
<para>createAffinityGroup </para>
<para>Creates an affinity or anti-affinity group.</para>
</listitem>
<listitem>
<para>deleteAffinityGroup </para>
<para>Deletes an affinity group.</para>
</listitem>
<listitem>
<para>listAffinityGroups </para>
<para>Lists all the affinity groups.</para>
</listitem>
<listitem>
<para>updateVMAffinityGroup </para>
<para>Updates the affinity or anti-affinity group associations of a VM. The VM has to be
stopped and restarted for the new properties to take effect.</para>
</listitem>
<listitem>
<para>listAffinityGroupTypes </para>
<para>Lists affinity group types available. </para>
</listitem>
<listitem>
<para>stopInternalLoadBalancerVM </para>
<para>Stops an Internal LB VM.</para>
</listitem>
<listitem>
<para>startInternalLoadBalancerVM </para>
<para>Starts an existing Internal LB VM.</para>
</listitem>
<listitem>
<para>listInternalLoadBalancerVMs </para>
<para>Lists internal LB VMs.</para>
</listitem>
<listitem>
<para>listNetworkIsolationMethods </para>
<para>Lists supported methods of network isolation.</para>
</listitem>
<listitem>
<para>dedicateZone </para>
<para>Dedicates a zone.</para>
</listitem>
<listitem>
<para>dedicatePod </para>
<para>Dedicates a pod. </para>
</listitem>
<listitem>
<para>dedicateCluster </para>
<para>Dedicates an existing cluster. </para>
</listitem>
<listitem>
<para>dedicateHost </para>
<para>Dedicates a host.</para>
</listitem>
<listitem>
<para>releaseDedicatedZone </para>
<para>Releases dedication of zone. </para>
</listitem>
<listitem>
<para>releaseDedicatedPod </para>
<para>Releases dedication for the pod. </para>
</listitem>
<listitem>
<para>releaseDedicatedCluster </para>
<para>Releases dedication for cluster. </para>
</listitem>
<listitem>
<para>releaseDedicatedHost </para>
<para>Releases dedication for host. </para>
</listitem>
<listitem>
<para>listDedicatedZones </para>
<para>Lists dedicated zones. </para>
</listitem>
<listitem>
<para>listDedicatedPods </para>
<para>Lists dedicated pods.</para>
</listitem>
<listitem>
<para>listDedicatedClusters </para>
<para>Lists dedicated clusters.</para>
</listitem>
<listitem>
<para>listDedicatedHosts </para>
<para>Lists dedicated hosts. </para>
</listitem>
</itemizedlist>
</section>

195
docs/en-US/added-API-commands.xml
View File

@ -1,195 +0,0 @@
<?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.
-->
<section id="added-API-commands">
<title>Added API commands in 3.0</title>
<section id="added-api-commands-3.0.2">
<title>Added in 3.0.2</title>
<itemizedlist>
<listitem>
<para>changeServiceForSystemVm</para>
<para>Changes the service offering for a system VM (console proxy or secondary storage). The
system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
</section>
<section id="added-api-commands-3.0.1">
<title>Added in 3.0.1</title>
<itemizedlist>
<listitem>
<para>changeServiceForSystemVm</para>
<para>Changes the service offering for a system VM (console proxy or secondary storage). The
system VM must be in a "Stopped" state for this command to take effect.</para>
</listitem>
</itemizedlist>
</section>
<section id="added-api-commands-3.0.0">
<title>Added in 3.0.0</title>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1"/>
<colspec colname="c2"/>
<colspec colname="c3"/>
<tbody>
<row>
<entry><para>assignVirtualMachine (Move a user VM to another user under same
domain.)</para></entry>
<entry><para>restoreVirtualMachine (Restore a VM to original template or specific
snapshot)</para></entry>
<entry><para>createLBStickinessPolicy (Creates a Load Balancer stickiness policy
)</para></entry>
</row>
<row>
<entry><para>deleteLBStickinessPolicy (Deletes a LB stickiness policy.)</para></entry>
<entry><para>listLBStickinessPolicies (Lists LBStickiness policies.)</para></entry>
<entry><para>ldapConfig (Configure the LDAP context for this site.)</para></entry>
</row>
<row>
<entry><para>addSwift (Adds Swift.)</para></entry>
<entry><para>listSwifts (List Swift.)</para></entry>
<entry><para>migrateVolume (Migrate volume)</para></entry>
</row>
<row>
<entry><para>updateStoragePool (Updates a storage pool.)</para></entry>
<entry><para>authorizeSecurityGroupEgress (Authorizes a particular egress rule for this
security group)</para></entry>
<entry><para>revokeSecurityGroupEgress (Deletes a particular egress rule from this
security group)</para></entry>
</row>
<row>
<entry><para>createNetworkOffering (Creates a network offering.)</para></entry>
<entry><para>deleteNetworkOffering (Deletes a network offering.)</para></entry>
<entry><para>createProject (Creates a project)</para></entry>
</row>
<row>
<entry><para>deleteProject (Deletes a project)</para></entry>
<entry><para>updateProject (Updates a project)</para></entry>
<entry><para>activateProject (Activates a project)</para></entry>
</row>
<row>
<entry><para>suspendProject (Suspends a project)</para></entry>
<entry><para>listProjects (Lists projects and provides detailed information for listed
projects)</para></entry>
<entry><para>addAccountToProject (Adds account to a project)</para></entry>
</row>
<row>
<entry><para>deleteAccountFromProject (Deletes account from the project)</para></entry>
<entry><para>listProjectAccounts (Lists project's accounts)</para></entry>
<entry><para>listProjectInvitations (Lists an account's invitations to join
projects)</para></entry>
</row>
<row>
<entry><para>updateProjectInvitation (Accepts or declines project
invitation)</para></entry>
<entry><para>deleteProjectInvitation (Deletes a project invitation)</para></entry>
<entry><para>updateHypervisorCapabilities (Updates a hypervisor
capabilities.)</para></entry>
</row>
<row>
<entry><para>listHypervisorCapabilities (Lists all hypervisor
capabilities.)</para></entry>
<entry><para>createPhysicalNetwork (Creates a physical network)</para></entry>
<entry><para>deletePhysicalNetwork (Deletes a Physical Network.)</para></entry>
</row>
<row>
<entry><para>listPhysicalNetworks (Lists physical networks)</para></entry>
<entry><para>updatePhysicalNetwork (Updates a physical network)</para></entry>
<entry><para>listSupportedNetworkServices (Lists all network services provided by
&PRODUCT; or for the given Provider.)</para></entry>
</row>
<row>
<entry><para>addNetworkServiceProvider (Adds a network serviceProvider to a physical
network)</para></entry>
<entry><para>deleteNetworkServiceProvider (Deletes a Network Service
Provider.)</para></entry>
<entry><para>listNetworkServiceProviders (Lists network serviceproviders for a given
physical network.)</para></entry>
</row>
<row>
<entry><para>updateNetworkServiceProvider (Updates a network serviceProvider of a physical
network)</para></entry>
<entry><para>addTrafficType (Adds traffic type to a physical network)</para></entry>
<entry><para>deleteTrafficType (Deletes traffic type of a physical network)</para></entry>
</row>
<row>
<entry><para>listTrafficTypes (Lists traffic types of a given physical
network.)</para></entry>
<entry><para>updateTrafficType (Updates traffic type of a physical network)</para></entry>
<entry><para>listTrafficTypeImplementors (Lists implementors of implementor of a network
traffic type or implementors of all network traffic types)</para></entry>
</row>
<row>
<entry><para>createStorageNetworkIpRange (Creates a Storage network IP
range.)</para></entry>
<entry><para>deleteStorageNetworkIpRange (Deletes a storage network IP
Range.)</para></entry>
<entry><para>listStorageNetworkIpRange (List a storage network IP range.)</para></entry>
</row>
<row>
<entry><para>updateStorageNetworkIpRange (Update a Storage network IP range, only allowed
when no IPs in this range have been allocated.)</para></entry>
<entry><para>listUsageTypes (List Usage Types)</para></entry>
<entry><para>addF5LoadBalancer (Adds a F5 BigIP load balancer device)</para></entry>
</row>
<row>
<entry><para>configureF5LoadBalancer (configures a F5 load balancer device)</para></entry>
<entry><para>deleteF5LoadBalancer ( delete a F5 load balancer device)</para></entry>
<entry><para>listF5LoadBalancers (lists F5 load balancer devices)</para></entry>
</row>
<row>
<entry><para>listF5LoadBalancerNetworks (lists network that are using a F5 load balancer
device)</para></entry>
<entry><para>addSrxFirewall (Adds a SRX firewall device)</para></entry>
<entry><para>deleteSrxFirewall ( delete a SRX firewall device)</para></entry>
</row>
<row>
<entry><para>listSrxFirewalls (lists SRX firewall devices in a physical
network)</para></entry>
<entry><para>listSrxFirewallNetworks (lists network that are using SRX firewall
device)</para></entry>
<entry><para>addNetscalerLoadBalancer (Adds a netscaler load balancer
device)</para></entry>
</row>
<row>
<entry><para>deleteNetscalerLoadBalancer ( delete a netscaler load balancer
device)</para></entry>
<entry><para>configureNetscalerLoadBalancer (configures a netscaler load balancer
device)</para></entry>
<entry><para>listNetscalerLoadBalancers (lists netscaler load balancer
devices)</para></entry>
</row>
<row>
<entry><para>listNetscalerLoadBalancerNetworks (lists network that are using a netscaler
load balancer device)</para></entry>
<entry><para>createVirtualRouterElement (Create a virtual router element.)</para></entry>
<entry><para>configureVirtualRouterElement (Configures a virtual router
element.)</para></entry>
</row>
<row>
<entry><para>listVirtualRouterElements (Lists all available virtual router
elements.)</para></entry>
<entry><para/></entry>
<entry><para/></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>

138
docs/en-US/added-error-codes.xml
View File

@ -1,138 +0,0 @@
<?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.
-->
<section id="added-error-codes">
<title>Added &PRODUCT; Error Codes</title>
<para>You can now find the &PRODUCT;-specific error code in the exception response for each type of exception. The following list of error codes is added to the new class named CSExceptionErrorCode.</para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<tbody>
<row>
<entry><para>4250 : "com.cloud.utils.exception.CloudRuntimeException"</para></entry>
<entry><para>4255 : "com.cloud.utils.exception.ExceptionUtil"</para></entry>
<entry><para>4260 : "com.cloud.utils.exception.ExecutionException"</para></entry>
</row>
<row>
<entry><para>4265 : "com.cloud.utils.exception.HypervisorVersionChangedException"</para></entry>
<entry><para>4270 : "com.cloud.utils.exception.RuntimeCloudException"</para></entry>
<entry><para>4275 : "com.cloud.exception.CloudException"</para></entry>
</row>
<row>
<entry><para>4280 : "com.cloud.exception.AccountLimitException"</para></entry>
<entry><para>4285 : "com.cloud.exception.AgentUnavailableException"</para></entry>
<entry><para>4290 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
</row>
<row>
<entry><para>4295 : "com.cloud.exception.CloudExecutionException"</para></entry>
<entry><para>4300 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
<entry><para>4305 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
</row>
<row>
<entry><para>4310 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
<entry><para>4315 : "com.cloud.exception.HAStateException"</para></entry>
<entry><para>4320 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
</row>
<row>
<entry><para>4325 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
<entry><para>4330 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
<entry><para>4335 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
</row>
<row>
<entry><para>4340 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
<entry><para>4345 : "com.cloud.exception.InternalErrorException"</para></entry>
<entry><para>4350 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
</row>
<row>
<entry><para>4355 : "com.cloud.exception.ManagementServerException"</para></entry>
<entry><para>4360 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
<entry><para>4365 : "com.cloud.exception.PermissionDeniedException"</para></entry>
</row>
<row>
<entry><para>4370 : "com.cloud.exception.ResourceAllocationException"</para></entry>
<entry><para>4375 : "com.cloud.exception.ResourceInUseException"</para></entry>
<entry><para>4380 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
</row>
<row>
<entry><para>4385 : "com.cloud.exception.StorageUnavailableException"</para></entry>
<entry><para>4390 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
<entry><para>4395 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
</row>
<row>
<entry><para>4400 : "com.cloud.exception.AccountLimitException"</para></entry>
<entry><para>4405 : "com.cloud.exception.AgentUnavailableException"</para></entry>
<entry><para>4410 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
</row>
<row>
<entry><para>4415 : "com.cloud.exception.CloudException"</para></entry>
<entry><para>4420 : "com.cloud.exception.CloudExecutionException"</para></entry>
<entry><para>4425 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
</row>
<row>
<entry><para>4430 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
<entry><para>4435 : "com.cloud.exception.ConnectionException"</para></entry>
<entry><para>4440 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
</row>
<row>
<entry><para>4445 : "com.cloud.exception.DiscoveryException"</para></entry>
<entry><para>4450 : "com.cloud.exception.HAStateException"</para></entry>
<entry><para>4455 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
</row>
<row>
<entry><para>4460 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
<entry><para>4465 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
<entry><para>4470 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
</row>
<row>
<entry><para>4475 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
<entry><para>4480 : "com.cloud.exception.InsufficientVirtualNetworkCapcityException"</para></entry>
<entry><para>4485 : "com.cloud.exception.InternalErrorException"</para></entry>
</row>
<row>
<entry><para>4490 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
<entry><para>4495 : "com.cloud.exception.ManagementServerException"</para></entry>
<entry><para>4500 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
</row>
<row>
<entry><para>4505 : "com.cloud.exception.PermissionDeniedException"</para></entry>
<entry><para>4510 : "com.cloud.exception.ResourceAllocationException"</para></entry>
<entry><para>4515 : "com.cloud.exception.ResourceInUseException"</para></entry>
</row>
<row>
<entry><para>4520 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
<entry><para>4525 : "com.cloud.exception.StorageUnavailableException"</para></entry>
<entry><para>4530 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
</row>
<row>
<entry><para>4535 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
<entry><para>9999 : "org.apache.cloudstack.api.ServerApiException"</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

45
docs/en-US/adding-IP-addresses-for-the-public-network.xml
View File

@ -1,45 +0,0 @@
<?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.
-->
<section id="adding-IP-addresses-for-the-public-network">
<title>Adding IP Addresses for the Public Network</title>
<para>These instructions assume you have already logged in to the &PRODUCT; UI.</para>
<orderedlist>
<listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the desired zone .</para></listitem>
<listitem><para>Click the Network tab.</para></listitem>
<listitem><para>In the Public node of the diagram, click Configure.</para></listitem>
<listitem><para>Click the IP Ranges tab.</para></listitem>
<listitem><para>Provide the following information:</para>
<itemizedlist>
<listitem><para>Gateway. The gateway in use for these IP addresses</para></listitem>
<listitem><para>Netmask. The netmask associated with this IP range</para></listitem>
<listitem><para>VLAN. The VLAN that will be used for public traffic</para></listitem>
<listitem><para>Start IP/End IP. 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>Click Add.</para></listitem>
</orderedlist>
</section>

31
docs/en-US/additional-installation-options.xml
View File

@ -1,31 +0,0 @@
<?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.
-->
<chapter id="additional-installation-options">
<title>Additional Installation Options</title>
<para>The next few sections describe &PRODUCT; features above and beyond the basic deployment options.</para>
<xi:include href="install-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ssl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="database-replication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

128
docs/en-US/admin-alerts.xml
View File

@ -1,128 +0,0 @@
<?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.
-->
<section id="admin-alerts">
<title>Administrator Alerts</title>
<para>The system provides alerts and events to help with the management of the cloud. Alerts are notices to an administrator, generally delivered by e-mail, notifying the administrator that an error has occurred in the cloud. Alert behavior is configurable.</para>
<para>Events track all of the user and administrator actions in the cloud. For example, every guest VM start creates an associated event. Events are stored in the Management Server’s database.</para>
<para>Emails will be sent to administrators under the following circumstances:</para>
<itemizedlist>
<listitem><para>The Management Server cluster runs low on CPU, memory, or storage resources</para></listitem>
<listitem><para>The Management Server loses heartbeat from a Host for more than 3 minutes</para></listitem>
<listitem><para>The Host cluster runs low on CPU, memory, or storage resources</para></listitem>
</itemizedlist>
<section id="external-snmp-manager">
<!-- CLOUDSTACK-680 -->
<title>Sending Alerts to External SNMP and Syslog Managers</title>
<para>In addition to showing administrator alerts on the Dashboard in the &PRODUCT; UI and
sending them in email, &PRODUCT; can also send the same alerts to external SNMP or
Syslog management software. This is useful if you prefer to use an SNMP or Syslog
manager to monitor your cloud.</para>
<para>The alerts which can be sent are listed in <xref linkend="alerts"/>. You can also
display the most up to date list by calling the API command listAlerts.</para>
<section id="snmp-alert-details">
<title>SNMP Alert Details</title>
<para>The supported protocol is SNMP version 2.</para>
<para>Each SNMP trap contains the following information: message, podId, dataCenterId, clusterId, and generationTime.</para>
</section>
<section id="syslog-alert-details">
<title>Syslog Alert Details</title>
<para>&PRODUCT; generates a syslog message for every alert. Each syslog message incudes
the fields alertType, message, podId, dataCenterId, and clusterId, in the following
format. If any field does not have a valid value, it will not be included.</para>
<programlisting>Date severity_level Management_Server_IP_Address/Name alertType:: value dataCenterId:: value podId:: value clusterId:: value message:: value</programlisting>
<para>For example:</para>
<programlisting>Mar 4 10:13:47 WARN localhost alertType:: managementNode message:: Management server node 127.0.0.1 is up</programlisting>
</section>
<section id="snmp-syslog-config">
<title>Configuring SNMP and Syslog Managers</title>
<para>To configure one or more SNMP managers or Syslog managers to receive alerts from
&PRODUCT;:</para>
<orderedlist>
<listitem><para>For an SNMP manager, install the &PRODUCT; MIB file on your SNMP manager system.
This maps the SNMP OIDs to trap types that can be more easily read by users.
The file must be publicly available.
For more information on how to install this file, consult the documentation provided with the SNMP manager.</para></listitem>
<listitem>
<para>Edit the file /etc/cloudstack/management/log4j-cloud.xml.</para>
<programlisting># vi /etc/cloudstack/management/log4j-cloud.xml</programlisting>
</listitem>
<listitem>
<para>Add an entry using the syntax shown below. Follow the appropriate example
depending on whether you are adding an SNMP manager or a Syslog manager. To specify
multiple external managers, separate the IP addresses and other configuration values
with commas (,).</para>
<note>
<para>The recommended maximum number of SNMP or Syslog managers is 20 for
each.</para>
</note>
<para/>
<para>The following example shows how to configure two SNMP managers at IP addresses
10.1.1.1 and 10.1.1.2. Substitute your own IP addresses, ports, and communities. Do
not change the other values (name, threshold, class, and layout values).</para>
<programlisting>&lt;appender name="SNMP" class="org.apache.cloudstack.alert.snmp.SnmpTrapAppender"&gt;
&lt;param name="Threshold" value="WARN"/&gt; &lt;!-- Do not edit. The alert feature assumes WARN. --&gt;
&lt;param name="SnmpManagerIpAddresses" value="10.1.1.1,10.1.1.2"/&gt;
&lt;param name="SnmpManagerPorts" value="162,162"/&gt;
&lt;param name="SnmpManagerCommunities" value="public,public"/&gt;
&lt;layout class="org.apache.cloudstack.alert.snmp.SnmpEnhancedPatternLayout"&gt; &lt;!-- Do not edit -->
&lt;param name="PairDelimeter" value="//"/&gt;
&lt;param name="KeyValueDelimeter" value="::"/&gt;
&lt;/layout&gt;
&lt;/appender&gt;</programlisting>
<para>The following example shows how to configure two Syslog managers at IP
addresses 10.1.1.1 and 10.1.1.2. Substitute your own IP addresses. You can
set Facility to any syslog-defined value, such as LOCAL0 - LOCAL7. Do not
change the other values.</para>
<programlisting>&lt;appender name="ALERTSYSLOG"&gt;
&lt;param name="Threshold" value="WARN"/&gt;
&lt;param name="SyslogHosts" value="10.1.1.1,10.1.1.2"/&gt;
&lt;param name="Facility" value="LOCAL6"/&gt;
&lt;layout&gt;
&lt;param name="ConversionPattern" value=""/&gt;
&lt;/layout&gt;
&lt;/appender&gt;</programlisting>
</listitem>
<listitem>
<para>If your cloud has multiple Management Server nodes, repeat these steps to edit
log4j-cloud.xml on every instance.</para>
</listitem>
<listitem>
<para>If you have made these changes while the Management Server is running, wait a
few minutes for the change to take effect.</para>
</listitem>
</orderedlist>
<para><emphasis role="bold">Troubleshooting:</emphasis> If no alerts appear at the
configured SNMP or Syslog manager after a reasonable amount of time, it is likely that
there is an error in the syntax of the &lt;appender&gt; entry in log4j-cloud.xml. Check
to be sure that the format and settings are correct.</para>
</section>
<section id="delete-snmp-syslog-manager">
<title>Deleting an SNMP or Syslog Manager</title>
<para>To remove an external SNMP manager or Syslog manager so that it no longer receives
alerts from &PRODUCT;, remove the corresponding entry from the file
/etc/cloudstack/management/log4j-cloud.xml.</para>
</section>
</section>
</section>

92
docs/en-US/admin-guide.xml
View File

@ -1,92 +0,0 @@
<?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.
-->
<chapter id="admin-guide">
<title>Administrator Guide</title>
<xi:include href="whats-in-this-adminguide.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="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vm-lifecycle.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-service-offering-for-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="manual-live-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="deleting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="best-practices-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="runtime-behavior-of-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="hypervisor-support-for-primarystorage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="storage-tags.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="maintenance-mode-for-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="best-practices-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="secondary-storage-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-secondary-storage-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-secondary-storage-servers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-swift-for-secondary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="working-with-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="creating-new-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="upload-existing-volume-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="upload-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="private-public-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="attaching-volume.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="detach-move-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="resizing-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="volume-deletion-garbage-collection.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="incremental-snapshots-backup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="volume-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="snapshot-restore.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-traffic.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-additional-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="change-network-offering-on-guest-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="about-virtual-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<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="add-ingress-egress-rules.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" />
<xi:include href="creating-network-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enable-security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-security-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-load-balancer-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="sticky-session-policies-for-lb-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="guest-ip-ranges.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="acquire-new-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="release-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="enable-disable-static-nat.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ip-forwarding-firewalling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="firewall-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="port-forwarding.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ip-load-balancing.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="dns-dhcp.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="configure-vpn.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="cloudstack-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>

25
docs/en-US/adv-zone-topology-req.xml
View File

@ -1,25 +0,0 @@
<?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.
-->
<section id="adv-zone-topology-req">
<title>Advanced Zone Topology Requirements</title>
<para>With Advanced Networking, separate subnets must be used for private and public
networks.</para>
</section>

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

@ -1,385 +0,0 @@
<?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.
-->
<section id="advanced-zone-configuration">
<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 in the Installation Guide. If you have enabled
VMware dvSwitch in the environment, you must specify the corresponding Switch name as
network traffic label for each traffic type on the physical network. For more information,
see Configuring a VMware Datacenter with VMware Distributed Virtual Switch in the
Installation Guide. </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, SharedMountPoint, CLVM, and RBD. 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 or fully
qualified domain name 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>

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

@ -1,31 +0,0 @@
<?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.
-->
<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. Additionally, the
administrator can reserve a part of the IP address space for non-&PRODUCT; VMs and
servers.</para>
</section>

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

@ -1,34 +0,0 @@
<?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.
-->
<section id="advanced-zone-network-traffic-types">
<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>
<listitem><para>Management. When &PRODUCT;’s internal resources communicate with each other, they generate management traffic. This includes communication between hosts, system VMs (VMs used by &PRODUCT; to perform various tasks in the cloud), and any other component that communicates directly with the &PRODUCT; Management Server. You must configure the IP range for the system VMs to use.</para></listitem>
<listitem><para>Public. Public traffic is generated when VMs in the cloud access the Internet. Publicly accessible IPs must be allocated for this purpose. End users can use the &PRODUCT; UI to acquire these IPs to implement NAT between their guest network and the public network, as described in “Acquiring a New IP Address” in the Administration Guide.</para></listitem>
<listitem><para>Storage. While labeled "storage" this is specifically about secondary storage, and doesn't affect traffic for primary storage. This includes traffic such as VM templates and snapshots, which is sent between the secondary storage VM and secondary storage servers. &PRODUCT; uses a separate Network Interface Controller (NIC) named storage NIC for storage network traffic. Use of a storage NIC that always operates on a high bandwidth network allows fast template and snapshot copying. You must configure the IP range to use for the storage network.</para></listitem>
</itemizedlist>
<para>These traffic types can each be on a separate physical network, or they can be combined with certain restrictions. When you use the Add Zone wizard in the UI to create a new zone, you are guided into making only valid choices.</para>
</section>

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

@ -1,30 +0,0 @@
<?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.
-->
<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>
<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"/>
<xi:include href="creating-shared-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</section>

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

@ -1,27 +0,0 @@
<?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.
-->
<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>
</section>

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

@ -1,53 +0,0 @@
<?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" [
<!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.
-->
<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>

28
docs/en-US/allocators.xml
View File

@ -1,28 +0,0 @@
<?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.
-->
<section id="allocators">
<title>Allocators</title>
<para>&PRODUCT; enables administrators to write custom allocators that will choose the Host to place a new guest and the storage host from which to allocate guest virtual disk images.</para>
</section>

33
docs/en-US/api-calls.xml
View File

@ -1,33 +0,0 @@
<?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.
-->
<chapter id="api-calls">
<title>Calling the &PRODUCT; API</title>
<xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="signing-api-requests.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" />
<xi:include href="api-throttling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<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" />
</chapter>

38
docs/en-US/api-overview.xml
View File

@ -1,38 +0,0 @@
<?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.
-->
<chapter id="api-overview">
<title>&PRODUCT; API</title>
<para>The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs.
It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF
standards.</para>
<para>Many &PRODUCT; API calls are asynchronous. These will return a Job ID immediately when
called. This Job ID can be used to query the status of the job later. Also, status calls on
impacted resources will provide some indication of their state.</para>
<para>The API has a REST-like query basis and returns results in XML or JSON.</para>
<para>See <ulink
url="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the
Developer’s Guide</ulink> and <ulink
url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API
Reference</ulink>.</para>
<xi:include href="provisioning-auth-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="allocators.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="user-data-and-meta-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>

24
docs/en-US/api-reference.xml
View File

@ -1,24 +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.
-->
<section id="api-reference">
<title>API Reference Documentation</title>
<para>You can find all the API reference documentation at the below site:</para>
<para><ulink url="http://cloudstack.apache.org/docs/api/">http://cloudstack.apache.org/docs/api/</ulink></para>
</section>

67
docs/en-US/api-throttling.xml
View File

@ -1,67 +0,0 @@
<?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.
-->
<section id="api-throttling">
<title>Limiting the Rate of API Requests</title>
<para>You can limit the rate at which API requests can be placed for each
account. This is useful to avoid malicious attacks on the Management Server, prevent
performance degradation, and provide fairness to all accounts.</para>
<para>If the number of API calls exceeds the threshold, an error message is returned for any additional API calls.
The caller will have to retry these API calls at another time.</para>
<section id="api-throttling-configure">
<title>Configuring the API Request Rate</title>
<para>To control the API request rate, use the following global configuration
settings:</para>
<itemizedlist>
<listitem><para>api.throttling.enabled - Enable/Disable API throttling. By default, this setting is false, so
API throttling is not enabled.</para></listitem>
<listitem><para>api.throttling.interval (in seconds) - Time interval during which the number of API requests is to be counted.
When the interval has passed, the API count is reset to 0.</para></listitem>
<listitem><para>api.throttling.max - Maximum number of APIs that can be placed within the api.throttling.interval period.</para></listitem>
<listitem><para>api.throttling.cachesize - Cache size for storing API counters.
Use a value higher than the total number of accounts managed by the cloud.
One cache entry is needed for each account, to store the running API total for that account.
</para></listitem>
</itemizedlist>
</section>
<section id="api-throttling-limitations">
<title>Limitations on API Throttling</title>
<para>The following limitations exist in the current implementation of this feature.</para>
<note><para>Even with these limitations, &PRODUCT; is still able to effectively use API throttling to
avoid malicious attacks causing denial of service.</para></note>
<para/>
<itemizedlist>
<listitem><para>In a deployment with multiple Management Servers,
the cache is not synchronized across them.
In this case, &PRODUCT; might not be able to
ensure that only the exact desired number of API requests are allowed.
In the worst case, the number of API calls that might be allowed is
(number of Management Servers) * (api.throttling.max).
</para></listitem>
<listitem><para>The API commands resetApiLimit and getApiLimit are limited to the
Management Server where the API is invoked.
</para></listitem>
</itemizedlist>
</section>
</section>

84
docs/en-US/append-displayname-vms.xml
View File

@ -1,84 +0,0 @@
<?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.
-->
<section id="append-displayname-vms">
<title>Appending a Display Name to the Guest VM’s Internal Name</title>
<para>Every guest VM has an internal name. The host uses the internal name to identify the guest
VMs. &PRODUCT; gives you an option to provide a guest VM with a display name. You can set this
display name as the internal name so that the vCenter can use it to identify the guest VM. A new
global parameter, vm.instancename.flag, has now been added to achieve this functionality.</para>
<para>The default format of the internal name is
i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;, where instance.name is a global
parameter. However, If vm.instancename.flag is set to true, and if a display name is provided
during the creation of a guest VM, the display name is appended to the internal name of the
guest VM on the host. This makes the internal name format as
i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;displayName&gt;. The default value of vm.instancename.flag
is set to false. This feature is intended to make the correlation between instance names and
internal names easier in large data center deployments.</para>
<para>The following table explains how a VM name is displayed in different scenarios.</para>
<informaltable>
<tgroup cols="5" align="left" colsep="1" rowsep="1">
<colspec colnum="1" colname="c1" colwidth="1.0*"/>
<colspec colnum="2" colname="c2" colwidth="1.31*"/>
<colspec colnum="3" colname="c3" colwidth="1.07*"/>
<colspec colnum="4" colname="c4" colwidth="2.6*"/>
<colspec colnum="5" colname="c5" colwidth="4.65*"/>
<thead>
<row>
<entry><para>User-Provided Display Name </para></entry>
<entry><para>vm.instancename.flag</para></entry>
<entry><para>Hostname on the VM</para></entry>
<entry><para>Name on vCenter</para></entry>
<entry><para>Internal Name</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>Yes</para></entry>
<entry><para>True</para></entry>
<entry><para>Display name</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-displayName</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-displayName</para></entry>
</row>
<row>
<entry><para>No</para></entry>
<entry><para>True</para></entry>
<entry><para>UUID</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
<row>
<entry><para>Yes</para></entry>
<entry><para>False</para></entry>
<entry><para>Display name</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
<row>
<entry><para>No</para></entry>
<entry><para>False</para></entry>
<entry><para>UUID</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

106
docs/en-US/asynchronous-commands-example.xml
View File

@ -1,106 +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.
-->
<section id="asynchronous-commands-example">
<title>Example</title>
<para>
The following shows an example of using an asynchronous command. Assume the API command:</para>
<programlisting>command=deployVirtualMachine&amp;zoneId=1&amp;serviceOfferingId=1&amp;diskOfferingId=1&amp;templateId=1
</programlisting>
<para>CloudStack will immediately return a job ID and any other additional data.</para>
<programlisting>
&lt;deployvirtualmachineresponse&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;id&gt;100&lt;/id&gt;
&lt;/deployvirtualmachineresponse&gt;
</programlisting>
<para>Using the job ID, you can periodically poll for the results by using the queryAsyncJobResult command.</para>
<programlisting>command=queryAsyncJobResult&amp;jobId=1</programlisting>
<para>Three possible results could come from this query.</para>
<para>Job is still pending:</para>
<programlisting>
&lt;queryasyncjobresult&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;0&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;1&lt;/jobprocstatus&gt;
&lt;/queryasyncjobresult&gt;
</programlisting>
<para>Job has succeeded:</para>
<programlisting>
&lt;queryasyncjobresultresponse cloud-stack-version="3.0.1.6"&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;1&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;0&lt;/jobprocstatus&gt;
&lt;jobresultcode&gt;0&lt;/jobresultcode&gt;
&lt;jobresulttype&gt;object&lt;/jobresulttype&gt;
&lt;jobresult&gt;
&lt;virtualmachine&gt;
&lt;id&gt;450&lt;/id&gt;
&lt;name&gt;i-2-450-VM&lt;/name&gt;
&lt;displayname&gt;i-2-450-VM&lt;/displayname&gt;
&lt;account&gt;admin&lt;/account&gt;
&lt;domainid&gt;1&lt;/domainid&gt;
&lt;domain&gt;ROOT&lt;/domain&gt;
&lt;created&gt;2011-03-10T18:20:25-0800&lt;/created&gt;
&lt;state&gt;Running&lt;/state&gt;
&lt;haenable&gt;false&lt;/haenable&gt;
&lt;zoneid&gt;1&lt;/zoneid&gt;
&lt;zonename&gt;San Jose 1&lt;/zonename&gt;
&lt;hostid&gt;2&lt;/hostid&gt;
&lt;hostname&gt;905-13.sjc.lab.vmops.com&lt;/hostname&gt;
&lt;templateid&gt;1&lt;/templateid&gt;
&lt;templatename&gt;CentOS 5.3 64bit LAMP&lt;/templatename&gt;
&lt;templatedisplaytext&gt;CentOS 5.3 64bit LAMP&lt;/templatedisplaytext&gt;
&lt;passwordenabled&gt;false&lt;/passwordenabled&gt;
&lt;serviceofferingid&gt;1&lt;/serviceofferingid&gt;
&lt;serviceofferingname&gt;Small Instance&lt;/serviceofferingname&gt;
&lt;cpunumber&gt;1&lt;/cpunumber&gt;
&lt;cpuspeed&gt;500&lt;/cpuspeed&gt;
&lt;memory&gt;512&lt;/memory&gt;
&lt;guestosid&gt;12&lt;/guestosid&gt;
&lt;rootdeviceid&gt;0&lt;/rootdeviceid&gt;
&lt;rootdevicetype&gt;NetworkFilesystem&lt;/rootdevicetype&gt;
&lt;nic&gt;
&lt;id&gt;561&lt;/id&gt;
&lt;networkid&gt;205&lt;/networkid&gt;
&lt;netmask&gt;255.255.255.0&lt;/netmask&gt;
&lt;gateway&gt;10.1.1.1&lt;/gateway&gt;
&lt;ipaddress&gt;10.1.1.225&lt;/ipaddress&gt;
&lt;isolationuri&gt;vlan://295&lt;/isolationuri&gt;
&lt;broadcasturi&gt;vlan://295&lt;/broadcasturi&gt;
&lt;traffictype&gt;Guest&lt;/traffictype&gt;
&lt;type&gt;Virtual&lt;/type&gt;
&lt;isdefault&gt;true&lt;/isdefault&gt;
&lt;/nic&gt;
&lt;hypervisor&gt;XenServer&lt;/hypervisor&gt;
&lt;/virtualmachine&gt;
&lt;/jobresult&gt;
&lt;/queryasyncjobresultresponse&gt;
</programlisting>
<para>Job has failed:</para>
<programlisting>
&lt;queryasyncjobresult&gt;
&lt;jobid&gt;1&lt;/jobid&gt;
&lt;jobstatus&gt;2&lt;/jobstatus&gt;
&lt;jobprocstatus&gt;0&lt;/jobprocstatus&gt;
&lt;jobresultcode&gt;551&lt;/jobresultcode&gt;
&lt;jobresulttype&gt;text&lt;/jobresulttype&gt;
&lt;jobresult&gt;Unable to deploy virtual machine id = 100 due to not enough capacity&lt;/jobresult&gt;
&lt;/queryasyncjobresult&gt;
</programlisting>
</section>

38
docs/en-US/asynchronous-commands.xml
View File

@ -1,38 +0,0 @@
<?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.
-->
<section id="asynchronous-commands">
<title>Asynchronous Commands</title>
<para>Asynchronous commands were introduced in &PRODUCT; 2.x. Commands are designated as asynchronous when they can potentially take a long period of time to complete such as creating a snapshot or disk volume. They differ from synchronous commands by the following:
</para>
<itemizedlist>
<listitem><para>They are identified in the API Reference by an (A).</para></listitem>
<listitem><para>They will immediately return a job ID to refer to the job that will be responsible in processing the command.</para></listitem>
<listitem><para>If executed as a "create" resource command, it will return the resource ID as well as the job ID.</para>
<para>You can periodically check the status of the job by making a simple API call to the command, queryAsyncJobResult and passing in the job ID.</para>
</listitem>
</itemizedlist>
<xi:include href="job-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="asynchronous-commands-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>

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

@ -1,40 +0,0 @@
<?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.
-->
<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>
</section>

61
docs/en-US/attaching-volume.xml
View File

@ -1,61 +0,0 @@
<?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.
-->
<section id="attaching-volume">
<title>Attaching a Volume</title>
<para>You can attach a volume to a guest VM to provide extra disk storage. Attach a volume when
you first create a new volume, when you are moving an existing volume from one VM to another, or
after you have migrated a volume from one storage pool to another.</para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI as a user or admin.</para>
</listitem>
<listitem>
<para>In the left navigation, click Storage.</para>
</listitem>
<listitem>
<para>In Select View, choose Volumes.</para>
</listitem>
<listitem>
<para>Click the volume name in the Volumes list, then click the Attach Disk button<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/attach-disk-icon.png"/>
</imageobject>
<textobject>
<phrase>AttachDiskButton.png: button to attach a volume</phrase>
</textobject>
</inlinemediaobject>
</para>
</listitem>
<listitem>
<para>In the Instance popup, choose the VM to which you want to attach the volume. You will
only see instances to which you are allowed to attach volumes; for example, a user will see
only instances created by that user, but the administrator will have more choices.</para>
<!-- <para>If the VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it.</para> -->
</listitem>
<listitem>
<para>When the volume has been attached, you should be able to see it by clicking Instances,
the instance name, and View Volumes.</para>
</listitem>
</orderedlist>
</section>

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

@ -1,36 +0,0 @@
<?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.
-->
<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>

286
docs/en-US/autoscale.xml
View File

@ -1,286 +0,0 @@
<?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.
-->
<section id="autoscale">
<title>Configuring AutoScale</title>
<para>AutoScaling allows you to scale your back-end services or application VMs up or down
seamlessly and automatically according to the conditions you define. With AutoScaling enabled,
you can ensure that the number of VMs you are using seamlessly scale up when demand increases,
and automatically decreases when demand subsides. Thus it helps you save compute costs by
terminating underused VMs automatically and launching new VMs when you need them, without the
need for manual intervention.</para>
<para>NetScaler AutoScaling is designed to seamlessly launch or terminate VMs based on
user-defined conditions. Conditions for triggering a scaleup or scaledown action can vary from a
simple use case like monitoring the CPU usage of a server to a complex use case of monitoring a
combination of server's responsiveness and its CPU usage. For example, you can configure
AutoScaling to launch an additional VM whenever CPU usage exceeds 80 percent for 15 minutes, or
to remove a VM whenever CPU usage is less than 20 percent for 30 minutes.</para>
<para>&PRODUCT; uses the NetScaler load balancer to monitor all aspects of a system's health and
work in unison with &PRODUCT; to initiate scale-up or scale-down actions.</para>
<note>
<para>AutoScale is supported on NetScaler Release 10 Build 73.e and beyond.</para>
</note>
<formalpara>
<title>Prerequisites</title>
<para>Before you configure an AutoScale rule, consider the following:</para>
</formalpara>
<itemizedlist>
<listitem>
<para>Ensure that the necessary template is prepared before configuring AutoScale. When a VM
is deployed by using a template and when it comes up, the application should be up and
running.</para>
<note>
<para>If the application is not running, the NetScaler device considers the VM as
ineffective and continues provisioning the VMs unconditionally until the resource limit is
exhausted.</para>
</note>
</listitem>
<listitem>
<para>Deploy the templates you prepared. Ensure that the applications come up on the first
boot and is ready to take the traffic. Observe the time requires to deploy the template.
Consider this time when you specify the quiet time while configuring AutoScale.</para>
</listitem>
<listitem>
<para>The AutoScale feature supports the SNMP counters that can be used to define conditions
for taking scale up or scale down actions. To monitor the SNMP-based counter, ensure that
the SNMP agent is installed in the template used for creating the AutoScale VMs, and the
SNMP operations work with the configured SNMP community and port by using standard SNMP
managers. For example, see <xref linkend="configure-snmp-rhel"/> to configure SNMP on a RHEL
machine.</para>
</listitem>
<listitem>
<para>Ensure that the endpointe.url parameter present in the Global Settings is set to the
Management Server API URL. For example, http://10.102.102.22:8080/client/api. In a
multi-node Management Server deployment, use the virtual IP address configured in the load
balancer for the management server’s cluster. Additionally, ensure that the NetScaler device
has access to this IP address to provide AutoScale support.</para>
<para>If you update the endpointe.url, disable the AutoScale functionality of the load
balancer rules in the system, then enable them back to reflect the changes. For more
information see <xref linkend="update-autoscale"/></para>
</listitem>
<listitem>
<para>If the API Key and Secret Key are regenerated for an AutoScale user, ensure that the
AutoScale functionality of the load balancers that the user participates in are disabled and
then enabled to reflect the configuration changes in the NetScaler.</para>
</listitem>
<listitem>
<para>In an advanced Zone, ensure that at least one VM should be present before configuring a
load balancer rule with AutoScale. Having one VM in the network ensures that the network is
in implemented state for configuring AutoScale.</para>
</listitem>
</itemizedlist>
<formalpara>
<title>Configuration</title>
<para>Specify the following:</para>
</formalpara>
<mediaobject>
<imageobject>
<imagedata fileref="./images/autoscale-config.png"/>
</imageobject>
<textobject>
<phrase>autoscaleateconfig.png: Configuring AutoScale</phrase>
</textobject>
</mediaobject>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Template</emphasis>: A template consists of a base OS image and
application. A template is used to provision the new instance of an application on a scaleup
action. When a VM is deployed from a template, the VM can start taking the traffic from the
load balancer without any admin intervention. For example, if the VM is deployed for a Web
service, it should have the Web server running, the database connected, and so on.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Compute offering</emphasis>: A predefined set of virtual hardware
attributes, including CPU speed, number of CPUs, and RAM size, that the user can select when
creating a new virtual machine instance. Choose one of the compute offerings to be used
while provisioning a VM instance as part of scaleup action.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Min Instance</emphasis>: The minimum number of active VM instances
that is assigned to a load balancing rule. The active VM instances are the application
instances that are up and serving the traffic, and are being load balanced. This parameter
ensures that a load balancing rule has at least the configured number of active VM instances
are available to serve the traffic.</para>
<note>
<para>If an application, such as SAP, running on a VM instance is down for some reason, the
VM is then not counted as part of Min Instance parameter, and the AutoScale feature
initiates a scaleup action if the number of active VM instances is below the configured
value. Similarly, when an application instance comes up from its earlier down state, this
application instance is counted as part of the active instance count and the AutoScale
process initiates a scaledown action when the active instance count breaches the Max
instance value.</para>
</note>
</listitem>
<listitem>
<para><emphasis role="bold">Max Instance</emphasis>: Maximum number of active VM instances
that <emphasis role="bold">should be assigned to </emphasis>a load balancing rule. This
parameter defines the upper limit of active VM instances that can be assigned to a load
balancing rule.</para>
<para>Specifying a large value for the maximum instance parameter might result in provisioning
large number of VM instances, which in turn leads to a single load balancing rule exhausting
the VM instances limit specified at the account or domain level.</para>
<note>
<para>If an application, such as SAP, running on a VM instance is down for some reason, the
VM is not counted as part of Max Instance parameter. So there may be scenarios where the
number of VMs provisioned for a scaleup action might be more than the configured Max
Instance value. Once the application instances in the VMs are up from an earlier down
state, the AutoScale feature starts aligning to the configured Max Instance value.</para>
</note>
</listitem>
</itemizedlist>
<para>Specify the following scale-up and scale-down policies:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Duration</emphasis>: The duration, in seconds, for which the
conditions you specify must be true to trigger a scaleup action. The conditions defined
should hold true for the entire duration you specify for an AutoScale action to be invoked.
</para>
</listitem>
<listitem>
<para><emphasis role="bold">Counter</emphasis>: The performance counters expose the state of
the monitored instances. By default, &PRODUCT; offers four performance counters: Three SNMP
counters and one NetScaler counter. The SNMP counters are Linux User CPU, Linux System CPU,
and Linux CPU Idle. The NetScaler counter is ResponseTime. The root administrator can add
additional counters into &PRODUCT; by using the &PRODUCT; API. </para>
</listitem>
<listitem>
<para><emphasis role="bold">Operator</emphasis>: The following five relational operators are
supported in AutoScale feature: Greater than, Less than, Less than or equal to, Greater than
or equal to, and Equal to.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Threshold</emphasis>: Threshold value to be used for the counter.
Once the counter defined above breaches the threshold value, the AutoScale feature initiates
a scaleup or scaledown action.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Add</emphasis>: Click Add to add the condition.</para>
</listitem>
</itemizedlist>
<para>Additionally, if you want to configure the advanced settings, click Show advanced settings,
and specify the following:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Polling interval</emphasis>: Frequency in which the conditions,
combination of counter, operator and threshold, are to be evaluated before taking a scale up
or down action. The default polling interval is 30 seconds.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Quiet Time</emphasis>: This is the cool down period after an
AutoScale action is initiated. The time includes the time taken to complete provisioning a
VM instance from its template and the time taken by an application to be ready to serve
traffic. This quiet time allows the fleet to come up to a stable state before any action can
take place. The default is 300 seconds.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Destroy VM Grace Period</emphasis>: The duration in seconds, after
a scaledown action is initiated, to wait before the VM is destroyed as part of scaledown
action. This is to ensure graceful close of any pending sessions or transactions being
served by the VM marked for destroy. The default is 120 seconds.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Security Groups</emphasis>: Security groups provide a way to
isolate traffic to the VM instances. A security group is a group of VMs that filter their
incoming and outgoing traffic according to a set of rules, called ingress and egress rules.
These rules filter network traffic according to the IP address that is attempting to
communicate with the VM.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Disk Offerings</emphasis>: A predefined set of disk size for
primary data storage. </para>
</listitem>
<listitem>
<para><emphasis role="bold">SNMP Community</emphasis>: The SNMP community string to be used by
the NetScaler device to query the configured counter value from the provisioned VM
instances. Default is public.</para>
</listitem>
<listitem>
<para><emphasis role="bold">SNMP Port</emphasis>: The port number on which the SNMP agent that
run on the provisioned VMs is listening. Default port is 161. </para>
</listitem>
<listitem>
<para><emphasis role="bold">User</emphasis>: This is the user that the NetScaler device use to
invoke scaleup and scaledown API calls to the cloud. If no option is specified, the user who
configures AutoScaling is applied. Specify another user name to override.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Apply</emphasis>: Click Apply to create the AutoScale
configuration.</para>
</listitem>
</itemizedlist>
<formalpara>
<title>Disabling and Enabling an AutoScale Configuration</title>
<para>If you want to perform any maintenance operation on the AutoScale VM instances, disable
the AutoScale configuration. When the AutoScale configuration is disabled, no scaleup or
scaledown action is performed. You can use this downtime for the maintenance activities. To
disable the AutoScale configuration, click the Disable AutoScale<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/enable-disable-autoscale.png"/>
</imageobject>
<textobject>
<phrase>EnableDisable.png: button to enable or disable AutoScale.</phrase>
</textobject>
</inlinemediaobject>button.</para>
</formalpara>
<para>The button toggles between enable and disable, depending on whether AutoScale is currently
enabled or not. After the maintenance operations are done, you can enable the AutoScale
configuration back. To enable, open the AutoScale configuration page again, then click the
Enable AutoScale<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/enable-disable-autoscale.png"/>
</imageobject>
<textobject>
<phrase>EnableDisable.png: button to enable or disable AutoScale.</phrase>
</textobject>
</inlinemediaobject>button.</para>
<formalpara id="update-autoscale">
<title>Updating an AutoScale Configuration</title>
<para>You can update the various parameters and add or delete the conditions in a scaleup or
scaledown rule. Before you update an AutoScale configuration, ensure that you disable the
AutoScale load balancer rule by clicking the Disable AutoScale button.</para>
</formalpara>
<para>After you modify the required AutoScale parameters, click Apply. To apply the new AutoScale
policies, open the AutoScale configuration page again, then click the Enable AutoScale
button.</para>
<formalpara>
<title>Runtime Considerations</title>
<para/>
</formalpara>
<itemizedlist>
<listitem>
<para>An administrator should not assign a VM to a load balancing rule which is configured for
AutoScale.</para>
</listitem>
<listitem>
<para>Before a VM provisioning is completed if NetScaler is shutdown or restarted, the
provisioned VM cannot be a part of the load balancing rule though the intent was to assign
it to a load balancing rule. To workaround, rename the AutoScale provisioned VMs based on
the rule name or ID so at any point of time the VMs can be reconciled to its load balancing
rule.</para>
</listitem>
<listitem>
<para>Making API calls outside the context of AutoScale, such as destroyVM, on an autoscaled
VM leaves the load balancing configuration in an inconsistent state. Though VM is destroyed
from the load balancer rule, NetScaler continues to show the VM as a service assigned to a
rule.</para>
</listitem>
</itemizedlist>
</section>

145
docs/en-US/aws-api-examples.xml
View File

@ -1,145 +0,0 @@
<?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.
-->
<section id="aws-api-examples">
<title>Examples</title>
<para>There are many tools available to interface with a AWS compatible API. In this section we provide
a few examples that users of &PRODUCT; can build upon.</para>
<section id="aws-api-boto-examples">
<title>Boto Examples</title>
<para>Boto is one of them. It is a Python package available at https://github.com/boto/boto.
In this section we provide two examples of Python scripts that use Boto and have been tested with the
&PRODUCT; AWS API Interface.</para>
<para>First is an EC2 example. Replace the Access and Secret Keys with your own and
update the endpoint.</para>
<para>
<example>
<title>An EC2 Boto example</title>
<programlisting>#!/usr/bin/env python
import sys
import os
import boto
import boto.ec2
region = boto.ec2.regioninfo.RegionInfo(name="ROOT",endpoint="localhost")
apikey='GwNnpUPrO6KgIdZu01z_ZhhZnKjtSdRwuYd4DvpzvFpyxGMvrzno2q05MB0ViBoFYtdqKd'
secretkey='t4eXLEYWw7chBhDlaKf38adCMSHx_wlds6JfSx3z9fSpSOm0AbP9Moj0oGIzy2LSC8iw'
def main():
'''Establish connection to EC2 cloud'''
conn =boto.connect_ec2(aws_access_key_id=apikey,
aws_secret_access_key=secretkey,
is_secure=False,
region=region,
port=7080,
path="/awsapi",
api_version="2010-11-15")
'''Get list of images that I own'''
images = conn.get_all_images()
print images
myimage = images[0]
'''Pick an instance type'''
vm_type='m1.small'
reservation = myimage.run(instance_type=vm_type,security_groups=['default'])
if __name__ == '__main__':
main()
</programlisting>
</example>
</para>
<para>Second is an S3 example. Replace the Access and Secret keys with your own,
as well as the endpoint of the service. Be sure to also update the file paths to something
that exists on your machine.</para>
<para>
<example>
<title>An S3 Boto Example</title>
<programlisting>#!/usr/bin/env python
import sys
import os
from boto.s3.key import Key
from boto.s3.connection import S3Connection
from boto.s3.connection import OrdinaryCallingFormat
apikey='ChOw-pwdcCFy6fpeyv6kUaR0NnhzmG3tE7HLN2z3OB_s-ogF5HjZtN4rnzKnq2UjtnHeg_yLA5gOw'
secretkey='IMY8R7CJQiSGFk4cHwfXXN3DUFXz07cCiU80eM3MCmfLs7kusgyOfm0g9qzXRXhoAPCH-IRxXc3w'
cf=OrdinaryCallingFormat()
def main():
'''Establish connection to S3 service'''
conn =S3Connection(aws_access_key_id=apikey,aws_secret_access_key=secretkey, \
is_secure=False, \
host='localhost', \
port=7080, \
calling_format=cf, \
path="/awsapi/rest/AmazonS3")
try:
bucket=conn.create_bucket('cloudstack')
k = Key(bucket)
k.key = 'test'
try:
k.set_contents_from_filename('/Users/runseb/Desktop/s3cs.py')
except:
print 'could not write file'
pass
except:
bucket = conn.get_bucket('cloudstack')
k = Key(bucket)
k.key = 'test'
try:
k.get_contents_to_filename('/Users/runseb/Desktop/foobar')
except:
print 'Could not get file'
pass
try:
bucket1=conn.create_bucket('teststring')
k=Key(bucket1)
k.key('foobar')
k.set_contents_from_string('This is my silly test')
except:
bucket1=conn.get_bucket('teststring')
k = Key(bucket1)
k.key='foobar'
k.get_contents_as_string()
if __name__ == '__main__':
main()
</programlisting>
</example>
</para>
</section>
<section id="aws-api-jclouds-examples">
<title>JClouds Examples</title>
<para></para>
</section>
</section>

109
docs/en-US/aws-ec2-configuration.xml
View File

@ -1,109 +0,0 @@
<?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.
-->
<section id="aws-ec2-configuration">
<title>Enabling the EC2 and S3 Compatible Interface</title>
<para>The software that provides AWS API compatibility is installed along with &PRODUCT;. You must enable the services and perform some setup steps prior to using it.
</para>
<orderedlist>
<listitem id="set-global-config"><para>Set the global configuration parameters for each service to true.
See <xref linkend="global-config" />.</para></listitem>
<listitem><para>Create a set of &PRODUCT; service offerings with names that match the Amazon service offerings.
You can do this through the &PRODUCT; UI as described in the Administration Guide.</para>
<warning><para>Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use.</para></warning>
</listitem>
<listitem><para>If you did not already do so when you set the configuration parameter in step <xref linkend="set-global-config"/>, restart the Management Server.</para>
<programlisting># service cloudstack-management restart</programlisting>
</listitem>
</orderedlist>
<para>The following sections provides details to perform these steps</para>
<section id="aws-api-settings">
<title>Enabling the Services</title>
<para>To enable the EC2 and S3 compatible services you need to set the configuration variables <emphasis>enable.ec2.api</emphasis>
and <emphasis>enable.s3.api</emphasis> to true. You do not have to enable both at the same time. Enable the ones you need.
This can be done via the &PRODUCT; GUI by going in <emphasis>Global Settings</emphasis> or via the API.</para>
<para>The snapshot below shows you how to use the GUI to enable these services</para>
<para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/ec2-s3-configuration.png"/>
</imageobject>
<textobject>
<phrase>Use the GUI to set the configuration variable to <emphasis>true</emphasis></phrase>
</textobject>
</mediaobject>
</para>
<para>Using the &PRODUCT; API, the easiest is to use the so-called integration port on which you can make
unauthenticated calls. In Global Settings set the port to 8096 and subsequently call the <emphasis>updateConfiguration</emphasis> method.
The following urls shows you how:</para>
<para>
<programlisting>
http://localhost:8096/client/api?command=updateConfiguration&amp;name=enable.ec2.api&amp;value=true
http://localhost:8096/client/api?command=updateConfiguration&amp;name=enable.ec2.api&amp;value=true
</programlisting>
</para>
<para>Once you have enabled the services, restart the server.</para>
</section>
<section id="aws-ec2-service-offerings">
<title>Creating EC2 Compatible Service Offerings</title>
<para>You will also need to define compute service offerings with names compatible with the <ulink url="http://aws.amazon.com/ec2/instance-types/">
Amazon EC2 instance types</ulink> API names (e.g m1.small,m1.large). This can be done via the &PRODUCT; GUI.
Go under <emphasis>Service Offerings</emphasis> select <emphasis>Compute offering</emphasis> and either create
a new compute offering or modify an existing one, ensuring that the name matches an EC2 instance type API name. The snapshot below shows you how:</para>
<para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/compute-service-offerings.png"/>
</imageobject>
<textobject>
<phrase>Use the GUI to set the name of a compute service offering to an EC2 instance
type API name.</phrase>
</textobject>
</mediaobject>
</para>
</section>
<section id="aws-api-port-change">
<title>Modifying the AWS API Port</title>
<note>
<para>(Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows:</para>
<orderedlist numeration="loweralpha">
<listitem><para>Edit the files /etc/cloudstack/management/server.xml, /etc/cloudstack/management/server-nonssl.xml,
and /etc/cloudstack/management/server-ssl.xml.</para></listitem>
<listitem><para>In each file, find the tag &lt;Service name="Catalina7080"&gt;. Under this tag,
locate &lt;Connector executor="tomcatThreadPool-internal" port= ....&lt;.</para></listitem>
<listitem><para>Change the port to whatever port you want to use, then save the files.</para></listitem>
<listitem><para>Restart the Management Server.</para></listitem>
</orderedlist>
<para>If you re-install &PRODUCT;, you will have to re-enable the services and if need be update the port.</para>
</note>
</section>
</section>

53
docs/en-US/aws-ec2-introduction.xml
View File

@ -1,53 +0,0 @@
<?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.
-->
<section id="aws-ec2-introduction">
<title>Amazon Web Services Compatible Interface</title>
<para>&PRODUCT; can translate Amazon Web Services (AWS) API calls to native &PRODUCT; API calls
so that users can continue using existing AWS-compatible tools. This translation service runs as
a separate web application in the same tomcat server as the management server of &PRODUCT;,
listening on a different port. The Amazon Web Services (AWS) compatible interface provides the
EC2 SOAP and Query APIs as well as the S3 REST API.</para>
<note>
<para>This service was previously enabled by separate software called CloudBridge. It is now
fully integrated with the &PRODUCT; management server. </para>
</note>
<warning>
<para>The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend.</para>
</warning>
<para>Limitations</para>
<itemizedlist>
<listitem>
<para>Supported only in zones that use basic networking.</para>
</listitem>
<listitem>
<para>Available in fresh installations of &PRODUCT;. Not available through upgrade of previous versions.</para>
</listitem>
<listitem>
<para>Features such as Elastic IP (EIP) and Elastic Load Balancing (ELB) are only available in an infrastructure
with a Citrix NetScaler device. Users accessing a Zone with a NetScaler device will need to use a
NetScaler-enabled network offering (DefaultSharedNetscalerEIP and ELBNetworkOffering).</para>
</listitem>
</itemizedlist>
</section>

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