From c5a115de9921af1fd47ffde8cea917dd4957c4d6 Mon Sep 17 00:00:00 2001 From: Jessica Date: Wed, 28 Aug 2013 01:19:53 -0700 Subject: [PATCH] CLOUDSTACK-815. DOC. Update Regions documentation to replace API steps with UI steps. --- docs/en-US/region-add.xml | 64 +++++++++++++++++++++++++++------------ 1 file changed, 44 insertions(+), 20 deletions(-) diff --git a/docs/en-US/region-add.xml b/docs/en-US/region-add.xml index 802e462ce16..b4dd1814af8 100644 --- a/docs/en-US/region-add.xml +++ b/docs/en-US/region-add.xml @@ -43,17 +43,29 @@ 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 -r <region_id> 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. - cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id> + 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. + cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id> 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. - Add region 2 to region 1. Use the API command addRegion. (For information about how to make an API call, see the Developer's Guide.) - http://<IP_of_region_1_Management_Server>:8080/client/api?command=addRegion&id=2&name=Western&endpoint=http://<region_2_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D - - Now perform the same command in reverse, adding region 1 to region 2. - http://<IP_of_region_2_Management_Server>:8080/client/api?command=addRegion&id=1&name=Northern&endpoint=http://<region_1_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D + Now add the new region to region 1 in &PRODUCT;. + + Log in to &PRODUCT; in the first region as root administrator + (that is, log in to <region.1.IP.address>:8080/client). + In the left navigation bar, click Regions. + Click Add Region. In the dialog, fill in the following fields: + + 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. + Name. Give the new region a descriptive name. + 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. + + + + Now perform the same procedure in reverse. Log in to region 2, and add region 1. Copy the account, user, and domain tables from the region 1 database to the region 2 database. 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 @@ -84,16 +96,23 @@ Install &PRODUCT; in each additional region. Set the region ID for each region during the database setup step. cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id> Once the Management Server is running, add your new region to all existing regions by - repeatedly calling the API command addRegion. For example, if you were adding + repeatedly using the Add Region button in the UI. For example, if you were adding region 3: - http://<IP_of_region_1_Management_Server>:8080/client/api?command=addRegion&id=3&name=Eastern&endpoint=http://<region_3_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D - -http://<IP_of_region_2_Management_Server>:8080/client/api?command=addRegion&id=3&name=Eastern&endpoint=http://<region_3_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D + + 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. + 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. + + 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: - http://<IP_of_region_3_Management_Server>:8080/client/api?command=addRegion&id=1&name=Northern&endpoint=http://<region_1_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D - -http://<IP_of_region_3_Management_Server>:8080/client/api?command=addRegion&id=2&name=Western&endpoint=http://<region_2_IP_address_here>:8080/client&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D + + Log in to &PRODUCT; in the third region as root administrator + (that is, log in to <region.3.IP.address>:8080/client). + Add a region with ID 1, the name of region 1, and the endpoint <region.1.IP.address>:8080/client. + Add a region with ID 2, the name of region 2, and the endpoint <region.2.IP.address>:8080/client. + + Copy the account, user, and domain tables from any existing region's database to the new region's database. In the following commands, it is assumed that you have set the root password on the @@ -109,7 +128,7 @@ http://<IP_of_region_3_Management_Server>:8080/client/api?command=addRegio - Remove project accounts. Run these commands on the region 2 database: + Remove project accounts. Run these commands on the region 3 database: mysql> delete from account where type = 5; Set the default zone as null: @@ -120,9 +139,14 @@ http://<IP_of_region_3_Management_Server>:8080/client/api?command=addRegio
Deleting a Region - To delete a region, use the API command removeRegion. Repeat the call to remove the region from all other regions. For example, to remove the 3rd region in a three-region cloud: - http://<IP_of_region_1_Management_Server>:8080/client/api?command=removeRegion&id=3&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D - -http://<IP_of_region_2_Management_Server>:8080/client/api?command=removeRegion&id=3&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D + 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: + + Log in to <region.1.IP.address>:8080/client. + In the left navigation bar, click Regions. + Click the name of the region you want to delete. + Click the Remove Region button. + Repeat these steps for <region.2.IP.address>:8080/client. +