From 36c7b73ba78f0939ed4baa049d33fa78ce3faa22 Mon Sep 17 00:00:00 2001 From: Shireesh Anjal Date: Wed, 31 Aug 2011 15:13:22 +0530 Subject: Latest help files --- .../html/gettingstarted/access_gmc_jws.html | 9 +++++-- .../html/gettingstarted/check_req_client.html | 2 +- .../html/gettingstarted/check_req_gmg.html | 8 +++--- .../html/gettingstarted/cifs_service.html | 11 ++++---- .../html/gettingstarted/explore_gmc.html | 2 +- .../html/gettingstarted/install_gmg.html | 21 +++++++++++----- .../html/gettingstarted/install_gmg_backend.html | 10 +++++--- .../html/gettingstarted/manage_cluster.html | 10 ++++---- .../html/gettingstarted/manage_volumes.html | 2 +- .../html/gettingstarted/setting_alerts_prefs.html | 6 ++--- .../html/gettingstarted/setting_charts_prefs.html | 7 +++--- .../html/gettingstarted/setting_gluster_prefs.html | 9 +++---- .../html/gettingstarted/setting_preferences.html | 2 +- .../gettingstarted/setting_terminal_prefs.html | 6 ++--- .../html/help_home.html | 2 +- .../html/images/GMC_1.0_Add_Server_Confirm.jpg | Bin 18359 -> 18572 bytes .../html/images/GMC_1.0_Discovered_Server_Add.jpg | Bin 94969 -> 92039 bytes .../html/images/GMC_Cluster_Summary_tab_new.jpg | Bin 0 -> 172135 bytes .../html/images/GMC_Create_Cluster.jpg | Bin 19934 -> 19986 bytes .../html/images/GMC_Preferences_gluster.jpg | Bin 52380 -> 51110 bytes .../html/images/GMC_Register_Cluster.jpg | Bin 20935 -> 21831 bytes .../html/images/GMC_Select_Cluster.jpg | Bin 22347 -> 23467 bytes .../html/images/GMC_Volume_Summary.jpg | Bin 92526 -> 113645 bytes .../html/tasks/delete_volume.html | 28 ++++++++++----------- .../html/tasks/register_cluster.html | 2 +- .../html/tasks/remove_brick.html | 5 +--- .../html/tasks/select_cluster.html | 2 +- .../html/tasks/tune_vol_opt.html | 5 ++-- 28 files changed, 79 insertions(+), 70 deletions(-) create mode 100644 src/com.gluster.storage.management.console.help/html/images/GMC_Cluster_Summary_tab_new.jpg (limited to 'src/com.gluster.storage.management.console.help/html') diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/access_gmc_jws.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/access_gmc_jws.html index 577882a9..e052a73a 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/access_gmc_jws.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/access_gmc_jws.html @@ -31,8 +31,13 @@ type="text/css" media="screen" />

Click Change. The system displays Change Password window indicating that the password was successfully changed.

Password Changed Successfully

Click OK. The Gluster Management Console window is displayed. -

Note: You can change the password at any time by accessing Edit > Change Password. + +

Click OK. The Select Cluster window is + displayed. You can now create a new cluster or register an existing + cluster. For more information on creating or registering clusters, + refer to Managing Clusters. +

Note: You can change the password at any time by + accessing Edit > Change Password. \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_client.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_client.html index ec93d66a..76a44038 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_client.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_client.html @@ -21,7 +21,7 @@

Web Browser Requirements

Use your JRE installer to configure your browser for Java Web Start. Also, ensure that you have configured your browser to open .jnlp files using the Java Web Start application or javaws exe located in bin folder of your JRE installation. -
When you access the Gluster Management Console, Java Web Start downloads all required .jar files from the Gateway server and launches the console’s GUI. During this process, web start may display a certificate warning mentioning that the application is signed by Gluster, Inc.. This certificate is authentic, but it requires full permissions as the application contains features that require registering information on the client's hard disk such as exporting the security keys from gateway. You can accept the warning and select Always Trust Content from this Provider on your browser to avoid this warning every time you launch the application +
When you access the Gluster Management Console, Java Web Start downloads all required .jar files from the Gateway server and launches the console's GUI. During this process, web start may display a certificate warning mentioning that the application is signed by Gluster, Inc.. This certificate is authentic, but it requires full permissions as the application contains features that require registering information on the client's hard disk such as exporting the security keys from gateway. You can accept the warning and select Always Trust Content from this Provider on your browser to avoid this warning every time you launch the application

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_gmg.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_gmg.html index 866b50ab..fa106b64 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_gmg.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/check_req_gmg.html @@ -11,11 +11,13 @@ type="text/css" media="screen" />

Checking Gluster Management Gateway Minimum Requirements

Gluster Management Gateway is installed on a central server using the Linux package published by Gluster. Before you install Gluster Management Gateway, you must verify that your environment matches the minimum requirements described in this section. -

Note: For checking the GlusterFS minimum requirements, refer to the Gluster 3.2 Filesystem Installation Guide, Checking Minimum Requirements.

You must verify that your central server matches the minimum requirements listed below:

Memory: 2 GM RAM -
Processor: 2 (2.4 GHz each) recommended; 64 bit
Disk Space: 10 GB +
Memory: 2 GB RAM +
Processor: 2 (2.4 GHz each) recommended; 64 bit +
Disk Space: 10 GB +
The gateway machine can be either Gluster Storage Software Appliance, Gluster Virtual Storage Appliance, or CentOS 5.6.

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/cifs_service.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/cifs_service.html index eccaa0f9..21ba31ec 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/cifs_service.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/cifs_service.html @@ -22,22 +22,21 @@ type="text/css" media="screen" />

To configure CIFS, you must create a text file consisting of a list of servers (hostnames or IP addresses).

Note: You can configure CIFS on a fresh install or on an existing installation on the server which you have installed Gluster Management Gateway after adding the server to the cluster.

Run the following command on the gateway server to configure CIFS:

$ grun.py <server list file>.txt setup_cifs_config.py

$ setup_cifs_config_all.py <server list file>

Note: Ensure that CIFS services are configured on all the servers of your cluster at all times. Any new servers added to the cluster, ensure that you configure CIFS services on them. This enables you to access the CIFS enabled volumes from any of the cluster nodes.

Creating CIFS Users

You must create users and their password to enable them to use the CIFS access protocol.

To create CIFS users, run the following on the gateway server:

$ add_user_cifs_all.py <server list file> <user list file> <password>

$ add_user_cifs_all.py <server list file> <user name> <password>

Server list file – contains one server name per line -
User list file – contains one user name per line

All users defined in the <user list file> will be created on each and every server defined in <server list file>, will be assigned the same password defined in <password>. -

Note: Ensure that CIFS users are created on all the servers of your cluster at all times. Any new servers added to the cluster, ensure that you create all the CIFS users on them. +

The user defined in the <user name> will be created on each and every server defined in <server list file>, will be assigned the same password defined in <password>. +

Note: Ensure that the CIFS user is created on all the servers of your cluster at all times which includes any new servers added to the cluster.

Removing CIFS Users

You can delete users and their password.

To delete CIFS users, run the following on the gateway server:

$ delete_user_cifs_all.py <server list> <user list>

$ delete_user_cifs_all.py <server list> <user name>

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/explore_gmc.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/explore_gmc.html index 48c1f892..8aee7171 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/explore_gmc.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/explore_gmc.html @@ -25,6 +25,6 @@ explains the type of functions you can perform using each section.

change password, change settings and refresh the application.

Gluster Menu: Helps you to manage your cluster, servers, and volumes. - +For example, if you have selected volumes, the Gluster menu displays all volume related options. \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg.html index e1e7a798..94d26c03 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg.html @@ -17,7 +17,7 @@ type="text/css" media="screen" />

Note: glustermg.repo has been created and tested with CentOS 5.6. It may work with other versions of CentOS, however it has not been extensively tested.

Save the file in the following location on your machine:

/etc/yum.repos.d/ -

5. Run the following command to install Gluster Management Gateway: +

Run the following command to install Gluster Management Gateway:

# yum groupinstall glustermg

The following packages are installed if not installed earlier:

Gateway generates SSH keys during installation. These keys are stored in the following location /opt/glustermg/keys. These keys are used for communication with the storage servers. However, in Amazon Web Services (AWS) environment, SSH communication is done using the private key provided by Amazon. Hence, the AWS genegrated private key (.pem file) must be stored in /opt/glustermg/keys and the file must be named as gluster.pem

Note: -

You can install the Gluster Management Gateway packages on a Gluster Storage Server. However, this can impact performance of the GlusterFS processes on this machine hence this is not recommended. -
The Gluster Management Gateway is shipped with a self-signed SSL certificate, by default. While this ensures that the communication between the console and gateway is encrypted and safe, some browsers may throw security warnings mentioning that the site is not secure. It is highly recommended that you install your own SSL certificate issued by a valid certifying authority in the tomcat5 configuration for the 8443 port. -
Enable port 8443 on the Gateway as the Management Console connects to it over SSL on this port. -
Gluster Management Gateway communicates with all storage servers through SSH, using their host names. Make sure all of your storage server's host names (fully qualified domain names) are resolvable by the Gateway and by each other. If you have a properly configured DNS setup, this should work seamlessly. -

The Gluster Management Gateway is shipped with a self-signed + SSL certificate, by default. While this ensures that the communication + between the console and gateway is encrypted and safe, some browsers + may throw security warnings mentioning that the site is not secure. It + is highly recommended that you install your own SSL certificate issued + by a valid certifying authority in the tomcat5 configuration for the + 8443 port. For more information on obtaining your own service + certificate, refer to Installing a Certificate from a + Certificate Authority from Tomcat documentation. +
Ensure to enable port 8443 (HTTPS), port 24731 (TCP), and port 24729 (UDP) on the gateway. +
Gluster Management Gateway communicates with all storage servers through SSH, using their host names. Make sure all of your storage server's host names (fully qualified domain names) are resolvable by the Gateway and by each other. If you have a properly configured DNS setup, this should work seamlessly. +

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg_backend.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg_backend.html index db8c48b3..af04461f 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg_backend.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/install_gmg_backend.html @@ -13,12 +13,12 @@ type="text/css" media="screen" /> Gluster Management Gateway communicates with every node of your cluster using the backend package. This package must be installed on each and every node of your cluster using the Linux package published by Gluster.

Pre-requisite

Ensure that you have installed GlusterFS v3.2.3 or higher on all the nodes of your cluster. +
Your backend machines can be either Gluster Storage Software Appliance, Gluster Virtual Storage Appliance, or CentOS 5.6 running GlusterFS v3.2.3 or higher.

To install the backend packages on each and every node of your cluster, perform the following steps:

Download Gluster Management Gateway repository configuration file (glustermg.repo) and the Gluster Management Gateway RPM (glustermg-1.0.0-1.x86_64.rpm) from the location provided by Gluster. : +
Download Gluster Management Gateway repository configuration file (glustermg.repo) and the Gluster Management Gateway Backend RPM (glustermg-backend-1.0.0-1.x86_64.rpm) from the location provided by Gluster. :
Note: glustermg.repo has been created and tested with CentOS 5.6. It may work with other versions of CentOS, however it has not been extensively tested.
Save the file in the following location on your machine:
/etc/yum.repos.d/ @@ -37,6 +37,10 @@ Gluster Management Gateway communicates with every node of your cluster using th
libxml2 v2.6

Note: In case CIFS only, the Samba services must be configured to run on port 445 which needs to be enabled and open on all the storage servers in your cluster.

Note: +

You must enable port 24729 (UDP) for auto discovery of servers. +
In case CIFS only, the Samba services must be configured to run on port 445 which needs to be enabled and open on all the storage servers in your cluster. +

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_cluster.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_cluster.html index 50d3cb4d..17b7f0a8 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_cluster.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_cluster.html @@ -15,16 +15,16 @@ in many respects forming a single computer. Gluster Management Console enables you to create, register and select cluster.

Cluster Summary

The console enables you to monitor your cluster resources from -the Summary tab. To display the summary of your cluster, click the +the Summary tab. To display the summary of your cluster, click the cluster node from the left pane of the console window. The summary of the selected cluster is displayed in the right pane of the console window. -

Cluster Summary +

Cluster Summary

After you log into the application successfully, you will be prompted to:

Select cluster: The cluster you will manage in the login session. -
Create cluster: Creating an empty cluster that can be expanded using the console. -
Register cluster: Registering an existing cluster and start managing it through the console. +
Selecting a Cluster: The cluster you will manage in the login session. +
Creating a Cluster: Creating an empty cluster that can be expanded using the console. +
Registering a Cluster: Registering an existing cluster and start managing it through the console.

\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_volumes.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_volumes.html index 2b372d0f..a37ed7b4 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_volumes.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_volumes.html @@ -28,7 +28,7 @@ manage the volumes stored on file server machines.

The console also enables you to monitor the volumes in your cluster from the Summary tab. To display the summary of your volumes, click the Volume node from the left pane of the console window. The summary of the volumes is displayed in the right pane of the console window. It also displays Tasks and Alerts of all the volumes. -

Volume Summary +

Volume Summary \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_alerts_prefs.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_alerts_prefs.html index e5f708a9..5673586e 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_alerts_prefs.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_alerts_prefs.html @@ -13,9 +13,9 @@ type="text/css" media="screen" /> Thresholds are the critical conditions that you define in Gluster Management Console.

To set the thresholds, perform the following steps:

Choose Edit > Settings -
Preferences window is displayed.
-
Choose Gluster > Alerts page from the right pane of the Preferences window. +
Choose Edit > Settings > Alerts +
The Preferences window displays the Alerts page on the right pane of the window.
+
Type the value for server CPU threshold limits in the Server CPU Threshold field.
Type the value for server memory usage threshold in the Server Memory Usage Threshold field. diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html index bc1199b0..e85d9324 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_charts_prefs.html @@ -11,12 +11,11 @@ type="text/css" media="screen" />
Setting the Charts Preferences
You can customize the console and change the way some of the monitoring data is displayed, as described in this section. -
Note: The default duration for all the charts is a week.
+
Note: The default duration for all the charts is a day.

To set the display of the charts, perform the following:
1. Choose Edit > Settings -
  The Preferences window is displayed.
  -
2. Choose Gluster > Charts page from the right pane of the Preferences window. +
3. Choose Edit > Settings > Charts +
  The Preferences window displays the Charts page on the right pane of the window.
4. Select the Aggregated CPU Usage chart period from the drop down list.
5. Select the Aggregated Network Usage chart period from the drop down list. diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_gluster_prefs.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_gluster_prefs.html index 74cb4ba4..16db7708 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_gluster_prefs.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_gluster_prefs.html @@ -13,15 +13,12 @@ type="text/css" media="screen" /> Please enter your text here.
  To set the Gluster perferences, perform the following steps:
  1. Choose Edit > Settings -
    The Preferences window is displayed. -
  2. Choose Gluster page from the right pane of the Preferences window. - - +
  3. Choose Edit > Settings > Gluster +
    The Preferences window displays the Gluster page on the right pane of the window.
  4. Select Show Cluster Selection Dialog on Login, if you want your cluster name to appear when you launch the application.
  5. Choose your cluster name from Default Cluster to Manage drop down list to manage the default cluster you wish to manage when you launch the application.
  6. Type the duration of the data synchronization intervals in the Data Sync Interval field. +
  7. Type the duration (in sec) of the refresh intervals in the Refresh Interval field.
  8. Click Apply.
  9. Click OK to exit the Preferences window. diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_preferences.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_preferences.html index 254fb15d..13f9f54c 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_preferences.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_preferences.html @@ -11,7 +11,7 @@ type="text/css" media="screen" />
    Preferences
    -You can use preferences to configure several aspects of the Gluster Management Console. These include setting preferences for the console, alerts, and charts. +You can use preferences to configure several aspects of the Gluster Management Console. These include setting preferences for the console, alerts, charts, and terminal.
    - Setting Gluster Preferences
    - Setting Alert Preferences diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_terminal_prefs.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_terminal_prefs.html index e48535be..8f381665 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_terminal_prefs.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_terminal_prefs.html @@ -13,10 +13,8 @@ type="text/css" media="screen" />
      You can customize the terminal window as described in this section.
      
      To set the display of the charts, perform the following:
      1. Choose Edit > Settings -
        Preferences window is displayed.
        -
      2. Choose Terminal from the right pane of the Preferences window. -
        The Preferences window displays the Terminal page on the left pane of the window. +
      3. Choose Edit > Settings > Terminal +
        The Preferences window displays the Terminal page on the right pane of the window.
      4. Type the limit of terminal buffer lines in the Terminal buffer lines field.
      5. Type the value of the serial timeout in the Serial timeout field.
      6. Select Register. Type the name of the cluster and server name in the respective fields.
        Note: Ensure that you type an online server name in the Server Name field.
        -
      7. Click OK. The Gluster Management Console will register the cluster with the gateway, fetch all the management information such as servers and volume resources and display them in the console. +
      8. Click OK. The Gluster Management Console will register the cluster with the gateway; fetch all the management information such as servers, volume resources and display them in the console.
      \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/remove_brick.html b/src/com.gluster.storage.management.console.help/html/tasks/remove_brick.html index a05c83ec..fbbfb89e 100644 --- a/src/com.gluster.storage.management.console.help/html/tasks/remove_brick.html +++ b/src/com.gluster.storage.management.console.help/html/tasks/remove_brick.html @@ -13,10 +13,7 @@ type="text/css" media="screen" /> You can shrink volumes, as needed, while the cluster is online and available. For example, you might need to remove a brick that has become inaccessible in a distributed volume due to hardware or network failure. -
      Note: Data residing on the brick that you are removing -will no longer be accessible; only the configuration information is -removed - you can continue to access the data directly from the brick, -as necessary. +
      To remove bricks from an existing volume, perform the following steps.
      1. Click OK.The Progress Information window is displayed is displayed while the console fetches the management information for the selected cluster.
        -
      2. The Gluster Management Console window displays the selected cluster. +
      3. The Gluster Management Console window displays the selected cluster.
      \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html b/src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html index 9a48b86e..b9dc0e72 100644 --- a/src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html +++ b/src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html @@ -15,9 +15,8 @@ type="text/css" media="screen" />
    - Select the volume for which you need to tune volume options.
    - Click the Volume Options tab.
      -
    - Click Add. Choose the volume option from Option Key drop down list - and type the value in the Option Value field. -
      You can edit the value of an existing option by selecting the Option Value field
      +
    - Click Add. Choose the volume option from Option Key drop down list and type the value in the Option Value field. +
      You can edit the value of an existing option by selecting the Option Value field.
  To read more about the volume options, refer to the Gluster Filesystem Administration Guide, Section 8.1 Tuning Volume Options. -- cgit

Web Browser Requirements

Checking Gluster Management Gateway Minimum Requirements

Creating CIFS Users

Removing CIFS Users

Cluster Summary

Setting the Charts Preferences

Preferences