mirror of https://github.com/apache/cloudstack.git
Patch from Joe Brockmeier: Add license headers to u-named files, fix DTDs, etc.
This commit is contained in:
Chip Childers
parent
f572bccc61
commit
7d5be64a58
|
|
@ -1,8 +1,27 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<chapter id="ui">
|
||||
<title>User Interface</title>
|
||||
<xi:include href="log-in.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||
|
|
|
|||
|
|
@ -1,15 +1,33 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="upgrade-virtual-router-with-service-offering">
|
||||
<title>Upgrading a Virtual Router with System Service Offerings</title>
|
||||
<para>When CloudPlatform creates a virtual router, it uses default settings which are defined in a default system service offering. See <xref linkend="system-service-offerings"/>. All the virtual routers in a single guest network use the same system service offering. You can upgrade the capabilities of the virtual router by creating and applying a custom system service offering.</para>
|
||||
<para>When &PRODUCT; creates a virtual router, it uses default settings which are defined in a default system service offering. See <xref linkend="system-service-offerings"/>. All the virtual routers in a single guest network use the same system service offering. You can upgrade the capabilities of the virtual router by creating and applying a custom system service offering.</para>
|
||||
<orderedlist>
|
||||
<listitem><para>Define your custom system service offering. See <xref linkend="creating-system-service-offerings"/>. In System VM Type, choose Domain Router.</para></listitem>
|
||||
<listitem><para>Associate the system service offering with a network offering. See <xref linkend="creating-network-offerings"/></para></listitem>
|
||||
<listitem><para>3. Apply the network offering to the network where you want the virtual routers to use the new system service offering. If this is a new network, follow the steps in Adding an Additional Guest Network on page 66. To change the service offering for existing virtual routers, follow the steps in <xref linkend="change-network-offering-on-guest-network"/>.</para></listitem>
|
||||
<listitem><para>Apply the network offering to the network where you want the virtual routers to use the new system service offering. If this is a new network, follow the steps in Adding an Additional Guest Network on page 66. To change the service offering for existing virtual routers, follow the steps in <xref linkend="change-network-offering-on-guest-network"/>.</para></listitem>
|
||||
</orderedlist>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,57 +1,76 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="upload-existing-volume-to-vm">
|
||||
<title>Uploading an Existing Volume to a Virtual Machine</title>
|
||||
<para>Existing data can be made accessible to a virtual machine. This is called uploading a volume to the VM. For example, this is useful to upload data from a local file system and attach it to a VM. Root administrators, domain administrators, and end users can all upload existing volumes to VMs.</para>
|
||||
<para>The upload is performed using HTTP. The uploaded volume is placed in the zone's secondary storage</para>
|
||||
<para>You cannot upload a volume if the preconfigured volume limit has already been reached. The default limit for the cloud is set in the global configuration parameter max.account.volumes, but administrators can also set per-domain limits that are different from the global default. See Setting Usage Limits </para>
|
||||
<para>To upload a volume:</para>
|
||||
<orderedlist>
|
||||
<listitem><para>(Optional) Create an MD5 hash (checksum) of the disk image file that you are going to upload. After uploading the data disk, CloudPlatform will use this value to verify that no data corruption has occurred.</para></listitem>
|
||||
<listitem><para>Log in to the CloudPlatform UI as an administrator or user</para></listitem>
|
||||
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
|
||||
<listitem><para>Click Upload Volume.</para></listitem>
|
||||
<listitem><para>Provide the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>Name and Description. Any desired name and a brief description that can be shown in the UI.</para></listitem>
|
||||
<listitem><para>Availability Zone. Choose the zone where you want to store the volume. VMs running on hosts in this zone can attach the volume.</para></listitem>
|
||||
<listitem><para>Format. Choose one of the following to indicate the disk image format of the volume.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
|
||||
<thead>
|
||||
<row>
|
||||
<entry><para>Hypervisor</para></entry>
|
||||
<entry><para>Disk Image Format</para></entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><para>XenServer</para></entry>
|
||||
<entry><para>VHD</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>VMware</para></entry>
|
||||
<entry><para>OVA</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>KVM</para></entry>
|
||||
<entry><para>QCOW2</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>OVM</para></entry>
|
||||
<entry><para>RAW</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable></listitem>
|
||||
<listitem><para>URL. The secure HTTP or HTTPS URL that CloudPlatform can use to access your disk. The type of file at the URL must match the value chosen in Format. For example, if Format is VHD, the URL might look like the following:</para>
|
||||
<para>http://yourFileServerIP/userdata/myDataDisk.vhd</para></listitem>
|
||||
<listitem><para>MD5 checksum. (Optional) Use the hash that you created in step 1.</para></listitem></itemizedlist></listitem>
|
||||
<listitem><para>Wait until the status of the volume shows that the upload is complete. Click Instances - Volumes, find the name you specified in step 5, and make sure the status is Uploaded.</para></listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
||||
<para>Existing data can be made accessible to a virtual machine. This is called uploading a volume to the VM. For example, this is useful to upload data from a local file system and attach it to a VM. Root administrators, domain administrators, and end users can all upload existing volumes to VMs.</para>
|
||||
<para>The upload is performed using HTTP. The uploaded volume is placed in the zone's secondary storage</para>
|
||||
<para>You cannot upload a volume if the preconfigured volume limit has already been reached. The default limit for the cloud is set in the global configuration parameter max.account.volumes, but administrators can also set per-domain limits that are different from the global default. See Setting Usage Limits </para>
|
||||
<para>To upload a volume:</para>
|
||||
<orderedlist>
|
||||
<listitem><para>(Optional) Create an MD5 hash (checksum) of the disk image file that you are going to upload. After uploading the data disk, &PRODUCT; will use this value to verify that no data corruption has occurred.</para></listitem>
|
||||
<listitem><para>Log in to the &PRODUCT; UI as an administrator or user</para></listitem>
|
||||
<listitem><para>In the left navigation bar, click Storage.</para></listitem>
|
||||
<listitem><para>Click Upload Volume.</para></listitem>
|
||||
<listitem><para>Provide the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>Name and Description. Any desired name and a brief description that can be shown in the UI.</para></listitem>
|
||||
<listitem><para>Availability Zone. Choose the zone where you want to store the volume. VMs running on hosts in this zone can attach the volume.</para></listitem>
|
||||
<listitem><para>Format. Choose one of the following to indicate the disk image format of the volume.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
||||
<thead>
|
||||
<row>
|
||||
<entry><para>Hypervisor</para></entry>
|
||||
<entry><para>Disk Image Format</para></entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><para>XenServer</para></entry>
|
||||
<entry><para>VHD</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>VMware</para></entry>
|
||||
<entry><para>OVA</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>KVM</para></entry>
|
||||
<entry><para>QCOW2</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>OVM</para></entry>
|
||||
<entry><para>RAW</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable></listitem>
|
||||
<listitem><para>URL. The secure HTTP or HTTPS URL that &PRODUCT; can use to access your disk. The type of file at the URL must match the value chosen in Format. For example, if Format is VHD, the URL might look like the following:</para>
|
||||
<para>http://yourFileServerIP/userdata/myDataDisk.vhd</para></listitem>
|
||||
<listitem><para>MD5 checksum. (Optional) Use the hash that you created in step 1.</para></listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem><para>Wait until the status of the volume shows that the upload is complete. Click Instances - Volumes, find the name you specified in step 5, and make sure the status is Uploaded.</para></listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,27 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="upload-template">
|
||||
<title>Uploading Templates</title>
|
||||
<note><para>If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail.</para></note>
|
||||
|
|
@ -13,32 +32,22 @@
|
|||
<listitem><para>Click Create Template.</para></listitem>
|
||||
<listitem><para>Provide the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so
|
||||
choose something descriptive.</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Name and Display Text</emphasis>. These will be shown in the UI, so choose something descriptive.</para></listitem>
|
||||
<listitem><para>URL. The Management Server will download the file from the specified URL, such as http://my.web.server/filename.vhd.gz.</para></listitem>
|
||||
<listitem><para>Zone. Choose the zone where you want the template to be available, or All Zones to make it available throughout CloudPlatform.</para></listitem>
|
||||
<listitem><para>OS Type: This helps CloudPlatform and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
|
||||
<listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para>
|
||||
<note><para>Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem><para><emphasis role="bold">Hypervisor</emphasis></para></listitem>
|
||||
<listitem><para><emphasis role="bold">Format</emphasis>. The format of the template upload file, such as VHD
|
||||
or OVA.</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the
|
||||
CloudPlatform password change script installed. See Adding Password
|
||||
Management to Your Templates</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Extractable</emphasis>. Choose Yes if the template is available for extraction. If this option is selected, end users can
|
||||
download a full image of a template.</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
|
||||
users of this CloudPlatform installation. The template will appear in the
|
||||
Community Templates list. See <xref linkend="private-public-template"/></para></listitem>
|
||||
<listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be
|
||||
more prominent for users to select. The template will appear in the Featured
|
||||
Templates list. Only an administrator can make a template Featured.</para></listitem>
|
||||
</itemizedlist></listitem>
|
||||
|
||||
<listitem><para>Zone. Choose the zone where you want the template to be available, or All Zones to make it available throughout &PRODUCT;.</para></listitem>
|
||||
<listitem><para>OS Type: This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
|
||||
<listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para>
|
||||
<note><para>Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
<listitem><para><emphasis role="bold">Hypervisor</emphasis></para></listitem>
|
||||
<listitem><para><emphasis role="bold">Format</emphasis>. The format of the template upload file, such as VHD or OVA.</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the &PRODUCT; password change script installed. See Adding Password Management to Your Templates</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Extractable</emphasis>. Choose Yes if the template is available for extraction. If this option is selected, end users can download a full image of a template.</para></listitem>
|
||||
<listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all users of this &PRODUCT; installation. The template will appear in the Community Templates list. See <xref linkend="private-public-template"/></para></listitem>
|
||||
<listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be more prominent for users to select. The template will appear in the Featured Templates list. Only an administrator can make a template Featured.</para></listitem>
|
||||
</itemizedlist></listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,27 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="usage-record-format">
|
||||
<title>Usage Record Format</title>
|
||||
<xi:include href="virtual-machine-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
|
@ -14,4 +33,3 @@
|
|||
<xi:include href="network-offering-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
<xi:include href="VPN-user-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
</section>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,101 +1,109 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="usage-types">
|
||||
<title>Usage Types</title>
|
||||
<para>The following table shows all usage types.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec colname="c1" colnum="1" colwidth="4cm" />
|
||||
<colspec colname="c2" colnum="2" colwidth="8cm" />
|
||||
<colspec colname="c3" colnum="3" colwidth="5cm" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Type ID</entry>
|
||||
<entry>Type Name</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>1</entry>
|
||||
<entry>RUNNING_VM</entry>
|
||||
<entry>Tracks the total running time of a VM per usage record period. If the VM is upgraded during the usage period, you will get a separate Usage Record for the new upgraded VM.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>2</para></entry>
|
||||
<entry><para>ALLOCATED_VM</para></entry>
|
||||
<entry><para>Tracks the total time the VM has been created to the time when it has been destroyed. This usage type is also useful in determining usage for specific templates such as Windows-based templates.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>3</para></entry>
|
||||
<entry><para>IP_ADDRESS</para></entry>
|
||||
<entry><para>Tracks the public IP address owned by the account.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>4</para></entry>
|
||||
<entry><para>NETWORK_BYTES_SENT</para></entry>
|
||||
<entry><para>Tracks the total number of bytes sent by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>5</para></entry>
|
||||
<entry><para>NETWORK_BYTES_RECEIVED</para></entry>
|
||||
<entry><para>Tracks the total number of bytes received by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>6</para></entry>
|
||||
<entry><para>VOLUME</para></entry>
|
||||
<entry><para>Tracks the total time a disk volume has been created to the time when it has been destroyed.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>7</para></entry>
|
||||
<entry><para>TEMPLATE</para></entry>
|
||||
<entry><para>Tracks the total time a template (either created from a snapshot or uploaded to the cloud) has been created to the time it has been destroyed. The size of the template is also returned.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>8</para></entry>
|
||||
<entry><para>ISO</para></entry>
|
||||
<entry><para>Tracks the total time an ISO has been uploaded to the time it has been removed from the cloud. The size of the ISO is also returned.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>9</para></entry>
|
||||
<entry><para>SNAPSHOT</para></entry>
|
||||
<entry><para>Tracks the total time from when a snapshot has been created to the time it have been destroyed.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>11</para></entry>
|
||||
<entry><para>LOAD_BALANCER_POLICY</para></entry>
|
||||
<entry><para>Tracks the total time a load balancer policy has been created to the time it has been removed. Cloud.com does not track whether a VM has been assigned to a policy.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>12</para></entry>
|
||||
<entry><para>PORT_FORWARDING_RULE</para></entry>
|
||||
<entry><para>Tracks the time from when a port forwarding rule was created until the time it was removed.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>13</para></entry>
|
||||
<entry><para>NETWORK_OFFERING</para></entry>
|
||||
<entry><para>The time from when a network offering was assigned to a VM until it is removed.</para></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><para>14</para></entry>
|
||||
<entry><para>VPN_USERS</para></entry>
|
||||
<entry><para>The time from when a VPN user is created until it is removed.</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</section>
|
||||
<title>Usage Types</title>
|
||||
<para>The following table shows all usage types.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec colname="c1" colnum="1" colwidth="4cm" />
|
||||
<colspec colname="c2" colnum="2" colwidth="8cm" />
|
||||
<colspec colname="c3" colnum="3" colwidth="5cm" />
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Type ID</entry>
|
||||
<entry>Type Name</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>1</entry>
|
||||
<entry>RUNNING_VM</entry>
|
||||
<entry>Tracks the total running time of a VM per usage record period. If the VM is upgraded during the usage period, you will get a separate Usage Record for the new upgraded VM.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>2</para></entry>
|
||||
<entry><para>ALLOCATED_VM</para></entry>
|
||||
<entry><para>Tracks the total time the VM has been created to the time when it has been destroyed. This usage type is also useful in determining usage for specific templates such as Windows-based templates.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>3</para></entry>
|
||||
<entry><para>IP_ADDRESS</para></entry>
|
||||
<entry><para>Tracks the public IP address owned by the account.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>4</para></entry>
|
||||
<entry><para>NETWORK_BYTES_SENT</para></entry>
|
||||
<entry><para>Tracks the total number of bytes sent by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>5</para></entry>
|
||||
<entry><para>NETWORK_BYTES_RECEIVED</para></entry>
|
||||
<entry><para>Tracks the total number of bytes received by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>6</para></entry>
|
||||
<entry><para>VOLUME</para></entry>
|
||||
<entry><para>Tracks the total time a disk volume has been created to the time when it has been destroyed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>7</para></entry>
|
||||
<entry><para>TEMPLATE</para></entry>
|
||||
<entry><para>Tracks the total time a template (either created from a snapshot or uploaded to the cloud) has been created to the time it has been destroyed. The size of the template is also returned.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>8</para></entry>
|
||||
<entry><para>ISO</para></entry>
|
||||
<entry><para>Tracks the total time an ISO has been uploaded to the time it has been removed from the cloud. The size of the ISO is also returned.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>9</para></entry>
|
||||
<entry><para>SNAPSHOT</para></entry>
|
||||
<entry><para>Tracks the total time from when a snapshot has been created to the time it have been destroyed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>11</para></entry>
|
||||
<entry><para>LOAD_BALANCER_POLICY</para></entry>
|
||||
<entry><para>Tracks the total time a load balancer policy has been created to the time it has been removed. Cloud.com does not track whether a VM has been assigned to a policy.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>12</para></entry>
|
||||
<entry><para>PORT_FORWARDING_RULE</para></entry>
|
||||
<entry><para>Tracks the time from when a port forwarding rule was created until the time it was removed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>13</para></entry>
|
||||
<entry><para>NETWORK_OFFERING</para></entry>
|
||||
<entry><para>The time from when a network offering was assigned to a VM until it is removed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>14</para></entry>
|
||||
<entry><para>VPN_USERS</para></entry>
|
||||
<entry><para>The time from when a VPN user is created until it is removed.</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,23 +1,38 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="use-project-view">
|
||||
<title>Using the Project View</title>
|
||||
<para>If you are a member of a project, you can use CloudPlatform’s project view to see project members, resources consumed, and more. The project view shows only information related to one project. It is a useful way to filter out other information so you can concentrate on a project status and resources.</para>
|
||||
<para>If you are a member of a project, you can use &PRODUCT;’s project view to see project members, resources consumed, and more. The project view shows only information related to one project. It is a useful way to filter out other information so you can concentrate on a project status and resources.</para>
|
||||
<orderedlist>
|
||||
<listitem><para>Log in to the CloudPlatform UI.</para></listitem>
|
||||
<listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
|
||||
<listitem><para>Click Project View.</para></listitem>
|
||||
<listitem><para>The project dashboard appears, showing the project’s VMs, volumes, users, events, network settings, and more. From the dashboard, you can:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>Click the Accounts tab to view and manage project members. If you are the project administrator, you can add new members, remove members, or change the role of a member from user to admin. Only one member at a time can have the admin role, so if you set another user’s role to admin, your role will change to regular user.</para></listitem>
|
||||
<listitem><para>(If invitations are enabled) Click the Invitations tab to view and manage invitations that
|
||||
have been sent to new project members but not yet accepted. Pending invitations will
|
||||
remain in this list until the new member accepts, the invitation timeout is reached, or
|
||||
you cancel the invitation.</para></listitem>
|
||||
<listitem><para>(If invitations are enabled) Click the Invitations tab to view and manage invitations that have been sent to new project members but not yet accepted. Pending invitations will remain in this list until the new member accepts, the invitation timeout is reached, or you cancel the invitation.</para></listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,14 +1,35 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="user-data-and-meta-data">
|
||||
<title>User Data and Meta Data</title>
|
||||
<para>CloudPlatform provides API access to attach user data to a deployed VM. Deployed VMs also have access to instance metadata via the virtual router.</para>
|
||||
<para>&PRODUCT; provides API access to attach user data to a deployed VM. Deployed VMs also have access to instance metadata via the virtual router.</para>
|
||||
<para>User data can be accessed once the IP address of the virtual router is known. Once the IP address is known, use the following steps to access the user data:</para>
|
||||
<orderedlist>
|
||||
<listitem><para>Run the following command to find the virtual router.</para><programlisting># cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1</programlisting></listitem>
|
||||
<listitem><para>Run the following command to find the virtual router.</para>
|
||||
<programlisting># cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1</programlisting>
|
||||
</listitem>
|
||||
<listitem><para>Access user data by running the following command using the result of the above command</para><programlisting># curl http://10.1.1.1/latest/user-data</programlisting></listitem>
|
||||
</orderedlist>
|
||||
<para>Meta Data can be accessed similarly, using a URL of the form http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards compatibility, the previous URL http://10.1.1.1/latest/{metadata type} is also supported.) For metadata type, use one of the following:</para>
|
||||
|
|
@ -20,6 +41,5 @@
|
|||
<listitem><para>public-ipv4. The first public IP for the router. (E.g. the first IP of eth2)</para></listitem>
|
||||
<listitem><para>public-hostname. This is the same as public-ipv4</para></listitem>
|
||||
<listitem><para>instance-id. The instance name of the VM</para></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
</section>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,16 +1,40 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="user-services-overview">
|
||||
<title>User Services Overview</title>
|
||||
<para>In addition to the physical and logical infrastructure of your cloud, and the CloudPlatform software and servers, you also need a layer of user services so that people can actually make use of the cloud. This means not just a user UI, but a set of options and resources that users can choose from, such as templates for creating virtual machines, disk storage, and more. If you are running a commercial service, you will be keeping track of what services and resources users are consuming and charging them for that usage. Even if you do not charge anything for people to use your cloud – say, if the users are strictly internal to your organization, or just friends who are sharing your cloud – you can still keep track of what services they use and how much of them.</para>
|
||||
<title>User Services Overview</title>
|
||||
<para>In addition to the physical and logical infrastructure of your cloud, and the &PRODUCT; software and servers, you also need a layer of user services so that people can actually make use of the cloud. This means not just a user UI, but a set of options and resources that users can choose from, such as templates for creating virtual machines, disk storage, and more. If you are running a commercial service, you will be keeping track of what services and resources users are consuming and charging them for that usage. Even if you do not charge anything for people to use your cloud – say, if the users are strictly internal to your organization, or just friends who are sharing your cloud – you can still keep track of what services they use and how much of them.</para>
|
||||
<section id="offerings-and-templates">
|
||||
<title>Service Offerings, Disk Offerings, Network Offerings, and Templates</title>
|
||||
<para>A user creating a new instance can make a variety of choices about its characteristics and capabilities. CloudPlatform provides several ways to present users with choices when creating a new instance:</para>
|
||||
<para>A user creating a new instance can make a variety of choices about its characteristics and capabilities. &PRODUCT; provides several ways to present users with choices when creating a new instance:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>Service Offerings, defined by the CloudPlatform administrator, provide a choice of CPU speed, number of CPUs, RAM size, tags on the root disk, and other choices. See Creating a New Compute Offering.</para></listitem>
|
||||
<listitem><para>Disk Offerings, defined by the CloudPlatform administrator, provide a choice of disk size for primary data storage. See Creating a New Disk Offering.</para></listitem>
|
||||
<listitem><para>Network Offerings, defined by the CloudPlatform administrator, describe the feature set that is available to end users from the virtual router or external networking devices on a given guest network. See Network Offerings.</para></listitem>
|
||||
<listitem><para> Templates, defined by the CloudPlatform administrator or by any CloudPlatform user, are the base OS images that the user can choose from when creating a new instance. For example, CloudPlatform includes CentOS as a template. See Working with Templates.</para></listitem>
|
||||
<listitem><para>Service Offerings, defined by the &PRODUCT; administrator, provide a choice of CPU speed, number of CPUs, RAM size, tags on the root disk, and other choices. See Creating a New Compute Offering.</para></listitem>
|
||||
<listitem><para>Disk Offerings, defined by the &PRODUCT; administrator, provide a choice of disk size for primary data storage. See Creating a New Disk Offering.</para></listitem>
|
||||
<listitem><para>Network Offerings, defined by the &PRODUCT; administrator, describe the feature set that is available to end users from the virtual router or external networking devices on a given guest network. See Network Offerings.</para></listitem>
|
||||
<listitem><para>Templates, defined by the &PRODUCT; administrator or by any &PRODUCT; user, are the base OS images that the user can choose from when creating a new instance. For example, &PRODUCT; includes CentOS as a template. See Working with Templates.</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>In addition to these choices that are provided for users, there is another type of service offering which is available only to the CloudPlatform root administrator, and is used for configuring virtual infrastructure resources. For more information, see Upgrading a Virtual Router with System Service Offerings.</para>
|
||||
<para>In addition to these choices that are provided for users, there is another type of service offering which is available only to the &PRODUCT; root administrator, and is used for configuring virtual infrastructure resources. For more information, see Upgrading a Virtual Router with System Service Offerings.</para>
|
||||
</section>
|
||||
<section id="accounts-users-domains">
|
||||
<title>Accounts, Users, and Domains</title>
|
||||
|
|
@ -20,19 +44,19 @@
|
|||
</section>
|
||||
<section id="using-ldap-server">
|
||||
<title>Using an LDAP Server for User Authentication</title>
|
||||
<para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate CloudPlatform end-users. Just map CloudPlatform accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by CloudPlatform for matching common values such as the user’s email address and name. CloudPlatform will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user.</para>
|
||||
<para>To set up LDAP authentication in CloudPlatform, call the CloudPlatform API command ldapConfig and provide the following:</para>
|
||||
<para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate &PRODUCT; end-users. Just map &PRODUCT; accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by &PRODUCT; for matching common values such as the user’s email address and name. &PRODUCT; will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user.</para>
|
||||
<para>To set up LDAP authentication in &PRODUCT;, call the &PRODUCT; API command ldapConfig and provide the following:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>Hostname or IP address and listening port of the LDAP server</para></listitem>
|
||||
<listitem><para>Base directory and query filter</para></listitem>
|
||||
<listitem><para>Search user DN credentials, which give CloudPlatform permission to search on the LDAP server</para></listitem>
|
||||
<listitem><para>Search user DN credentials, which give &PRODUCT; permission to search on the LDAP server</para></listitem>
|
||||
<listitem><para>SSL keystore and password, if SSL is used</para></listitem>
|
||||
</itemizedlist>
|
||||
<section id="example-ldap-commands">
|
||||
<title>Example LDAP Configuration Commands</title>
|
||||
<para>To understand the examples in this section, you need to know the basic concepts behind calling the CloudPlatform API, which are explained in the Developer’s Guide.</para>
|
||||
<para>To understand the examples in this section, you need to know the basic concepts behind calling the &PRODUCT; API, which are explained in the Developer’s Guide.</para>
|
||||
<para>The following shows an example invocation of ldapConfig with an ApacheDS LDAP server.</para>
|
||||
<programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash
|
||||
<programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash
|
||||
</programlisting>
|
||||
<para>The command must be URL-encoded. Here is the same example without the URL encoding:</para>
|
||||
<programlisting>
|
||||
|
|
@ -51,8 +75,7 @@ http://127.0.0.1:8080/client/api?command=ldapConfig
|
|||
&signature=YourSignatureHash
|
||||
</programlisting>
|
||||
<para>The following shows a similar command for Active Directory. Here, the search base is the testing group within a company, and the users are matched up based on email address.</para>
|
||||
<programlisting>http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29&binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash
|
||||
</programlisting>
|
||||
<programlisting>http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29&binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash</programlisting>
|
||||
<para>The next few sections explain some of the concepts you will need to know when filling out the ldapConfig parameters.</para>
|
||||
</section>
|
||||
<section id="search-base">
|
||||
|
|
@ -71,7 +94,5 @@ http://127.0.0.1:8080/client/api?command=ldapConfig
|
|||
<title>SSL Keystore Path and Password</title>
|
||||
<para>Coming soon: TODO</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,31 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-multiple-guest-networks">
|
||||
<title>Using Multiple Guest Networks</title>
|
||||
<para>In zones that use advanced networking, additional networks for guest traffic may be added at any time after the initial installation. You can also customize the domain name associated with the network by specifying a DNS suffix for each network.</para>
|
||||
<para>A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network.</para>
|
||||
<para>Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network.</para>
|
||||
<para>Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests. Networks that are assigned to a specific account provide strong isolation.</para>
|
||||
<para>Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests.Networks that are assigned to a specific account provide strong isolation.</para>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,21 +1,40 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-netscaler-load-balancers">
|
||||
<title>About Using a NetScaler Load Balancer</title>
|
||||
<para>Citrix NetScaler is supported as an external network element for load balancing in zones that use advanced networking (also called advanced zones). Set up an external load balancer when you want to provide load balancing through means other than CloudPlatform’s provided virtual router.</para>
|
||||
<para>Citrix NetScaler is supported as an external network element for load balancing in zones that use advanced networking (also called advanced zones). Set up an external load balancer when you want to provide load balancing through means other than &PRODUCT;’s provided virtual router.</para>
|
||||
<para>The NetScaler can be set up in direct (outside the firewall) mode. It must be added before any load balancing rules are deployed on guest VMs in the zone.</para>
|
||||
<para>The functional behavior of the NetScaler with CloudPlatform is the same as described in the CloudPlatform documentation for using an F5 external load balancer. The only exception is that the F5 supports routing domains, and NetScaler does not. NetScaler can not yet be used as a firewall.</para>
|
||||
<para>The Citrix NetScaler comes in three varieties. The following table summarizes how these variants are treated in CloudPlatform.</para>
|
||||
<para>The functional behavior of the NetScaler with &PRODUCT; is the same as described in the &PRODUCT; documentation for using an F5 external load balancer. The only exception is that the F5 supports routing domains, and NetScaler does not. NetScaler can not yet be used as a firewall.</para>
|
||||
<para>The Citrix NetScaler comes in three varieties. The following table summarizes how these variants are treated in &PRODUCT;.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="3" align="left" colsep="1" rowsep="1">
|
||||
<thead>
|
||||
<row>
|
||||
<entry><para>NetScaler ADC Type</para></entry>
|
||||
<entry><para>Description of Capabilities</para></entry>
|
||||
<entry><para>CloudPlatform 3.0.3 Supported Features</para></entry>
|
||||
<entry><para>&PRODUCT; 3.0.3 Supported Features</para></entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
|
@ -28,15 +47,14 @@
|
|||
<row>
|
||||
<entry><para>VPX</para></entry>
|
||||
<entry><para>Virtual appliance. Can run as VM on XenServer, ESXi, and Hyper-V hypervisors. Same functionality as MPX</para></entry>
|
||||
<entry><para>Supported only on ESXi. Same functional support as for MPX. CloudPlatform will treat VPX and MPX as the same device type</para></entry>
|
||||
<entry><para>Supported only on ESXi. Same functional support as for MPX. &PRODUCT; will treat VPX and MPX as the same device type</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>SDX</para></entry>
|
||||
<entry><para>Physical appliance. Can create multiple fully isolated VPX instances on a single appliance to support multi-tenant usage</para></entry>
|
||||
<entry><para>CloudPlatform will dynamically provision, configure, and manage the lifecycle of VPX instances on the SDX. Provisioned instances are added into CloudPlatform automatically – no manual configuration by the administrator is required. Once a VPX instance is added into CloudPlatform, it is treated the same as a VPX on an ESXi host.</para></entry>
|
||||
<entry><para>&PRODUCT; will dynamically provision, configure, and manage the lifecycle of VPX instances on the SDX. Provisioned instances are added into &PRODUCT; automatically – no manual configuration by the administrator is required. Once a VPX instance is added into &PRODUCT;, it is treated the same as a VPX on an ESXi host.</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,19 +1,32 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-sshkeys">
|
||||
<title>Using the SSH Keys for Authentication on Cloud</title>
|
||||
<para>In addition to the username and password authentication, CloudStack supports using SSH
|
||||
keys to log in to the cloud infrastructure for additional security for your cloud
|
||||
infrastructure. You can use the createSSHKeyPair API to generate the SSH keys.</para>
|
||||
<para>Because each cloud user has their own ssh key, one cloud user cannot log in to another
|
||||
cloud user's instances unless they share their ssh key files. Using a single SSH key pair,
|
||||
you can manage multiple instances.</para>
|
||||
<sect1 id="create-template">
|
||||
<title> Creating an Instance Template that Supports SSH Keys</title>
|
||||
<para></para>
|
||||
<subtitle>Using the SSH Keys for Authentication on Cloud</subtitle>
|
||||
<para>In addition to the username and password authentication, CloudStack supports using SSH keys to log in to the cloud infrastructure for additional security for your cloud infrastructure. You can use the createSSHKeyPair API to generate the SSH keys.</para>
|
||||
<para>Because each cloud user has their own ssh key, one cloud user cannot log in to another cloud user's instances unless they share their ssh key files. Using a single SSH key pair, you can manage multiple instances.</para>
|
||||
<subtitle> Creating an Instance Template that Supports SSH Keys</subtitle>
|
||||
<orderedlist>
|
||||
<listitem><para>Create a instance template that supports SSH Keys.</para>
|
||||
<orderedlist numeration="loweralpha"><listitem><para>Create a new instance by using the template provided by cloudstack.</para>
|
||||
|
|
@ -29,9 +42,7 @@
|
|||
<listitem><para>Stop the instance.</para></listitem>
|
||||
</orderedlist></listitem>
|
||||
</orderedlist>
|
||||
</sect1>
|
||||
<sect1 id="gen-ssh-keypair">
|
||||
<title>Creating the SSH Keypair</title>
|
||||
<subtitle>Creating the SSH Keypair</subtitle>
|
||||
<para>You must make a call to the createSSHKeyPair api method. You can either use the cloudstack python api library or the curl commands to make the call to the cloudstack api.</para>
|
||||
<para>For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain:</para>
|
||||
<note><para>Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys.</para></note>
|
||||
|
|
@ -67,21 +78,15 @@ KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
|
|||
-----END RSA PRIVATE KEY-----</programlisting></listitem>
|
||||
<listitem><para>Save the file.</para></listitem>
|
||||
</orderedlist>
|
||||
</sect1>
|
||||
<sect1>
|
||||
<title>Creating an Instance</title>
|
||||
<subtitle>Creating an Instance</subtitle>
|
||||
<para>After you save the SSH keypair file, you must create an instance by using the template that you created at <xref linkend="create-template"/>. Ensure that you use the same SSH key name that you created at <xref linkend="gen-ssh-keypair"/>.</para>
|
||||
<note><para>You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair.</para></note>
|
||||
<para>A sample curl command to create a new instance is:</para>
|
||||
<programlisting>curl --globoff http://localhost:<port numbet>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc</programlisting>
|
||||
<para>Substitute the template, service offering and security group IDs (if you are using the security group feature) that are in your cloud environment.</para>
|
||||
</sect1>
|
||||
<sect1 id="login-using-sshkey">
|
||||
<title>Logging In Using the SSH Keypair</title>
|
||||
<subtitle>Logging In Using the SSH Keypair</subtitle>
|
||||
<para>To test your SSH key generation is successful, check whether you can log in to the cloud setup.</para>
|
||||
<para>For exaple, from a Linux OS, run:</para>
|
||||
<programlisting>ssh -i ~/.ssh/keypair-doc <ip address></programlisting>
|
||||
<para>The -i parameter tells the ssh client to use a ssh key found at ~/.ssh/keypair-doc.</para>
|
||||
</sect1>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,11 +1,29 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-swift-for-secondary-storage">
|
||||
<title>Using Swift for Secondary Storage</title>
|
||||
<para>CloudPlatform supports OpenStack Object Storage (<ulink url="http://swift.openstack.org/"> Swift</ulink>) for secondary storage. When using Swift, you configure Swift storage for the entire CloudPlatform, then set up NFS secondary storage for each zone as usual. 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 Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. 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>Swift storage must be set up before you add NFS secondary storage to zones. This is accomplished through some additional configuration steps on a fresh Management Server installation, before you add the first zone. The procedure is described in Adding a Zone in the Advanced Installation Guide.</para>
|
||||
</section>
|
||||
|
||||
<para>Swift storage must be set up before you add NFS secondary storage to zones. This is accomplished through some additional configuration steps on a fresh Management Server installation, before you add the first zone. The procedure is described in Adding a Zone in the Advanced Installation Guide.</para>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,9 +1,28 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-vpn-with-mac">
|
||||
<title>Using VPN with Mac OS X</title>
|
||||
<para>In Mac OS X, in Network Preferences – Advanced, make sure Send all traffic over VPN connection is not checked.</para>
|
||||
</section>
|
||||
<para>In Mac OS X, in Network Preferences - Advanced, make sure Send all traffic over VPN connection is not checked.</para>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -1,16 +1,35 @@
|
|||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
|
||||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||||
%BOOK_ENTITIES;
|
||||
]>
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||||
or more contributor license agreements. See the NOTICE file
|
||||
distributed with this work for additional information
|
||||
regarding copyright ownership. The ASF licenses this file
|
||||
to you under the Apache License, Version 2.0 (the
|
||||
"License"); you may not use this file except in compliance
|
||||
with the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
<section id="using-vpn-with-windows">
|
||||
<title>Using VPN with Windows</title>
|
||||
<para>The procedure to use VPN varies by Windows version. Generally, the user must edit the VPN properties and make sure that the default route is not the VPN. The following steps are for Windows L2TP clients on Windows Vista. The commands should be similar for other Windows versions.</para>
|
||||
<orderedlist>
|
||||
<listitem><para>Log in to the CloudPlatform UI and click on the source NAT IP for the account. The VPN tab should display the IPsec preshared key. Make a note of this and the source NAT IP. The UI also lists one or more users and their passwords. Choose one of these users, or, if none exists, add a user and password.</para></listitem>
|
||||
<listitem><para>Log in to the &PRODUCT; UI and click on the source NAT IP for the account. The VPN tab should display the IPsec preshared key. Make a note of this and the source NAT IP. The UI also lists one or more users and their passwords. Choose one of these users, or, if none exists, add a user and password.</para></listitem>
|
||||
<listitem><para>On the Windows box, go to Control Panel, then select Network and Sharing center. Click Setup a connection or network.</para></listitem>
|
||||
<listitem><para>In the next dialog, select No, create a new connection.</para></listitem>
|
||||
<listitem><para>In the next dialog, select Use my Internet Connection (VPN).</para></listitem>
|
||||
<listitem><para>In the next dialog, select Use my Internet Connection (VPN).</para></listitem>
|
||||
<listitem><para>In the next dialog, enter the source NAT IP from step 1 and give the connection a name. Check Don't connect now.</para></listitem>
|
||||
<listitem><para>In the next dialog, enter the user name and password selected in step 1.</para></listitem>
|
||||
<listitem><para>Click Create.</para></listitem>
|
||||
|
|
@ -19,5 +38,5 @@
|
|||
<listitem><para>In Type of VPN, choose L2TP IPsec VPN, then click IPsec settings. Select Use preshared key. Enter the preshared key from Step 1.</para></listitem>
|
||||
<listitem><para>The connection is ready for activation. Go back to Control Panel -> Network Connections and double-click the created connection.</para></listitem>
|
||||
<listitem><para>Enter the user name and password from Step 1.</para></listitem>
|
||||
</orderedlist>
|
||||
</orderedlist>
|
||||
</section>
|
||||
|
|
|
|||
Loading…
Reference in New Issue