adfef39798
This commit updates some examples in the README file to use defines and parameters that aren't deprecated. Change-Id: Iad3a33379a787e74ca6c89748b64e782d723d158
215 lines
5.9 KiB
Markdown
215 lines
5.9 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[](https://governance.openstack.org/tc/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
glance
|
|
=======
|
|
|
|
#### 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. [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 glance module is a part of [OpenStack](https://opendev.org/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.
|
|
|
|
Setup
|
|
-----
|
|
|
|
**What the glance module affects**
|
|
|
|
* [Glance](https://docs.openstack.org/glance/latest/), 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. This is not an exhaustive list of all the components needed, we recommend you consult and understand the [core openstack](https://docs.openstack.org) documentation.
|
|
|
|
**Define a glance node**
|
|
|
|
```puppet
|
|
class { 'glance::api::authtoken':
|
|
password => '12345',
|
|
auth_url => 'http://172.17.0.3:5000',
|
|
www_authenticate_uri => 'http://172.17.0.3:5000',
|
|
}
|
|
|
|
class { 'glance::api::db':
|
|
database_connection => 'mysql+pymysql://glance:12345@127.0.0.1/glance',
|
|
}
|
|
|
|
class { 'glance::api':
|
|
enabled_backends => ['my_store:file'],
|
|
default_backend => 'my_store:file',
|
|
}
|
|
|
|
glance::backend::multistore::file {
|
|
'my_store': ;
|
|
}
|
|
```
|
|
|
|
**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_url => 'http://172.17.0.3:9292',
|
|
admin_url => 'http://172.17.0.3:9292',
|
|
internal_url => 'http://172.17.1.3:9292',
|
|
region => 'example-west-1',
|
|
}
|
|
```
|
|
|
|
**Setup up notifications for multiple RabbitMQ nodes**
|
|
|
|
```puppet
|
|
class { 'glance::notify::rabbitmq':
|
|
default_transport_url => os_transport_url({
|
|
'transport' => 'rabbit',
|
|
'hosts' => ['host1', 'host2'],
|
|
'username' => 'glance',
|
|
'password' => 'secret',
|
|
'virtual_host' => 'glance',
|
|
)},
|
|
notification_transport_url => os_transport_url({
|
|
'transport' => 'rabbit',
|
|
'hosts' => ['host1', 'host2'],
|
|
'username' => 'notify',
|
|
'password' => 'secret',
|
|
'virtual_host' => 'notify',
|
|
)},
|
|
}
|
|
```
|
|
|
|
### Types
|
|
|
|
#### glance_api_config
|
|
|
|
The `glance_api_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/glance/glance-api.conf` file.
|
|
|
|
```puppet
|
|
glance_api_config { 'DEFAULT/image_cache_dir' :
|
|
value => /var/lib/glance/image-cache,
|
|
}
|
|
```
|
|
|
|
This will write `image_cache_dir=/var/lib/glance/image-cache` in the `[DEFAULT]` section.
|
|
|
|
##### name
|
|
|
|
Section/setting name to manage from `glance-api.conf`
|
|
|
|
##### value
|
|
|
|
The value of the setting to be defined.
|
|
|
|
##### secret
|
|
|
|
Whether to hide the value from Puppet logs. Defaults to `false`.
|
|
|
|
##### ensure_absent_val
|
|
|
|
If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`
|
|
|
|
#### glance_cache_config
|
|
|
|
The `glance_cache_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/glance/glance-cache.conf` file.
|
|
|
|
```puppet
|
|
glance_cache_config { 'DEFAULT/image_cache_stall_time' :
|
|
value => 86400,
|
|
}
|
|
```
|
|
|
|
This will write `image_cache_stall_time=86400` in the `[DEFAULT]` section.
|
|
|
|
##### name
|
|
|
|
Section/setting name to manage from `glance-cache.conf`
|
|
|
|
##### value
|
|
|
|
The value of the setting to be defined.
|
|
|
|
##### secret
|
|
|
|
Whether to hide the value from Puppet logs. Defaults to `false`.
|
|
|
|
##### ensure_absent_val
|
|
|
|
If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`
|
|
|
|
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.
|
|
|
|
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-glance
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* https://github.com/openstack/puppet-glance/graphs/contributors
|
|
|
|
Repository
|
|
----------
|
|
|
|
* https://opendev.org/openstack/puppet-glance
|