puppet-ironic/manifests/glance.pp
Takashi Kajinami fb064ecb91 Deprecate ironic::glance::swift_account_project_name
This parameter has been supposed to allow users to use project name,
instead of project id, and have puppet code look up project id
automatically.

However this implementation has been problematic, especially in usual
usecase where a single set of manifests is used to set up all services.
The most challenging point is the unavoidable circular dependency.
Resolving the parameter requires access to Keystone API, which is not
correctly enforced now, while setting the parameter should trigger
restarting ironic services. When ironic-api and keystone are both
running by httpd+mod_wsgi, this eventually results in circular
dependency, because the parameter requires httpd and notifies httpd.

This change deprecates the parameter, since it has not been working
as intended in most of the cases.

Change-Id: Icdea064773915a5f68beb3a08590645aba6d29bc
2022-02-12 23:55:12 +09:00

161 lines
5.8 KiB
Puppet

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# == Class: ironic::glance
#
# [*auth_type*]
# The authentication plugin to use when connecting to glance.
# Defaults to 'password'
#
# [*auth_url*]
# The address of the keystone api endpoint.
# Defaults to $::os_service_default
#
# [*project_name*]
# The Keystone project name.
# Defaults to 'services'
#
# [*username*]
# The admin username for ironic to connect to glance.
# Defaults to 'ironic'.
#
# [*password*]
# The admin password for ironic to connect to glance.
# Defaults to $::os_service_default
#
# [*user_domain_name*]
# The name of user's domain (required for Identity V3).
# Defaults to 'Default'
#
# [*project_domain_name*]
# The name of project's domain (required for Identity V3).
# Defaults to 'Default'
#
# [*region_name*]
# (optional) Region name for connecting to glance in admin context
# through the OpenStack Identity service.
# Defaults to $::os_service_default
#
# [*num_retries*]
# (optional) Number retries when downloading an image from glance.
# Defaults to $::os_service_default
#
# [*api_insecure*]
# (optional) Allow to perform insecure SSL (https) requests to glance.
# Defaults to $::os_service_default
#
# [*swift_account*]
# (optional) The account that Glance uses to communicate with Swift.
# The format is "AUTH_uuid".
# Can not be set together with swift_account_project_name.
# Defaults to $::os_service_default
#
# [*swift_container*]
# (optional) Swift container where Glance images are stored. Used for
# generating temporary URLs.
# Defaults to $::os_service_default
#
# [*swift_endpoint_url*]
# (optional) Swift endpoint to use for generating temporary URLs.
# Defaults to $::os_service_default
#
# [*swift_temp_url_key*]
# (optional) The secret token given to Swift to allow temporary URL
# downloads. Required for several drivers (e.g. agent_ipmitool).
# Defaults to $::os_service_default
#
# [*swift_temp_url_duration*]
# (optional) The length of time in seconds that the temporary URL will be
# valid for.
# Defaults to $::os_service_default
#
# [*endpoint_override*]
# The endpoint URL for requests for this client
# Defaults to $::os_service_default
#
# DEPRECATED PARAMETERS
#
# [*api_servers*]
# Has no effect, use endpoint_override.
# Defaults to undef
#
# [*swift_account_project_name*]
# (optional) The project of account that Glance uses to communicate with Swift.
# Will be converted to UUID, and option glance/swift_account will be set in
# the "AUTH_uuid" format.
# Can not be set together with swift_account.
# Defaults to undef, which leaves the configuration intact
#
class ironic::glance (
$auth_type = 'password',
$auth_url = $::os_service_default,
$project_name = 'services',
$username = 'ironic',
$password = $::os_service_default,
$user_domain_name = 'Default',
$project_domain_name = 'Default',
$region_name = $::os_service_default,
$num_retries = $::os_service_default,
$api_insecure = $::os_service_default,
$swift_account = $::os_service_default,
$swift_container = $::os_service_default,
$swift_endpoint_url = $::os_service_default,
$swift_temp_url_key = $::os_service_default,
$swift_temp_url_duration = $::os_service_default,
$endpoint_override = $::os_service_default,
# DEPRECATED PARAMETERS
$api_servers = undef,
$swift_account_project_name = undef,
) {
if $api_servers {
warning("The ironic::glance::api_servers parameter is deprecated and \
has no effect. Please use ironic::glance::endpoint_override instead.")
}
if $swift_account_project_name != undef {
warning('The swift_account_project_name parameter is deprecated and will be removed in a future release.')
}
if ($swift_account_project_name and !is_service_default($swift_account)) {
fail('swift_account_project_name and swift_account can not be specified in the same time.')
}
ironic_config {
'glance/auth_type': value => $auth_type;
'glance/username': value => $username;
'glance/password': value => $password, secret => true;
'glance/auth_url': value => $auth_url;
'glance/project_name': value => $project_name;
'glance/user_domain_name': value => $user_domain_name;
'glance/project_domain_name': value => $project_domain_name;
'glance/region_name': value => $region_name;
'glance/num_retries': value => $num_retries;
'glance/insecure': value => $api_insecure;
'glance/swift_container': value => $swift_container;
'glance/swift_endpoint_url': value => $swift_endpoint_url;
'glance/swift_temp_url_key': value => $swift_temp_url_key, secret => true;
'glance/swift_temp_url_duration': value => $swift_temp_url_duration;
'glance/endpoint_override': value => $endpoint_override;
}
if $swift_account_project_name {
ironic_config {
'glance/swift_account': value => $swift_account_project_name, transform_to => 'project_uuid';
}
} else {
ironic_config {
'glance/swift_account': value => $swift_account;
}
}
}