Files
puppet-glance/manifests/backend/multistore/swift.pp
Takashi Kajinami da11a7e02b swift: Switch to domain_name
glance_store has correctly supported usage of domain_name options since
bug 1480330 was fixed[1] in 4.1.0(Zed release).

Domain names are preferred to domain ids because these are predictable.
Add new parameters to manage domain_name options so that we can replace
the existing domain_id parameters.

[1] 6738d0b156fc1caae0604eb7bd8f05a6ed1c2d68

Change-Id: Id4d6e0f23d6571acee717152c863a25f7be62f8f
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
2025-07-02 23:18:42 +09:00

212 lines
9.0 KiB
Puppet

#
# Copyright 2019 Red Hat, Inc.
#
# 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.
#
# == Define: glance::backend::swift
#
# configures the storage backend for glance
# as a swift instance
#
# === Parameters:
#
# [*swift_store_user*]
# (Required) Swift store user.
#
# [*swift_store_key*]
# (Required) Swift store key.
#
# [*swift_store_auth_address*]
# (Optional) The address where the Swift authentication service is listening.
# Defaults to 'http://127.0.0.1:5000/v3/'
#
# [*swift_store_auth_project_domain_name*]
# (Optional) Name of the domain to which the project belongs.
# Defaults to 'Default'
#
# [*swift_store_auth_user_domain_name*]
# (Optional) Name of the domain to which the user belongs.
# Defaults to 'Default'
#
# [*swift_store_container*]
# (Optional) Name of single container to store images/name prefix for
# multiple containers.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_large_object_size*]
# (Optional) The size threshold, in MB, after which Glance will start
# segmenting image data.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_large_object_chunk_size*]
# (Optional) The maximum size, in MB, of the segments when image data is
# segmented.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_create_container_on_put*]
# (Optional) Create container, if it doesn't already exist, when uploading
# image.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_endpoint_type*]
# (Optional) Endpoint type of Swift service.
# Defaults to 'internalURL'
#
# [*swift_store_service_type*]
# (Optional) Type of the swift service to use.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_region*]
# (Optional) The region of Swift endpoint to use by Glance.
# Defaults to $facts['os_service_default'].
#
# [*default_swift_reference*]
# (Optional) The reference to the default swift account/backing store
# parameters to use for adding new images. String value.
# Defaults to 'ref1'.
#
# [*swift_buffer_on_upload*]
# (Optional) Buffer image segments before upload to Swift.
# Defaults to $facts['os_service_default'].
#
# [*swift_upload_buffer_dir*]
# (Optional) Directory to buffer image segments before upload to Swift.
# Defaults to $facts['os_service_default'].
#
# [*swift_store_retry_get_count*]
# (Optional) The number of times a Swift download will be retried before
# the request fails.
# Defaults to $facts['os_service_default'].
#
# [*store_description*]
# (Optional) Provides constructive information about the store backend to
# end users.
# Defaults to $facts['os_service_default'].
#
# [*weight*]
# (Optional) Define a relative weight for this store over any others that
# are configured.
# Defaults to $facts['os_service_default'].
#
# DEPRECATED PARAMETERS
#
# [*swift_store_config_file*]
# (Optional) Absolute path to the file containing the swift account(s)
# configuration.
# Defaults to '/etc/glance/glance-swift.conf'
#
# [*swift_store_auth_version*]
# (Optional) The authentication version to be used.
# Defaults to undef
#
# [*swift_store_auth_project_domain_id*]
# (Optional) ID of the domain to which the project belongs.
# Defaults to undef
#
# [*swift_store_auth_user_domain_id*]
# (Optional) ID of the domain to which the user belongs.
# Defaults to undef
#
define glance::backend::multistore::swift(
$swift_store_user,
$swift_store_key,
$swift_store_auth_address = 'http://127.0.0.1:5000/v3/',
$swift_store_container = $facts['os_service_default'],
$swift_store_auth_project_domain_name = 'Default',
$swift_store_auth_user_domain_name = 'Default',
$swift_store_large_object_size = $facts['os_service_default'],
$swift_store_large_object_chunk_size = $facts['os_service_default'],
$swift_store_create_container_on_put = $facts['os_service_default'],
$swift_store_endpoint_type = 'internalURL',
$swift_store_service_type = $facts['os_service_default'],
$swift_store_region = $facts['os_service_default'],
$default_swift_reference = 'ref1',
$swift_buffer_on_upload = $facts['os_service_default'],
$swift_upload_buffer_dir = $facts['os_service_default'],
$swift_store_retry_get_count = $facts['os_service_default'],
$store_description = $facts['os_service_default'],
$weight = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$swift_store_config_file = undef,
$swift_store_auth_version = undef,
$swift_store_auth_project_domain_id = undef,
$swift_store_auth_user_domain_id = undef,
) {
include glance::deps
include swift::client
Class['swift::client'] -> Anchor['glance::install::end']
Anchor['swift::service::end'] -> Anchor['glance::service::end']
if $swift_store_config_file != undef {
warning('The swift_store_config_file parameter is deprecated')
$swift_store_config_file_real = $swift_store_config_file
} else {
$swift_store_config_file_real = '/etc/glance/glance-swift.conf'
}
[
'swift_store_auth_version',
'swift_store_auth_project_domain_id',
'swift_store_auth_user_domain_id'
].each |String $dep_opt| {
if getvar($dep_opt) != undef {
warning("The ${dep_opt} parameter is deprecated")
}
}
glance_api_config {
"${name}/swift_store_region": value => $swift_store_region;
"${name}/swift_store_container": value => $swift_store_container;
"${name}/swift_store_create_container_on_put": value => $swift_store_create_container_on_put;
"${name}/swift_store_large_object_size": value => $swift_store_large_object_size;
"${name}/swift_store_large_object_chunk_size": value => $swift_store_large_object_chunk_size;
"${name}/swift_store_endpoint_type": value => $swift_store_endpoint_type;
"${name}/swift_store_service_type": value => $swift_store_service_type;
"${name}/swift_store_config_file": value => $swift_store_config_file_real;
"${name}/default_swift_reference": value => $default_swift_reference;
"${name}/swift_buffer_on_upload": value => $swift_buffer_on_upload;
"${name}/swift_upload_buffer_dir": value => $swift_upload_buffer_dir;
"${name}/swift_store_retry_get_count": value => $swift_store_retry_get_count;
"${name}/store_description": value => $store_description;
"${name}/weight": value => $weight;
}
glance_cache_config {
"${name}/swift_store_region": value => $swift_store_region;
"${name}/swift_store_container": value => $swift_store_container;
"${name}/swift_store_create_container_on_put": value => $swift_store_create_container_on_put;
"${name}/swift_store_large_object_size": value => $swift_store_large_object_size;
"${name}/swift_store_large_object_chunk_size": value => $swift_store_large_object_chunk_size;
"${name}/swift_store_endpoint_type": value => $swift_store_endpoint_type;
"${name}/swift_store_service_type": value => $swift_store_service_type;
"${name}/swift_store_config_file": value => $swift_store_config_file_real;
"${name}/default_swift_reference": value => $default_swift_reference;
"${name}/swift_buffer_on_upload": value => $swift_buffer_on_upload;
"${name}/swift_upload_buffer_dir": value => $swift_upload_buffer_dir;
"${name}/swift_store_retry_get_count": value => $swift_store_retry_get_count;
"${name}/weight": value => $weight;
}
glance_swift_config {
"${default_swift_reference}/user": value => $swift_store_user;
"${default_swift_reference}/key": value => $swift_store_key, secret => true;
"${default_swift_reference}/auth_address": value => $swift_store_auth_address;
"${default_swift_reference}/auth_version": value => pick($swift_store_auth_version, $facts['os_service_default']);
"${default_swift_reference}/user_domain_name": value => $swift_store_auth_user_domain_name;
"${default_swift_reference}/project_domain_name": value => $swift_store_auth_project_domain_name;
"${default_swift_reference}/user_domain_id": value => pick($swift_store_auth_user_domain_id, $facts['os_service_default']);
"${default_swift_reference}/project_domain_id": value => pick($swift_store_auth_project_domain_id, $facts['os_service_default']);
}
}