From 8edb8b6e07ac7ce64a70396f54910eda7e93406c Mon Sep 17 00:00:00 2001 From: Ryan Hefner Date: Mon, 27 Apr 2015 18:06:30 -0400 Subject: [PATCH] Add support for NFS Backup Adds support for configuring Cinder to backup volumes to an NFS share. Change-Id: I9b3322699f44543829dfaabfa2373d2163bda494 --- manifests/backup/nfs.pp | 106 +++++++++++++++++++++++++ spec/classes/cinder_backup_nfs_spec.rb | 83 +++++++++++++++++++ 2 files changed, 189 insertions(+) create mode 100644 manifests/backup/nfs.pp create mode 100644 spec/classes/cinder_backup_nfs_spec.rb diff --git a/manifests/backup/nfs.pp b/manifests/backup/nfs.pp new file mode 100644 index 00000000..08f3f59c --- /dev/null +++ b/manifests/backup/nfs.pp @@ -0,0 +1,106 @@ +# == Class: cinder::backup::nfs +# +# Setup Cinder to backup volumes into NFS +# +# === Parameters +# +# [*backup_share*] +# (required) The NFS share to attach to, to be specified in +# fqdn:path, ipv4addr:path, or "[ipv6addr]:path" format. +# +# [*backup_driver*] +# (optional) The backup driver for NFS back-end. +# Defaults to 'cinder.backup.drivers.nfs'. +# +# [*backup_file_size*] +# (optional) The maximum size in bytes of the files used to hold +# backups. If the volume being backed up exceeds this size, then +# it will be backed up into multiple files. This must be a multiple +# of the backup_sha_block_size_bytes parameter. +# Defaults to 1999994880 +# +# [*backup_sha_block_size_bytes*] +# (optional) The size in bytes that changes are tracked for +# incremental backups. +# Defaults to 32768 +# +# [*backup_enable_progress_timer*] +# (optional) Enable or Disable the timer to send the periodic +# progress notifications to Ceilometer when backing up the volume +# to the backend storage. +# Defaults to true +# +# [*backup_mount_point_base*] +# (optional) The base directory containing the mount point for the +# NFS share. +# Defaults to '$state_path/backup_mount' +# +# [*backup_mount_options*] +# (optional) The mount options that are passed to the NFS client. +# Defaults to undef +# +# [*backup_container*] +# (optional) Custom container to use for backups. +# Defaults to undef +# +# [*backup_compression_algorithm*] +# (optional) Compression algorithm to use when writing backup data. +# Defaults to 'zlib' +# +# === Author(s) +# +# Ryan Hefner +# +# === Copyright +# +# Copyright (C) 2015 Ryan Hefner +# +# 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. +# +# +class cinder::backup::nfs ( + $backup_share, + $backup_driver = 'cinder.backup.drivers.nfs', + $backup_file_size = 1999994880, + $backup_sha_block_size_bytes = 32768, + $backup_enable_progress_timer = true, + $backup_mount_point_base = '$state_path/backup_mount', + $backup_mount_options = undef, + $backup_container = undef, + $backup_compression_algorithm = 'zlib', +) { + + validate_string($backup_share) + + if $backup_mount_options { + cinder_config { + 'DEFAULT/backup_mount_options': value => $backup_mount_options; + } + } else { + cinder_config { + 'DEFAULT/backup_mount_options': ensure => absent; + } + } + + cinder_config { + 'DEFAULT/backup_share': value => $backup_share; + 'DEFAULT/backup_driver': value => $backup_driver; + 'DEFAULT/backup_file_size': value => $backup_file_size; + 'DEFAULT/backup_sha_block_size_bytes': value => $backup_sha_block_size_bytes; + 'DEFAULT/backup_enable_progress_timer': value => $backup_enable_progress_timer; + 'DEFAULT/backup_mount_point_base': value => $backup_mount_point_base; + 'DEFAULT/backup_container': value => $backup_container; + 'DEFAULT/backup_compression_algorithm': value => $backup_compression_algorithm; + } + +} diff --git a/spec/classes/cinder_backup_nfs_spec.rb b/spec/classes/cinder_backup_nfs_spec.rb new file mode 100644 index 00000000..92bab079 --- /dev/null +++ b/spec/classes/cinder_backup_nfs_spec.rb @@ -0,0 +1,83 @@ +# === Author(s) +# +# Ryan Hefner +# +# === Copyright +# +# Copyright (C) 2015 Ryan Hefner +# +# 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. +# +# + +require 'spec_helper' + +describe 'cinder::backup::nfs' do + + let :params do + { + :backup_share => '10.0.0.1:/nfs_backup', + } + end + + let :default_params do + { + :backup_driver => 'cinder.backup.drivers.nfs', + :backup_file_size => 1999994880, + :backup_sha_block_size_bytes => 32768, + :backup_enable_progress_timer => true, + :backup_mount_point_base => '$state_path/backup_mount', + :backup_compression_algorithm => 'zlib', + } + end + + shared_examples_for 'cinder backup with nfs' do + let :all_params do + default_params.merge(params) + end + + it 'configures cinder.conf' do + all_params.each_pair do |config,value| + is_expected.to contain_cinder_config("DEFAULT/#{config}").with_value( value ) + end + end + + context 'with optional parameters' do + let (:all_params) { params.merge!({ + :backup_mount_options => 'sec=sys', + :backup_container => 'container', + }) } + + it 'should include optional values' do + is_expected.to contain_cinder_config('DEFAULT/backup_mount_options').with_value(all_params[:backup_mount_options]) + is_expected.to contain_cinder_config('DEFAULT/backup_container').with_value(all_params[:backup_container]) + end + end + end + + context 'on Debian platforms' do + let :facts do + { :osfamily => 'Debian' } + end + + it_configures 'cinder backup with nfs' + end + + context 'on RedHat platforms' do + let :facts do + { :osfamily => 'RedHat' } + end + + it_configures 'cinder backup with nfs' + end +end