Skip to content

Commit

Permalink
Merge pull request #441 from FittedCloud/feature/fittedcloud-revised-…
Browse files Browse the repository at this point in the history
…storage-providers-docs

FittedCloud Revised Storage Provider Docs
  • Loading branch information
akutz authored Feb 24, 2017
2 parents 1661af9 + 4bd5d0a commit 6964d5f
Showing 1 changed file with 96 additions and 0 deletions.
96 changes: 96 additions & 0 deletions .docs/user-guide/storage-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -696,6 +696,102 @@ dobs:
to ensure that the driver must be explicitly configured for access instead
of detecting a default token that may not be intended for the driver.

## FittedCloud
Another example of the great community shared by the libStorage project, the
talented people at FittedCloud have provided a driver for their EBS optimizer.

<a class="headerlink hiddenanchor" name="fittedcloud-ebs"></a>
<a class="headerlink hiddenanchor" name="fittedcloud-ebs-optimizer"></a>

### EBS Optimizer
The FittedCloud EBS Optimizer driver registers a storage driver named
`fittedcloud` with the libStorage service registry and provides the ability to
connect and manage thin-provisioned EBS volumes for EC2 instances.

!!! note
This version of the FittedCloud driver only supports configurations where
client and server are on the same host. The libStorage server must be
running on each node along side with the FittedCloud Agent.

!!! note
This version of the FittedCloud driver does not support co-existing with the
ebs driver on the same host. As a result it also doesn't support optimizing
existing EBS volumes. See the [Examples](#fittedcloud-examples) section
below for a running example.

!!! note
The FittedCloud driver does not yet support snapshots or tags.

#### Requirements
This driver has the following requirements:

* AWS account
* VPC - EBS can be accessed within VPC
* AWS Credentials
* FittedCloud Agent software

<a class="headerlink hiddenanchor" name="fittedcloud-getting-started"></a>

#### Getting Started
Before starting, please make sure to register as a user by visiting the
FittedCloud [customer website](https://customer.fittedcloud.com/register).
Once an account is activated it will be assigned a user ID, which can be found
on the Settings page after logging into the web site.

The following commands will download and install the latest FittedCloud Agent
software. The flags `-o S -m` enable new thin volumes to be created via the
docker command instead of optimizing existing EBS volumes.
Please replace the `<User ID>` with a FittedCloud user ID.

```sh
$ curl -skSL 'https://customer.fittedcloud.com/downloadsoftware?ver=latest' \
-o fcagent.run
$ sudo bash ./fcagent.run -- -o S -m -d <User ID>
```

Please refer to FittedCloud
[website](https://customer.fittedcloud.com/download) for more details.

<a class="headerlink hiddenanchor" name="fittedcloud-config"></a>

#### Configuration
The following is an example with all possible fields configured. For a running
example see the `Examples` section.

```yaml
ebs:
accessKey: XXXXXXXXXX
secretKey: XXXXXXXXXX
kmsKeyID: abcd1234-a123-456a-a12b-a123b4cd56ef
```

##### Configuration Notes
- FittedCloud driver shares the ebs driver's configuration
parameters.
- The `accessKey` and `secretKey` configuration parameters are optional and
should be used when explicit AWS credentials configuration needs to be provided.
FittedCloud driver uses official golang AWS SDK library and supports all other
ways of providing access credentials, like environment variables or instance
profile IAM permissions.
- If the `kmsKeyID` field is specified it will be used as the encryption key for
all volumes that are created with a truthy encryption request field.

<a class="headerlink hiddenanchor" name="fittedcloud-examples"></a>

#### Examples
The following example illustrates how to configured the FittedCloud driver:

```yaml
libstorage:
service: fittedcloud
ebs:
accessKey: XXXXXXXXXX
secretKey: XXXXXXXXXX
```

Additional information on configuring the FittedCloud driver may be found
at [this](https://goo.gl/I6mf20) location.

## Google
libStorage ships with support for Google Compute Engine (GCE) as well.

Expand Down

0 comments on commit 6964d5f

Please sign in to comment.