Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdf/zfs_linux-cookbook
Split from https://github.com/biola/chef-cookbooks
https://github.com/pdf/zfs_linux-cookbook
Last synced: about 2 months ago
JSON representation
Split from https://github.com/biola/chef-cookbooks
- Host: GitHub
- URL: https://github.com/pdf/zfs_linux-cookbook
- Owner: pdf
- Created: 2014-08-26T06:03:09.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-08-26T06:03:46.000Z (over 10 years ago)
- Last Synced: 2023-03-10T20:53:06.084Z (almost 2 years ago)
- Language: Ruby
- Size: 133 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
zfs\_linux Cookbook
==================
Installs & configures zfs on linux. Currently only targeting Ubuntu.
Requirements
------------
Ubuntu 12.04+
Usage
-----
#### zfs\_linux::default
Just include `zfs_linux` in your node's `run_list`:
```json
{
"name":"my_node",
"run_list": [
"recipe[zfs_linux]"
]
}
```
#### zfs\_linux::auto-snapshot
Installs the zfs-auto-snapshot package, which automatically sets up rotating snapshots (hourly snapshots kept for a day, daily snapshots kept for a month, etc).
#### zfs\_linux::snapshot-pruning
Complements the auto-snapshot recipe by providing a mechanism (via attributes) for controlling how many snapshots are retained on a daily basis. This recipe is included in the default recipe, as action is only taken if attributes like the following are set:
```json
"zfs": {
"filesystems": [
{
"zfsfilesytem1": {
"zpool": "zpool1",
"snapshot_retention": {
"monthly": "3",
"weekly": "2",
"daily": "15"
}
}
},
...
]
}
```
The retention values (each are optional) dicate the number of the most recent snapshots to keep. So in the example above, each day the snapshots of zpool1/zfsfilesystem1 will be evaluated and only the 15 most recent daily snapshots will be kept, etc. For any given snapshot type you can set the value to "0" to have all snapshots of that type deleted.
#### zfs\_linux::auto-scrub
Uses cron.d (via the cron cookbook) to setup cron jobs on Sunday morning for each zpool. If greater than 4 zpools are present, runs the checks once a month on the first Sunday.
#### zfs\_linux::source
Since the released version of ZoL is getting a little old, this recipe was developed to install it from source. Apply it to your node to pull down the ZFS revision from git (specified in your node's attributes).
__WARNING:__ On Debian-family systems, the current build method will disable automatic updates for your kernel because the ZoL packages will be built for the kernel that is running at the time of compilation. Do not apply this without a process in place for monitoring security updates and applying them manually in the following manner:
1. Update your system kernel packages
2. Disable the auto-start of any services that depend on your ZoL-mounted volumes
3. Reboot into the new kernel
4. Delete the zfs & spl directories in /var/chef/cache/
5. Perform a chef-client run
6. Enable auto-start again for your node's services
7. Reboot
#### zfs\_linux::backblaze4
Hardware support for the "Backblaze Storage Pod 4.0", notably the R750 HBA. See warning in zfs\_linux::source regarding the hold on kernel updates this may place on your system.
Support has been added for the optional installation of the "Non-RAID Web Management GUI" from (HighPoint Technologies, Inc.)[http://www.highpoint-tech.com/USA_new/series_r750-Download.htm]. To enable this, perform the following:
1. Download the (Linux Web GUI package)[http://www.highpoint-tech.com/USA_new/series_r750-Download.htm].
2. (Optionally) - convert the package into an appropriate format for your system. E.g., Debian-family systems should execute `sudo alien --scripts hptsvr-https-1.0.0-13.0111.x86_64.rpm`.
3. Note the SHA-256 checksum of the package.
3. Upload the installation package to your deployment web server.
4. Set the `['zol']['drivers']['r750_management_pkg']` & `['zol']['drivers']['r750_management_pkg_checksum']` attributes on your node/role to point to the url & checksum for the package.
5. (Optionally) After you've configured your mail settings in the web gui, copy the generated /etc/hptmailset.dat file to your deployment web server and set the `['zol']['drivers']['r750_management_mailsettings']` & `['zol']['drivers']['r750_management_mailsettings_checksum']` attributes to sync mail settings across your nodes.
See the (help site)[http://www.highpoint-tech.com/help/] for more information on using the software.
#### zfs\_linux::hold_samba
Simple support recipe to support custom integrations with Samba (not at all directly related to ZoL, but perhaps more common to large fileservers running ZoL) -- applying this recipe to Debian-family nodes will keep them from auto-updating their Samba packages.
Contributing
------------
1. Fork the repository on Github
2. Create a named feature branch (like `add_component_x`)
3. Write you change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github
License and Authors
-------------------
Copyright 2014, Biola University
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.