Quick Start Guide: Try It Out

Important Note: Upgrading your server to the latest version

When evaluating StorReduce we recommend upgrading to the latest version by running ‘yum upgrade’ before performing the evalution. For production servers we recommend running ‘yum upgrade’ once a week. See In-place Upgrades using Yum for details.


Have a look around the StorReduce dashboard. This page shows a selection of things you may want to try.


Change your root password

Click on the Users tab, then select the row for Root User and click on Manage Password

Root Password Screenshot 1

Enter the new password for root:

Root Password Screenshot 2


Create a bucket

Click on the Browse Data tab, then click on Create Bucket and enter a bucket name. The name must be consist of lower-case letters, numbers and a few characters such as ‘-’.

Make Bucket Screenshot


Upload a file and check your Deduplication Statistics

Click on the name of a bucket on the browse data view, then click Upload to send a file to the bucket.

Upload Screenshot

Try uploading more copies of the same file, or files that have overlapping or duplicated content to see deduplication in action.

Dedup Ratio Screenshot


Create an access key for a the root user

In order to use an S3-compatible client to talk to StorReduce you will need an Access Key and Secret Key generated by the StorReduce server. The easiest way to do this is to create a key for the StorReduce root user.

Click on the Users tab, select the root user and click on Manage Keys. Then click on New Key to create the key. Make sure you write down the Secret Access Key before you leave the screen. You can then use this Access Key ID and Secret Access Key to connect clients to the StorReduce server via its S3 interface.

New Key Screenshot 1

You can see how many keys each user has on the Users screen:

New Key Screenshot 2


Try an S3 client

You can configure any S3 client to talk to StorReduce by specifying your EC2 instance DNS name and port as an S3 endpoint, and providing an Access Key ID and Secret Access Key obtained from the StorReduce dashboard. We suggested trying s3cmd for Linux/Mac, or s3browser for Windows.

Important Notes:

  • For clients that use subdomain-style bucket names you may need to add an entry into your hosts file for each bucket. Alternatively you can make use of a DNS service that can provide wildcard DNS, like xip.io (see our xip.io instructions).

  • StorReduce now supports both AWS Signature Version 2 and AWS Signature Version 4.

  • We recommend testing using an access key created for the root user because the root user automatically has access rights for every bucket.

S3Cmd

Here are some example settings from an s3cmd config file, for use with xip.io and StorReduce:

[default]
access_key = ABCDEFGHIJKLMNOPQRST
secret_key = abcDEFgHIJKLmno/pQRSTIvwxyZ01234567890+A
host_base = 123.45.67.49.xip.io
host_bucket = %(bucket)s.123.45.67.49.xip.io

Using s3cmd with this config we can then look around and fetch a file from StorReduce:

$ s3cmd -c $HOME/.sr-s3cfg ls
2015-01-23 00:10  s3://my-bucket-1
$ s3cmd -c $HOME/.sr-s3cfg ls s3://my-bucket-1
2015-01-23 00:15   6941544   s3://my-bucket-1/second-copy-node.exe
2015-01-23 00:13   6941544   s3://my-bucket-1/test-file-node.exe
$ s3cmd -c $HOME/.sr-s3cfg get s3://my-bucket-1/test-file-node.exe
s3://my-bucket-1/test-file-node.exe -> ./test-file-node.exe  [1 of 1]
 6941544 of 6941544   100% in   25s   267.90 kB/s  done

S3Browser

To configure S3Browser to use StorReduce, start S3Browser and select Add new account ... in the Accounts menu, and fill out the Add New Account dialog as shown below.

Add New Account Dialog

Set:

  • the Account Name field to something meaningful,
  • the Storage Type field to S3 Compatible Storage,
  • the Rest Endpoint field to the domain name of your server, in this case we are using a xip.io domain name because S3Browser users sub-domain style addressing for buckets, and
  • the Access Key ID and Secret Access Key fields to a key pair that you have generated in the StorReduce dashboard (see above).

Then click the Add new account button. S3 Browser will check that the configuration works, if there is an error then you will see a message in the Tasks window and the Failed icon will be lit.

Now you can create a bucket by clicking New bucket button. When you have created and selected a bucket, you can upload files into it by clicking the Upload button and download files using the Download button.

S3Browser ready for action


Create a new user account (advanced)

StorReduce maintains its own set of users independently of AWS. You can set up any number of users, each with their own access rights and set of access keys.

Please note: You don’t need to add any new users in order to test StorReduce with an S3 client. We recommend testing using the root user as described above because the root user automatically has access rights for every bucket.

Initially a new user will have no access rights until they are granted access by creating a Security Policy.

To set up a new user, click on the Users tab, then click on New User and enter details.

New User Screenshot 1

If you want the user to be able to log in to the dashboard, give them a password by selecting the new user and clicking on Manage Password.

New User Screenshot 2

You can see that the new user now has a password:

New User Screenshot 3

If you want the user account to be used via the S3 API you will need to create an access key. Select the user, then click on Manage Keys, then click on New Key. Make sure you write down the Secret Access Key before you leave the screen. You can then use this Access Key ID and Secret Access Key to connect clients to the StorReduce server via its S3 interface, as described for the root user in previous sections.

Before the user account can read or write any data to a StorReduce bucket, you must add a Security Policy to the bucket giving access to the user. See the following section for details.

Create a Security Policy to grant access to a user (advanced)

Security policies are stored against each StorReduce bucket, and specify users and their access rights. Security policies are written in the same policy language as AWS IAM Policies and are similar to S3 bucket policies.

To set up a security policy to grant access to a bucket for a particular user, click on the Browse Data tab, then select the row for the bucket (do not click on the bucket name, just click elsewhere on the row). On the right of the screen the bucket details will be shown, including a ‘Security Policy’ section.

Click on the ‘Add’ button under the Security Policy section to bring up the Bucket Policy Editor, then enter or paste in your Security Policy and click ‘Save’. When writing the policy you will need the ARN identifier for the bucket, and the ARN identifier for each user who should have access. Browse to the Users tab to see the ARN identifiers for each user.

Here is an example policy that allows users ‘alice’ and ‘john’ to perform any action on the bucket named ‘my-bucket’. This is a good starting point to paste in and edit:

{
  "Id": "My-Test-Policy",
  "Statement": [
    {
      "Action": "s3:*",
      "Effect": "Allow",
      "Resource": [
        "arn:aws:s3:::my-bucket",
        "arn:aws:s3:::my-bucket/*"
      ],
      "Principal": {
        "AWS": [
          "arn:aws:iam::0:user/john",
          "arn:aws:iam::0:user/alice"
        ]
      }
    }
  ]
}

Please see the StorReduce Policy Help page for more details and examples of Security Policies.