Permalink
Browse files

update docs

  • Loading branch information...
Dan Bode
Dan Bode committed Oct 31, 2012
1 parent 879dfa3 commit a9f0d034c6ded9c7e188d7cd3859408efeb73cbe
Showing with 90 additions and 28 deletions.
  1. +62 −17 README.markdown
  2. +19 −11 manifests/api.pp
  3. +3 −0 manifests/client.pp
  4. +6 −0 manifests/init.pp
View
@@ -3,33 +3,78 @@
This module provides a set of manifests that can be used to install and
configure glance.
-It is currently targettting the essex release of OpenStack.
+It is currently targettting the folsom release of OpenStack.
-For Daiblo support, use the Diablo branch.
+Use the essex branch for essex support.
## Platforms
* Ubuntu 11.04 (Natty)
* Ubuntu 11.10 (Oneiric)
* Ubuntu 12.04 (Precise)
-## Quick Start
+## configurations
-The below example shows how the classes from this module can be declared in
-site.pp to install both the glance registry and api services on a node
-identified as glance.
+Glance is configured with the following classes:
-In the below example, the default port for the registy service has been
-overridden from its default value of 9191.
- node glance {
- class { 'glance': }
+ #configures glance::api service
- class { 'glance::registry':
- bind_port => '9393',
- }
+ class { 'glance::api':
+ verbose => $verbose,
+ debug => $verbose,
+ auth_type => 'keystone',
+ auth_port => '35357',
+ auth_host => $keystone_host,
+ keystone_tenant => 'services',
+ keystone_user => 'glance',
+ keystone_password => $glance_user_password,
+ sql_connection => $sql_connection,
+ enabled => $enabled,
+ }
- class { 'glance::api':
- registry_port = '9393',
- }
- }
+ # configures the glance registry
+
+ class { 'glance::registry':
+ verbose => $verbose,
+ debug => $verbose,
+ auth_host => $keystone_host,
+ auth_port => '35357',
+ auth_type => 'keystone',
+ keystone_tenant => 'services',
+ keystone_user => 'glance',
+ keystone_password => $glance_user_password,
+ sql_connection => $sql_connection,
+ enabled => $enabled,
+ }
+
+ # Configure file storage backend
+
+ class { 'glance::backend::file': }
+
+ # Create the Glance db, this should be configured on your mysql server
+ class { 'glance::db::mysql':
+ user => $glance_db_user,
+ password => $glance_db_password,
+ dbname => $glance_db_dbname,
+ allowed_hosts => $allowed_hosts,
+ }
+
+ # configures glance endpoints in keystone
+ # should be run on your keystone server
+ class { 'glance::keystone::auth':
+ password => $glance_user_password,
+ public_address => $glance_public_real,
+ admin_address => $glance_admin_real,
+ internal_address => $glance_internal_real,
+ region => $region,
+ }
+
+for full examples, see the examples directory.
+
+in the module, puppetlabs-openstack, the following classes
+configure parts of glance:
+
+ - openstack::glance # api, file backend, and registry
+ - openstack::keystone # sets up endpoints
+ - openstack::db::mysql # sets up db config
View
@@ -1,31 +1,39 @@
-
#
# == Paremeters:
#
-# $verbose - rather to log the glance api service at verbose level.
-# Optional. Default: false
#
-# $debug - rather to log the glance api service at debug level.
+# * keystone_password Password used to authemn
+#
+# * verbose - rather to log the glance api service at verbose level.
# Optional. Default: false
#
-# $default_store - Backend used to store glance dist images.
-# Optional. Default: file
+# * debug - rather to log the glance api service at debug level.
+# Optional. Default: false
#
-# $bind_host - The address of the host to bind to.
+# * bind_host - The address of the host to bind to.
# Optional. Default: 0.0.0.0
#
-# $bind_port - The port the server should bind to.
+# * bind_port - The port the server should bind to.
# Optional. Default: 9292
#
-# $registry_host - The address used to connecto to the registy service.
+# * registry_host - The address used to connecto to the registy service.
# Optional. Default:
#
-# $registry_port - The port of the Glance registry service.
+# * registry_port - The port of the Glance registry service.
# Optional. Default: 9191
#
-# $log_file - The path of file used for logging
+# * log_file - The path of file used for logging
# Optional. Default: /var/log/glance/api.log
#
+# * auth_type - Type is authorization being used. Optional. Defaults to 'keystone'
+# * auth_host - Host running auth service. Optional. Defaults to '127.0.0.1'.
+# * auth_port - Port to use for auth service on auth_host. Optional. Defaults to '35357'.
+# * auth_protocol - Protocol to use for auth. Optional. Defaults to 'http'.
+# * keystone_tenant - tenant to authenticate to. Optioal. Defaults to admin.
+# * keystone_user User to authenticate as with keystone Optional. Defaults to admin.
+# * enabled Whether to enable services. Optional. Defaults to true.
+# * sql_idle_timeout
+# * sql_connection db conection.
#
class glance::api(
$keystone_password,
View
@@ -1,6 +1,9 @@
#
# Installs the glance python library.
#
+# == parameters
+# * ensure - ensure state for pachage.
+#
class glance::client (
$ensure = 'present'
) {
View
@@ -1,3 +1,9 @@
+#
+# base glacne config.
+#
+# == parameters
+# * package_ensure - ensure state for package.
+#
class glance(
$package_ensure = 'present'
) {

0 comments on commit a9f0d03

Please sign in to comment.