puppet-glance/README.md
Denis Egorenko 8b8723d1b6 Update README.md for Glance
Update installing Glance section and update links to Glance on wiki.

Change-Id: I2285a6308837632bfc361bfffcedc0d34ad6ae32
2015-07-31 17:13:11 +03:00

149 lines
4.4 KiB
Markdown

glance
=======
6.0.0 - 2015.1 - Kilo
#### Table of Contents
1. [Overview - What is the glance module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with glance](#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. [Contributors - Those with commits](#contributors)
Overview
--------
The glance module is a part of [OpenStack](https://github.com/openstack), an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects as part of the core software. The module its self is used to flexibly configure and manage the image service for OpenStack.
Module Description
------------------
The glance module is a thorough attempt to make Puppet capable of managing the entirety of glance. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to glance, and database connections. Types are shipped as part of the glance module to assist in manipulation of configuration files.
This module is tested in combination with other modules needed to build and leverage an entire OpenStack software stack. These modules can be found, all pulled together in the [openstack module](https://github.com/stackforge/puppet-openstack).
Setup
-----
**What the glance module affects**
* [Glance](https://wiki.openstack.org/wiki/Glance), the image service for OpenStack.
### Installing glance
puppet module install openstack/glance
### Beginning with glance
To utilize the glance module's functionality you will need to declare multiple resources. The following is a modified excerpt from the [openstack module](https://github.com/stackfoge/puppet-openstack). This is not an exhaustive list of all the components needed, we recommend you consult and understand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core openstack](http://docs.openstack.org) documentation.
**Define a glance node**
```puppet
class { 'glance::api':
verbose => true,
keystone_tenant => 'services',
keystone_user => 'glance',
keystone_password => '12345',
database_connection => 'mysql://glance:12345@127.0.0.1/glance',
}
class { 'glance::registry':
verbose => true,
keystone_tenant => 'services',
keystone_user => 'glance',
keystone_password => '12345',
database_connection => 'mysql://glance:12345@127.0.0.1/glance',
}
class { 'glance::backend::file': }
```
**Setup postgres node glance**
```puppet
class { 'glance::db::postgresql':
password => '12345',
}
```
**Setup mysql node for glance**
```puppet
class { 'glance::db::mysql':
password => '12345',
allowed_hosts => '%',
}
```
**Setup up keystone endpoints for glance on keystone node**
```puppet
class { 'glance::keystone::auth':
password => '12345'
email => 'glance@example.com',
public_address => '172.17.0.3',
admin_address => '172.17.0.3',
internal_address => '172.17.1.3',
region => 'example-west-1',
}
```
**Setup up notifications for multiple RabbitMQ nodes**
```puppet
class { 'glance::notify::rabbitmq':
rabbit_password => 'pass',
rabbit_userid => 'guest',
rabbit_hosts => [
'localhost:5672', 'remotehost:5672'
],
rabbit_use_ssl => false,
}
```
Implementation
--------------
### glance
glance is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
Limitations
------------
* Only supports configuring the file, swift and rbd storage backends.
Beaker-Rspec
------------
This module has beaker-rspec tests
To run the tests on the default vagrant node:
To run:
```shell
bundle install
bundle exec rspec spec/acceptance
```
For more information on writing and running beaker-rspec tests visit the documentation:
* https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module
Development
-----------
Developer documentation for the entire puppet-openstack project.
* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
Contributors
------------
* https://github.com/openstack/puppet-glance/graphs/contributors