Puppet Class: openstack_extras::auth_file

Defined in:
manifests/auth_file.pp

Overview

Class: openstack_extras::auth_file

Creates an auth file that can be used to export environment variables that can be used to authenticate against a keystone server.

Parameters

password

(Required) Password for this account as defined in keystone

auth_url

(Optional) URL to authenticate against Defaults to ‘127.0.0.1:5000/v3/’

service_token

(Optional) Keystone service token NOTE: This setting will trigger a warning from keystone. Authentication credentials will be ignored by keystone client in favor of token authentication. Defaults to undef.

service_endpoint

(Optional) Keystone service endpoint Defaults to ‘127.0.0.1:5000/v3/’

username

(Optional) Username for this account as defined in keystone Defaults to ‘admin’.

project_name

(Optional) Project for this account as defined in keystone Use instead of tenant_name for when using identity v3. Defaults to ‘openstack’.

region_name

(Optional) Openstack region to use Defaults to ‘RegionOne’.

use_no_cache

(Optional) Do not use the auth token cache. Defaults to true.

os_interface

(Optional) The common endpoint to use with OSC Defaults to ‘public’.

os_endpoint_type

(Optional) The common endpoint to use with service-specific clients Defaults to ‘publicURL’.

cinder_endpoint_type

(Optional) The Cinder endpoint to use Defaults to ‘publicURL’.

glance_endpoint_type

(Optional) The Glance endpoint to use Defaults to ‘publicURL’.

keystone_endpoint_type

(Optional) The Keystone endpoint to use Defaults to ‘publicURL’.

nova_endpoint_type

(Optional) The Nova endpoint to use Defaults to ‘publicURL’.

neutron_endpoint_type

(Optional) The Neutron endpoint to use Defaults to ‘publicURL’.

auth_strategy

(Optional) The method to use for authentication Defaults to ‘keystone’.

path

(Optional) File path Defaults to ‘/root/openrc’.

project_domain_name

(Optional) Project domain in v3 api. Defaults to ‘Default’.

user_domain_name

(Optional) User domain in v3 api. Defaults to ‘Default’.

auth_type

(Optional) Authentication type to load. Default to undef.

compute_api_version

(Optional) Compute API version to use. Defaults to undef.

network_api_version

(Optional) Network API version to use. Defaults to undef.

image_api_version

(Optional) Image API version to use. Defaults to undef.

volume_api_version

(Optional) Volume API version to use. Defaults to undef.

identity_api_version

(Optional) Identity API version to use. Defaults to ‘3’.

object_api_version

(Optional) Object API version to use. Defaults to undef.

DEPRECATED PARAMETERS

tenant_name

(Optional) Tenant for this account as defined in keystone Defaults to undef.

Parameters:

  • password (Any)
  • auth_url (Any) (defaults to: 'http://127.0.0.1:5000/v3/')
  • service_token (Any) (defaults to: undef)
  • service_endpoint (Any) (defaults to: 'http://127.0.0.1:5000/v3/')
  • username (Any) (defaults to: 'admin')
  • project_name (Any) (defaults to: 'openstack')
  • region_name (Any) (defaults to: 'RegionOne')
  • use_no_cache (Any) (defaults to: true)
  • project_domain_name (Any) (defaults to: 'Default')
  • user_domain_name (Any) (defaults to: 'Default')
  • auth_type (Any) (defaults to: undef)
  • os_interface (Any) (defaults to: 'public')
  • os_endpoint_type (Any) (defaults to: 'publicURL')
  • cinder_endpoint_type (Any) (defaults to: 'publicURL')
  • glance_endpoint_type (Any) (defaults to: 'publicURL')
  • keystone_endpoint_type (Any) (defaults to: 'publicURL')
  • nova_endpoint_type (Any) (defaults to: 'publicURL')
  • neutron_endpoint_type (Any) (defaults to: 'publicURL')
  • auth_strategy (Any) (defaults to: 'keystone')
  • path (Any) (defaults to: '/root/openrc')
  • compute_api_version (Any) (defaults to: undef)
  • network_api_version (Any) (defaults to: undef)
  • image_api_version (Any) (defaults to: undef)
  • volume_api_version (Any) (defaults to: undef)
  • identity_api_version (Any) (defaults to: '3')
  • object_api_version (Any) (defaults to: undef)
  • tenant_name (Any) (defaults to: undef) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'manifests/auth_file.pp', line 122

class openstack_extras::auth_file (
  $password,
  $auth_url               = 'http://127.0.0.1:5000/v3/',
  $service_token          = undef,
  $service_endpoint       = 'http://127.0.0.1:5000/v3/',
  $username               = 'admin',
  $project_name           = 'openstack',
  $region_name            = 'RegionOne',
  $use_no_cache           = true,
  $project_domain_name    = 'Default',
  $user_domain_name       = 'Default',
  $auth_type              = undef,
  $os_interface           = 'public',
  $os_endpoint_type       = 'publicURL',
  $cinder_endpoint_type   = 'publicURL',
  $glance_endpoint_type   = 'publicURL',
  $keystone_endpoint_type = 'publicURL',
  $nova_endpoint_type     = 'publicURL',
  $neutron_endpoint_type  = 'publicURL',
  $auth_strategy          = 'keystone',
  $path                   = '/root/openrc',
  $compute_api_version    = undef,
  $network_api_version    = undef,
  $image_api_version      = undef,
  $volume_api_version     = undef,
  $identity_api_version   = '3',
  $object_api_version     = undef,
  # DEPRECATED PARAMETERS
  $tenant_name            = undef,
) {

  if $tenant_name != undef {
    warning('tenant_name is deprecated and will be removed in a future release. \
Use project_name instead')
  }

  file { $path:
    owner     => 'root',
    group     => 'root',
    mode      => '0700',
    show_diff => false,
    tag       => ['openrc'],
    content   => template('openstack_extras/openrc.erb')
  }
}