Defined Type: oslo::limit

Defined in:
manifests/limit.pp

Overview

Define: oslo::limit

Configure oslo_limit options

Parameters:

username

(Required) The name of the service user

password

(Required) Password to create for the service user

endpoint_id

(Optional) The service’s endpoint id which is registered in Keystone. Defaults to undef

endpoint_service_name

(Optional) Service name for endpoint discovery Defaults to undef

endpoint_service_type

(Optional) Service type for endpoint discovery Defaults to undef

endpoint_region_name

(Optional) Region to which the endpoint belongs. Defaults to $facts

endpoint_interface

(Optional) The interface for endpoint discovery. Defaults to $facts

auth_url

(Optional) The URL to use for authentication. Defaults to ‘localhost:5000’.

project_name

(Optional) Service project name Defaults to ‘services’.

user_domain_name

(Optional) Name of domain for $username Defaults to ‘Default’.

project_domain_name

(Optional) Name of domain for $project_name Defaults to ‘Default’.

system_scope

(Optional) Scope for system operations. Defaults to $facts

auth_type

(Optional) Authentication type to load Defaults to ‘password’.

service_type

(Optional) The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules. Defaults to $facts.

valid_interfaces

(Optional) List of interfaces, in order of preference, for endpoint URL. Defaults to $facts.

region_name

(Optional) The region in which the identity server can be found. Defaults to $facts.

endpoint_override

(Optional) Always use this endpoint URL for requests for this client. Defaults to $facts.

Parameters:

  • username (String[1])
  • password (String[1])
  • endpoint_id (Optional[String[1]]) (defaults to: undef)
  • endpoint_service_name (Optional[String[1]]) (defaults to: undef)
  • endpoint_service_type (Optional[String[1]]) (defaults to: undef)
  • endpoint_region_name (Any) (defaults to: $facts['os_service_default'])
  • endpoint_interface (Any) (defaults to: $facts['os_service_default'])
  • auth_url (Any) (defaults to: 'http://localhost:5000')
  • project_name (Any) (defaults to: 'services')
  • user_domain_name (Any) (defaults to: 'Default')
  • project_domain_name (Any) (defaults to: 'Default')
  • system_scope (Any) (defaults to: $facts['os_service_default'])
  • auth_type (Any) (defaults to: 'password')
  • service_type (Any) (defaults to: $facts['os_service_default'])
  • valid_interfaces (Any) (defaults to: $facts['os_service_default'])
  • region_name (Any) (defaults to: $facts['os_service_default'])
  • endpoint_override (Any) (defaults to: $facts['os_service_default']) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'manifests/limit.pp', line 74

define oslo::limit(
  String[1] $username,
  String[1] $password,
  Optional[String[1]] $endpoint_id           = undef,
  Optional[String[1]] $endpoint_service_name = undef,
  Optional[String[1]] $endpoint_service_type = undef,
  $endpoint_region_name                      = $facts['os_service_default'],
  $endpoint_interface                        = $facts['os_service_default'],
  $auth_url                                  = 'http://localhost:5000',
  $project_name                              = 'services',
  $user_domain_name                          = 'Default',
  $project_domain_name                       = 'Default',
  $system_scope                              = $facts['os_service_default'],
  $auth_type                                 = 'password',
  $service_type                              = $facts['os_service_default'],
  $valid_interfaces                          = $facts['os_service_default'],
  $region_name                               = $facts['os_service_default'],
  $endpoint_override                         = $facts['os_service_default'],
) {

  if delete_undef_values([$endpoint_id, $endpoint_service_name, $endpoint_service_type]) == [] {
    fail('Either endpoint_id, endpoint_service_name or endpoint_service_type is required')
  }
  if $endpoint_id and ($endpoint_service_name or $endpoint_service_type) {
    fail('endpoint_id and endpoint_service_name/type are mutually exclusive')
  }

  if is_service_default($system_scope) {
    $project_name_real        = $project_name
    $project_domain_name_real = $project_domain_name
  } else {
    # When system scope is used, project parameters should be removed otherwise
    # project scope is used.
    $project_name_real        = $facts['os_service_default']
    $project_domain_name_real = $facts['os_service_default']
  }

  $limit_options = {
    'oslo_limit/endpoint_id'           => { value => pick($endpoint_id, $facts['os_service_default']) },
    'oslo_limit/endpoint_service_name' => { value => pick($endpoint_service_name, $facts['os_service_default']) },
    'oslo_limit/endpoint_service_type' => { value => pick($endpoint_service_type, $facts['os_service_default']) },
    'oslo_limit/endpoint_region_name'  => { value => $endpoint_region_name },
    'oslo_limit/endpoint_interface'    => { value => $endpoint_interface },
    'oslo_limit/username'              => { value => $username },
    'oslo_limit/password'              => { value => $password, secret => true },
    'oslo_limit/auth_url'              => { value => $auth_url },
    'oslo_limit/project_name'          => { value => $project_name_real },
    'oslo_limit/user_domain_name'      => { value => $user_domain_name },
    'oslo_limit/project_domain_name'   => { value => $project_domain_name_real },
    'oslo_limit/system_scope'          => { value => $system_scope },
    'oslo_limit/auth_type'             => { value => $auth_type },
    'oslo_limit/service_type'          => { value => $service_type },
    'oslo_limit/valid_interfaces'      => { value => join(any2array($valid_interfaces), ',') },
    'oslo_limit/region_name'           => { value => $region_name },
    'oslo_limit/endpoint_override'     => { value => $endpoint_override },
  }
  create_resources($name, $limit_options)
}