puppet-ironic/manifests/conductor.pp
Takashi Kajinami 19851a4d62 Rename inspect_timeout to inspect_wait_timeout
... to make the parameter name consistent with the actual parameter
in ironic.

Change-Id: I4eb34f578f0a00dd8fe23acd5366f3983798c458
2020-05-02 00:11:28 +09:00

444 lines
17 KiB
Puppet

#
# Copyright (C) 2013 eNovance SAS <licensing@enovance.com>
#
# Author: Emilien Macchi <emilien.macchi@enovance.com>
#
# 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.
# Configure the conductor service in Ironic
#
# === Parameters
#
# [*package_ensure*]
# (optional) Control the ensure parameter for the package ressource.
# Defaults to 'present'.
#
# [*enabled*]
# (optional) Define if the service must be enabled or not.
# Defaults to true.
#
# [*enabled_hardware_types*]
# (optional) Array of hardware types to load during service initialization.
# Defaults to ['ipmi'].
#
# [*force_power_state_during_sync*]
# (optional) Should the hardware power state be set to the state recorded in
# the database (True) or should the database be updated based on the hardware
# state (False).
# Defaults to true.
#
# [*http_url*]
# (optional) ironic-conductor node's HTTP server URL.
# Defaults to $::os_service_default
#
# [*http_root*]
# (optional) ironic-conductor node's HTTP root path.
# Defaults to $::os_service_default
#
# [*force_raw_images*]
# (optional) If true, convert backing images to "raw" disk image format.
# Defaults to $::os_service_default
#
# [*automated_clean*]
# (optional) Whether to enable automated cleaning on nodes.
# Defaults to $::os_service_default
#
# [*cleaning_network*]
# (optional) UUID or name of the network to create Neutron ports on, when
# booting to a ramdisk for cleaning using Neutron DHCP.
# Can not be specified together with cleaning_network_name.
# Defaults to $::os_service_default
#
# [*cleaning_disk_erase*]
# (optional) Whether and how to erase hard drives during automated cleaning.
# Accepts the following values:
# * full - erase all data from all disks,
# * metadata - erase only metadata (partitioning table, etc),
# * none - do not erase anything (dangerous, use with caution).
# Defaults to undef, which leaves the configuration intact
#
# [*continue_if_disk_secure_erase_fails*]
# (optional) Whether to continue with shredding the hard drive if secure ATA
# erasure fails. Only makes sense if full hard disk erasing is enabled.
# Defaults to $::os_service_default
#
# [*provisioning_network*]
# (optional) Neutron network UUID or name for the ramdisk to be booted into
# for provisioning nodes. Required for neutron network interface.
# Can not be specified together with provisioning_network_name.
# Defaults to $::os_service_default
#
# [*rescuing_network*]
# (optional) Neutron network UUID or name for the ramdisk to be booted into
# for rescue. Can not be specified together with rescuing_network_name.
# Defaults to $::os_service_default
#
# [*inspection_network*]
# (optional) Neutron network UUID or name for the ramdisk to be booted into
# for in-band inspection. Can not be specified together with
# inspection_network_name.
# Defaults to $::os_service_default
#
# [*configdrive_use_object_store*]
# (optional) Whether to use object store for storing config drives instead of
# the database. Recommended for bigger config drives.
# Defaults to $::os_service_default
#
# [*configdrive_swift_container*]
# (optinal) Swift container to use for storing config drives if
# configdrive_use_object_store is true.
# Defaults to $::os_service_default
#
# [*inspect_wait_timeout*]
# (optional) Timeout (seconds) for waiting for node inspection.
# 0 for unlimited.
# Defaults to $::os_service_default
#
# [*default_boot_option*]
# (optional) Default boot option to use when no boot option is explicitly
# requested. One of "netboot" or "local".
# Defaults to $::os_service_default
#
# [*default_boot_mode*]
# (optional) Default boot mode to use when no boot mode is explicitly
# requested in node's driver_info, capabilities or in the "instance_info"
# configuration.requested. One of "bios" or "uefi".
# Defaults to $::os_service_default
#
# [*cleaning_network_name*]
# (optional) If provided the name will be converted to UUID and set
# as value of neutron/cleaning_network option in ironic.conf
# Can not be specified together with cleaning_network.
# Defaults to undef, which leaves the configuration intact
#
# [*provisioning_network_name*]
# (optional) If provided the name will be converted to UUID and set
# as value of neutron/provisioning_network option in ironic.conf
# Can not be specified together with provisioning_network.
# Defaults to undef, which leaves the configuration intact
#
# [*rescuing_network_name*]
# (optional) If provided the name will be converted to UUID and set
# as value of neutron/rescuing option in ironic.conf
# Can not be specified together with rescuing_network.
# Defaults to undef, which leaves the configuration intact
#
# [*inspection_network_name*]
# (optional) If provided the name will be converted to UUID and set
# as value of neutron/inspection_network option in ironic.conf
# Can not be specified together with inspection_network.
# Defaults to undef, which leaves the configuration intact
#
# [*port_setup_delay*]
# (optional) Delay value to wait for Neutron agents to setup
# sufficient DHCP configuration for port.
# Defaults to $::os_service_default
#
# [*power_state_change_timeout*]
# (optional) Timeout value to wait for a power operation to complete,
# so that the baremetal node is in the desired new power state.
# Defaults to $::os_service_default
#
# [*sync_power_state_interval*]
# (optional) Interval between syncing the node power state to the database,
# in seconds.
# Defaults to $::os_service_default
#
# [*power_state_sync_max_retries*]
# (optional) The number of times Ironic should try syncing the hardware node
# power state with the node power state in the database.
# Defaults to $::os_service_default
#
# [*power_failure_recovery_interval*]
# (optional) Interval (in seconds) between checking the power
# state for nodes previously put into maintenance mode due to power
# synchronization failure.
# Defaults to $::os_service_default
#
# [*conductor_group*]
# (optional) Name of the conductor group to join. This conductor will only
# manage nodes with a matching "conductor_group" field set on the node.
# Defaults to $::os_service_default
#
# [*deploy_kernel*]
# (optional) Glance UUID or URL of a deploy kernel to use by default.
# Defaults to $::os_service_default
#
# [*deploy_ramdisk*]
# (optional) Glance UUID or URL of a deploy ramdisk to use by default.
# Defaults to $::os_service_default
#
# [*rescue_kernel*]
# (optional) Glance UUID or URL of a rescue kernel to use by default.
# Defaults to $::os_service_default
#
# [*rescue_ramdisk*]
# (optional) Glance UUID or URL of a rescue ramdisk to use by default.
# Defaults to $::os_service_default
#
# [*allow_provisioning_in_maintenance*]
# (optional) Whether to allow nodes to enter or undergo deploy or cleaning
# when in maintenance mode. If this option is set to False, and a node enters
# maintenance during deploy or cleaning, the process will be aborted
# after the next heartbeat.
# Defaults to $::os_service_default
#
# DEPRECATED PARAMETERS
#
# [*max_time_interval*]
# (optional) Maximum time, in seconds, since the last check-in of a conductor.
# Should be an interger value
# Defaults to undef.
#
# [*api_url*]
# (optional) Ironic API URL.
# Defaults to undef.
#
# [*configdrive_use_swift*]
# (optional) Whether to use Swift for storing config drives instead of
# the database. Recommended for bigger config drives.
# Defaults to undef
#
# [*inspect_timeout*]
# (optional) Timeout (seconds) for waiting for node inspection.
# 0 for unlimited.
# Defaults to undef
#
class ironic::conductor (
$package_ensure = 'present',
$enabled = true,
$enabled_hardware_types = ['ipmi'],
$force_power_state_during_sync = true,
$http_url = $::os_service_default,
$http_root = $::os_service_default,
$force_raw_images = $::os_service_default,
$automated_clean = $::os_service_default,
$cleaning_network = $::os_service_default,
$cleaning_disk_erase = undef,
$continue_if_disk_secure_erase_fails = $::os_service_default,
$provisioning_network = $::os_service_default,
$rescuing_network = $::os_service_default,
$inspection_network = $::os_service_default,
$configdrive_use_object_store = $::os_service_default,
$configdrive_swift_container = $::os_service_default,
$inspect_wait_timeout = $::os_service_default,
$default_boot_option = $::os_service_default,
$default_boot_mode = $::os_service_default,
$port_setup_delay = $::os_service_default,
$cleaning_network_name = undef,
$provisioning_network_name = undef,
$rescuing_network_name = undef,
$inspection_network_name = undef,
$power_state_change_timeout = $::os_service_default,
$sync_power_state_interval = $::os_service_default,
$power_state_sync_max_retries = $::os_service_default,
$power_failure_recovery_interval = $::os_service_default,
$conductor_group = $::os_service_default,
$deploy_kernel = $::os_service_default,
$deploy_ramdisk = $::os_service_default,
$rescue_kernel = $::os_service_default,
$rescue_ramdisk = $::os_service_default,
$allow_provisioning_in_maintenance = $::os_service_default,
# DEPRECATED PARAMETERS
$max_time_interval = undef,
$api_url = undef,
$configdrive_use_swift = undef,
$inspect_timeout = undef,
) {
include ironic::deps
include ironic::params
# For backward compatibility
include ironic::glance
if $max_time_interval != undef {
warning('ironic::conductor::max_time_interval is deprecated and has no effect')
}
if $api_url != undef {
warning('ironic::conductor::api_url is deprecated. \
Use ironic::service_catalog::endpoint_override instead')
ironic_config {
'conductor/api_url': value => $api_url;
}
}
if $configdrive_use_swift != undef {
warning('configdrive_use_swift is deprecated and will be removed \
in a future release. Use configdrive_use_object_store instead')
$configdrive_use_object_store_real = $configdrive_use_swift
} else {
$configdrive_use_object_store_real = $configdrive_use_object_store
}
if $inspect_timeout != undef {
warning('inspect_timeout is deprecated and will be removed in a future release. \
Use inspect_wait_timeout instead')
$inspect_wait_timeout_real = $inspect_timeout
} else {
$inspect_wait_timeout_real = $inspect_wait_timeout
}
if ($cleaning_network_name and !is_service_default($cleaning_network)) {
fail('cleaning_network_name and cleaning_network can not be specified at the same time.')
}
if ($provisioning_network_name and !is_service_default($provisioning_network)) {
fail('provisioning_network_name and provisioning_network can not be specified in the same time.')
}
if ($rescuing_network_name and !is_service_default($rescuing_network)) {
fail('rescuing_network_name and rescuing_network can not be specified in the same time.')
}
if ($inspection_network_name and !is_service_default($inspection_network)) {
fail('inspection_network_name and inspection_network can not be specified in the same time.')
}
validate_legacy(Array, 'validate_array', $enabled_hardware_types)
# NOTE(dtantsur): all in-tree drivers are IPA-based, so it won't hurt
# including its manifest (which only contains configuration options)
include ironic::drivers::agent
# On Ubuntu, ipmitool dependency is missing and ironic-conductor fails to start.
# https://bugs.launchpad.net/cloud-archive/+bug/1572800
if member($enabled_hardware_types, 'ipmi') and $::osfamily == 'Debian' {
ensure_packages('ipmitool',
{
ensure => $package_ensure,
tag => ['openstack', 'ironic-package'],
}
)
}
if $cleaning_disk_erase {
validate_legacy(Enum['full', 'metadata', 'none'], 'validate_re', $cleaning_disk_erase,
[['^full$', '^metadata$', '^none$']])
}
case $cleaning_disk_erase {
'full': {
$erase_devices_priority = 10
$erase_devices_metadata_priority = 0
}
'metadata': {
$erase_devices_priority = 0
$erase_devices_metadata_priority = 10
}
'none': {
$erase_devices_priority = 0
$erase_devices_metadata_priority = 0
}
default: {
$erase_devices_priority = $::os_service_default
$erase_devices_metadata_priority = $::os_service_default
}
}
# Configure ironic.conf
ironic_config {
'DEFAULT/enabled_hardware_types': value => join($enabled_hardware_types, ',');
'conductor/force_power_state_during_sync': value => $force_power_state_during_sync;
'conductor/automated_clean': value => $automated_clean;
'deploy/http_url': value => $http_url;
'deploy/http_root': value => $http_root;
'DEFAULT/force_raw_images': value => $force_raw_images;
'deploy/erase_devices_priority': value => $erase_devices_priority;
'deploy/erase_devices_metadata_priority': value => $erase_devices_metadata_priority;
'deploy/continue_if_disk_secure_erase_fails': value => $continue_if_disk_secure_erase_fails;
'deploy/configdrive_use_object_store': value => $configdrive_use_object_store_real;
'conductor/configdrive_swift_container': value => $configdrive_swift_container;
'conductor/inspect_wait_timeout': value => $inspect_wait_timeout_real;
'deploy/default_boot_option': value => $default_boot_option;
'deploy/default_boot_mode': value => $default_boot_mode;
'neutron/port_setup_delay': value => $port_setup_delay;
'conductor/power_state_change_timeout': value => $power_state_change_timeout;
'conductor/sync_power_state_interval': value => $sync_power_state_interval;
'conductor/power_state_sync_max_retries': value => $power_state_sync_max_retries;
'conductor/power_failure_recovery_interval': value => $power_failure_recovery_interval;
'conductor/conductor_group': value => $conductor_group;
'conductor/deploy_kernel': value => $deploy_kernel;
'conductor/deploy_ramdisk': value => $deploy_ramdisk;
'conductor/rescue_kernel': value => $rescue_kernel;
'conductor/rescue_ramdisk': value => $rescue_ramdisk;
'conductor/allow_provisioning_in_maintenance': value => $allow_provisioning_in_maintenance;
}
if $cleaning_network_name {
ironic_config {
'neutron/cleaning_network': value => $cleaning_network_name, transform_to => 'net_uuid';
}
} else {
ironic_config {
'neutron/cleaning_network': value => $cleaning_network;
}
}
if $provisioning_network_name {
ironic_config {
'neutron/provisioning_network': value => $provisioning_network_name, transform_to => 'net_uuid';
}
} else {
ironic_config {
'neutron/provisioning_network': value => $provisioning_network;
}
}
if $rescuing_network_name {
ironic_config {
'neutron/rescuing_network': value => $rescuing_network_name, transform_to => 'net_uuid';
}
} else {
ironic_config {
'neutron/rescuing_network': value => $rescuing_network;
}
}
if $inspection_network_name {
ironic_config {
'neutron/inspection_network': value => $inspection_network_name, transform_to => 'net_uuid';
}
} else {
ironic_config {
'neutron/inspection_network': value => $inspection_network;
}
}
# Install package
if $::ironic::params::conductor_package {
package { 'ironic-conductor':
ensure => $package_ensure,
name => $::ironic::params::conductor_package,
tag => ['openstack', 'ironic-package'],
}
}
if $enabled {
$ensure = 'running'
} else {
$ensure = 'stopped'
}
# Manage service
service { 'ironic-conductor':
ensure => $ensure,
name => $::ironic::params::conductor_service,
enable => $enabled,
hasstatus => true,
tag => 'ironic-service',
}
}