Forge Home

rclone

Puppet Rclone management module

3,178 downloads

999 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.0.2 (latest)
  • 0.0.1
released May 7th 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'smarteon-rclone', '0.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add smarteon-rclone
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install smarteon-rclone --version 0.0.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

smarteon/rclone — version 0.0.2 May 7th 2022

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.