Puppet Class: manila::keystone::auth

Defined in:
manifests/keystone/auth.pp

Overview

Class: manila::keystone::auth

Configures Manila user, service and endpoint in Keystone.

Parameters

password

(Required) Password for Manila user.

email

(Optional) Email for Manila user. Defaults to ‘manila@localhost’.

auth_name

(Optional) Username for Manila service. Defaults to ‘manila’.

service_name

(Optional) Name of the service. Defaults to ‘manila’.

service_name_v2

(Optional) Name of the service. Defaults to ‘manilav2’.

configure_endpoint

Should Manila endpoint be configured? Optional. API v1 endpoint should be enabled in Icehouse for compatibility with Nova. Defaults to true

configure_user

(Optional) Should the service user be configured? Defaults to true

configure_user_role

(Optional) Should the admin role be configured for the service user? Defaults to true

configure_service

(Optional) Should the service be configurd? Defaults to True

service_type

(Optional) Type of service. Defaults to ‘share’.

service_description

(Optional) Description for keystone service. Defaults to ‘Manila Service’.

region

(Optional) Region for endpoint. Defaults to ‘RegionOne’.

tenant

(Optional) Tenant for Manila user. Defaults to ‘services’.

roles

(Optional) List of roles assigned to Manila user. Defaults to [‘admin’]

system_scope

(Optional) Scope for system operations. Defaults to ‘all’

system_roles

(Optional) List of system roles assigned to Manila user. Defaults to []

public_url

(Optional) The endpoint’s public url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v1/%(tenant_id)s’

admin_url

(Optional) The endpoint’s admin url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v1/%(tenant_id)s’

internal_url

(Optional) The endpoint’s internal url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v1/%(tenant_id)s’

configure_endpoint_v2

(Optional) Should Manila v2 endpoint be configured? Defaults to true.

configure_service_v2

(Optional) Should the service v2 be configurd? Defaults to True

service_type_v2

(Optional) Type of service v2. Optional. Defaults to ‘sharev2’.

service_description_v2

(Optional) Description for keystone service v2. Defaults to ‘Manila Service v2’.

public_url_v2

(Optional) The v2 endpoint’s public url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v2’

admin_url_v2

(Optional) The endpoint’s admin url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v2’

internal_url_v2

(Optional) The endpoint’s internal url. This url should not contain any trailing ‘/’. Defaults to ‘127.0.0.1:8786/v2’

DEPRECATED PARAMETERS

password_v2

(Optional) Password for Manila v2 user. Defaults to undef.

email_v2

(Optional) Email for Manila v2 user. Defaults to ‘manilav2@localhost’.

auth_name_v2

(Optional) Username for Manila v2 service. Defaults to ‘manilav2’.

configure_user_v2

(Optional) Should the v2 service user be configured? Defaults to false

configure_user_role_v2

(Optional) Should the admin role be configured for the v2 service user? Defaults to false

Examples

class { 'manila::keystone::auth':
  public_url   => 'https://10.0.0.10:8786/v1/%(tenant_id)s',
  internal_url => 'https://10.0.0.11:8786/v1/%(tenant_id)s',
  admin_url    => 'https://10.0.0.11:8786/v1/%(tenant_id)s',
}

Parameters:

  • password (String[1])
  • auth_name (String[1]) (defaults to: 'manila')
  • service_name (String[1]) (defaults to: 'manila')
  • service_name_v2 (String[1]) (defaults to: 'manilav2')
  • email (String[1]) (defaults to: 'manila@localhost')
  • tenant (String[1]) (defaults to: 'services')
  • roles (Array[String[1]]) (defaults to: ['admin'])
  • system_scope (String[1]) (defaults to: 'all')
  • system_roles (Array[String[1]]) (defaults to: [])
  • configure_endpoint (Boolean) (defaults to: true)
  • configure_endpoint_v2 (Boolean) (defaults to: true)
  • configure_user (Boolean) (defaults to: true)
  • configure_user_role (Boolean) (defaults to: true)
  • configure_service (Boolean) (defaults to: true)
  • configure_service_v2 (Boolean) (defaults to: true)
  • service_type (String[1]) (defaults to: 'share')
  • service_type_v2 (String[1]) (defaults to: 'sharev2')
  • service_description (String[1]) (defaults to: 'Manila Service')
  • service_description_v2 (String[1]) (defaults to: 'Manila Service v2')
  • region (String[1]) (defaults to: 'RegionOne')
  • public_url (Keystone::PublicEndpointUrl) (defaults to: 'http://127.0.0.1:8786/v1/%(tenant_id)s')
  • public_url_v2 (Keystone::PublicEndpointUrl) (defaults to: 'http://127.0.0.1:8786/v2')
  • admin_url (Keystone::EndpointUrl) (defaults to: 'http://127.0.0.1:8786/v1/%(tenant_id)s')
  • admin_url_v2 (Keystone::EndpointUrl) (defaults to: 'http://127.0.0.1:8786/v2')
  • internal_url (Keystone::EndpointUrl) (defaults to: 'http://127.0.0.1:8786/v1/%(tenant_id)s')
  • internal_url_v2 (Keystone::EndpointUrl) (defaults to: 'http://127.0.0.1:8786/v2')
  • password_v2 (Optional[String[1]]) (defaults to: undef)
  • auth_name_v2 (String[1]) (defaults to: 'manilav2')
  • email_v2 (String[1]) (defaults to: 'manilav2@localhost')
  • configure_user_v2 (Boolean) (defaults to: false)
  • configure_user_role_v2 (Boolean) (defaults to: false) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'manifests/keystone/auth.pp', line 147

class manila::keystone::auth (
  String[1] $password,
  String[1] $auth_name                       = 'manila',
  String[1] $service_name                    = 'manila',
  String[1] $service_name_v2                 = 'manilav2',
  String[1] $email                           = 'manila@localhost',
  String[1] $tenant                          = 'services',
  Array[String[1]] $roles                    = ['admin'],
  String[1] $system_scope                    = 'all',
  Array[String[1]] $system_roles             = [],
  Boolean $configure_endpoint                = true,
  Boolean $configure_endpoint_v2             = true,
  Boolean $configure_user                    = true,
  Boolean $configure_user_role               = true,
  Boolean $configure_service                 = true,
  Boolean $configure_service_v2              = true,
  String[1] $service_type                    = 'share',
  String[1] $service_type_v2                 = 'sharev2',
  String[1] $service_description             = 'Manila Service',
  String[1] $service_description_v2          = 'Manila Service v2',
  String[1] $region                          = 'RegionOne',
  Keystone::PublicEndpointUrl $public_url    = 'http://127.0.0.1:8786/v1/%(tenant_id)s',
  Keystone::PublicEndpointUrl $public_url_v2 = 'http://127.0.0.1:8786/v2',
  Keystone::EndpointUrl $admin_url           = 'http://127.0.0.1:8786/v1/%(tenant_id)s',
  Keystone::EndpointUrl $admin_url_v2        = 'http://127.0.0.1:8786/v2',
  Keystone::EndpointUrl $internal_url        = 'http://127.0.0.1:8786/v1/%(tenant_id)s',
  Keystone::EndpointUrl $internal_url_v2     = 'http://127.0.0.1:8786/v2',
  # DEPRECATED PARAMETERS
  Optional[String[1]] $password_v2           = undef,
  String[1] $auth_name_v2                    = 'manilav2',
  String[1] $email_v2                        = 'manilav2@localhost',
  Boolean $configure_user_v2                 = false,
  Boolean $configure_user_role_v2            = false,
) {

  include manila::deps

  Keystone::Resource::Service_identity['manila'] -> Anchor['manila::service::end']
  Keystone::Resource::Service_identity['manilav2'] -> Anchor['manila::service::end']

  if $configure_user_v2 or $configure_user_role_v2 {
    warning("Management of share v2 user has been deprecated and will be removed \
and will be removed in a future release.")
  }

  # for interface backward compatibility, we can't enforce to set a new parameter
  # so we take 'password' parameter by default but allow to override it.
  if ! $password_v2 {
    $password_v2_real = $password
  } else {
    $password_v2_real = $password_v2
  }

  keystone::resource::service_identity { 'manila':
    configure_user      => $configure_user,
    configure_user_role => $configure_user_role,
    configure_endpoint  => $configure_endpoint,
    configure_service   => $configure_service,
    service_type        => $service_type,
    service_description => $service_description,
    auth_name           => $auth_name,
    service_name        => $service_name,
    region              => $region,
    password            => $password,
    email               => $email,
    tenant              => $tenant,
    roles               => $roles,
    system_scope        => $system_scope,
    system_roles        => $system_roles,
    public_url          => $public_url,
    admin_url           => $admin_url,
    internal_url        => $internal_url,
  }

  keystone::resource::service_identity { 'manilav2':
    configure_user      => $configure_user_v2,
    configure_user_role => $configure_user_role_v2,
    configure_endpoint  => $configure_endpoint_v2,
    configure_service   => $configure_service_v2,
    service_type        => $service_type_v2,
    service_description => $service_description_v2,
    auth_name           => $auth_name_v2,
    service_name        => $service_name_v2,
    region              => $region,
    password            => $password_v2_real,
    email               => $email_v2,
    tenant              => $tenant,
    roles               => $roles,
    system_scope        => $system_scope,
    system_roles        => $system_roles,
    public_url          => $public_url_v2,
    admin_url           => $admin_url_v2,
    internal_url        => $internal_url_v2,
  }
}