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

Patch for missed out files for admin guide documentation

This commit is contained in:
Radhika PC 2012-10-04 11:46:31 +05:30 committed by Pranav Saxena
parent d50141d268
commit 8bd5f67e1d
9 changed files with 508 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

121
docs/en-US/add-clusters-vsphere.xml Normal file
View File

@ -0,0 +1,121 @@
<?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
values from vCenter.</para>
<itemizedlist>
<listitem>
<para>Cluster Name. Enter the name of the cluster you created in vCenter. For example,
"cloud.cluster.2.2.1"</para>
</listitem>
<listitem>
<para>vCenter Host. Enter the hostname or IP address of the vCenter server. </para>
</listitem>
<listitem>
<para>vCenter Username. Enter the username that &PRODUCT; should use to connect to
vCenter. This user must have all administrative privileges.</para>
</listitem>
<listitem>
<para>vCenter Password. Enter the password for the user named above</para>
</listitem>
<listitem>
<para>vCenter Datacenter. Enter the vCenter datacenter that the cluster is in. For
example, "cloud.dc.VM".</para>
<para>If you have enabled Nexus dvSwitch in the environment, the following parameters for
dvSwitch configuration are displayed:</para>
</listitem>
<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
applicance.</para>
</listitem>
<listitem>
<para>Nexus dvSwitch Password: The password associated with the username specified
above.</para>
<mediaobject>
<imageobject>
<imagedata fileref="./images/add-cluster.png"/>
</imageobject>
<textobject>
<phrase>addcluster.png: add cluster</phrase>
</textobject>
</mediaobject>
<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>

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

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

108
docs/en-US/create-vr-network-offering.xml Normal file
View File

@ -0,0 +1,108 @@
<?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="create-vr-network-offering">
<title>Creating and Changing a Virtual Router Network Offering</title>
<para>To create the network offering in association with a virtual router system service
offering:</para>
<orderedlist>
<listitem>
<para>Log in to the &PRODUCT; UI as a user or admin.</para>
</listitem>
<listitem>
<para>First, create a system service offering, for example: VRsystemofferingHA.</para>
<para>For more information on creating a system service offering, see <xref
linkend="creating-system-service-offerings"/>.</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. For a description of these terms, see <xref
linkend="about-virtual-networks"/>.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Specify VLAN</emphasis>. (Isolated guest networks only)
Indicate whether a VLAN should be specified when this offering is used.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Supported Services</emphasis>. Select one or more of the
possible network services. For some services, you must also choose the service provider;
for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or
any other load balancers that have been configured in the cloud. Depending on which
services you choose, additional fields may appear in the rest of the dialog box. For
more information, see <xref linkend="creating-network-offerings"/></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. In this case, the default “System
Offering For Software Router” and the custom “VRsystemofferingHA” are available and
displayed.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click OK and the network offering is created.</para>
</listitem>
</orderedlist>
<para>To change the network offering of a guest network to the virtual router service
offering:</para>
<orderedlist>
<listitem>
<para>Select Network from the left navigation pane.</para>
</listitem>
<listitem>
<para>Select the guest network that you want to offer this network service to.</para>
</listitem>
<listitem>
<para>Click the Edit button.</para>
</listitem>
<listitem>
<para>From the Network Offering drop-down, select the virtual router network offering you have
just created.</para>
</listitem>
<listitem>
<para>Click OK.</para>
</listitem>
</orderedlist>
</section>

54
docs/en-US/global-config.xml Normal file
View File

@ -0,0 +1,54 @@
<?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="global-config">
<title>Setting Global Configuration Parameters</title>
<para>&PRODUCT; provides parameters that you can set to control many aspects of the cloud. When
&PRODUCT; is first installed, and periodically thereafter, you might need to modify these
settings.</para>
<orderedlist>
<listitem>
<para>Log in to the UI as administrator.</para>
</listitem>
<listitem>
<para>In the left navigation bar, click Global Settings.</para>
</listitem>
<listitem>
<para>In Select View, choose one of the following:</para>
<itemizedlist>
<listitem>
<para>Global Settings. This displays a list of the parameters with brief descriptions and
current values.</para>
</listitem>
<listitem>
<para>Hypervisor Capabilities. This displays a list of hypervisor versions with the
maximum number of guests supported for each.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Use the search box to narrow down the list to those you are interested in.</para>
</listitem>
<listitem>
<para>Click the Edit icon to modify a value. If you are viewing Hypervisor Capabilities, you
must click the name of the hypervisor first to display the editing screen.</para>
</listitem>
</orderedlist>
</section>

48
docs/en-US/networks.xml Normal file
View File

@ -0,0 +1,48 @@
<?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="networks">
<title>Managing Networks and Traffic</title>
<para>In a &PRODUCT;, guest VMs can communicate with each other using shared infrastructure with
the security and user perception that the guests have a private LAN. The &PRODUCT; virtual
router is the main component providing networking features for guest traffic. </para>
<xi:include href="guest-traffic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="networking-in-a-pod.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="networking-in-a-zone.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="basic-zone-physical-network-configuration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="advanced-zone-physical-network-configuration.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="security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="external-firewalls-and-load-balancers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="load-balancer-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="ip-forwarding-firewalling.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="inter-vlan-routing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="configure-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>

25
docs/en-US/provisioning.xml Normal file
View File

@ -0,0 +1,25 @@
<?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="provisioning">
<title>Provisioning Your Cloud Infrastructure</title>
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>

27
docs/en-US/storage-overview.xml Normal file
View File

@ -0,0 +1,27 @@
<?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="storage-overview">
<title>Storage Overview</title>
<para>&PRODUCT; defines two types of storage: primary and secondary. Primary storage can be
accessed by either iSCSI or NFS. Additionally, direct attached storage may be used for primary
storage. Secondary storage is always accessed using NFS.</para>
<para>There is no ephemeral storage in &PRODUCT;. All volumes on all nodes are persistent.</para>
</section>

34
docs/en-US/virtual-machines.xml Normal file
View File

@ -0,0 +1,34 @@
<?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="virtual-machines">
<title>Working With Virtual Machines</title>
<xi:include href="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="best-practices-for-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="creating-vms.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="working-with-iso.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>