OpenStack Keystone Puppet Module
Go to file
Zuul d6871860b8 Merge "Fix documentation for Keystone_user_role." 2018-10-29 19:37:21 +00:00
doc Follow the new PTI for document build 2018-02-28 14:42:11 +08:00
examples Fix documentation for Keystone_user_role. 2018-10-19 18:46:48 +02:00
ext Replace port 35357 with 5000 2018-07-18 13:21:48 +02:00
lib Replace port 35357 with 5000 2018-07-18 13:21:48 +02:00
manifests Merge "Add password hash algorithm and rounds config" 2018-10-19 00:56:55 +00:00
releasenotes Merge "Add password hash algorithm and rounds config" 2018-10-19 00:56:55 +00:00
spec Merge "Add password hash algorithm and rounds config" 2018-10-19 00:56:55 +00:00
templates Federation mellon support Web Single Sign-On (SSO) 2017-01-16 22:46:25 +00:00
tests Replace port 35357 with 5000 2018-07-18 13:21:48 +02:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:24 +08:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
.sync.yml Initial msync run for all Puppet OpenStack modules 2015-08-06 20:47:48 +02:00
.zuul.yaml Add puppet-keystone-tripleo-standalone job 2018-10-20 10:48:45 +00:00 Release 8.0.0 2016-03-23 17:08:06 -04:00
Gemfile Load puppet-openstack_spec_helper locally during tests 2018-02-12 10:53:36 +08:00
LICENSE Update LICENSE 2018-04-06 20:14:33 +08:00 Add the missing 'Table of Contents' in README 2018-08-28 13:44:06 +00:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-27 17:38:14 +00:00
bindep.txt modulesync: sync and add nodepool-bionic for beaker 2018-07-18 16:18:30 +02:00
metadata.json Bump version for the start of Stein 2018-08-30 12:09:49 -06:00
setup.cfg Update URLs in documents according to document migration 2017-07-14 12:40:59 +08:00 Add basic structure for ReNo 2016-01-26 14:30:35 -05:00
tox.ini Update min tox version to 2.0 2018-10-16 11:40:17 +08:00

Team and repository tags

Team and repository tags


Table of Contents

  1. Overview - What is the keystone module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with keystone
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits
  8. Release Notes - Release notes for the project
  9. Repository - The project source code repository


The keystone module is a part of 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 itself is used to flexibly configure and manage the identity service for OpenStack.

Module Description

The keystone module is a thorough attempt to make Puppet capable of managing the entirety of keystone. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the keystone 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.


What the keystone module affects

  • Keystone, the identity service for OpenStack.

Installing keystone

puppet module install openstack/keystone

Beginning with keystone

To utilize the keystone 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 documentation.

Define a keystone node

class { 'keystone':
  catalog_type        => 'sql',
  admin_token         => 'random_uuid',
  database_connection => 'mysql://',

# Adds the admin credential to keystone.
class { 'keystone::roles::admin':
  email        => '',
  password     => 'super_secret',

# Installs the service user endpoint.
class { 'keystone::endpoint':
  public_url   => '',
  admin_url    => '',
  internal_url => '',
  region       => 'example-1',

# Remove the admin_token_auth paste pipeline.
# After the first puppet run this requires setting keystone v3
# admin credentials via /root/openrc or as environment variables.
include keystone::disable_admin_token_auth

Leveraging the Native Types

Keystone ships with a collection of native types that can be used to interact with the data stored in keystone. The following, related to user management could live throughout your Puppet code base. They even support puppet's ability to introspect the current environment much the same as puppet resource user, puppet resource keystone_tenant will print out all the currently stored tenants and their parameters.

keystone_tenant { 'openstack':
  ensure  => present,
  enabled => true,
keystone_user { 'openstack':
  ensure  => present,
  enabled => true,
keystone_role { 'admin':
  ensure => present,
keystone_user_role { 'admin@openstack':
  roles => ['admin', 'superawesomedude'],
  ensure => present

These two will seldom be used outside openstack related classes, like nova or cinder. These are modified examples from Class['nova::keystone::auth'].

# Setup the nova keystone service
keystone_service { 'nova':
  ensure      => present,
  type        => 'compute',
  description => 'OpenStack Compute Service',

Services can also be written with the type as a suffix:

keystone_service { 'nova::type':
  ensure      => present,
  description => 'OpenStack Compute Service',

# Setup nova keystone endpoint
keystone_endpoint { 'example-1-west/nova':
   ensure       => present,
   type         => 'compute',
   public_url   => "",
   admin_url    => "",
   internal_url => "",

Endpoints can also be written with the type as a suffix:

keystone_endpoint { 'example-1-west/nova::compute':
   ensure       => present,
   public_url   => "",
   admin_url    => "",
   internal_url => "",

Defining an endpoint without the type is supported in Liberty release for backward compatibility, but will be dropped in Mitaka, as this can lead to corruption of the endpoint database if omitted. See this bug

Setting up a database for keystone

A keystone database can be configured separately from the keystone services.

If one needs to actually install a fresh database they have the choice of mysql or postgres. Use the mysql::server or postgreql::server classes to do this setup, and then the Class['keystone::db::mysql'] or Class['keystone::db::postgresql'] for adding the databases and users that will be needed by keystone.

  • For mysql
class { 'mysql::server': }

class { 'keystone::db::mysql':
  password      => 'super_secret_db_password',
  allowed_hosts => '%',
  • For postgresql
class { 'postgresql::server': }

class { 'keystone::db::postgresql': password => 'super_secret_db_password', }

About Keystone V3 syntax in keystone_user/keystone_tenant/keystone_user_role

A complete description of the syntax available for those resources are in examples/user_project_user_role_composite_namevar.pp

About Keystone V3 and default domain

For users

With Keystone V3, domains made their appearance. For backward compatibility a default domain is defined in the keystone.conf file. All the V2 resources are then assigned to this default domain. The default domain id is by default default associated with the name Default.

What it means is that this user:

keystone_user { 'my_non_full_qualified_user':
  ensure => present

will be assigned to the Default domain.

The same is true for keystone_tenant and keystone_user_role:

keystone_tenant { 'project_one':
  ensure => present

keystone_user_role { 'user_one@project_one':
  ensure => present,
  roles  => ['admin']

will be assigned to the Default domain.

Now, you can change the default domain if you want. But then the puppet resource you defined will have to be fully qualified.

So, for instance, if you change the default domain to be my_new_default, then you'll have to do:

keystone_user { 'full_qualified_user::my_new_default':
  ensure => present
keystone_tenant { 'project_one::my_new_default':
  ensure => present

keystone_user_role { 'user_one::my_new_default@project_one::my_new_default':
  ensure => present,
  roles  => ['admin']

as the module will always assign a resource without domain to the Default domain.

A deprecation warning will be visible in the log when you have changed the default domain id and used an non fully qualified name for your resource.

In Mitaka, a deprecation warning will be displayed any time you use a non fully qualified resource.

After Mitaka all the resources will have to be fully qualified.

For developers

Other modules can try to find user/tenant resources using Puppet's indirection. The rule for the name of the resources are:

  1. fully qualified if domain is not 'Default';
  2. short form if domain is 'Default'

This is for backward compatibility.

Note that, as stated above, the 'Default' domain is hardcoded. It is not related to the real default domain which can be set to something else. But then again, you will have to set the fully qualified name.

You can check spec/acceptance/default_domain_spec.rb to see an example of the behavior described here.



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



The keystone_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/keystone/keystone.conf file.

keystone_config { 'token/expiration' :
  value => 3600,

This will write expiration=3600 in the [token] section.


Section/setting name to manage from keystone.conf


The value of the setting to be defined.


Whether to hide the value from Puppet logs. Defaults to false.


If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>


  • All the keystone types use the CLI tools and so need to be run on the keystone node.

Upgrade warning

  • If you've setup OpenStack using previous versions of this module you need to be aware that it used UUID as the default for the token_format parameter but now defaults to PKI. If you're using this module to manage a Grizzly OpenStack deployment that was set up using a development release of the modules or are attempting an upgrade from Folsom then you'll need to make sure you set the token_format to UUID at classification time.


This module has beaker-rspec tests

To run:

bundle install
bundle exec rspec spec/acceptance


Developer documentation for the entire puppet-openstack project.


Release Notes