Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pcfens/puppet-yas3fs

Manage yas3fs with puppet.
https://github.com/pcfens/puppet-yas3fs

Last synced: about 2 months ago
JSON representation

Manage yas3fs with puppet.

Awesome Lists containing this project

README 

        
#puppet-yas3fs



[![Build Status](https://travis-ci.org/pcfens/puppet-yas3fs.png?branch=master)](https://travis-ci.org/pcfens/puppet-yas3fs)



####Table of Contents



1. [Overview](#overview)

2. [Module Description](#module-description)

3. [Setup - The basics of getting started with yas3fs](#setup)

    * [What yas3fs affects](#what-yas3fs-affects)

    * [Beginning with yas3fs](#beginning-with-yas3fs)

4. [Usage - Configuration options and additional functionality](#usage)

    * [Classes and Defined Types](#classes-and-defined-types)

        * [Class: yas3fs](#class-yas3fs)

        * [Defined Type: yas3fs::mount](#defined-type-yas3fs)

5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)

5. [Limitations - OS compatibility, etc.](#limitations)



##Overview



The yas3fs module installs yas3fs, and provides a way to manage S3 mounts.



##Module Description



[yas3fs](https://github.com/danilop/yas3fs) is a python tool used to mount S3

buckets using fuse. yas3fs provides caching, as well as a mechanism for

invalidating caches on other nodes using SQS and SNS.



##Setup



###What yas3fs affects



* fuse package and configuration

* init jobs (sysvinit, upstart or systemd) that are used to manage yas3fs mounts

* python-pip package (optional)



###Beginning with yas3fs



To install fuse, python-pip, and yas3fs

```puppet

class { 'yas3fs': }

```

To install fuse, python-pip, and yas3fs from github source

```puppet

class { 'yas3fs':

  provider: 'vcs',

}

```



If you'd rather provide pip though some other means, set

`install_pip_package` to `false`:

```puppet

class { 'yas3fs':

  install_pip_package => false,

}

```



##Usage



###Classes and Defined Types



####Class: `yas3fs`



The primary module. By default, fuse, python-pip, and yas3fs are installed and

configured.



**Parameters within `yas3fs`**



#####`install_pip_package`



When set to true, the python-pip package is installed. If the parameter is false

then the pip command should be provided by some other means or yas3fs will not

be installed.



#####`init_system`



Defines the type of init script/configuration to install out of `upstart`,

`systemd` or `sysvinit`. If the parameter is unset, autodiscovery takes place.



#####`provider`



Sets if yas3fs should installed from default pip package provider

or if github source is pulled and pip package is built.

Set to 'vcs' to build from github source.

To switch to vcs from yas3fs previously installied pip package

manually intervention is required. Please manually

uninstall previosly installied pip package before switching to

vcs type install.

Default: 'pip'



#####`vcs_remote`



Optionally set yas3fs source code to be other than original

Default: 'https://github.com/danilop/yas3fs.git'



#####`vcs_revision`



Optionally set to use code from a specific commit or branch

Default: 'master'



#####`mounts`



A hash of mounts can be passed (possibly from hiera) as part of the class

declaration.



```puppet

class { 'yas3fs':

  mounts => {

    'example-mount' => {

      's3_url'     => 's3://example-bucket/',

      'local_path' => '/media/s3',

    }

  }

}

```



####Defined Type: `yas3fs::mount`



Mounts a bucket/path using fuse by creating an init job.



```puppet

yas3fs::mount { 'example-mount':

  s3_url     => 's3://example-bucket/',

  local_path => '/media/s3',

  options    => [

    'recheck-s3',

    'uid 1000',

    'gid 1000',

  ]

}

```



**Parameters within `yas3fs::mount`**



#####`ensure`



Control what to do with this mount. Valid values are `mounted` (default), `unmounted`, `absent`,

and `present`.



WARNING: setting ensure to `absent` removes the service configuration, but cannot

verify that the service is stopped.



#####`s3_url`



The S3 URL that should be mounted (e.g. s3://my-bucket/my-path)



#####`local_path`



The location where the S3 bucket should be mounted.



#####`aws_access_key_id` and `aws_secret_access_key`



The credentials to use when connecting to AWS. Credentials can be omitted on EC2

instances with appropriate IAM roles assigned.



#####`options`



An array of command line arguments that should be passed to yas3fs. The leading

dashes can be omitted. A full list of options is in the

[yas3fs documentation](https://github.com/danilop/yas3fs/blob/master/README.md).



##Reference



###Classes



####Public Classes



* [`yas3fs`](#class-yas3fs): Guides the install of yas3fs



####Private Classes



* `yas3fs::config`: Manages the fuse configuration

* `yas3fs::package`: Installs pip, fuse, and yas3fs

* `yas3fs::params`: Manages base parameters



###Defined Types



####Public Defined Types



* `yas3fs::mount`: Manages a single yas3fs mount



##Limitations



yas3fs is written for python 2.6, though there has been a lot of success running

it on 2.7.