Veeam:

a cookbook to deploy Veeam Backup and Replication server

This cookbook installs and configures Veeam Backup and Replication based on documented Veeam best practices. The cookbook includes recipes to deploy all components of the solution as well as the optional Explorers.

Note: Veeam prerequisites requires that Microsoft .NET Framework 4.5.2 be installed on the host. As part of the installation, a reboot is required and will automatically be handled by the resource

Table of Contents

generated with DocToc

• Requirements
  • Platforms
  • Chef
  • Cookbooks
• Attributes
  • Installation Media
  • Catalog
  • Server
  • Console
• Veeam Backup and Replication ISO
• Veeam Backup and Replication License file
• Resource/Provider
  • Veeam_Prerequisites
  • Veeam_Catalog
  • Veeam_Console
  • Veeam_Server
  • Veeam_Explorer
• Usage
  • default
  • catalog recipe
  • server recipe
  • console recipe
  • server_with_catalog recipe
  • server_with_console recipe
  • standalone_complete recipe
• Upload to Chef Server
• Matchers/Helpers
  • Matchers
  • Veeam::Helper
  • Windows_Helper
• Cookbook Testing
  • Before you begin
  • Data_bags for Test-Kitchen
  • Rakefile and Tasks
  • Chefspec and Test-Kitchen
  • Compliance Profile
• Contribute
• License and Author

Requirements

Platforms

• Windows Server 2012
• Windows Server 2012R2
• Windows Server 2016

Windows 2008R2 and lower is not supported.

Chef

• Chef 12.5+

Cookbooks

• windows

Attributes

Installation Media

Catalog

Server

Console

Veeam Backup and Replication ISO

The attribute node['veeam']['version'] is used to evaluate the ISO download path and checksum for the installation media. When provided, the version selected will be downloaded based on the value found in libraries/helper.rb. This media path can be overridden by providing the appropriate installation media attributes - node['veeam']['installer']['package_url'] and node['veeam']['installer']['package_checksum']. By default, these attributes are nil and the system will download the ISO every time.

Veeam Backup and Replication License file

The server must be licensed to unlock the full potential of the application. The attribute node['veeam']['server']['evaluation'] should be configured as false. To license, choose one of the below options.

1. Save the license file on a web server to which the Veeam Backup and Replication server can access. Set the node['veeam']['license_url'] attribute to include the full path to the license file.
2. Encode the license file as a Base64 string and create a new DataBag veeam with an Item license. Add the key license with the value as the Base64 encoded string.

{
  "id": "license",
  "license": "base64_encoded_license"
}

Resource/Provider

Veeam_Prerequisites

Installs the required resoures to support Veeam applications. Included in this resource:
- .NET Framework 4.5.2
- Microsoft SQL Server System CLR Types (x64)
- Microsoft SQL Server Management Objects (x64)
- Microsoft SQL Server (64-bit) [optional]

Actions:

• :install - Installs all of the prerequisites and optionally installs SQL Express

Properties:

NOTE: properties in bold are required
* version - Installation version. Will determine ISO download path if package_url is nil
* package_url - Full URL to the installation media
* package_checksum - sha256 checksum of the installation media
* install_sql - Determines if SQL Express should be installed as part of adding the prerequisites.
* package_name - FUTURE property
* share_path - FUTURE property

Examples:

# Install default Prerequisite tools including SQL Express
veeam_prerequisites 'Install Veeam Prerequisites' do
  version '9.0'
  install_sql true
  action :install
end

# Install default Prerequisite tools but no SQL Express using a custom url
veeam_prerequisites 'Install Veeam Prerequisites' do
  package_url 'http://myartifactory/Veeam/installationmedia.iso'
  package_checksum 'sha256checksum'
  action :install
end

Veeam_Catalog

Installs the Veeam Catalog Service

Actions:

• :install - Installs the Veeam Backup Catalog service

Properties:

NOTE: properties in bold are required

• version - Installation version. Will determine ISO download path if package_url is nil
• package_url - Full URL to the installation media
• package_checksum - sha256 checksum of the installation media
• install_dir - Sets the install directory for the Veeam Backup Catalog service
• vm_catalogpath - Specifies a path to the catalog folder where index files must be stored
• vbrc_service_user - Specifies a user account under which the Veeam Guest Catalog Service will run
• vbrc_service_password - Specifies a password for the account under which the Veeam Guest Catalog Service will run
• vbrc_service_port - Specifies a TCP port that will be used by the Veeam Guest Catalog Service. By default, port number 9393 is used
• keep_media - When set to true, the downloaded ISO will not be deleted. This is helpful if you are installing multiple services on a single node.
• package_name - FUTURE property
• share_path - FUTURE property

Examples:

# A quick install of the catalog accepting all of the defaults
veeam_catalog 'Install Veeam Backup Catalog' do
  version '9.0'
  action :install
end

# A quick install of the catalog accepting all of the defaults using a custom url
veeam_catalog 'Install Veeam Backup Catalog' do
  package_url 'http://myartifactory/Veeam/installationmedia.iso'
  package_checksum 'sha256checksum'
  action :install
end

# Install of the catalog with a custom the service user set to a domain service account
veeam_catalog 'Install Veeam Backup Catalog' do
  version '9.0'
  vbrc_service_user 'mydomain\_srvcuser'
  vbrc_service_password 'myPassword1'
  action :install
end

Veeam_Console

Installs the Veeam Backup and Replication Console

Actions:

• :install - Installs the Veeam Backup and Replication Console service

Properties:

NOTE: properties in bold are required

• version - Installation version. Will determine ISO download path if package_url is nil
• package_url - Full URL to the installation media
• package_checksum - sha256 checksum of the installation media
• accept_eula - Must be set to true or the server will not install. Since we can download the media directly, it is a good idea to enforce the EULA. Default = false
• install_dir - Sets the install directory for the Veeam Backup console service
• keep_media - When set to true, the downloaded ISO will not be deleted. This is helpful if you are installing multiple services on a single node.
• package_name - FUTURE property
• share_path - FUTURE property

Examples:

# A quick install of the console accepting all of the defaults
veeam_console 'Install Veeam Backup console' do
  version '9.0'
  accept_eula true
  action :install
end

# A quick install of the console accepting all of the defaults using a custom url
veeam_console 'Install Veeam Backup console' do
  package_url 'http://myartifactory/Veeam/installationmedia.iso'
  package_checksum 'sha256checksum'
  accept_eula true
  action :install
end

# Install of the console with to a custom installation directory
veeam_console 'Install Veeam Backup console' do
  version '9.0'
  install_dir 'C:\Veeam\Console'
  accept_eula true
  action :install
end

Veeam_Server

Installs the Veeam Backup and Replication Service

Actions:

• :install - Installs the Veeam Backup and Replication service

Properties:

NOTE: properties in bold are required

• version - Installation version. Will determine ISO download path if package_url is nil
• package_url - Full URL to the installation media
• package_checksum - sha256 checksum of the installation media
• accept_eula - Must be set to true or the server will not install. Since we can download the media directly, it is a good idea to enforce the EULA. Default = false
• install_dir - Sets the install directory for the Veeam Backup and Replication service
• evaluation - Determines if the Veeam Backup and Replication server should be installed using Evaluation Mode or if a license should be attached.
• vbr_check_updates - Specifies if you want Veeam Backup & Replication to automatically check for new product patches and versions.
• vbr_service_user - Specifies a user account under which the Veeam Guest Backup Service will run
• vbr_service_password - Specifies a password for the account under which the Veeam Guest Backup Service will run
• vbr_service_port - Specifies a TCP port that will be used by the Veeam Guest Backup Service. By default, port number 9392 is used
• vbr_secure_connections_port - Specifies a SSL port that will be used by the Veeam Guest Backup Service. By default, port number 9401 is used
• vbr_sqlserver_server - Specifies a Microsoft SQL server and instance on which the configuration database will be deployed. By default, Veeam Backup & Replication uses the (local)\VEEAMSQL2012 server. If not included or set, the recipe will install SQLExpress 2012 on the node.
• vbr_sqlserver_database - Specifies a name of the configuration database to be deployed, by default, VeeamBackup.
• vbr_sqlserver_auth - Specifies if you want to use the SQL Server authentication mode to connect to the Microsoft SQL Server where the Veeam Backup & Replication is deployed. Supported Values are Windows or Mixed
• vbr_sqlserver_username - This parameter must be used if you have specified the VBR_SQLSERVER_AUTHENTICATION parameter. Specifies a LoginID to connect to the Microsoft SQL Server in the SQL Server authentication mode.
• vbr_sqlserver_password - This parameter must be used if you have specified the VBR_SQLSERVER_AUTHENTICATION parameter. Specifies a password to connect to the Microsoft SQL Server in the SQL Server authentication mode.
• pf_ad_nfsdatastore - Specifies the vPower NFS root folder to which Instant VM Recovery cache will be stored. By default, the C:\ProgramData\Veeam\Backup\NfsDatastore\ folder is used.
• keep_media - When set to true, the downloaded ISO will not be deleted. This is helpful if you are installing multiple services on a single node.
• package_name - FUTURE property
• share_path - FUTURE property

Examples:

# A quick install of the backup service accepting the EULA and all of the defaults
veeam_server 'Install Veeam Backup Server' do
  version '9.0'
  accept_eula true
  action :install
end

# A quick install of the backup service accepting the EULA and all of the defaults using a custom url
veeam_server 'Install Veeam Backup Server' do
  package_url 'http://myartifactory/Veeam/installationmedia.iso'
  package_checksum 'sha256checksum'
  accept_eula true
  action :install
end

# Install of the Backup and Replication service with a custom the service user set to a domain service account
veeam_server 'Install Veeam Backup Catalog' do
  version '9.0'
  accept_eula true
  vbr_service_user 'mydomain\_srvcuser'
  vbr_service_password 'myPassword1'
  action :install
end

Veeam_Explorer

Installs the Veeam Backup and Replication Explorers

Actions:

• :install - Installs the Veeam Backup and Replication Console service

Properties:

NOTE: properties in bold are required

• version - Installation version. Will determine ISO download path if package_url is nil
• package_url - Full URL to the installation media
• package_checksum - sha256 checksum of the installation media
• keep_media - When set to true, the downloaded ISO will not be deleted. This is helpful if you are installing multiple services on a single node.
• explorers - List of Veeam Backup Explorers to be installed.
• package_name - FUTURE property
• share_path - FUTURE property

Examples:

# A quick install of the Active Directory Explorer accepting all of the defaults
veeam_explorer 'Veeam Explorer for Microsoft Active Directory' do
  version '9.0'
  explorers 'ActiveDirectory'
  action :install
end

# A quick install of the SQL Server Explorer accepting all of the defaults using a custom url
veeam_explorer 'Veeam Explorer for Microsoft SQL Server' do
  package_url 'http://myartifactory/Veeam/installationmedia.iso'
  package_checksum 'sha256checksum'
  explorers 'SQL'
  action :install
end

Usage

default

This is an empty recipe and should not be used

catalog recipe

Installs and configures Veeam Backup and Replication Catalog service using the default configuration including pre-requisites

server recipe

Installs and configures Veeam Backup and Replication Server service using the default configuration including pre-requisites and SQLExpress

console recipe

Installs and configures Veeam Backup and Replication Console using the default configuration including pre-requisites

server_with_catalog recipe

Installs and configures Veeam Backup and Replication Server & Catalog using the default configuration including pre-requisites and SQLExpress

server_with_console recipe

Installs and configures Veeam Backup and Replication Server & Console using the default configuration including pre-requisites and SQLExpress. Also installs all of the Veeam Backup Explorers

standalone_complete recipe

Installs and configures Veeam Backup and Replication Server, Console & the Catalog service using the default configuration including pre-requisites and SQLExpress. Also installs all of the Veeam Backup Explorers

Upload to Chef Server

This cookbook should be included in each organization of your CHEF environment. When importing, leverage Berkshelf:

berks upload

NOTE: use the --no-ssl-verify switch if the CHEF server in question has a self-signed SSL certificate.

berks upload --no-ssl-verify

Matchers/Helpers

Matchers

Note: Matchers should always be created in libraries/matchers.rb and used for validating calls to LWRP

Tests the LWRP (veeam_catalog) with an action
* install_veeam_catalog(resource_name)
* install_veeam_console(resource_name)
* install_veeam_server(resource_name)
* install_veeam_prerequisites(resource_name)
* install_veeam_explorer(resource_name)

Veeam::Helper

Note: A helper to handle common and repeated functions

check_os_version

Determines if the current node meets the OS type and requirements. If False, then raise an Argument Errors depending if the node['platform_version'] or node['kernel']['machine'] are wrong.
```

usage in a custom_resource

veeam = Veeam::Helper
veeam.check_os_version(node)
```

find_package_url(version)

Uses the supplied version identifier to return the stored URL location of the installation media. This method calls the package_list method to identify the correct information
```

usage in a custom_resource

veeam = Veeam::Helper
package_url = veeam.find_package_url(new_resource.version)
```

find_package_checksum(version)

Uses the supplied version identifier to return the stored checksum for the installation media. This method calls the package_list method to identify the correct information
```

usage in a custom_resource

veeam = Veeam::Helper
package_checksum = veeam.find_package_checksum(new_resource.version)
```

prerequisites_list

Returns an array of version specific prerequisite package versions
```

usage in a custom_resource

veeam = Veeam::Helper
prerequisites_list = veeam.prerequisites_list(new_resource.version)
```

explorers_list

Returns an array of version specific explorer package versions
```

usage in a custom_resource

veeam = Veeam::Helper
explorers_list = veeam.explorers_list(new_resource.version)
```

Windows_Helper

Testing with ChefSpec on Linux or Mac for specific Windows items such as register, Win32, etc can cause failures in the testing. Included in this library is a helper file designed to stub and mock out these calls.

The file is located at spec/windows_helper.rb

Cookbook Testing

Before you begin

Setup your testing and ensure all dependencies are installed. Open a terminal windows and execute:

gem install bundler
bundle install
berks install

Data_bags for Test-Kitchen

This cookbook requires the use of a data_bag for setting certain values. Local JSON version need to be stored in the directory structure as indicated below:

├── chef-repo/
│   ├── cookbooks
│   │   ├── veeam
│   │   │   ├── .kitchen.yml
│   ├── data_bags
│   │   ├── data_bag_name
│   │   │   ├── data_bag_item.json

Note: Storing local testing versions of the data_bags at the root of your repo is considered best practice. This ensures that you only need to maintain a single copy while protecting the cookbook from being accientally committed with the data_bag. However, if you must change this location, then update the following key in the .kitchen.yml file.

data_bags_path: "../../data_bags/"

Rakefile and Tasks

This repo includes a Rakefile for common tasks

Chefspec and Test-Kitchen

1. bundle install: Installs and pulls all ruby gems dependencies from the Gemfile.

2. berks install: Installs all cookbook dependencies based on the [Berksfile](Berksfile) and the [metadata.rb](metadata.rb)

3. rake: This will run all of the local tests - syntax, lint, unit, and maintainers file.

4. rake integration: This will run all of the kitchen tests

Compliance Profile

Included in this cookbook is a set of Inspec profile tests used for the Windows 2012 and greater Test-Kitchen. These profiles can also be loaded into Chef Compliance to ensure on-going validation. The Control files are located at test/inspec/suite_name

• test/inspec/9.0.0.902/catalog
• test/inspec/9.0.0.902/console
• test/inspec/9.0.0.902/server
• test/inspec/9.5.0.711/catalog
• test/inspec/9.5.0.711/console
• test/inspec/9.5.0.711/server

Contribute

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request

License and Author

Note: This cookbook is not officially supported by or released by Veeam Software, Inc.

• Author:: Exosphere Data, LLC (chef@exospheredata.com)

Copyright 2017 Exosphere Data, LLC
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.