Version information
released Jan 24th 2016
This version is compatible with:
- , FreeBSD
Start using this module
Add this module to your Puppetfile:
mod 'brainsware-s3ql', '1.1.0'Learn more about managing modules with a PuppetfileDocumentation
brainsware/s3ql — version 1.1.0 Jan 24th 2016
Table of Contents
- Overview
- Setup - The basics of getting started with s3ql
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This is a puppet module to manage s3ql installation, authentication configuration and mounts.
Setup
What s3ql affects
- This module will install 2.x version of s3ql from upstream repositories if you so chose
- It will run a python daemon as the owning user per filesystem mount
- That daemon will connect to the cloud
Beginning with s3ql
puppet-s3ql cannot help you setup an S3 or Google Storage account, or take the prerequisite steps to be able to use them as backends.
This first iteration will not support an initial formatting so you'll have to do that, too. It does support creating authinfo files though.
Usage
First, let's install it:
# only on Ubuntu:
# apt::ppa { 'ppa:nikratio/s3ql': }
# everywhere:
include s3ql
Next, we can setup our authentication:
s3ql::authinfo { 'gs backend for www-data fluffy bucket':
backend => 'gs',
storage_url => 'gs://fluffy/example',
backend_login => 'oauth2',
backend_password => 'actually a very long and secure oauth token',
fs_passphrase => 'also a very long and very secure passphrase for encrypting this filesystem',
}
And finally, we can mount it:
s3ql_mount { '/srv/web/example/htdocs/uploads':
ensure => 'present',
owner => 'www-data',
group => 'www-data',
storage_url => 'gs://fluffy/example',
}
Reference
s3ql
This class is only responsible for installing the s3ql package
s3ql::package_name
Name of the s3ql package. Default: s3ql
s3ql::package_ensure
Whether to install or remove, or keep the s3ql package in specific version. Default: present
s3ql::package_provider
Maybe some day s3ql will be easily installable via pip then you can override this parameter. Default: undef
s3ql::authinfo
This defined type creates ~/.s3ql/authinfo2 files, storing credentials to the
various backends. It's basically just a very thin wrapper around
ini_setting :)
s3ql::authinfo::ensure
Whether to add or remove this entry. Default: present
s3ql::authinfo::owner
s3ql::authinfo::group
s3ql::authinfo::home
Owner, group and HOME have to be set. HOME should point to the fully-qualified path of ~/.s3ql.
Default: 0, and /root/.s3ql
s3ql::authinfo::manage_home
Whether to create the user's .s3ql home directory. Default: false
s3ql::authinfo::backend
Which backend to configure. Can be gs, s3, etc...
s3ql::authinfo::storage_url
The storage-url for which these credentials are valid.
s3ql::authinfo::backend_login
s3ql::authinfo::backend_password
The login and password. For gs there's a special backend-login oauth2
which activates OAuth authentication.
s3ql::authinfo::fs_passphrase
The passphrase with which this filesystem is encrypted.
s3ql_mount
s3ql_mount creates mount.s3ql mounts. It can be used with puppet resource.
s3ql_mount::mountpoint
The path to the mountpoint. Default: name
s3ql_mount::storage_url
The storage-url to mount
s3ql_mount::backend_login
The backend-login for the specified storage-url. If ommited, it will be read from authfile.
s3ql_mount::backend_password
The backend-login for the specified storage-url. If ommited, it will be read from authfile.
s3ql_mount::fs_passphrase
The fs-passphrase for the specified storage-url. If ommited, it will be read from authfile.
s3ql_mount::backend_options
Additional options passed to mount.s3ql when mounting this filesystem.
s3ql_mount::owner
The owner this filesytem will belong to. (normalized to uid). Default: 0
s3ql_mount::group
The group this filesytem will belong to. (normalized to gid). Default: 0
s3ql_mount::home
The fully-qualified path to the ~/.s3ql home dir
This directory will be used cache directory, and as base for the authinfo2 searchpath.
This parameter is not entirely discoverable. It will default to $HOME/.s3ql,
but this might be wrong for users who have no $HOME, for instance.
s3ql_mount::backend
The backend used. This property is read-only.
Limitations
Given the rather clumsy installation on RHEL (or rather: the lack of package repositories), this module will currently only work properly on:
- Archlinux
- Debian
- FreeBSD
- Gentoo
- OS X
- Ubuntu
Development
If you find a way to install this module painfree under RHEL, I would very happily accept your patch! Please follow our guidlines in CONTRIBUTING.md.
Types in this module release
2016-01-24 Release 1.1.0
Production Ready release
After doing lots of testing… in production, this release is now ready to be used by the general public!
The most important fix is that now everything defaults to root, which makes things actually work for users who aren't root, or the mount owner.
2015-09-19 Release 1.0.0
Initial release
This marks the initial release of the module. From the general look and feel it's complete, and what is complete is completely tested.
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
- puppetlabs-inifile (>= 1.4.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.