From cbf33ecd9cfdb138b543e7f67cdce775455e1915 Mon Sep 17 00:00:00 2001 From: Shireesh Anjal Date: Thu, 4 Aug 2011 13:21:23 +0530 Subject: Updating help contents --- .../html/tasks/add_brick.html | 24 ++++++++++++ .../html/tasks/add_servers.html | 22 +++++++++++ .../html/tasks/configure_gmc.html | 15 ++++++++ .../html/tasks/create_volume.html | 31 +++++++++++++++ .../html/tasks/delete_brick.html | 29 ++++++++++++++ .../html/tasks/logging.html | 12 ++++++ .../html/tasks/start_vol.html | 23 +++++++++++ .../html/tasks/stop_vol.html | 20 ++++++++++ .../html/tasks/subtopic.html | 45 ++++++++++++++++------ .../html/tasks/subtopic3.html | 13 +++++++ .../html/tasks/subtopic4.html | 13 +++++++ .../html/tasks/subtopic5.html | 13 +++++++ .../html/tasks/subtopic6.html | 13 +++++++ .../html/tasks/tune_vol_opt.html | 20 ++++++++++ .../html/tasks/volumes.html | 38 ++++++++++++++++++ 15 files changed, 319 insertions(+), 12 deletions(-) create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/add_brick.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/add_servers.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/configure_gmc.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/create_volume.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/delete_brick.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/logging.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/start_vol.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/stop_vol.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/subtopic3.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/subtopic4.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/subtopic5.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/subtopic6.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html create mode 100644 src/com.gluster.storage.management.console.help/html/tasks/volumes.html (limited to 'src/com.gluster.storage.management.console.help/html/tasks') diff --git a/src/com.gluster.storage.management.console.help/html/tasks/add_brick.html b/src/com.gluster.storage.management.console.help/html/tasks/add_brick.html new file mode 100644 index 00000000..6621d479 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/add_brick.html @@ -0,0 +1,24 @@ + + + + + + Sub Topic + + + +

Adding a Brick

+You can expand a volume, as required, by adding new bricks to an existing volume. +

Note: You need to add at least one brick to a distributed volume, two (or multiples of two) bricks to mirrored distributed volumes, and four (or multiples of four) bricks to striped distributed volumes when expanding your storage space. +

To add a brick to an existing volume, perform the following steps.

Choose from the menu, toolbar, or right click and select the Volume and select Add Bricks. +
The Add Brick window is displayed.
+
+
Select the bricks that you want to add to the current volume. Click Add to add a specific brick or Click Add All to add all the available bricks. +
Click Finish. The Add Brick(s)to Volume window appears indicating that the brick(s) is successfully added. +
+
Click OK. +

+ + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/add_servers.html b/src/com.gluster.storage.management.console.help/html/tasks/add_servers.html new file mode 100644 index 00000000..760ed812 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/add_servers.html @@ -0,0 +1,22 @@ + + + + + + Main Topic + + + +

Add a Server

+Gluster Management Console enables you to manage your storage cluster with ease. This section describes how you can manage your server. +

Add a new server to the storage cluster +
Reboot the server, as required +
Shut down the server, as required +
Format a disk +
Migrate a disk +
Delete a server, as required +

+ + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/configure_gmc.html b/src/com.gluster.storage.management.console.help/html/tasks/configure_gmc.html new file mode 100644 index 00000000..39a57dd8 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/configure_gmc.html @@ -0,0 +1,15 @@ + + + + + + Sub Topic + + + +

Configuring the Gluster Management Console

+Gluster Managment Console enable you to manage you storage cluster. This section describes how you can configure the GMC with your cloud storage environment. + +

Need more Info here

+ + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/create_volume.html b/src/com.gluster.storage.management.console.help/html/tasks/create_volume.html new file mode 100644 index 00000000..bc2d498a --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/create_volume.html @@ -0,0 +1,31 @@ + + + + + + Creating Volumes + + + +

Creating a Volume

+You can use the Management Console to create and start new volumes featuring a single global namespace. When creating a new volume, you can select the servers that will comprise the volume and, optionally, specify whether the volume is to be distributed, distributed mirrored, or distributed stripedPlease enter your text here.

To create a volume, perform the following steps: +

Choose from the menu, toolbar, or right click and select the Volume and select Create Volume. + +
The Create Volume window is displayed. +
+
Enter the name of the volume in the Name field. +
Select the type of the volume from the Type drop-down list. You can choose the type as either Plain Distribute, Distributed Mirror, or Distributed Stripe. +
Bricks will be created on all the disks of the cluster when you create a volume, by default. Click Customize, to select and add specific bricks to your volume. +
Select the Access Protocol for the new volume. You can select GlusterFS, NFS, or CIFS checkbox. +
If you choose CIFS, specify the user name and password to use from Windows clients to connect to the volume. +
You need to use user-based authentication for CIFS exports, hence you must specify the user’s who can access the volume as a comma-separated list in the Users field. +
Specify the volume access control as a comma-separated list of IP addresses or hostnames in the Access Control field. +
You can use wildcard to specify ranges of addresses. Typing an asterisk (*) specifies all IP addresses. You need to use IP-based authentication for Gluster Filesystem and NFS exports.
+
Select the Start Volume check box to automatically start the volume once created. +
Click Create Volume. The console displays Create Volume window to indicate that the volume was successfully created. +
+
Click OK. +

+ + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/delete_brick.html b/src/com.gluster.storage.management.console.help/html/tasks/delete_brick.html new file mode 100644 index 00000000..ad2b3059 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/delete_brick.html @@ -0,0 +1,29 @@ + + + + + + Sub Topic + + + +

Delete a Brick

+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 delete bricks from an existing volume, perform the following steps.

Choose from the menu, toolbar, or right click and select the Volume and select Delete Bricks. +
If the volume is currently running, you are asked to confirm before deleting a brick. +
+
If you wish to delete the brick permanently, click Remove Bricks, Delete Data. +
If you wish to keep the data but delete the brick, click Remove Bricks, Keep Data. +
The Delete Brick window is displayed indicating that the volume was deleted successfully.
+ [Insert Screenshot] +
Click OK. + + +

+ + + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/logging.html b/src/com.gluster.storage.management.console.help/html/tasks/logging.html new file mode 100644 index 00000000..79e32a25 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/logging.html @@ -0,0 +1,12 @@ + + + + + + Main Topic + + + +

Logging into the Management Console

The GMC console is a GUI application accessible at http://localhost:8080/glustergmc -console when you start the server. + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/start_vol.html b/src/com.gluster.storage.management.console.help/html/tasks/start_vol.html new file mode 100644 index 00000000..0b427eee --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/start_vol.html @@ -0,0 +1,23 @@ + + + + + + Sub Topic + + + +

Start a Volume

+You can start a volume that is currently stopped, as required. +

To start a volume, perform the following steps:

Choose from the menu, toolbar, or right click and select the Volume and select Start Volume. +
Alternatively, you can select the Volume node and from the right pane select the volumes that you need to start or click All to select all volumes. +
The Create Volume window appears indicating that the volume (or volumes) were successfully started. +
+
Click OK. + +

+ + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/stop_vol.html b/src/com.gluster.storage.management.console.help/html/tasks/stop_vol.html new file mode 100644 index 00000000..c91fc600 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/stop_vol.html @@ -0,0 +1,20 @@ + + + + + + Sub Topic 2 + + + +

Stopping a Volume

+You can stop 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. +

You can stop a volume that is currently running, as required. To stop a volume, perform the following steps. +

1. Choose from the menu, toolbar, or right click and select and select Stop Volume. If the volume is currently running, you are asked to confirm before stopping a volume. +
Select Stop Volume. +
The following dialog appears indicating that the volume (or volumes) were successfully stopped.
+
Insert Screenshot. +

+ + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/subtopic.html b/src/com.gluster.storage.management.console.help/html/tasks/subtopic.html index 8a61c501..21ded1cd 100644 --- a/src/com.gluster.storage.management.console.help/html/tasks/subtopic.html +++ b/src/com.gluster.storage.management.console.help/html/tasks/subtopic.html @@ -1,13 +1,34 @@ - - - - - - Sub Topic - - - -

Sub Topic

-Please enter your text here. - + + + + + + Sub Topic + + + +

Displaying a Log

+You can display the server logs using the Management Console. + +The following table describes the information displayed when viewing logs: + + + + + + + + + + + + + + + + + +

Date	The date of the log entry
Time	The time of the log entry
Type	The type of the log entry; either Normal or Error
Details	Details about the log entry

+ \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/subtopic3.html b/src/com.gluster.storage.management.console.help/html/tasks/subtopic3.html new file mode 100644 index 00000000..6dccc35e --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/subtopic3.html @@ -0,0 +1,13 @@ + + + + + + Sub Topic + + + +

Sub Topic

+Please enter your text here. + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/subtopic4.html b/src/com.gluster.storage.management.console.help/html/tasks/subtopic4.html new file mode 100644 index 00000000..6dccc35e --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/subtopic4.html @@ -0,0 +1,13 @@ + + + + + + Sub Topic + + + +

Sub Topic

+Please enter your text here. + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/subtopic5.html b/src/com.gluster.storage.management.console.help/html/tasks/subtopic5.html new file mode 100644 index 00000000..6dccc35e --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/subtopic5.html @@ -0,0 +1,13 @@ + + + + + + Sub Topic + + + +

Sub Topic

+Please enter your text here. + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/subtopic6.html b/src/com.gluster.storage.management.console.help/html/tasks/subtopic6.html new file mode 100644 index 00000000..6dccc35e --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/subtopic6.html @@ -0,0 +1,13 @@ + + + + + + Sub Topic + + + +

Sub Topic

+Please enter your text here. + + \ 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 new file mode 100644 index 00000000..d885664a --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/tune_vol_opt.html @@ -0,0 +1,20 @@ + + + + + + Sub Topic 2 + + + +

Tuning Volume Options

+You can set volume options, as needed, while the cluster is online and available. +

To tune volume options, perform the following steps.

Select the volume that you need to add Volume Options. +
Click the Volume Options tab. +
Click Add. Choose the volume options from the drop down list and enter the Options value. +

To read more about the volume options, refer to the Gluster Filesystem Administration Guide, Section 8.1 Tuning Volume Options. + + \ No newline at end of file diff --git a/src/com.gluster.storage.management.console.help/html/tasks/volumes.html b/src/com.gluster.storage.management.console.help/html/tasks/volumes.html new file mode 100644 index 00000000..84532085 --- /dev/null +++ b/src/com.gluster.storage.management.console.help/html/tasks/volumes.html @@ -0,0 +1,38 @@ + + + + + + Main Topic + + + +

Creating Volumes to Simplify Administration

+A volume is a logical collection of bricks where each brick is an export directory on a server in the trusted storage pool. Most of the gluster management operations happen on the volume. + +You can create new volumes in your storage environment, as needed. When creating a new volume, you must specify the bricks that comprise the volume. +

Assigning Volume Names

+ +

You can name your volumes anything you choose, subject to a few restrictions: +

Volume names can be up to ?? characters in length. The maximum length for volume names is 32 characters. +
It is best to assign volume names that indicate the type of data they contain, and to use similar names for volumes with similar contents. It is also helpful if the volume name is similar to (or at least has elements in common with) the name of the directory at which it is mounted. Understanding the pattern then enables you accurately to guess what a volume contains and where it is mounted.
+

Types of Volumes

Volumes of the following types can be created in your storage environment:

Plain Distributed - Distributes files throughout the bricks in the volume. +
Distributed Striped - Distributes data across striped bricks in the volume. +
Distributed Mirror - Creates a mirrored volume with all files replicated.
Note: You must have at least two servers to activate this feature.

This section describes the various talks enabling you to manage your volumes on the storage cluster: +

Create a new volume (featuring a single global namespace) +
Start a volume that is currently stopped +
Stop a volume that is currently running +
Delete a volume from your storage environment + +

+ + + + \ No newline at end of file -- cgit