Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wavesoftware/puppet-xtreemfs
The XtreemFS module allows you to easily manage XtreemFS installation, volumes and mounts with Puppet.
https://github.com/wavesoftware/puppet-xtreemfs
Last synced: about 13 hours ago
JSON representation
The XtreemFS module allows you to easily manage XtreemFS installation, volumes and mounts with Puppet.
- Host: GitHub
- URL: https://github.com/wavesoftware/puppet-xtreemfs
- Owner: wavesoftware
- License: apache-2.0
- Created: 2014-11-17T02:10:44.000Z (about 10 years ago)
- Default Branch: develop
- Last Pushed: 2015-12-13T22:43:48.000Z (almost 9 years ago)
- Last Synced: 2024-10-19T03:18:16.703Z (about 1 month ago)
- Language: Ruby
- Size: 145 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
xtreemfs
========
##### Status Info
[](https://github.com/wavesoftware/puppet-xtreemfs/issues) [](https://forge.puppetlabs.com/wavesoftware/xtreemfs) [](https://raw.githubusercontent.com/wavesoftware/puppet-xtreemfs/develop/LICENSE)
##### Master (stable) branch
[](https://travis-ci.org/wavesoftware/puppet-xtreemfs) [](https://coveralls.io/r/wavesoftware/puppet-xtreemfs?branch=master) [](https://codeclimate.com/github/wavesoftware/puppet-xtreemfs) [](http://inch-ci.org/github/wavesoftware/puppet-xtreemfs)
##### Development branch
[](https://travis-ci.org/wavesoftware/puppet-xtreemfs) [](https://gemnasium.com/wavesoftware/puppet-xtreemfs) [](https://coveralls.io/r/wavesoftware/puppet-xtreemfs?branch=develop) [](http://sonar-ro.wavesoftware.pl/dashboard/index/2687) [](https://codeclimate.com/github/wavesoftware/puppet-xtreemfs) [](http://inch-ci.org/github/wavesoftware/puppet-xtreemfs)
Table of Contents
-----------------
1. [Overview - What is the XtreemFS module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with XtreemFS module](#setup)
* [Configuring the installation](#configuring-the-installation)
4. [Usage - How to use the module for various tasks](#usage)
* [Creating a volume](#creating-a-volume)
* [Managing mounts](#managing-mounts)
* [Replication](#replication)
* [Automatic replication](#automatic-replication)
5. [Tests - how to perform unit and acceptance tests](#tests)
6. [Contributing - how to send your work?](#contributing)
Overview
--------
The XtreemFS module allows you to easily manage XtreemFS installation, volumes and mounts with Puppet.
Module Description
-------------------
XtreemFS is a fault-tolerant distributed file system for all storage needs. The xtreemfs module allows you to manage XtreemFS packages and services on several operating systems, while also supporting basic management of XtreemFS volumes and mounts. The module offers support for basic management of replication settings.
Setup
-----
**What wavesoftware/xtreemfs affects:**
* package/service/configuration files for XtreemFS
* listened-to ports
###Configuring the installation
The main configuration you'll need to do will be around the `xtreemfs::role::directory`, `xtreemfs::role::metadata` and `xtreemfs::role::storage` classes. The default parameters are reasonable.
####To manage a XtreemFS with sane defaults on one server:
```puppet
include xtreemfs::role::directory
include xtreemfs::role::metadata
include xtreemfs::role::storage
```
####Hiera configuration
- `xtreemfs::settings::dir_host`
- Provide an host to where metadata and storage nodes will be connecting, defaults: `$::fqdn`
- `xtreemfs::settings::dir_port`
- A port for directory service connection
- `xtreemfs::settings::dir_protocol`
- A protocol for directory service connection
- `xtreemfs::settings::object_dir`
- A direcory where storage nodes will hold their replicated data. Good idea is to provide a directory on secure RAID drive, defaults: `/var/lib/xtreemfs`
- `xtreemfs::settings::install_packages`
- If set to `true` will install packages of XtreemFS, defaults: `true`di
- `xtreemfs::settings::add_repo`
- If set to `true` will add to system repository for XtreemFS, defaults: `true`
- `xtreemfs::settings::properties`
- A properties hash to provide configuration options in form exactly like: http://www.xtreemfs.org/xtfs-guide-1.5/index.html#tth_sEc3.2.6
####For distributed without hiera
Directory service
```puppet
# In this example fqdn is dir.vagrant.dev
include xtreemfs::role::directory
```
Metadata server
```puppet
class { 'xtreemfs::role::metadata':
dir_host => 'dir.vagrant.dev',
}
```
Storage node(s)
```puppet
class { 'xtreemfs::role::storage':
dir_host => 'dir.vagrant.dev',
object_dir => '/mnt/sdb1/xtreem', # actual object will be in: /mnt/sdb1/xtreem/objs
}
```
Client(s)
Described in usage section.
Usage
-----
###Creating a volume
There are many ways to set up a XtreemFS volume using the `xtreemfs::volume` definition. For instance, to set up simple volume on default parameters:
```puppet
xtreemfs::volume { 'myVolume':
ensure => 'present',
dir_host => 'dir.vagrant.dev',
}
```
In this example, you would create volume with default parameters.
###Managing mounts
To manage mount point:
```puppet
xtreemfs::mount { '/mnt/xtreemfs':
ensure => 'mounted',
volume => 'myVolume',
dir_host => 'dir.vagrant.dev',
}
```
In this example, you would mount an existing volume into `/mnt/xtreemfs` directory that already exists.
###Replication
To replicate an existing file for ex.: `/mnt/xtreemfs/centos7.iso` inside the XtreemFS mount point, use:
```puppet
xtreemfs::replicate { '/mnt/xtreemfs/centos7.iso':
policy => 'WqRq',
factor => 2, # Required storage nodes
}
```
###Automatic replication
To automatically replicate new files in XtreemFS mount point you can set a policy for directory. This will not affect existing files. Take a look at example usage:
```puppet
xtreemfs::policy { '/mnt/xtreemfs':
policy => 'WqRq', # Replicate policy
factor => 2, # Required storage nodes
striping_policy => 'RAID0', # Actually only one supported by XtreemFS
stripe_count => 1, # Number of storage servers used for striping
stripe_size => 128, # The size of an individual stripe in KiB
}
```
### Tests
There are two types of tests distributed with the module. Unit tests with rspec-puppet and system tests using rspec-system.
For unit testing, make sure you have:
* rake
* bundler
Install the necessary gems (gems will be downloaded to private `.vendor` directory):
```shell
bundle install --path .vendor
```
And then run the unit tests:
```shell
bundle exec rake spec
```
The unit tests are ran in Travis-CI as well, if you want to see the results of your own tests register the service hook through Travis-CI via the accounts section for your Github clone of this project.
If you want to run the system acceptance tests, make sure you also have:
* vagrant > 1.2.x
* Virtualbox > 4.2.10
Then run the tests using:
```shell
bundle exec rake acceptance
```
To run the tests on different operating system, see the sets available in `spec/acceptance/nodesets/` and run the specific set with the following syntax:
```shell
bundle exec rake acceptance RS_SET=debian-76-x64
```
You can also run system acceptance tests against Docker containers. If you want to do this, make sure you also have:
* docker > 1.0.0
To run the the test on docker container use:
```shell
bundle exec rake acceptance RS_SET=centos-65-x64-docker
```
###Contributing
Contributions are welcome!
To contribute, follow the standard [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) of:
1. Fork it
1. Create your feature branch (`git checkout -b feature/my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin feature/my-new-feature`)
1. Create new Pull Request
Even if you can't contribute code, if you have an idea for an improvement please open an [issue](https://github.com/wavesoftware/puppet-xtreemfs/issues).