Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-freezer.svg)](https://governance.openstack.org/tc/reference/tags/index.html)

<!-- Change things from this point on -->

freezer
=======

#### Table of Contents

1. [Overview - What is the freezer module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with freezer](#setup)
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Release Notes - Release notes for the project](#release-notes)
8. [Contributors - Those with commits](#contributors)
9. [Repository - The project source code repository](#repository)

Overview
--------

The freezer module is a part of [OpenStack](https://git.openstack.org), an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects not part of the core software.  The module its self is used to flexibly configure and manage the distributed backup restore and disaster recovery as a service platform for OpenStack.

Module Description
------------------

The freezer module is a thorough attempt to make Puppet capable of managing the entirety of freezer.  This includes manifests to provision region specific endpoint and database connections.  Types are shipped as part of the freezer module to assist in manipulation of configuration files.

Setup
-----

**What the freezer module affects**

* [Freezer](https://wiki.openstack.org/wiki/Freezer), the distributed backup restore and disaster recovery as a service platform for OpenStack.

### Installing freezer

    freezer is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install freezer with:
    puppet module install openstack/freezer

### Beginning with freezer

To utilize the freezer module's functionality you will need to declare multiple resources.

Implementation
--------------

### freezer

freezer is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations
------------

* All the freezer types use the CLI tools and so need to be ran on the freezer node.

Beaker-Rspec
------------

This module has beaker-rspec tests

To run the tests on the default vagrant node:

```shell
bundle install
bundle exec rake acceptance
```

For more information on writing and running beaker-rspec tests visit the documentation:

* https://github.com/puppetlabs/beaker-rspec/blob/master/README.md

Development
-----------

Developer documentation for the entire puppet-openstack project.

* https://docs.openstack.org/puppet-openstack-guide/latest/

Release Notes
-------------

* https://docs.openstack.org/releasenotes/puppet-freezer

Contributors
------------

* https://github.com/openstack/puppet-freezer/graphs/contributors

Repository
----------

* https://git.openstack.org/cgit/openstack/puppet-freezer