Skip to content

Latest commit

 

History

History
70 lines (57 loc) · 1.48 KB

README.md

File metadata and controls

70 lines (57 loc) · 1.48 KB
Raw

Puppet Rclone management module

Puppet module helping with installation and configuration of Rclone

Disclaimer: This module is in early stage of development - everything are subject to change. Any feedback or help is welcomed.

Description

Use this module to automate installation and configuration of Rclone - cloud rsync tool.

Setup

Setup Requirements

Depends on following modules:

  • puppet/archive

Beginning with rclone

class { 'rclone':
  ensure => 'desired rclone version'
}

# configure s3
rclone::config::s3 { 'my_S3':
  access_key_id     => 'AKI...',
  secret_access_key => '...',
  os_user           => 'my_user',
  region            => 'eu-west-1',
}

Usage

See reference guide

Limitations

Module in early stage, anything can break anytime.

Development

Prerequisites: Installed ruby, gem and bundler and also PDK can help.

pdk bundle update
pdk bundle install

Run unit tests

pdk bundle exec rake spec

or with PDK

pdk test unit

Generate reference

bundle exec rake strings:generate:reference

Releasing

Build and release the module to puppet forge (note currently validation and changelog doesn't work)

pdk build
pdk release

Tag the release in git

git tag -a v<version> -m "message"
git push --tags

Bump the version to next devel and make pull request.