diff options
| author | Shireesh Anjal <shireesh@gluster.com> | 2011-08-23 20:44:44 +0530 |
|---|---|---|
| committer | Shireesh Anjal <shireesh@gluster.com> | 2011-08-23 20:44:44 +0530 |
| commit | d314b052f837db9a45a6aac8b8da003ae7d51fca (patch) | |
| tree | 0932d229623efb7204dc4ca271b68d4e5a38fa2e /src/com.gluster.storage.management.console.help/html/gettingstarted | |
| parent | 7818bc9924b823d0bd3fb9ced5db2c1afcaeae41 (diff) | |
Latest help contents
Diffstat (limited to 'src/com.gluster.storage.management.console.help/html/gettingstarted')
23 files changed, 288 insertions, 94 deletions
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 517d70e8..577882a9 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 @@ -21,7 +21,18 @@ type="text/css" media="screen" /> <li>Type the following default user name and password in the login window:
<p>Username: gluster</p>
<p>Password: syst3m</p>
+<p><b>Note:</b> In Mac OS, it is not possible to identify the CPU architecture through Java script. The system provides links to all possible combinations, click on the appropriate link to launch the application.</p>
+<li>When you access the application for the first time, the console requests you to change this password.
+<p><img src="../images/GMC_Change_Password.jpg" alt="Change Default Password" /></p>
+ <li>Type your current default password in the <b>Old Password</b> field.
+ <p>The default system-assigned password is syst3m.</p>
+ <li>Type your new password in the <b>New Password</b> field.
+ <li>Retype your new password in the <b>Confirm Password</b> field.
+ <li>Click <b>Change</b>. The system displays <b>Change Password</b> window
+ indicating that the password was successfully changed.
+ <p><img src="../images/GMC_Change_Password_Confirm.jpg" alt="Password Changed Successfully" /></p>
+ <li>Click <b>OK</b>. The Gluster Management Console window is displayed.
+ <p><b>Note:</b> You can change the password at any time by accessing <b>Edit</b> > <b>Change Password</b>.
</ol>
-<p>For more information on how you can change the password, refer to <a href="change_password.html">Changing Administrator´s Password</a>
</body>
</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/alerts.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/alerts.html index 223ffec0..69033fff 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/alerts.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/alerts.html @@ -10,7 +10,7 @@ type="text/css" media="screen" /> <body>
<h1>Alerts</h1>
-Alerts page enables you to quickly define alerts for typical alarm conditions found in your cluster environment. For example, low disk space is frequently a problem on managed machines. You can generate alerts for the critical conditions in your cluster by defining threshold conditions. An alert is generated when it reaches the threshold conditions that you set against server resources. These alerts are real-time data collected from your resources and are displayed in the <b>Cluster Summary</b> tab.
+Alerts section lists the typical alarm conditions found in your cluster environment. For example, low disk space is frequently a problem on managed machines. You can generate alerts for the critical conditions in your cluster by defining threshold conditions. An alert is generated when it reaches the threshold conditions that you set against server resources. These alerts are real-time data collected from your resources and are displayed in the <b>Cluster Summary</b> tab.
<ul>
<li>CPU utilization
<li>Memory utilization
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 358dc0d9..ec93d66a 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 @@ -2,8 +2,7 @@ <html>
<head>
-<link rel="stylesheet" href="../css/builder-gluster/style.css"
-type="text/css" media="screen" />
+<link rel="stylesheet" href="../css/builder-gluster/style.css" type="text/css" media="screen" />
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Main Topic</title>
</head>
@@ -12,15 +11,17 @@ type="text/css" media="screen" /> <h1>Checking the Minimum Requirements of Client Machines</h1>
<p>Verify the following:</p>
-<ul>
-<li>Processor - 1.4GHz CPU
-<li>Memory - 2 GB RAM
-<li>Disk - 100 MB
-<li>Operating Systems: Windows XP/Vista/7, Linux, Mac OS X
-<li>Oracle JRE 1.6+
+<ul style="margin-top: 8px;">
+<li> Processor - 1.4GHz CPU</li>
+<li> Memory - 2 GB RAM</li>
+<li> Disk - 100 MB</li>
+<li> Operating Systems: Windows XP/Vista/7, Linux, Mac OS X</li>
+<li> Oracle JRE 1.6</li>
</ul>
<h2>Web Browser Requirements</h2>
-<p>Using the JRE installer, you can 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 the bin folder of your JRE installation.</p>
-<p> 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., which 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 this warning and select <b>Always Trust Content from this Provider</b> on your browser to avoid getting this warning every time you launch the application.</p>
+<ul>
+<li>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.
+<li>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
+</ul>
</body>
</html>
\ 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 593a22c9..866b50ab 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 @@ -10,16 +10,12 @@ type="text/css" media="screen" /> <body>
<h1>Checking Gluster Management Gateway Minimum Requirements</h1>
-Gluster Management Gateway is installed on a central server using the Linux package (e.g. rpm for CentOS) published by Gluster. Before you install Gluster Management Gateway, you must verify that your environment matches the minimum requirements described in this section.
+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.
+<p><b>Note:</b> For checking the GlusterFS minimum requirements, refer to the <a href= "http://www.gluster.com/community/documentation/index.php/Gluster_3.2:_Checking_Minimum_Requirements">Gluster 3.2 Filesystem Installation Guide, Checking Minimum Requirements</a>.</p>
<p>You must verify that your central server matches the minimum requirements listed below:</p>
<ul>
<li>Memory: 2 GM RAM
-<li>Processor: 2 (2.4 GHz each) recommended
-<li>Disk Space: 10 GB
-<P>The following packages must be installed:</P>
-<li>Java SE runtime version 1.6 – openjdk => 1.6.0.0
-<li>tomcat5 => 5.5.23
-<li>wget
+<li>Processor: 2 (2.4 GHz each) recommended; 64 bit<li>Disk Space: 10 GB
</ul>
</body>
</html>
\ 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 03b7091a..eccaa0f9 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 @@ -10,21 +10,31 @@ type="text/css" media="screen" /> <body>
<h1>CIFS Services</h1>
-The Common Internet File System (CIFS), also known as Server Message
-Block (SMB), is a network protocol whose most common use is sharing
-files on a Local Area Network (LAN). It operates as an application-layer network protocol to provide shared access to files, printers, serial ports, and miscellaneous communications between nodes on a network. It also provides an authenticated inter-process communication mechanism. Most usage of SMB involves computers running Microsoft Windows operating system.
-
-<p>CIFS can be used as an access protocol by Microsoft Windows users to access files in a GlusterFS volume. Users will be able to perform regular file system operations such as creating files, read/write data to files, deletion of data through CIFS.</p>
+<p>Common Internet File System (CIFS) operates as an application - layer network protocol to provide shared access to files, printers, serial ports, and miscellaneous communications between nodes on a network. It also provides an authenticated inter-process communication mechanism. Most usage of SMB involves computers running Microsoft Windows operating system.</p>
+<p>CIFS can be used as an access protocol by Microsoft Windows users to access files in a GlusterFS volume. Users will be able to perform regular file system operations such as creating files, read or write data to files, deletion of data through CIFS.</p>
+<p>Typically, all CIFS releated operations such as configuring CIFS services, creating and removing users, enabling CIFS re-export of a volume must be perfomed on each and every node of your cluster. Gluster Management Gateway provides an easy way to manage these opeartions, such as:
+<ul>
+<li>An user interface for enabling or disabling CIFS re-export of volumes and configuring CIFS users for a volume.</li>
+<li>Command line utilities for configuring CIFS services, creating and removing CIFS users on all the servers.</li>
+</ul>
<h2>Configuring the CIFS Service</h2>
<p>To configure CIFS, you must create a text file consisting of a list of servers (hostnames or IP addresses).</p>
<p><b>Note:</b> 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.</p>
<p>Run the following command on the gateway server to configure CIFS:</p>
-<p><FONT FACE = "Courier">$ grun.py <server list>.txt setup_cifs_config.py</FONT></p>
+<p><FONT FACE = "Courier">$ grun.py <server list file>.txt setup_cifs_config.py</FONT></p>
+<p><b>Note:</b> 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.
<h2>Creating CIFS Users</h2>
<p>You must create users and their password to enable them to use the CIFS access protocol.</p>
<p>To create CIFS users, run the following on the gateway server:</p>
-<p><FONT FACE = "Courier">$ add_user_cifs_all.py <server list> <user list> <password></FONT></p>
+<p><FONT FACE = "Courier">$ add_user_cifs_all.py <server list file> <user list file> <password></FONT></p>
+<ul>
+<li>Server list file – contains one server name per line
+<li>User list file – contains one user name per line
+</ul>
+<p>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>.
+<p><b>Note:</b> 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.
+
<h2>Removing CIFS Users</h2>
<p>You can delete users and their password.</p>
<p>To delete CIFS users, run the following on the gateway server:</p>
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 d24dd7ef..48c1f892 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 @@ -13,12 +13,13 @@ type="text/css" media="screen" /> <p>This section describes the main sections of the user interface and explains the type of functions you can perform using each section.</p> <p><b>Note:</b> You can use Gluster Management Console to set up different cloud environments; but can only manage one cloud in one login session. +<p>The Gluster Management Console window is divided into two panes: a navigation tree in the left and a tabbed information pane in the right. <p><img src="../images/GMC_Landing_Page.jpg" alt="Gluster Management Console" height="350" width="500" /></p> <ul> <li><b>Left Pane:</b> The Left pane displays the cloud, it's servers, and it's volumes. - <li><b>Right Pane: </b> Displays the <b>Summary</b> and <b>Task</b> tab. It also displays Actions such as create volume, add server. + <li><b>Right Pane: </b> At any point of time, the Right pane shows tabs with information that are applicable to the resource selected in the left pane such as Server, Volumes, Bricks, and Discovered Server. <li><b>File Menu:</b> Helps you to exit the application. <li><b>Edit Menu:</b> Helps you to import keys, export keys, change password, change settings and refresh the application. diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_terminal_window.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_terminal_window.html new file mode 100644 index 00000000..ee78defe --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_terminal_window.html @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<link rel="stylesheet" href="../css/builder-gluster/style.css"
+type="text/css" media="screen" />
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>Sub Topic</title>
+</head>
+
+<body>
+<h1>Terminal</h1>
+<p>The Gluster Management Console provides a stand-alone ANSI or vt102 terminal emulator that enables you to connect to servers through SSH.</p>
+<p>It processes ANSI control characters, including NUL, backspace, carriage return, linefeed, and a subset of ANSI escape sequences sufficient to enable the use of screen-oriented applications, such as vi, Emacs, and any GNU readline-enabled application such as Bash, bc, or ncftp.</p>
+<p><b>Note:</b> Gluster Terminal window is not a fully compliant vt100 or vt102 terminal emulator.</p>
+<p><img src="../images/GMC_Terminal_window.jpg" alt="Terminal Window" />
+<p>You must provide SSH connection details to connect to the required host. Here is a screenshot of how to configure these settings on Gluster Management Console.
+<p><img src="../images/GMC_terminal_Settings.jpg" alt="Terminal Window" />
+</body>
+</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_toolbar.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_toolbar.html new file mode 100644 index 00000000..77681663 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/gmc_toolbar.html @@ -0,0 +1,98 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<link rel="stylesheet" href="../css/builder-gluster/style.css"
+type="text/css" media="screen" />
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Main Topic</title>
+</head>
+
+<body>
+<h1>Gluster Management Console Toolbar</h1>
+The Toolbar provides shortcuts to the main Gluster Management Console functions.
+<p>The table below describes the buttons on the toolbar of the console.</p>
+<table border="1">
+<tr>
+<th>Icon</th>
+<th>Description</th>
+</tr>
+<tr>
+<td><img src="../images/GMC_terminal_toolbar.jpg" alt="Terminal Icon" /></td>
+<td>Launches the terminal window that allows you type system commands.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_settings.jpg" alt="Preferences Icon" /></td>
+<td>Opens the Preferences window.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Refresh.jpg" alt="Refresh Icon" /></td>
+<td>Refreshes the application.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_add_server_icon.jpg" alt="Add Server Icon" /></td>
+<td>Allows you to add a server to a cluster.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Remove_Server_icon.jpg" alt="Remove Server Icon" /></td>
+<td>Allows you to removes a server from a cluster.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Create_Vol_icon.jpg" alt="Create Volume Icon" /></td>
+<td>Opens the Create Volume window.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_start_vol_icon.jpg" alt="Create Volume Icon" /></td>
+<td>Allows you to start a volume.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_stop_vol_icon.jpg" alt="Stop Volume Icon" /></td>
+<td>Allows you to stop a volume.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_remove_volume_icon.jpg" alt="Remove Volume Icon" /></td>
+<td>Allows you to removes a volume.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Rebalance_icon.jpg" alt="Rebalance Volume Icon" /></td>
+<td>Allows you to rebalance a volume.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_setting_icon.jpg" alt="Reset Volume Option Icon" /></td>
+<td>Allows you to reset the volume options.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_download_log_icon.jpg" alt="Download Log Icon" /></td>
+<td>Allows you to download logs.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Add_Brick_icon.jpg" alt="Add Brick Icon" /></td>
+<td>Opens the Add Brick window.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Remove_Brick_icon.jpg" alt="Remove Brick Icon" /></td>
+<td>Removes brick from a volume.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_migrate_brick_icon.jpg" alt="Migrate Brick Icon" /></td>
+<td>Migrates a brick from one volume to another.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Start_task_icon.jpg" alt="Start Task Icon" /></td>
+<td>Allows you to start a task from the Tasks tab.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Stop_icon.jpg" alt="Stop Task Icon" /></td>
+<td>Allows you to stop a task from the Tasks tab.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_pause_icon.jpg" alt="Pause Task Icon" /></td>
+<td>Allows you to pause a task from the Tasks tab.</td>
+</tr>
+<tr>
+<td><img src="../images/GMC_Clear_task_icon.jpg" alt="Clear Task Icon" /></td>
+<td>Allows you to clear completed task from the Tasks tab.</td>
+</tr>
+</table>
+</body>
+</html>
\ 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 08ce1e1d..306df66b 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 @@ -10,20 +10,31 @@ type="text/css" media="screen" /> <body>
<h1>Installing the Gluster Management Gateway</h1>
-<p><b>Note:</b> For checking the GlusterFS minimum requirements, refer to the <a href= "http://www.gluster.com/community/documentation/index.php/Gluster_3.2:_Checking_Minimum_Requirements">Gluster 3.2 Filesystem Installation Guide, Checking Minimum Requirements</a>.</p>
-<P>You can install the Gluster Management Gateway through the following command:</P>
+
+<p>To install the Gluster Management Gateway, perform the following steps:</p>
<ol>
-<li>Open a terminal and type the following command
-<p><FONT FACE = "Courier"># rpm -ivh glustermg-1.0.0-1.x86_64.rpm</FONT>
-<li>Start the Gluster Management Gateway by executing the following service
-<p><FONT FACE = "Courier"># service tomcat5 start</FONT>
+<li>Download the Gluster Management Gateway repository configuration file (<FONT FACE = "Courier">glustermg.repo</FONT>) and the Gluster Management Gateway RPM (<FONT FACE = "Courier">glustermg-1.0.0-1.x86_64.rpm</FONT>) from the location provided by Gluster.
+<p><b>Note:</b> <FONT FACE = "Courier">glustermg.repo</FONT> has been created and tested with CentOS 5.6. It may work with other versions of CentOS, however it has not been extensively tested.
+<li>Save the file in the following location on your machine:
+<p><FONT FACE = "Courier">/etc/yum.repos.d/</FONT>
+<li>5. Run the following command to install Gluster Management Gateway:
+<p><FONT FACE = "Courier"># yum groupinstall glustermg</FONT>
+<li>The following packages are installed if not installed earlier:
+<ul>
+<li>Java SE runtime version 1.6 – OpenJDK v1.6.0.0
+<li>Tomcat v5.5.23 or higher
+<li>wget
+</ul>
+<li>Run the following command to install Gluster Management Gateway.
+<p><FONT FACE = "Courier">rpm -ivh glustermg-1.0.0-1.x86_64.rpm </FONT>
</ol>
+<p>Gateway generates SSH keys during installation. These keys are stored in the following location <FONT FACE = "Courier">/opt/glustermg/keys</FONT>. 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 <FONT FACE = "Courier">/opt/glustermg/keys</FONT> and the file must be named as <FONT FACE = "Courier">gluster.pem</FONT></p>
<p><b>Note:</b>
-<ul>
+<ol>
<li>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.
<li>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.
-<li>Enable port 8443 on the Gateway as the Management Console connects to it over SSL on this port
-</ul>
-<p>Gateway generates SSH keys during installation. These keys are stored in the following location <FONT FACE = "Courier">/opt/glustermg/keys</FONT>. These keys are used for communication with the storage servers. However, in 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 <FONT FACE = "Courier">/opt/glustermg/keys</FONT> and the file must be named as <FONT FACE = "Courier">gluster.pem</FONT></p>
+<li>Enable port 8443 on the Gateway as the Management Console connects to it over SSL on this port.
+<li>Gluster Management Gateway communicates with all storage servers through SSH, using their host names. Make sure all of your storage server’s host names are resolvable by the Gateway.
+</ol>
</body>
</html>
\ 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 d67f251b..a1ed4b59 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 @@ -9,20 +9,29 @@ type="text/css" media="screen" /> </head>
<body>
-<h1>Installing Gluster Management Gateway Backend Packages</h1>
-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 (e.g. rpm for CentOS) published by Gluster.
-<p>The minimum requirements for installing the backend package:</p>
+<h1>Installing Gluster Management Gateway Backend Package</h1>
+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.
+<p>To install the backend packages on each and every node of your cluster, perform the following steps:</p>
+<ol>
+<li>Download the Gluster Management Gateway repository configuration file (<FONT FACE = "Courier">glustermg.repo</FONT>) and the Gluster Management Gateway RPM (<FONT FACE = "Courier">glustermg-1.0.0-1.x86_64.rpm</FONT>) from the location provided by Gluster. :
+<p><b>Note:</b> <FONT FACE = "Courier">glustermg.repo</FONT> has been created and tested with CentOS 5.6. It may work with other versions of CentOS, however it has not been extensively tested.
+<li>Save the file in the following location on your machine:
+<p><FONT FACE = "Courier">/etc/yum.repos.d/</FONT>
+<li>Run the following command to install the glustermg-backend dependencies:
+<p><FONT FACE = "Courier">rpm -ivh glustermg-backend-1.0.0-1.x86_64.rpm</FONT>
+<li>The following backend packages are installed if not installed earlier:
<ul>
<li>chkconfig
-<li>python = > 2.4.3
-<li>perl = > 5.8.8
-<li>rrdtool-perl = > 1.2.27
-<li>appliance-base = >1.3 (published by Gluster)
+<li>python v2.4.3
+<li>perl v5.8.8
+<li>rrdtool-perl v1.2.27
+<li>appliance-base v1.3
<li>sudo
<li>crontabs
+<li>samba3
+<li>libxml2 v2.6
</ul>
-<p>To install the backend packages on each and every node of your cluster run the following command:
-<p><FONT FACE = "Courier"># rpm -ivh cluster glustermg-backend-1.0.0-1.x86_64.rpm</FONT></p>
+</ol>
<p><b>Note:</b> 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.</p>
</body>
</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_bricks.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_bricks.html index d5f3d30b..96233f0e 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_bricks.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_bricks.html @@ -14,9 +14,6 @@ Brick is the basic unit of storage, represented by an export directory on a server in the storage cluster. You can expand, shrink, and migrate volume of you cluster, as required, by adding new bricks, removing bricks, and migrating bricks. -<p><b>Note:</b> You need to add at least one brick to a distributed -volume, multiples of two bricks to mirrored distributed volumes, -multiples of four bricks to striped distributed volumes when expanding -your storage space.</p> +<p><b>Note:</b> You need to add at least one brick to a distributed volume, multiples of two bricks to replicated volumes, multiples of four bricks to striped volumes when expanding your storage space.</p> </body> </html>
\ 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 52545bc7..50d3cb4d 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 @@ -19,6 +19,12 @@ 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.
-<p><img src="../images/GMC_Cluster_Summary_tab.jpg" width="75%" alt="Cluster Summary" />
+<p><img src="../images/GMC_Cluster_Summary_tab.jpg" alt="Cluster Summary" />
+<p>After you log into the application successfully, you will be prompted to:
+<ul>
+<li>Select cluster: The cluster you will manage in the login session.
+<li>Create cluster: Creating an empty cluster that can be expanded using the console.
+<li>Register cluster: Registering an existing cluster and start managing it through the console.
+</ul>
</body>
</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_logs.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_logs.html index de5cab45..790fc206 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_logs.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_logs.html @@ -10,9 +10,7 @@ type="text/css" media="screen" /> <body> <h1>Managing Logs</h1> -You can use the Logs tab of your Management Console to download the -gateway, server, volumes, and UI logs to your local machine to analyze -and archive. +You can download volume logs to your local machine to analyze and archive or you can retrieve volume logs based on a search criteria. This section describes how you can manage logs on your storage cluster. <p>Typically, the log file includes:</p> <ul> <li>Installation messages @@ -20,7 +18,11 @@ and archive. <li>Configuration messages <li>Informational messages </ul> -<p>The default location for this log file is <need this -information>.</p> +<p>The Gluster Management Gateway log files are stored in the following locations on your server:</p> +<ul> +<li>Tomcat servlet container logs - <FONT FACE = "Courier">/var/log/tomcat5/catalina.out</FONT> +<li>Gluster Management Gateway logs - <FONT FACE = "Courier">/var/log/glustermg/glustermg.log</FONT> +</ul> + </body> </html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_servers.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_servers.html index 71019d08..1326eb34 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_servers.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/manage_servers.html @@ -10,16 +10,13 @@ type="text/css" media="screen" /> <body>
<h1>Managing Your Servers</h1>
-A server is a computer or device on a network that manages network
-resources. It is a group of linked computers, working together closely
-thus in many respects forming a single computer. You can add a new
-server to the storage cluster to expand the amount of available storage.
+A server is a computer on a network that is used as a storage node in a cluster. You can add a new server to the storage cluster to expand the amount of available storage.
<h2>Server Summary</h2>
<p>The console enables you to monitor your servers in your cluster
-from the Summary tab. To display the summary of your cluster, click the
-Server node from the left pane of the console window. The summary of the
+from the <b>Summary</b> tab. To display the summary of your cluster, click the
+<b>Server </b>node from the left pane of the console window. The summary of the
servers in your cluster is displayed in the right pane of the console
-window. It also displays the Tasks and Alerts.</p>
-<p><img src="../images/GMC_Server_Summary_tab.jpg" width="75%" alt="Server Summary" />
+window. It also displays the <b>Tasks</b> and <b>Alerts</b>.</p>
+<p><img src="../images/GMC_Server_Summary_tab.jpg" alt="Server Summary" />
</body>
</html>
\ 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 5934614d..2b372d0f 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 @@ -18,31 +18,17 @@ large part of the administrator's duties. This section explains how to manage the volumes stored on file server machines.
<p>You can use Volumes to do the following:
<ul>
- <li> Create and start a new volume (featuring a single global
- namespace)</li>
- <li>Start a volume that is currently stopped</li>
- <li>Stop a volume that is currently running</li>
+ <li> Create a new volume </li>
+ <li>Start a volume </li>
+ <li>Stop a volume </li>
<li>Migrate a volume</li>
- <li>Delete a volume from your storage environment</li>
+ <li>Rebalance a volume</li>
</ul>
<h2>Volume Summary</h2>
<p>The console also enables you to monitor the volumes in your cluster from the <b>Summary</b> 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 <B>Tasks</B> and <B>Alerts</B> of all the volumes.
-<p><img src="../images/GMC_Volume_Summary_tab.jpg" width="75%" alt="Volume Summary" />
+<p><img src="../images/GMC_Volume_Summary_tab.jpg" alt="Volume Summary" />
-<p><b>Types of Volumes</b></p>
-<p>Volumes of the following types can be created in your storage
-environment:</p>
-<ul>
- <li>Plain Distributed - Distributes files throughout the bricks in
- the volume.
- <li>Distributed Striped - Distributes data across striped bricks
- in the volume.
- <li>Distributed Mirror - Creates a mirrored volume with all files
- replicated.
- <p><b>Note:</b> You must have at least two servers to activate this
- feature.</p>
-</ul>
</body>
</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/monitor_resources.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/monitor_resources.html index 89e15bc6..907f2d73 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/monitor_resources.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/monitor_resources.html @@ -22,7 +22,7 @@ steps.</p> network usage, and disk utilization by day, week, or month. In case of
Network usage, the graph will be displayed for the selected network
from the drop down list.
- <p>Note: At any point of time, the Summary tab will show views that
+ <p><b>Note:</b> At any point of time, the <b>Summary</b> tab will show views that
are applicable to the resource selected from the navigation tree in the
left pane.</p>
<p><img src="../images/GMC_Cluster_Summary_tab.jpg"
diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/security_keys.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/security_keys.html index eeade559..5b723899 100644 --- a/src/com.gluster.storage.management.console.help/html/gettingstarted/security_keys.html +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/security_keys.html @@ -10,8 +10,7 @@ type="text/css" media="screen" /> <body>
<h1>Security Keys</h1>
-In order to secure all of the virtual machines that are created, root access to these machines is controlled by SSH key access rather than by using an interactive password. This establishes trust between your account on your central server and the new virtual machine you just added to your cluster.
-<p>Administrators can export and/or import the SSH keys (of the gateway) for security reasons from the Gluster Management Gateway server.</p>
+Gluster Management Gateway communicates with storage servers using public key authentication. This establishes trust between your account on your central server and the new machine you just added to your cluster. Administrators can export and/or import the SSH keys (of the gateway) for security reasons from the Gluster Management Gateway server.
<h2>Importing Keys</h2>
<p>To import the security keys, perform the following steps:</p>
<ol>
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 7894ad1a..e5f708a9 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 @@ -15,8 +15,8 @@ Thresholds are the critical conditions that you define in Gluster Management Con <ol>
<li>Choose <b>Edit</b> > <b>Settings</b>
<p><b>Preferences</b> window is displayed.</p>
-<li>Choose <b>Gluster</b> > <b>Alerts</b> page from the left pane of the <b>Preferences</b> window.
-<p><img src="../images/GMC_Alerts.jpg" width="55%" alt="Alerts Perferences" /></p>
+<li>Choose <b>Gluster</b> > <b>Alerts</b> page from the right pane of the <b>Preferences</b> window.
+<p><img src="../images/GMC_Alerts.jpg" alt="Alerts Perferences" /></p>
<li>Type the value for server CPU threshold limits in the <b>Server CPU Threshold</b> field.
<li>Type the value for server memory usage threshold in the <b>Server Memory Usage Threshold</b> field.
<li>Type the value for disk space usage threshold in the <b>Disk Space Threshold</b> 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 0cdf339e..bc1199b0 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 @@ -14,9 +14,10 @@ You can customize the console and change the way some of the monitoring data is <p><b>Note:</b> The default duration for all the charts is a week.</p>
<p>To set the display of the charts, perform the following:</p>
<ol>
-<li>Choose <b>Edit</b> > <b>Settings</b> > <b>Charts</b>
-<p>The <b>Preferences</b> window displays the <b>Charts</b> page on the left pane of the window.</p>
-<p><img src="../images/GMC_Charts.jpg" width="55%" alt="Charts Perferences" /></p>
+<li>Choose <b>Edit</b> > <b>Settings</b>
+<p>The <b>Preferences</b> window is displayed. </p>
+<li>Choose <b>Gluster</b> > <b>Charts</b> page from the right pane of the <b>Preferences</b> window.
+<p><img src="../images/GMC_Charts.jpg" alt="Charts Perferences"/></p>
<li>Select the <b>Aggregated CPU Usage chart period</b> from the drop down list.
<li>Select the <b>Aggregated Network Usage chart period</b> from the drop down list.
<li>Select the <b>CPU Usage chart period</b> 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 89c7cea0..74cb4ba4 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,9 +13,12 @@ type="text/css" media="screen" /> Please enter your text here.
<p>To set the Gluster perferences, perform the following steps:
<ol>
-<li>Choose <b>Edit</b> > <b>Settings</b> > <b>Gluster</b>
-<p>The <b>Preferences</b> window displays the Gluster page on the left pane of the window.
-<p><img src="../images/GMC_Preferences_gluster.jpg" width="55%" alt="Gluster Perferences" /></p>
+<li>Choose <b>Edit</b> > <b>Settings</b>
+<p>The <b>Preferences</b> window is displayed.
+<li>Choose <b>Gluster</b> page from the right pane of the <b>Preferences</b> window.
+
+
+<p><img src="../images/GMC_Preferences_gluster.jpg" alt="Gluster Perferences" /></p>
<li>Select <b>Show Cluster Selection Dialog on Login</b>, if you want your cluster name to appear when you launch the application.
<li>Choose your cluster name from <b>Default Cluster to Manage</b> drop down list to manage the default cluster you wish to manage when you launch the application.</li>
<li>Type the duration of the data synchronization intervals in the <b>Data Sync Interval</b> field.
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 90625ede..254fb15d 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 @@ -16,6 +16,7 @@ You can use preferences to configure several aspects of the Gluster Management C <li><a href="setting_gluster_prefs.html">Setting Gluster Preferences</a>
<li><a href="setting_alerts_prefs.html">Setting Alert Preferences</a>
<li><a href="setting_charts_prefs.html">Setting Charts Preferences</a>
+<li><a href="setting_terminal_prefs.html">Setting Terminal Preferences</a>
</ul>
</body>
</html>
\ No newline at end of file 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 new file mode 100644 index 00000000..e48535be --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/setting_terminal_prefs.html @@ -0,0 +1,28 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<link rel="stylesheet" href="../css/builder-gluster/style.css"
+type="text/css" media="screen" />
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Sub Topic</title>
+</head>
+
+<body>
+<h1>Setting Terminal Preferences</h1>
+<p>You can customize the terminal window as described in this section.</p>
+<p>To set the display of the charts, perform the following:</p>
+<ol>
+<li>Choose <b>Edit</b> > <b>Settings</b>
+<p><b>Preferences</b> window is displayed.</p>
+<li>Choose <b>Terminal</b> from the right pane of the <b>Preferences</b> window.
+<p>The <b>Preferences</b> window displays the <b>Terminal</b> page on the left pane of the window.
+<p><img src="../images/GMC_Preferences_terminal.jpg" alt="Gluster Perferences" /></p>
+<li>Type the limit of terminal buffer lines in the <b>Terminal buffer lines</b> field.
+<li>Type the value of the serial timeout in the <b>Serial timeout</b> field.</li>
+<li>Type the value of the network timeout in the <b>Network timeout</b> field.
+<li>Click <b>Apply</b>.
+<li>Click <b>OK</b> to exit the <b>Preferences</b> window.
+</ol>
+</body>
+</html>
\ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/gettingstarted/tasks.html b/src/com.gluster.storage.management.console.help/html/gettingstarted/tasks.html new file mode 100644 index 00000000..c5647b9a --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/gettingstarted/tasks.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<link rel="stylesheet" href="../css/builder-gluster/style.css"
+type="text/css" media="screen" />
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Sub Topic</title>
+</head>
+
+<body>
+<h1>Tasks</h1>
+<b>Task</b> tab is displayed when you select the cluster node. It displays the status of all running tasks such as disk initialization, brick migration, volume rebalance.
+<p><img src="../images/GMC_Task_tab.jpg" alt="Task Tab"/></p>
+<p>When you select a task on this tab, the relevent toolbar options are enabled. These include pause, resume, abort, commit, or clear operations.
+</body>
+</html>
\ No newline at end of file |