Browse Source

Prepare repository for a Puppet Forge release

  Commit updates README.md with a more consistent template for documentation,
  removes travis.yml since we're on stackfoge now, updates the Modulefile
  for the new release, deletes TODO list, CHANGELOGs deleted in favor of
  summarized release notes in README.md, which will show up on Forge,
  and moves examples to tests to adhere with Puppet Labs Style
  Guide(http://docs.puppetlabs.com/guides/style_guide.html#tests)

Change-Id: Iffa30f6f35b996305f635317fc0770f908e9057e
tags/2.0.0
Cody Herriges 6 years ago
parent
commit
202a27b66a
6 changed files with 113 additions and 128 deletions
  1. 0
    33
      .travis.yml
  2. 0
    22
      CHANGELOG
  3. 10
    10
      Modulefile
  4. 103
    61
      README.md
  5. 0
    2
      TODO
  6. 0
    0
      tests/site.pp

+ 0
- 33
.travis.yml View File

@@ -1,33 +0,0 @@
1
-language: ruby
2
-bundler_args: --without development
3
-before_script:
4
-  - echo $PUPPET_GEM_VERSION | grep '2.6' && git clone git://github.com/puppetlabs/puppetlabs-create_resources.git spec/fixtures/modules/create_resources || true
5
-script: "bundle exec rake spec SPEC_OPTS='--format documentation'"
6
-rvm:
7
-  - 1.8.7
8
-  - 1.9.3
9
-  - ruby-head
10
-branches:
11
-  only:
12
-   - master
13
-   - folsom
14
-   - essex
15
-env:
16
-  - PUPPET_GEM_VERSION="~> 2.6"
17
-  - PUPPET_GEM_VERSION="~> 2.7"
18
-  - PUPPET_GEM_VERSION="~> 3.0"
19
-  - PUPPET_GEM_VERSION="~> 3.1"
20
-matrix:
21
-  allow_failures:
22
-    - rvm: ruby-head
23
-  exclude:
24
-    - rvm: 1.9.3
25
-      env: PUPPET_GEM_VERSION="~> 2.7"
26
-    - rvm: ruby-head
27
-      env: PUPPET_GEM_VERSION="~> 2.7"
28
-    - rvm: 1.9.3
29
-      env: PUPPET_GEM_VERSION="~> 2.6"
30
-    - rvm: ruby-head
31
-      env: PUPPET_GEM_VERSION="~> 2.6"
32
-notifications:
33
-  email: false

+ 0
- 22
CHANGELOG View File

@@ -1,22 +0,0 @@
1
-* 2013-03-19 1.1.0
2
-- update travis matrix (add ruby 1.9, puppet 3.0)
3
-- implement provider changes for purging
4
-- refactor of glance_image native types
5
-- remove /v1 from endpoints
6
-- allow specifying https for public endpoint
7
-- parse credentials out of apt-paste.conf
8
-* 2012-11-02 1.0.0
9
-- Add travisci support to repo
10
-- Remove essex support
11
-- Add folsom support
12
-- Remove file concat
13
-- Add native types for managing all config file
14
-- Remove password defaults
15
-- update multi-region support for compat with keystone 1.0.0
16
-- switch log_verbose,log_debug to debug,verbose
17
-* 2012-10-08 0.1.0
18
-- add enable param for services
19
-- add basic image management
20
-- allow keystone to be on a different host
21
-* 2012-06-07 0.1.0
22
-- initial release

+ 10
- 10
Modulefile View File

@@ -1,13 +1,13 @@
1 1
 name    'puppetlabs-glance'
2
-version '1.1.0'
3
-source  'git://github.com/puppetlabs/puppetlabs-glance'
2
+version '2.0.0'
3
+source  'https://github.com/stackforge/puppet-glance'
4 4
 author  'Puppet Labs'
5
-license 'Apache'
6
-summary 'Glance Puppet Module'
7
-description 'Openstack Glance module for folsom. Tested on Ubuntu Precise and RHEL6'
8
-project_page 'http://github.com/puppetlabs/puppetlabs-glance'
5
+license 'Apache License 2.0'
6
+summary 'Puppet Labs Glance Module'
7
+description 'Puppet module to install and configure the Openstack Glance image service'
8
+project_page 'https://launchpad.net/puppet-openstack'
9 9
 
10
-dependency 'cprice404/inifile', '>= 0.9.0'
11
-dependency 'puppetlabs/keystone', '>= 1.1.0'
12
-dependency 'puppetlabs/mysql', '>= 0.5.0'
13
-dependency 'puppetlabs/stdlib', '>= 2.4.0'
10
+dependency 'cprice404/inifile', '>= 0.10.3'
11
+dependency 'puppetlabs/keystone', '>= 2.0.0'
12
+dependency 'puppetlabs/mysql', '>= 0.6.1'
13
+dependency 'puppetlabs/stdlib', '>= 2.5.0'

+ 103
- 61
README.md View File

@@ -1,82 +1,124 @@
1
-# PuppetLabs Glance module
1
+glance
2
+=======
2 3
 
3
-This module can be used to flexibly configure [glance](http://glance.openstack.org/),
4
-the image service of openstack.
4
+#### Table of Contents
5 5
 
6
-It has been tested with a combination of other modules, and has primarily been
7
-developed as a subcomponent of the [openstack module](https://github.com/stackforge/puppet-openstack)
6
+1. [Overview - What is the glance module?](#overview)
7
+2. [Module Description - What does the module do?](#module-description)
8
+3. [Setup - The basics of getting started with glance](#setup)
9
+4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
10
+5. [Limitations - OS compatibility, etc.](#limitations)
11
+6. [Development - Guide for contributing to the module](#development)
12
+7. [Contributors - Those with commits](#contributors)
13
+8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
8 14
 
9
-It is currently targettting the folsom/grizzly releases of OpenStack.
15
+Overview
16
+--------
10 17
 
11
-## Platforms
18
+The glance module is a part of [Stackforge](https://github.com/stackfoge), 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 image service for Openstack.
12 19
 
13
-* Ubuntu 12.04 (Precise)
14
-* RHEL 6
20
+Module Description
21
+------------------
15 22
 
16
-## configurations
23
+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.
17 24
 
18
-Glance is configured with the following classes:
25
+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/stackfoge/puppet-openstack).
19 26
 
27
+Setup
28
+-----
20 29
 
21
-### configures glance::api service
30
+**What the glance module affects**
22 31
 
23
-    class { 'glance::api':
24
-      verbose           => $verbose,
25
-      debug             => $verbose,
26
-      auth_type         => 'keystone',
27
-      auth_port         => '35357',
28
-      auth_host         => $keystone_host,
29
-      keystone_tenant   => 'services',
30
-      keystone_user     => 'glance',
31
-      keystone_password => $glance_user_password,
32
-      sql_connection    => $sql_connection,
33
-      enabled           => $enabled,
34
-    }
32
+* glance, the image service for Openstack.
35 33
 
36
-### configures the glance registry
34
+### Installing glance
37 35
 
38
-    class { 'glance::registry':
39
-      verbose           => $verbose,
40
-      debug             => $verbose,
41
-      auth_host         => $keystone_host,
42
-      auth_port         => '35357',
43
-      auth_type         => 'keystone',
44
-      keystone_tenant   => 'services',
45
-      keystone_user     => 'glance',
46
-      keystone_password => $glance_user_password,
47
-      sql_connection    => $sql_connection,
48
-      enabled           => $enabled,
49
-    }
36
+    example% puppet module install puppetlabs/glance
50 37
 
51
-### Configure file storage backend
38
+### Beginning with glance
52 39
 
53
-    class { 'glance::backend::file': }
40
+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.
54 41
 
55
-### Create the Glance db, this should be configured on your mysql server
42
+**Define a glance node**
56 43
 
57
-    class { 'glance::db::mysql':
58
-      user          => $glance_db_user,
59
-      password      => $glance_db_password,
60
-      dbname        => $glance_db_dbname,
61
-      allowed_hosts => $allowed_hosts,
62
-    }
44
+```puppet
45
+class { 'glance::api':
46
+  verbose           => 'True',
47
+  keystone_tenant   => 'services',
48
+  keystone_user     => 'glance',
49
+  keystone_password => '12345',
50
+  sql_connection    => 'mysql://glance:12345@127.0.0.1/glance',
51
+}
63 52
 
64
-### configures glance endpoints in keystone
65
-should be run on your keystone server
53
+class { 'glance::registry':
54
+  verbose           => 'True',
55
+  keystone_tenant   => 'services',
56
+  keystone_user     => 'glance',
57
+  keystone_password => '12345',
58
+  sql_connection    => 'mysql://glance:12345@127.0.0.1/glance',
59
+}
66 60
 
67
-    class { 'glance::keystone::auth':
68
-      password         => $glance_user_password,
69
-      public_address   => $glance_public_real,
70
-      admin_address    => $glance_admin_real,
71
-      internal_address => $glance_internal_real,
72
-      region           => $region,
73
-    }
61
+class { 'glance::backend::file': }
62
+```
74 63
 
75
-for full examples, see the examples directory.
64
+**Setup postgres node glance**
76 65
 
77
-in the module, puppet-openstack, the following classes
78
-configure parts of glance:
66
+```puppet
67
+class { 'glance::db::postgresql':
68
+  password => '12345',
69
+}
70
+```
79 71
 
80
-  - openstack::glance    # api, file backend, and registry
81
-  - openstack::keystone  # sets up endpoints
82
-  - openstack::db::mysql # sets up db config
72
+**Setup mysql node for glance**
73
+
74
+```puppet
75
+class { 'glance::db::mysql':
76
+  password      => '12345',
77
+  allowed_hosts => '%',
78
+}
79
+```
80
+
81
+**Setup up keystone endpoints for glance on keystone node**
82
+
83
+```puppet
84
+class { 'glance::keystone::auth':
85
+  password         => '12345'
86
+  public_address   => '172.17.0.3',
87
+  admin_address    => 'admin@example.com',
88
+  internal_address => '172.17.1.3',
89
+  region           => 'example-west-1',
90
+}
91
+```
92
+
93
+Implementation
94
+--------------
95
+
96
+### glance
97
+
98
+glance is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
99
+
100
+Limitations
101
+------------
102
+
103
+* Only supports configuring the file and swift storage backends.
104
+
105
+Development
106
+-----------
107
+
108
+Developer documentation for the entire puppet-openstack project.
109
+
110
+* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
111
+
112
+Contributors
113
+------------
114
+
115
+* https://github.com/stackforge/puppet-glance/graphs/contributors
116
+
117
+Release Notes
118
+-------------
119
+
120
+**2.0.0**
121
+
122
+* Upstream is now part of stackfoge.
123
+* Added postgresql support.
124
+* Various cleanups and bug fixes.

+ 0
- 2
TODO View File

@@ -1,2 +0,0 @@
1
-The glance api file is still massively different between Chris's version and
2
-the version deployed on Precise

examples/site.pp → tests/site.pp View File


Loading…
Cancel
Save