http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/region-add.xml ---------------------------------------------------------------------- diff --git a/en-US/region-add.xml b/en-US/region-add.xml deleted file mode 100644 index 212047a..0000000 --- a/en-US/region-add.xml +++ /dev/null @@ -1,151 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="region-add"> - <title>Adding Regions (optional)</title> - <para>Grouping your cloud resources into geographic regions is an optional step when provisioning the cloud. - For an overview of regions, see <xref linkend="about-regions"/>.</para> - <section id="region-first"> - <title>The First Region: The Default Region</title> - <para>If you do not take action to define regions, then all the zones in your cloud will be - automatically grouped into a single default region. This region is assigned the region - ID of 1. You can change the name or URL of the default region by displaying the region in - the &PRODUCT; UI and clicking the Edit button.</para> - </section> - <section id="region-add-2"> - <title>Adding a Region</title> - <para>Use these steps to add a second region in addition to the default region.</para> - <orderedlist> - <listitem><para>Each region has its own &PRODUCT; instance. Therefore, the first step of creating a new region - is to install the Management Server software, on one or more nodes, in the - geographic area where you want to set up the new region. Use the steps in the - Installation guide. When you come to the step where you set up the database, use - the additional command-line flag <code>-r <region_id></code> to set a - region ID for the new region. The default region is automatically assigned a - region ID of 1, so your first additional region might be region 2.</para> - <programlisting>cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id></programlisting> - </listitem> - <listitem><para>By the end of the installation procedure, the Management Server should have been started. Be sure that the Management Server installation was successful and complete.</para></listitem> - <listitem><para>Now add the new region to region 1 in &PRODUCT;.</para> - <orderedlist numeration="loweralpha"> - <listitem><para>Log in to &PRODUCT; in the first region as root administrator - (that is, log in to <region.1.IP.address>:8080/client).</para></listitem> - <listitem><para>In the left navigation bar, click Regions.</para></listitem> - <listitem><para>Click Add Region. In the dialog, fill in the following fields:</para> - <itemizedlist> - <listitem><para>ID. A unique identifying number. Use the same number - you set in the database during Management Server installation in the new region; - for example, 2.</para></listitem> - <listitem><para>Name. Give the new region a descriptive name.</para></listitem> - <listitem><para>Endpoint. The URL where you can log in to the Management Server in the new region. - This has the format <region.2.IP.address>:8080/client.</para></listitem> - </itemizedlist> - </listitem> - </orderedlist> - </listitem> - <listitem><para>Now perform the same procedure in reverse. Log in to region 2, and add region 1.</para></listitem> - <listitem><para>Copy the account, user, and domain tables from the region 1 database to the region 2 database.</para> - <para>In the following commands, it is assumed that you have set the root password on the - database, which is a &PRODUCT; recommended best practice. Substitute your own MySQL - root password.</para> - <orderedlist numeration="loweralpha"> - <listitem><para>First, run this command to copy the contents of the database:</para> - <programlisting># mysqldump -u root -p<mysql_password> -h <region1_db_host> cloud account user domain > region1.sql</programlisting> - </listitem> - <listitem><para>Then run this command to put the data onto the region 2 database:</para> - <programlisting># mysql -u root -p<mysql_password> -h <region2_db_host> cloud < region1.sql</programlisting> - </listitem> - </orderedlist> - </listitem> - <listitem><para>Remove project accounts. Run these commands on the region 2 database:</para> - <programlisting>mysql> delete from account where type = 5;</programlisting> - </listitem> - <listitem><para>Set the default zone as null:</para> - <programlisting>mysql> update account set default_zone_id = null;</programlisting> - </listitem> - <listitem><para>Restart the Management Servers in region 2.</para></listitem> - </orderedlist> - </section> - <section id="region-add-n"> - <title>Adding Third and Subsequent Regions</title> - <para>To add the third region, and subsequent additional regions, the steps are similar to those for adding the second region. - However, you must repeat certain steps additional times for each additional region:</para> - <orderedlist> - <listitem><para>Install &PRODUCT; in each additional region. Set the region ID for each region during the database setup step.</para> - <programlisting>cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id></programlisting></listitem> - <listitem><para>Once the Management Server is running, add your new region to all existing regions by - repeatedly using the Add Region button in the UI. For example, if you were adding - region 3:</para> - <orderedlist numeration="loweralpha"> - <listitem><para>Log in to &PRODUCT; in the first region as root administrator - (that is, log in to <region.1.IP.address>:8080/client), and add a region with ID 3, the name of region 3, and the endpoint <region.3.IP.address>:8080/client.</para></listitem> - <listitem><para>Log in to &PRODUCT; in the second region as root administrator (that is, log in to <region.2.IP.address>:8080/client), and add a region with ID 3, the name of region 3, and the endpoint <region.3.IP.address>:8080/client.</para></listitem> - </orderedlist> - </listitem> - <listitem><para>Repeat the procedure in reverse to add all existing regions to the new region. For example, - for the third region, add the other two existing regions:</para> - <orderedlist numeration="loweralpha"> - <listitem><para>Log in to &PRODUCT; in the third region as root administrator - (that is, log in to <region.3.IP.address>:8080/client).</para></listitem> - <listitem><para>Add a region with ID 1, the name of region 1, and the endpoint <region.1.IP.address>:8080/client.</para></listitem> - <listitem><para>Add a region with ID 2, the name of region 2, and the endpoint <region.2.IP.address>:8080/client.</para></listitem> - </orderedlist> - </listitem> - <listitem><para>Copy the account, user, and domain tables from any existing region's database to the new - region's database.</para> - <para>In the following commands, it is assumed that you have set the root password on the - database, which is a &PRODUCT; recommended best practice. Substitute your own MySQL - root password.</para> - <orderedlist numeration="loweralpha"> - <listitem><para>First, run this command to copy the contents of the database:</para> - <programlisting># mysqldump -u root -p<mysql_password> -h <region1_db_host> cloud account user domain > region1.sql</programlisting> - </listitem> - <listitem><para>Then run this command to put the data onto the new region's database. For example, for region - 3:</para> - <programlisting># mysql -u root -p<mysql_password> -h <region3_db_host> cloud < region1.sql</programlisting> - </listitem> - </orderedlist> - </listitem> - <listitem><para>Remove project accounts. Run these commands on the region 3 database:</para> - <programlisting>mysql> delete from account where type = 5;</programlisting> - </listitem> - <listitem><para>Set the default zone as null:</para> - <programlisting>mysql> update account set default_zone_id = null;</programlisting> - </listitem> - <listitem><para>Restart the Management Servers in the new region.</para></listitem> - </orderedlist> - </section> - <section id="region-delete"> - <title>Deleting a Region</title> - <para>Log in to each of the other regions, navigate to the one you want to delete, and click Remove Region. - For example, to remove the third region in a 3-region cloud:</para> - <orderedlist> - <listitem><para>Log in to <region.1.IP.address>:8080/client.</para></listitem> - <listitem><para>In the left navigation bar, click Regions.</para></listitem> - <listitem><para>Click the name of the region you want to delete.</para></listitem> - <listitem><para>Click the Remove Region button.</para></listitem> - <listitem><para>Repeat these steps for <region.2.IP.address>:8080/client.</para></listitem> - </orderedlist> - </section> -</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/release-ip-address.xml ---------------------------------------------------------------------- diff --git a/en-US/release-ip-address.xml b/en-US/release-ip-address.xml deleted file mode 100644 index 9fdccd7..0000000 --- a/en-US/release-ip-address.xml +++ /dev/null @@ -1,43 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="release-ip-address"> - <title>Releasing an IP Address</title> - <para>When the last rule for an IP address is removed, you can release that IP address. The IP address still belongs to the VPC; however, it can be picked up for any guest network again.</para> - <orderedlist> - <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem> - <listitem><para>In the left navigation, choose Network.</para></listitem> - <listitem><para>Click the name of the network where you want to work with.</para></listitem> - <listitem><para>Click View IP Addresses.</para></listitem> - <listitem><para>Click the IP address you want to release.</para> - </listitem> - <listitem><para>Click the Release IP button. <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/release-ip-icon.png"/> - </imageobject> - <textobject> - <phrase>ReleaseIPButton.png: button to release an IP</phrase> - </textobject> - </inlinemediaobject></para></listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/release-ip-for-vpc.xml ---------------------------------------------------------------------- diff --git a/en-US/release-ip-for-vpc.xml b/en-US/release-ip-for-vpc.xml deleted file mode 100644 index f827b67..0000000 --- a/en-US/release-ip-for-vpc.xml +++ /dev/null @@ -1,95 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="release-ip-for-vpc"> - <title>Releasing an IP Address Alloted to a VPC</title> - <para>The IP address is a limited resource. If you no longer need a particular IP, you can - disassociate it from its VPC and return it to the pool of available addresses. An IP address can - be released from its tier, only when all the networking ( port forwarding, load balancing, or - StaticNAT ) rules are removed for this IP address. The released IP address will still belongs to - the same VPC.</para> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPC.</para> - <para>All the VPCs that you have created for the account is listed in the page.</para> - </listitem> - <listitem> - <para>Click the Configure button of the VPC whose IP you want to release.</para> - <para>The VPC page is displayed where all the tiers you created are listed in a - diagram.</para> - <para>The following options are displayed.</para> - <itemizedlist> - <listitem> - <para>Internal LB</para> - </listitem> - <listitem> - <para>Public LB IP</para> - </listitem> - <listitem> - <para>Static NAT</para> - </listitem> - <listitem> - <para>Virtual Machines</para> - </listitem> - <listitem> - <para>CIDR</para> - </listitem> - </itemizedlist> - <para>The following router information is displayed:</para> - <itemizedlist> - <listitem> - <para>Private Gateways</para> - </listitem> - <listitem> - <para>Public IP Addresses</para> - </listitem> - <listitem> - <para>Site-to-Site VPNs</para> - </listitem> - <listitem> - <para>Network ACL Lists</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Select Public IP Addresses.</para> - <para>The IP Addresses page is displayed.</para> - </listitem> - <listitem> - <para>Click the IP you want to release.</para> - </listitem> - <listitem> - <para>In the Details tab, click the Release IP button <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/release-ip-icon.png"/> - </imageobject> - <textobject> - <phrase>release-ip-icon.png: button to release an IP.</phrase> - </textobject> - </inlinemediaobject></para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/remove-member-from-project.xml ---------------------------------------------------------------------- diff --git a/en-US/remove-member-from-project.xml b/en-US/remove-member-from-project.xml deleted file mode 100644 index dcd3746..0000000 --- a/en-US/remove-member-from-project.xml +++ /dev/null @@ -1,44 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="remove-member-from-project"> - <title>Removing a Member From a Project</title> - <para>When a member is removed from a project, the memberâs resources continue to be owned by the project. The former project member cannot create any new resources within the project or use any of the projectâs existing resources.</para> - <para>A member of a project can be removed by the project administrator, the domain administrator of the domain the project belongs to or of its parent domain, or the &PRODUCT; root administrator.</para> - <orderedlist> - <listitem><para>Log in to the &PRODUCT; UI.</para></listitem> - <listitem><para>In the left navigation, click Projects.</para></listitem> - <listitem><para>In Select View, choose Projects.</para></listitem> - <listitem><para>Click the name of the project.</para></listitem> - <listitem><para>Click the Accounts tab.</para></listitem> - <listitem><para>Click the name of the member.</para></listitem> - <listitem><para>Click the Delete button.<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/delete-button.png" /> - </imageobject> - <textobject><phrase>deletebutton.png: Removes a member</phrase></textobject> - </inlinemediaobject></para></listitem> - </orderedlist> - </section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/remove-tier.xml ---------------------------------------------------------------------- diff --git a/en-US/remove-tier.xml b/en-US/remove-tier.xml deleted file mode 100644 index 701645c..0000000 --- a/en-US/remove-tier.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="remove-tier"> - <title>Removing Tiers</title> - <para>You can remove a tier from a VPC. A removed tier cannot be revoked. When a tier is removed, - only the resources of the tier are expunged. All the network rules (port forwarding, load - balancing and staticNAT) and the IP addresses associated to the tier are removed. The IP address - still be belonging to the same VPC.</para> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPC.</para> - <para>All the VPC that you have created for the account is listed in the page.</para> - </listitem> - <listitem> - <para>Click the Configure button of the VPC for which you want to set up tiers.</para> - <para>The Configure VPC page is displayed. Locate the tier you want to work with.</para> - </listitem> - <listitem> - <para>Select the tier you want to remove.</para> - </listitem> - <listitem> - <para>In the Network Details tab, click the Delete Network button. - <inlinemediaobject><imageobject> - <imagedata fileref="./images/del-tier.png"/> - </imageobject> - <textobject> - <phrase>del-tier.png: button to remove a tier</phrase> - </textobject> - </inlinemediaobject></para> - <para>Click Yes to confirm. Wait for some time for the tier to be removed.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/remove-vpc.xml ---------------------------------------------------------------------- diff --git a/en-US/remove-vpc.xml b/en-US/remove-vpc.xml deleted file mode 100644 index b373f1a..0000000 --- a/en-US/remove-vpc.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="remove-vpc"> - <title>Editing, Restarting, and Removing a Virtual Private Cloud</title> - <note> - <para>Ensure that all the tiers are removed before you remove a VPC.</para> - </note> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user. </para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPC.</para> - <para>All the VPCs that you have created for the account is listed in the page.</para> - </listitem> - <listitem> - <para>Select the VPC you want to work with.</para> - </listitem> - <listitem> - <para>In the Details tab, click the Remove VPC button<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/remove-vpc.png"/> - </imageobject> - <textobject> - <phrase>remove-vpc.png: button to remove a VPC</phrase> - </textobject> - </inlinemediaobject></para> - <para>You can remove the VPC by also using the remove button in the Quick View.</para> - <para>You can edit the name and description of a VPC. To do that, select the VPC, then click - the Edit button. <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/edit-icon.png"/> - </imageobject> - <textobject> - <phrase>edit-icon.png: button to edit a VPC</phrase> - </textobject> - </inlinemediaobject></para> - <para>To restart a VPC, select the VPC, then click the Restart button.<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/restart-vpc.png"/> - </imageobject> - <textobject> - <phrase>restart-vpc.png: button to restart a VPC</phrase> - </textobject> - </inlinemediaobject></para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/removed-API-commands.xml ---------------------------------------------------------------------- diff --git a/en-US/removed-API-commands.xml b/en-US/removed-API-commands.xml deleted file mode 100644 index 51bb7cf..0000000 --- a/en-US/removed-API-commands.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - - <section id="removed-API-commands"> - <title>Removed API commands</title> - <itemizedlist> - <listitem><para>createConfiguration (Adds configuration value)</para></listitem> - <listitem><para>configureSimulator (Configures simulator)</para></listitem> - </itemizedlist> - </section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/removed-api-4.2.xml ---------------------------------------------------------------------- diff --git a/en-US/removed-api-4.2.xml b/en-US/removed-api-4.2.xml deleted file mode 100644 index 596d316..0000000 --- a/en-US/removed-api-4.2.xml +++ /dev/null @@ -1,144 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="removed-api-4.2"> - <title>Deprecated APIs</title> - <itemizedlist> - <listitem> - <para>deleteCiscoNexusVSM (Deletes a Cisco Nexus VSM device) </para> - </listitem> - <listitem> - <para>enableCiscoNexusVSM (Enables a Cisco Nexus VSM device) </para> - </listitem> - <listitem> - <para>disableCiscoNexusVSM (Disables a Cisco Nexus VSM device) </para> - </listitem> - <listitem> - <para>listCiscoNexusVSMs (Retrieves a Cisco Nexus 1000v Virtual Switch Manager device - associated with a Cluster) </para> - </listitem> - <listitem> - <para>addBaremetalHost (Adds a new host.) </para> - </listitem> - <listitem> - <para>addExternalFirewall (Adds an external firewall appliance) </para> - </listitem> - <listitem> - <para>deleteExternalFirewall (Deletes an external firewall appliance.) </para> - </listitem> - <listitem> - <para>listExternalFirewalls (Lists external firewall appliances.) </para> - </listitem> - <listitem> - <para>addExternalLoadBalancer (Adds F5 external load balancer appliance.) </para> - </listitem> - <listitem> - <para>deleteExternalLoadBalancer (Deletes a F5 external load balancer appliance added in a - zone.) </para> - </listitem> - <listitem> - <para>listExternalLoadBalancers (Lists F5 external load balancer appliances added in a - zone.) </para> - </listitem> - <listitem> - <para>createVolumeOnFiler (Creates a volume.) </para> - </listitem> - <listitem> - <para>destroyVolumeOnFiler (Destroys a volume.) </para> - </listitem> - <listitem> - <para>listVolumesOnFiler (Lists volumes.) </para> - </listitem> - <listitem> - <para>createLunOnFiler (Creates a LUN from a pool.) </para> - </listitem> - <listitem> - <para>destroyLunOnFiler (Destroys a LUN.) </para> - </listitem> - <listitem> - <para>listLunsOnFiler (Lists LUN.) </para> - </listitem> - <listitem> - <para>associateLun (Associates a LUN with a guest IQN.) </para> - </listitem> - <listitem> - <para>dissociateLun (Dissociates a LUN.) </para> - </listitem> - <listitem> - <para>createPool (Creates a pool.) </para> - </listitem> - <listitem> - <para>deletePool (Deletes a pool.) </para> - </listitem> - <listitem> - <para>modifyPool (Modifies pool.) </para> - </listitem> - <listitem> - <para>listPools (Lists pool.) </para> - </listitem> - <listitem> - <para>addF5LoadBalancer (Adds a F5 BigIP load balancer device.) </para> - </listitem> - <listitem> - <para>configureF5LoadBalancer (Configures a F5 load balancer device.) </para> - </listitem> - <listitem> - <para>deleteF5LoadBalancer (Deletes a F5 load balancer device.) </para> - </listitem> - <listitem> - <para>listF5LoadBalancers (Lists F5 load balancer devices.) </para> - </listitem> - <listitem> - <para>listF5LoadBalancerNetworks (Lists network that are using a F5 load balancer device.) - </para> - </listitem> - <listitem> - <para>addSrxFirewall (Adds a SRX firewall device.) </para> - </listitem> - <listitem> - <para>deleteSrxFirewall (Deletes a SRX firewall device.) </para> - </listitem> - <listitem> - <para>configureSrxFirewall (Configures a SRX firewall device) </para> - </listitem> - <listitem> - <para>listSrxFirewalls (Lists SRX firewall devices in a physical network) </para> - </listitem> - <listitem> - <para>listSrxFirewallNetworks (Lists network that are using SRX firewall device) </para> - </listitem> - <listitem> - <para>addNetscalerLoadBalancer (Adds a netscaler load balancer device) </para> - </listitem> - <listitem> - <para>deleteNetscalerLoadBalancer (Deletes a netscaler load balancer device) </para> - </listitem> - <listitem> - <para>configureNetscalerLoadBalancer (Configures a netscaler load balancer device) </para> - </listitem> - <listitem> - <para>listNetscalerLoadBalancers (Lists netscaler load balancer devices) </para> - </listitem> - <listitem> - <para>listNetscalerLoadBalancerNetworks (Lists network that are using a netscaler load - balancer device) </para> - </listitem> - </itemizedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/removing-hosts.xml ---------------------------------------------------------------------- diff --git a/en-US/removing-hosts.xml b/en-US/removing-hosts.xml deleted file mode 100644 index 468f36e..0000000 --- a/en-US/removing-hosts.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="removing-hosts"> - <title>Removing Hosts</title> - <para>Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type.</para> - <xi:include href="removing-xenserver-kvm-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="removing-vsphere-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/removing-vsphere-hosts.xml ---------------------------------------------------------------------- diff --git a/en-US/removing-vsphere-hosts.xml b/en-US/removing-vsphere-hosts.xml deleted file mode 100644 index 3f819f0..0000000 --- a/en-US/removing-vsphere-hosts.xml +++ /dev/null @@ -1,28 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="removing-vsphere-hosts"> - <title>Removing vSphere Hosts</title> - <para>To remove this type of host, first place it in maintenance mode, as described in <xref linkend="scheduled-maintenance-maintenance-mode-hosts"/>. Then use &PRODUCT; to remove the host. &PRODUCT; will not direct commands to a host that has been removed using &PRODUCT;. However, the host may still exist in the vCenter cluster.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/removing-xenserver-kvm-hosts.xml ---------------------------------------------------------------------- diff --git a/en-US/removing-xenserver-kvm-hosts.xml b/en-US/removing-xenserver-kvm-hosts.xml deleted file mode 100644 index c704372..0000000 --- a/en-US/removing-xenserver-kvm-hosts.xml +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="removing-xenserver-kvm-hosts"> - <title>Removing XenServer and KVM Hosts</title> - <para>A node cannot be removed from a cluster until it has been placed in maintenance mode. This will ensure that all of the VMs on it have been migrated to other Hosts. To remove a Host from the cloud:</para> - <orderedlist> - <listitem><para>Place the node in maintenance mode.</para><para> See <xref linkend="scheduled-maintenance-maintenance-mode-hosts"/>.</para></listitem> - <listitem><para>For KVM, stop the cloud-agent service.</para></listitem> - <listitem><para>Use the UI option to remove the node.</para><para>Then you may power down the Host, re-use its IP address, re-install it, etc</para></listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/requirements-templates.xml ---------------------------------------------------------------------- diff --git a/en-US/requirements-templates.xml b/en-US/requirements-templates.xml deleted file mode 100644 index f434dbe..0000000 --- a/en-US/requirements-templates.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="requirements-templates"> - <title>Requirements for Templates</title> - <itemizedlist> - <listitem><para>For XenServer, install PV drivers / Xen tools on each template that you create. This will enable live migration and clean guest shutdown.</para></listitem> - <listitem><para>For vSphere, install VMware Tools on each template that you create. This will enable console view to work properly.</para></listitem> -</itemizedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/reserved-ip-addresses-non-csvms.xml ---------------------------------------------------------------------- diff --git a/en-US/reserved-ip-addresses-non-csvms.xml b/en-US/reserved-ip-addresses-non-csvms.xml deleted file mode 100644 index 0f20b63..0000000 --- a/en-US/reserved-ip-addresses-non-csvms.xml +++ /dev/null @@ -1,166 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="reserved-ip-addresses-non-csvms"> - <title>IP Reservation in Isolated Guest Networks</title> - <para>In isolated guest networks, a part of the guest IP address space can be reserved for - non-&PRODUCT; VMs or physical servers. To do so, you configure a range of Reserved IP addresses - by specifying the CIDR when a guest network is in Implemented state. If your customers wish to - have non-&PRODUCT; controlled VMs or physical servers on the same network, they can share a part - of the IP address space that is primarily provided to the guest network.</para> - <para>In an Advanced zone, an IP address range or a CIDR is assigned to a network when the network - is defined. The &PRODUCT; virtual router acts as the DHCP server and uses CIDR for assigning IP - addresses to the guest VMs. If you decide to reserve CIDR for non-&PRODUCT; purposes, you can - specify a part of the IP address range or the CIDR that should only be allocated by the DHCP - service of the virtual router to the guest VMs created in &PRODUCT;. The remaining IPs in that - network are called Reserved IP Range. When IP reservation is configured, the administrator can - add additional VMs or physical servers that are not part of &PRODUCT; to the same network and - assign them the Reserved IP addresses. &PRODUCT; guest VMs cannot acquire IPs from the Reserved - IP Range.</para> - <section id="ip-reserve-consider"> - <title>IP Reservation Considerations</title> - <para>Consider the following before you reserve an IP range for non-&PRODUCT; machines:</para> - <itemizedlist> - <listitem> - <para>IP Reservation is supported only in Isolated networks.</para> - </listitem> - <listitem> - <para>IP Reservation can be applied only when the network is in Implemented state.</para> - </listitem> - <listitem> - <para>No IP Reservation is done by default.</para> - </listitem> - <listitem> - <para>Guest VM CIDR you specify must be a subset of the network CIDR.</para> - </listitem> - <listitem> - <para>Specify a valid Guest VM CIDR. IP Reservation is applied only if no active IPs exist - outside the Guest VM CIDR. </para> - <para>You cannot apply IP Reservation if any VM is alloted with an IP address that is - outside the Guest VM CIDR.</para> - </listitem> - <listitem> - <para>To reset an existing IP Reservation, apply IP reservation by specifying the value of - network CIDR in the CIDR field.</para> - <para>For example, the following table describes three scenarios of guest network - creation:</para> - <informaltable> - <tgroup cols="5" align="left" colsep="1" rowsep="1"> - <colspec colnum="1" colname="c1" colwidth="33.0pt"/> - <colspec colnum="2" colname="c2" colwidth="84.75pt"/> - <colspec colnum="3" colname="c3" colwidth="97.5pt"/> - <colspec colnum="4" colname="c4" colwidth="129.0pt"/> - <colspec colnum="5" colname="c5" colwidth="336.0pt"/> - <thead> - <row> - <entry><para>Case</para></entry> - <entry><para> CIDR</para></entry> - <entry><para>Network CIDR</para></entry> - <entry><para>Reserved IP Range for Non-&PRODUCT; VMs</para></entry> - <entry><para>Description</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>1</para></entry> - <entry><para>10.1.1.0/24</para></entry> - <entry><para> None</para></entry> - <entry><para>None</para></entry> - <entry><para>No IP Reservation.</para></entry> - </row> - <row> - <entry><para>2</para></entry> - <entry><para>10.1.1.0/26</para></entry> - <entry><para>10.1.1.0/24</para></entry> - <entry><para>10.1.1.64 to 10.1.1.254</para></entry> - <entry><para>IP Reservation configured by the UpdateNetwork API with - guestvmcidr=10.1.1.0/26 or enter 10.1.1.0/26 in the CIDR field in the - UI.</para></entry> - </row> - <row> - <entry><para>3</para></entry> - <entry><para>10.1.1.0/24</para></entry> - <entry><para>None</para></entry> - <entry><para>None</para></entry> - <entry><para>Removing IP Reservation by the UpdateNetwork API with - guestvmcidr=10.1.1.0/24 or enter 10.1.1.0/24 in the CIDR field in the UI. - </para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - </itemizedlist> - </section> - <section id="ip-reserv-limition"> - <title>Limitations</title> - <itemizedlist> - <listitem> - <para>The IP Reservation is not supported if active IPs that are found outside the Guest VM - CIDR. </para> - </listitem> - <listitem> - <para>Upgrading network offering which causes a change in CIDR (such as upgrading an - offering with no external devices to one with external devices) IP Reservation becomes - void if any. Reconfigure IP Reservation in the new re-implemeted network.</para> - </listitem> - </itemizedlist> - </section> - <section id="best-practice-ipreserv"> - <title>Best Practices</title> - <para>Apply IP Reservation to the guest network as soon as the network state changes to - Implemented. If you apply reservation soon after the first guest VM is deployed, lesser - conflicts occurs while applying reservation. </para> - </section> - <section id="reserve-ip"> - <title>Reserving an IP Range</title> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>Click the name of the network you want to modify.</para> - </listitem> - <listitem> - <para>In the Details tab, click Edit.<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/edit-icon.png"/> - </imageobject> - <textobject> - <phrase>edit-icon.png: button to edit a network</phrase> - </textobject> - </inlinemediaobject></para> - <para>The CIDR field changes to editable one.</para> - </listitem> - <listitem> - <para>In CIDR, specify the Guest VM CIDR.</para> - </listitem> - <listitem> - <para>Click Apply.</para> - <para>Wait for the update to complete. The Network CIDR and the Reserved IP Range are - displayed on the Details page.</para> - </listitem> - </orderedlist> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/reset-ssh-key-dev.xml ---------------------------------------------------------------------- diff --git a/en-US/reset-ssh-key-dev.xml b/en-US/reset-ssh-key-dev.xml deleted file mode 100644 index 1a904e5..0000000 --- a/en-US/reset-ssh-key-dev.xml +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="reset-ssh-key-dev"> - <title>Resetting SSH Keys to Access VMs</title> - <para>Use the resetSSHKeyForVirtualMachine API to set or reset the SSH keypair assigned to a - virtual machine. With the addition of this feature, a lost or compromised SSH keypair can be - changed, and the user can access the VM by using the new keypair. Just create or register a new - keypair, then call resetSSHKeyForVirtualMachine.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/reset-volume-on-reboot.xml ---------------------------------------------------------------------- diff --git a/en-US/reset-volume-on-reboot.xml b/en-US/reset-volume-on-reboot.xml deleted file mode 100644 index da423ab..0000000 --- a/en-US/reset-volume-on-reboot.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="reset-vm-reboot"> - <!-- CLOUDSTACK-745 --> - <title>Reset VM to New Root Disk on Reboot</title> - <para>You can specify that you want to discard the root disk and create a new one whenever a given - VM is rebooted. This is useful for secure environments that need a fresh start on every boot and - for desktops that should not retain state. The IP address of the VM will not change due to this - operation.</para> - <para><emphasis role="bold">To enable root disk reset on VM reboot:</emphasis></para> - <para>When creating a new service offering, set the parameter isVolatile to True. VMs created from - this service offering will have their disks reset upon reboot. See <xref linkend="creating-compute-offerings"/>.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/resizing-volumes.xml ---------------------------------------------------------------------- diff --git a/en-US/resizing-volumes.xml b/en-US/resizing-volumes.xml deleted file mode 100644 index 42b584b..0000000 --- a/en-US/resizing-volumes.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="resizing-volumes"> - <title>Resizing Volumes</title> - <para>&PRODUCT; provides the ability to resize data disks; &PRODUCT; controls volume size by using - disk offerings. This provides &PRODUCT; administrators with the flexibility to choose how much - space they want to make available to the end users. Volumes within the disk offerings with the - same storage tag can be resized. For example, if you only want to offer 10, 50, and 100 GB - offerings, the allowed resize should stay within those limits. That implies if you define a 10 - GB, a 50 GB and a 100 GB disk offerings, a user can upgrade from 10 GB to 50 GB, or 50 GB to 100 - GB. If you create a custom-sized disk offering, then you have the option to resize the volume by - specifying a new, larger size. </para> - <para>Additionally, using the resizeVolume API, a data volume can be moved from a static disk - offering to a custom disk offering with the size specified. This functionality allows those who - might be billing by certain volume sizes or disk offerings to stick to that model, while - providing the flexibility to migrate to whatever custom size necessary. </para> - <para>This feature is supported on KVM, XenServer, and VMware hosts. However, shrinking volumes is - not supported on VMware hosts.</para> - <para>Before you try to resize a volume, consider the following:</para> - <itemizedlist> - <listitem> - <para>The VMs associated with the volume are stopped.</para> - </listitem> - <listitem> - <para>The data disks associated with the volume are removed.</para> - </listitem> - <listitem> - <para>When a volume is shrunk, the disk associated with it is simply truncated, and doing so - would put its content at risk of data loss. Therefore, resize any partitions or file systems - before you shrink a data disk so that all the data is moved off from that disk.</para> - </listitem> - </itemizedlist> - <para>To resize a volume:</para> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as a user or admin.</para> - </listitem> - <listitem> - <para>In the left navigation bar, click Storage.</para> - </listitem> - <listitem> - <para>In Select View, choose Volumes.</para> - </listitem> - <listitem> - <para>Select the volume name in the Volumes list, then click the Resize Volume button <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/resize-volume-icon.png"/> - </imageobject> - <textobject> - <phrase>resize-volume-icon.png: button to display the resize volume option.</phrase> - </textobject> - </inlinemediaobject></para> - </listitem> - <listitem> - <para>In the Resize Volume pop-up, choose desired characteristics for the storage.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/resize-volume.png"/> - </imageobject> - <textobject> - <phrase>resize-volume.png: option to resize a volume.</phrase> - </textobject> - </mediaobject> - <orderedlist numeration="loweralpha"> - <listitem> - <para>If you select Custom Disk, specify a custom size.</para> - </listitem> - <listitem> - <para>Click Shrink OK to confirm that you are reducing the size of a volume. </para> - <para>This parameter protects against inadvertent shrinking of a disk, which might lead to - the risk of data loss. You must sign off that you know what you are doing.</para> - </listitem> - </orderedlist> - </listitem> - <listitem> - <para>Click OK.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/response-formats.xml ---------------------------------------------------------------------- diff --git a/en-US/response-formats.xml b/en-US/response-formats.xml deleted file mode 100644 index b21f4ab..0000000 --- a/en-US/response-formats.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="response-formats"> - <title>Response Formats: XML and JSON</title> - <para>CloudStack supports two formats as the response to an API call. The default response is XML. If you would like the response to be in JSON, add &response=json to the Command String.</para> - <para>The two response formats differ in how they handle blank fields. In JSON, if there is no value for a response field, it will not appear in the response. If all the fields were empty, there might be no response at all. - In XML, even if there is no value to be returned, an empty field will be returned as a placeholder XML element.</para> - <para>Sample XML Response:</para> - <programlisting> - <listipaddressesresponse> - <allocatedipaddress> - <ipaddress>192.168.10.141</ipaddress> - <allocated>2009-09-18T13:16:10-0700</allocated> - <zoneid>4</zoneid> - <zonename>WC</zonename> - <issourcenat>true</issourcenat> - </allocatedipaddress> - </listipaddressesresponse> - </programlisting> - <para>Sample JSON Response:</para> - <programlisting> - { "listipaddressesresponse" : - { "allocatedipaddress" : - [ - { - "ipaddress" : "192.168.10.141", - "allocated" : "2009-09-18T13:16:10-0700", - "zoneid" : "4", - "zonename" : "WC", - "issourcenat" : "true" - } - ] - } - } - </programlisting> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/responses.xml ---------------------------------------------------------------------- diff --git a/en-US/responses.xml b/en-US/responses.xml deleted file mode 100644 index 9f70c87..0000000 --- a/en-US/responses.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="responses"> - <title>Responses</title> - <xi:include href="response-formats.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="max-result-page-returned.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="error-handling.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/roles.xml ---------------------------------------------------------------------- diff --git a/en-US/roles.xml b/en-US/roles.xml deleted file mode 100644 index 775e30b..0000000 --- a/en-US/roles.xml +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="roles"> - <title>Roles</title> - <para> - The &PRODUCT; API supports three access roles:</para> - <orderedlist> - <listitem><para>Root Admin. Access to all features of the cloud, including both virtual and physical resource management.</para></listitem> - <listitem><para>Domain Admin. Access to only the virtual resources of the clouds that belong to the administratorâs domain.</para></listitem> - <listitem><para>User. Access to only the features that allow management of the userâs virtual instances, storage, and network.</para></listitem> - </orderedlist> -</section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/root-admin-ui-overview.xml ---------------------------------------------------------------------- diff --git a/en-US/root-admin-ui-overview.xml b/en-US/root-admin-ui-overview.xml deleted file mode 100644 index f59aaea..0000000 --- a/en-US/root-admin-ui-overview.xml +++ /dev/null @@ -1,28 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="root-admin-ui-overview"> - <title>Root Administrator's UI Overview</title> - <para>The &PRODUCT; UI helps the &PRODUCT; administrator provision, view, and manage the cloud infrastructure, domains, user accounts, projects, and configuration settings. The first time you start the UI after a fresh Management Server installation, you can choose to follow a guided tour to provision your cloud infrastructure. On subsequent logins, the dashboard of the logged-in user appears. The various links in this screen and the navigation bar on the left provide access to a variety of administrative functions. The root administrator can also use the UI to perform all the same tasks that are present in the end-userâs UI.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/runtime-allocation-virtual-network-resources.xml ---------------------------------------------------------------------- diff --git a/en-US/runtime-allocation-virtual-network-resources.xml b/en-US/runtime-allocation-virtual-network-resources.xml deleted file mode 100644 index 479f069..0000000 --- a/en-US/runtime-allocation-virtual-network-resources.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="runtime-allocation-virtual-network-resources"> - <title>Runtime Allocation of Virtual Network Resources</title> - <para>When you define a new virtual network, all your settings for that network are stored in - &PRODUCT;. The actual network resources are activated only when the first virtual - machine starts in the network. When all virtual machines have left the virtual network, the - network resources are garbage collected so they can be allocated again. This helps to - conserve network resources.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/runtime-behavior-of-primary-storage.xml ---------------------------------------------------------------------- diff --git a/en-US/runtime-behavior-of-primary-storage.xml b/en-US/runtime-behavior-of-primary-storage.xml deleted file mode 100644 index 5e17a4f..0000000 --- a/en-US/runtime-behavior-of-primary-storage.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="runtime-behavior-of-primary-storage"> - <title>Runtime Behavior of Primary Storage</title> - <para>Root volumes are created automatically when a virtual machine is created. Root volumes are deleted when the VM is destroyed. Data volumes can be created and dynamically attached to VMs. <!-- (although, when the Oracle VM hypervisor is used, the VM must be stopped before an additional volume can be attached)--> Data volumes are not deleted when VMs are destroyed.</para> - <para>Administrators should monitor the capacity of primary storage devices and add additional primary storage as needed. See the Advanced Installation Guide.</para> - <para>Administrators add primary storage to the system by creating a &PRODUCT; storage pool. Each storage pool is associated with a cluster or a zone.</para> - <para>With regards to data disks, when a user executes a Disk Offering to create a data disk, the information is initially written to the CloudStack database only. Upon the first request that the data disk be attached to a VM, CloudStack determines what storage to place the volume on and space is taken from that storage (either from preallocated storage or from a storage system (ex. a SAN), depending on how the primary storage was added to CloudStack).</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/runtime-internal-comm-req.xml ---------------------------------------------------------------------- diff --git a/en-US/runtime-internal-comm-req.xml b/en-US/runtime-internal-comm-req.xml deleted file mode 100644 index f4539dd..0000000 --- a/en-US/runtime-internal-comm-req.xml +++ /dev/null @@ -1,39 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="runtime-internal-comm-req"> - <title>Runtime Internal Communications Requirements</title> - <itemizedlist> - <listitem> - <para>The Management Servers communicate with each other to coordinate tasks. This - communication uses TCP on ports 8250 and 9090.</para> - </listitem> - <listitem> - <para>The console proxy VMs connect to all hosts in the zone over the management traffic - network. Therefore the management traffic network of any given pod in the zone must have - connectivity to the management traffic network of all other pods in the zone.</para> - </listitem> - <listitem> - <para>The secondary storage VMs and console proxy VMs connect to the Management Server on - port 8250. If you are using multiple Management Servers, the load balanced IP address of the - Management Servers on port 8250 must be reachable.</para> - </listitem> - </itemizedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/scheduled-maintenance-maintenance-mode-hosts.xml ---------------------------------------------------------------------- diff --git a/en-US/scheduled-maintenance-maintenance-mode-hosts.xml b/en-US/scheduled-maintenance-maintenance-mode-hosts.xml deleted file mode 100644 index 6b736e4..0000000 --- a/en-US/scheduled-maintenance-maintenance-mode-hosts.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="scheduled-maintenance-maintenance-mode-hosts"> - <title>Scheduled Maintenance and Maintenance Mode for Hosts</title> - <para>You can place a host into maintenance mode. When maintenance mode is activated, the host becomes unavailable to receive new guest VMs, and the guest VMs already running on the host are seamlessly migrated to another host not in maintenance mode. This migration uses live migration technology and does not interrupt the execution of the guest.</para> - <xi:include href="vcenter-maintenance-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="xenserver-maintenance-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/search-base.xml ---------------------------------------------------------------------- diff --git a/en-US/search-base.xml b/en-US/search-base.xml deleted file mode 100644 index b8fc092..0000000 --- a/en-US/search-base.xml +++ /dev/null @@ -1,51 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="search-base"> - <title>Search Base</title> -<para>An LDAP query is relative to a given node of the LDAP directory tree, called the search base. The search base is the distinguished name (DN) of a level of the directory tree below which all users can be found. The users can be in the immediate base directory or in some subdirectory. The search base may be equivalent to the organization, group, or domain name. The syntax for writing a DN varies depending on which LDAP server you are using. A full discussion of distinguished names is outside the scope of our documentation. The following table shows some examples of search bases to find users in the testing department..</para> - - <informaltable> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <thead> - <row> - <entry><para>LDAP Server</para></entry> - <entry><para>Example Search Base DN</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>ApacheDS</para></entry> - <entry><para>ou=testing,o=project</para></entry> - </row> - <row> - <entry><para>Active Directory</para></entry> - <entry><para>OU=testing, DC=company</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/search-user-bind-dn.xml ---------------------------------------------------------------------- diff --git a/en-US/search-user-bind-dn.xml b/en-US/search-user-bind-dn.xml deleted file mode 100644 index a2d8b6a..0000000 --- a/en-US/search-user-bind-dn.xml +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="search-user-bind-dn"> - <title>Search User Bind DN</title> - <para>The bind DN is the user on the external LDAP server permitted to search the LDAP directory within the defined search base. When the DN is returned, the DN and passed password are used to authenticate the &PRODUCT; user with an LDAP bind. A full discussion of bind DNs is outside the scope of our documentation. The following table shows some examples of bind DNs.</para> - <informaltable> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <thead> - <row> - <entry><para>LDAP Server</para></entry> - <entry><para>Example Bind DN</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>ApacheDS</para></entry> - <entry><para>cn=Administrator,dc=testing,ou=project,ou=org</para></entry> - </row> - <row> - <entry><para>Active Directory</para></entry> - <entry><para>CN=Administrator, OU=testing, DC=company, DC=com</para></entry></row> - </tbody> - </tgroup> - </informaltable> -</section>
