- Description
- Setup - The basics of getting started with ravendb
- 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
The ravendb module installs and manages the ravendb server and service on Windows systems.
Ravendb is a NoSQL database.
The ravendb module requires the following:
- Puppet Agent 4.7.1 or later.
- Access to the internet.
- Windows Server 2012/2012R2/2016.
To get started with the ravendb module simply include the following in your manifest:
class { 'ravendb':
package_ensure => 'present',
}This example downloads, installs, and configured the currently pinned version of the ravendb (3.5.4) and ensures the ravendb service is running and in the desired state. After running this you should be able to access the ravendb management studio via http://localhost:8080.
A more advanced configuration including all attributes available:
class { 'ravendb':
package_ensure => 'present',
include_management_tools => true,
management_tools_install_directory => 'C:\\RavenDB Tools',
ravendb_service_name => 'RavenDB',
ravendb_port => 8080,
ravendb_target_environment => 'development',
ravendb_database_directory => 'C:\\RavenDB\\Databases',
ravendb_filesystems_database_directory => 'C:\\RavenDB\\FileSystems',
service_ensure => 'running',
service_enable => true,
service_restart_on_config_change => true,
config => {
'Raven/Esent/DbExtensionSize' => 128,
'Raven/Esent/MaxCursors' => 4096,
'Raven/Esent/MaxVerPages' => 6144,
},
}The above is just an example of the flexibility you have with this module. You will generally never need to specify every or even so many parameters as shown.
Sometimes you might want to install ravendb but not manage the service with puppet.
class { 'ravendb':
package_ensure => 'present',
service_manage => false,
}Sometimes you might want to install ravendb and the management tools along with it if you plan on taking backups on the same server.
class { 'ravendb':
package_ensure => 'present',
include_management_tools => true,
management_tools_install_directory => 'C:\\RavenDB Tools',
}If you find yourself needing to customize ravendb's configuration don't worry because this is covered.
class { 'ravendb':
package_ensure => 'present',
config => {
'Raven/Esent/DbExtensionSize' => 128,
'Raven/Esent/MaxCursors' => 4096,
'Raven/Esent/MaxVerPages' => 6144,
},
}A full list of documented configuration possiblities that exist can be found at https://ravendb.net/docs/article-page/3.5/csharp/server/configuration/configuration-options.
Generally in production you don't want your database to restart in an uncontrolled manner. For Example, If you are not allowed to restart the database during production hours because it would cause downtime. If that is the case then in your production environment you will want to use hiera to set service_restart_on_config_change to false. You can then push out your code changes to production and at some point in the future during a green window trigger a restart of the service using any method you prefer. ( Puppet Tasks/MCollective/WinRM )
class { 'ravendb':
package_ensure => 'present',
service_restart_on_config_change => false,
config => {
'Raven/Esent/DbExtensionSize' => 128,
'Raven/Esent/MaxCursors' => 4096,
'Raven/Esent/MaxVerPages' => 6144,
},
}Parameters are optional unless otherwise noted.
Installs and manages the ravendb server, service, and management tools.
Specifies whether the ravendb package resource should be present. Valid options: 'present', 'absent', and 'installed'.
Default: 'present'.
Specified if management tools should be installed. This includes things like Raven.Smuggler.exe, Raven.Backup.exe, and more.
Default: false.
The full url in which to download the management tools archive (.zip).
Default: 'https://daily-builds.s3.amazonaws.com/RavenDB-3.5.4.Tools.zip'.
Specifies the absolute path on the target system in which to download the ravendb management tools .zip archive to.
Default: 'C:\RavenDB-3.5.4.Tools.zip'.
Specifies the absolute path on the target system to extract the management tools to.
Default: 'C:\RavenDB Tools'.
The name of the RavenDB service.
Default: 'RavenDB'.
The port in which the ravendb service will listen on.
Default: 8080.
The absolute path in which to log the installation process to.
Default: 'C:\RavenDB.install.log'.
The absolute path in which to log the uninstallation process to.
Default: 'C:\RavenDB.uninstall.log'.
The environment in which you are targeting. Valid options: 'development' and 'production'.
Default: 'development'.
The path in which to store database folders into.
Default: 'C:\RavenDB\Databases'.
The path in which to store filesystem database folders into.
Default: 'C:\RavenDB\FileSystems'.
Whether or not the stackify services should be running or stopped. Valid options: 'running' and 'stopped'.
Default: 'running'.
Whether or not the ravendb service should be enabled to start at boot or disabled. Valid options: true, false, manual
Default: 'true'.
Whether ot not to restart the ravendb service when the ravendb configuration file is updated/changed by puppet. (Raven.Server.exe.config)
Default: true.
Which configuration key values pairs should exist in the ravendb configuration file. (Raven.Server.exe.config)
Default: '{}'.
- Fork it ( https://github.com/tragiccode/tragiccode-ravendb/fork )
- 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 a new Pull Request