openstack/puppet-ironic
Code Issues Proposed changes

Deprecate support for inspector inspect interface

Browse Source 
The interface is being removed from ironic because

Depends-on: https://review.opendev.org/967476
Change-Id: Idf5d184b1dc76959b5fbbd7e501118b157ae4d32
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
This commit is contained in:
Takashi Kajinami
2025-11-18 15:36:18 +09:00
parent badee8d328
commit df112fcf9c
3 changed files with 123 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

175
manifests/drivers/inspector.pp
View File

@@ -14,52 +14,6 @@
#
# Configure how Ironic talks to Ironic Inspector.
#
# [*password*]
# (Optional) The admin password for ironic to connect to ironic-inspector.
#
# [*auth_type*]
# (Optional) The authentication plugin to use when connecting to
# ironic-inspector.
# Defaults to 'password'
#
# [*auth_url*]
# (Optional) The address of the keystone api endpoint.
# Defaults to 'http://127.0.0.1:5000'
#
# [*project_name*]
# (Optional) The Keystone project name.
# Defaults to 'services'
#
# [*username*]
# (Optional) The admin username for ironic to connect to ironic-inspector.
# Defaults to 'ironic'.
#
# [*user_domain_name*]
# (Optional) The name of user's domain.
# Defaults to 'Default'
#
# [*project_domain_name*]
# (Optional) The name of project's domain.
# Defaults to 'Default'
#
# [*system_scope*]
# (Optional) Scope for system operations
# Defaults to $facts['os_service_default']
#
# [*region_name*]
# (Optional) Region name for connecting to ironic-inspector in admin context
# through the OpenStack Identity service.
# Defaults to $facts['os_service_default']
#
# [*endpoint_override*]
# (Optional) The endpoint URL for requests for this client
# Defaults to $facts['os_service_default']
#
# [*callback_endpoint_override*]
# (Optional) The endpoint URL to use for ramdisk callback in case of managed
# boot.
# Defaults to $facts['os_service_default']
#
# [*power_off*]
# (Optional) Whether to power off a node after inspection in case of managed
# boot.
@@ -89,18 +43,56 @@
# [*physical_network_cidr_map*]
# (Optional) Mapping of IP subnet CIDR to physical network.
#
# DEPRECATED PARAMETERS
#
# [*password*]
# (Optional) The admin password for ironic to connect to ironic-inspector.
# Defaults to undef
#
# [*auth_type*]
# (Optional) The authentication plugin to use when connecting to
# ironic-inspector.
# Defaults to undef
#
# [*auth_url*]
# (Optional) The address of the keystone api endpoint.
# Defaults to undef
#
# [*project_name*]
# (Optional) The Keystone project name.
# Defaults to undef
#
# [*username*]
# (Optional) The admin username for ironic to connect to ironic-inspector.
# Defaults to undef
#
# [*user_domain_name*]
# (Optional) The name of user's domain.
# Defaults to undef
#
# [*project_domain_name*]
# (Optional) The name of project's domain.
# Defaults to undef
#
# [*system_scope*]
# (Optional) Scope for system operations
# Defaults to undef
#
# [*region_name*]
# (Optional) Region name for connecting to ironic-inspector in admin context
# through the OpenStack Identity service.
# Defaults to undef
#
# [*endpoint_override*]
# (Optional) The endpoint URL for requests for this client
# Defaults to undef
#
# [*callback_endpoint_override*]
# (Optional) The endpoint URL to use for ramdisk callback in case of managed
# boot.
# Defaults to undef
#
class ironic::drivers::inspector (
$password = undef,
$auth_type = undef,
$auth_url = 'http://127.0.0.1:5000',
$project_name = 'services',
$username = 'ironic',
$user_domain_name = 'Default',
$project_domain_name = 'Default',
$system_scope = $facts['os_service_default'],
$region_name = $facts['os_service_default'],
$endpoint_override = $facts['os_service_default'],
$callback_endpoint_override = $facts['os_service_default'],
$power_off = $facts['os_service_default'],
$extra_kernel_params = $facts['os_service_default'],
$require_managed_boot = $facts['os_service_default'],
@@ -108,29 +100,37 @@ class ironic::drivers::inspector (
$keep_ports = $facts['os_service_default'],
$additional_hooks = undef,
Hash $physical_network_cidr_map = {},
# DEPRECATED PARAMETERS
$password = undef,
$auth_type = undef,
$auth_url = undef,
$project_name = undef,
$username = undef,
$user_domain_name = undef,
$project_domain_name = undef,
$system_scope = undef,
$region_name = undef,
$endpoint_override = undef,
$callback_endpoint_override = undef,
) {
include ironic::deps
if $auth_type {
if $password == undef {
fail('The password parameter is required to use ironic-inspector')
[
'password',
'auth_type',
'auth_url',
'project_name',
'username',
'user_domain_name',
'project_domain_name',
'system_scope',
'region_name',
'endpoint_override',
'callback_endpoint_override',
].each |String $deprecated_opt| {
if getvar($deprecated_opt) != undef {
warning("The ${deprecated_opt} parameter is deprecated and has no effect.")
}
$auth_type_real = $auth_type
$password_real = $password
} elsif $password {
$auth_type_real = 'password'
$password_real = $password
} else {
$auth_type_real = $facts['os_service_default']
$password_real = $facts['os_service_default']
}
if is_service_default($system_scope) {
$project_name_real = $project_name
$project_domain_name_real = $project_domain_name
} else {
$project_name_real = $facts['os_service_default']
$project_domain_name_real = $facts['os_service_default']
}
$hooks = $additional_hooks ? {
@@ -143,16 +143,6 @@ class ironic::drivers::inspector (
}
ironic_config {
'inspector/auth_type': value => $auth_type_real;
'inspector/username': value => $username;
'inspector/password': value => $password_real, secret => true;
'inspector/auth_url': value => $auth_url;
'inspector/project_name': value => $project_name_real;
'inspector/user_domain_name': value => $user_domain_name;
'inspector/project_domain_name': value => $project_domain_name_real;
'inspector/system_scope': value => $system_scope;
'inspector/region_name': value => $region_name;
'inspector/endpoint_override': value => $endpoint_override;
'inspector/callback_endpoint_override': value => $callback_endpoint_override;
'inspector/power_off': value => $power_off;
'inspector/extra_kernel_params': value => $extra_kernel_params;
@@ -162,4 +152,17 @@ class ironic::drivers::inspector (
'inspector/hooks': value => $hooks;
'inspector/physical_network_cidr_map': value => $physical_network_cidr_map_real;
}
ironic_config {
'inspector/auth_type': ensure => absent;
'inspector/username': ensure => absent;
'inspector/password': ensure => absent, secret => true;
'inspector/auth_url': ensure => absent;
'inspector/project_name': ensure => absent;
'inspector/user_domain_name': ensure => absent;
'inspector/project_domain_name': ensure => absent;
'inspector/system_scope': ensure => absent;
'inspector/region_name': ensure => absent;
'inspector/endpoint_override': ensure => absent;
}
}

17
releasenotes/notes/remove-inspector-3845d6ebec125d4b.yaml
View File

@@ -2,3 +2,20 @@
upgrade:
- |
Support for ironic-inspector has been removed.
deprecations:
- |
The following parameters of the ``ironic::drivers::inspector`` class have
been deprecated and have no effect now.
- ``password``
- ``auth_type``
- ``auth_url``
- ``project_name``
- ``username``
- ``user_domain_name``
- ``project_domain_name``
- ``system_scope``
- ``region_name``
- ``endpoint_override``
- ``callback_endpoint_override``

92
spec/classes/ironic_drivers_inspector_spec.rb
View File

@@ -17,22 +17,10 @@ require 'spec_helper'
describe 'ironic::drivers::inspector' do
let :params do
{ :password => 'secret' }
end
shared_examples_for 'ironic ironic-inspector access configuration' do
shared_examples_for 'ironic::drivers::inspector' do
it 'configures ironic.conf' do
is_expected.to contain_ironic_config('inspector/auth_type').with_value('password')
is_expected.to contain_ironic_config('inspector/auth_url').with_value('http://127.0.0.1:5000')
is_expected.to contain_ironic_config('inspector/project_name').with_value('services')
is_expected.to contain_ironic_config('inspector/username').with_value('ironic')
is_expected.to contain_ironic_config('inspector/password').with_value('secret').with_secret(true)
is_expected.to contain_ironic_config('inspector/user_domain_name').with_value('Default')
is_expected.to contain_ironic_config('inspector/project_domain_name').with_value('Default')
is_expected.to contain_ironic_config('inspector/system_scope').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/endpoint_override').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/power_off').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/extra_kernel_params').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/require_managed_boot').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/add_ports').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/keep_ports').with_value('<SERVICE DEFAULT>')
@@ -40,55 +28,23 @@ describe 'ironic::drivers::inspector' do
is_expected.to contain_ironic_config('inspector/physical_network_cidr_map').with_value('<SERVICE DEFAULT>')
end
context 'without password' do
let :params do
{}
end
it 'configures ironic.conf' do
is_expected.to contain_ironic_config('inspector/auth_type').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/auth_url').with_value('http://127.0.0.1:5000')
is_expected.to contain_ironic_config('inspector/project_name').with_value('services')
is_expected.to contain_ironic_config('inspector/username').with_value('ironic')
is_expected.to contain_ironic_config('inspector/password').with_value('<SERVICE DEFAULT>').with_secret(true)
is_expected.to contain_ironic_config('inspector/user_domain_name').with_value('Default')
is_expected.to contain_ironic_config('inspector/project_domain_name').with_value('Default')
end
end
context 'when overriding parameters' do
before :each do
params.merge!(
:auth_type => 'v3password',
:auth_url => 'http://example.com',
:project_name => 'project1',
:username => 'admin',
:user_domain_name => 'NonDefault',
:project_domain_name => 'NonDefault',
:region_name => 'regionTwo',
:endpoint_override => 'http://example2.com',
:callback_endpoint_override => 'http://10.0.0.1/v1/continue',
:power_off => false,
:extra_kernel_params => 'ipa-inspection-collectors=a,b,c',
:require_managed_boot => true,
:add_ports => 'all',
:keep_ports => 'all',
:additional_hooks => 'hook1,hook2',
:physical_network_cidr_map => {'192.168.20.0/24' => 'physnet_a',
'2001:db8::/64' => 'physnet_b'},
)
let :params do
{
:power_off => false,
:extra_kernel_params => 'ipa-inspection-collectors=a,b,c',
:require_managed_boot => true,
:add_ports => 'all',
:keep_ports => 'all',
:additional_hooks => 'hook1,hook2',
:physical_network_cidr_map => {
'192.168.20.0/24' => 'physnet_a',
'2001:db8::/64' => 'physnet_b'
},
}
end
it 'should replace default parameter with new value' do
is_expected.to contain_ironic_config('inspector/auth_type').with_value(params[:auth_type])
is_expected.to contain_ironic_config('inspector/auth_url').with_value(params[:auth_url])
is_expected.to contain_ironic_config('inspector/project_name').with_value(params[:project_name])
is_expected.to contain_ironic_config('inspector/username').with_value(params[:username])
is_expected.to contain_ironic_config('inspector/user_domain_name').with_value(params[:user_domain_name])
is_expected.to contain_ironic_config('inspector/project_domain_name').with_value(params[:project_domain_name])
is_expected.to contain_ironic_config('inspector/system_scope').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/region_name').with_value(params[:region_name])
is_expected.to contain_ironic_config('inspector/endpoint_override').with_value(params[:endpoint_override])
is_expected.to contain_ironic_config('inspector/callback_endpoint_override').with_value(params[:callback_endpoint_override])
is_expected.to contain_ironic_config('inspector/power_off').with_value(params[:power_off])
is_expected.to contain_ironic_config('inspector/extra_kernel_params').with_value(params[:extra_kernel_params])
is_expected.to contain_ironic_config('inspector/require_managed_boot').with_value(true)
@@ -98,20 +54,6 @@ describe 'ironic::drivers::inspector' do
is_expected.to contain_ironic_config('inspector/physical_network_cidr_map').with_value('192.168.20.0/24:physnet_a,2001:db8::/64:physnet_b')
end
end
context 'when system_scope is set' do
before :each do
params.merge!(
:system_scope => 'all'
)
end
it 'configures system-scoped credential' do
is_expected.to contain_ironic_config('inspector/project_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/project_domain_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_ironic_config('inspector/system_scope').with_value('all')
end
end
end
on_supported_os({
@@ -122,7 +64,7 @@ describe 'ironic::drivers::inspector' do
facts.merge!(OSDefaults.get_facts())
end
it_behaves_like 'ironic ironic-inspector access configuration'
it_behaves_like 'ironic::drivers::inspector'
end
end