Greyhole

What is Greyhole

A new feature in Amahi is Storage pooling using Greyhole.

This feature is installed by default, but requires a few simple steps to begin utilizing the features.

You can add additional drives to your hda and prepare them for use in Greyhole by following this tutorial.

To add a drive to your Greyhole storage pool. First open your dashboard and navigate to the Shares tab. Then click on the Storage Pool sub-category. You will see a page similar to the one below.

Important Warnings

You should never change or delete files in the shared directories (/var/hda/files/* by default) directly on the HDA, using the terminal, or the Gnome file browser, for the shares for which you checked the Uses pool option in the Amahi dashboard.

You should be safe reading existing files directly, or adding new files directly, as long as don't care that your new files will only be moved into the storage pool during the next check, which runs automatically at midnight (or manually using greyhole --fsck). Until then, your new files will be stored in your shared directories (normally /var/hda/files/share_name/).

Also, touching anything inside the gh directories that Greyhole creates at the root of your partitions is a recipe for disaster.

We strongly discourage you from using the root partition in a drive pool.

First things first

You need to go in the Settings tab, and enable Advanced Settings.
Without Advanced Settings enabled, you won't see the following page and options.

For Storage Pool (Partitions)

Select the drives you want available for your storage pool.

Greyhole options

The next step is to select the share you want to replicate across the pool.

From the Shares tab, select the Shares sub-catagory. We chose the Pictures share for this tutorial.

Check the option for "Uses pool" and choose the number of drives to replicate this share. In this instance we have chosen to use all drives available to the greyhole pool.

Note: Greyhole is not a backup solution. If a file is removed, all copies are removed.

Greyhole advanced options

You can further configure Greyhole by manually editing the following file:
/var/hda/platform/html/config/greyhole.yml

To see what options are available, and what they do, refer to the sample greyhole.conf provided with Greyhole.

greyhole.yml is in in YAML format. Most of it should be easy enough to modify. The only exception would be the sticky_files (and optional sticky_into) options.
Here's an example of how those should appear:

To specify the following to Greyhole in greyhole.conf:

sticky_files = Music/
sticky_files = Videos/Movies/
    stick_into = /mnt/hdd1/gh
    stick_into = /mnt/hdd5/gh
sticky_files = Backups/CrashPlan/
    stick_into = /mnt/hdd0/gh

one should specify this in the greyhole.yml file, where precise indentation matters:

sticky_files: 
- - Music/
- - Videos/Movies/
  - - /mnt/hdd1/gh
    - /mnt/hdd5/gh
- - Backups/CrashPlan/
  - - /mnt/hdd0/gh

For your changes to be effective, you'll need to force Amahi to regenerate the greyhole.conf file. You can do so by editing a share, clicking it's path, and just clicking the Save button without actually changing the path.

Copying you data into Greyhole shares the first time

When you start using Greyhole, you might want to copy or move all your exiting files into your new shares that use the storage pool.

Note: This is not necessary if your files are already in Amahi shares. If they are there, and you enable the Uses pool option in the Amahi dashboard, the files will start getting moved around into the drives in your storage pool during the night (starting at midnight), when the nightly storage pool check starts.
The instructions below are for users who have more data to copy into the Greyhole shares than their currently free space in the /var/hda/files/ folder.

Once way to do that is to mount the shares that use the Greyhole storage pool, either on the HDA itself, or on a client computer on your local network, and copy your data from their existing location into the mounted shares. This can be time consuming, but it is the safest way to use Greyhole.

Another way to move your files from their current location into the storage pool is to share their current location using an Amahi share that Uses pool, then let Greyhole nightly check move the files from there into the pool.

Here's a more detailed walkthrough for this method:

1. Setup the Greyhole Storage Pool in the Amahi dashboard, Shares > Storage Pool page.
2. Go in the Shares > Shares page. In there, make sure you have an existing share for each share you have data for. Create new ones if you need, remove the ones you don't need.
3. Edit the path of each of those shares, and enter the current location of your existing data. For example, the Movies share could have a path = /media/External Drive/Movies
4. Enable the Uses pool option for each of your shares, and select the number of extra copies you'd like, if any.
5. Now, you either need to wait for Greyhole'S nightly check to start, or you can start it manually from a terminal, as root, using this command: greyhole --fsck
6. Monitor /var/log/greyhole.log to see when the fsck operation is done.
7. Once fsck is done, your data has now been moved into the Greyhole storage pool (in the drives you selected in Shares > Storage Pool). All that should be left in the previous location of your data (/media/External Drive/Movies from the previous example) should be symbolic links pointing to the new file copies. If the previous location is just empty directories (no symlinks), do not panic. This is normal if your previous location is an NTFS or FAT partition (drive).
8. Move all those directories / symlinks from there into the correct folders in /var/hda/files/share_name
9. Back in the Amahi dashboard, edit the path of the shares once again, and put back /var/hda/files/share_name (i.e. the folders where you moved the symbolic links).
10. If you used an NTFS or FAT partition for the previous location, you'll need another fsck to create the symlinks where they should be. Either wait for midnight, or launch it manually, from a command line, as root: greyhole --fsck

You're done. All your existing data is now stored in the various drives included in your storage pool, and are accessible via the Samba shares you have defined in the Amahi dashboard.

/media

Including any drive mounted as /media/Something in your storage pool is usually a bad idea.
Those mounts are created by the gnome-automounter, which requires you to be logged in into X (Gnome) to become available.
This will create issues with Greyhole, which expects drives to always be available, and will take action when some of them are missing.

Follow this guide to permanently mount your drives, before you include them in your storage pool.

Disable Greyhole

For those who do not use Greyhole, you can disable it. This is based on the fact you never have used it by enabling 'Uses pool' on any share. Recommend using extreme caution as this could have unpredictable results.

Perform the following steps as user root:

chkconfig greyhole off
remove /etc/monit.d/greyhole.conf
service monit restart
service greyhole stop

DO NOT attempt to remove the Greyhole package as it is a dependency of the HDA software. Doing so will break your HDA.