Deprecate configuration molds

Per the consensus during the 2024.1 PTG, configuration molds
are being deprecated in favor of a to be developed in the future
step templating mechanism.

Change-Id: Ieab94972e89ca9cded7fae225191bd63d9311581
This commit is contained in:
Julia Kreger 2023-11-20 11:04:15 -08:00
parent 6ac1308050
commit 5db871ead6
4 changed files with 26 additions and 2 deletions

View File

@ -286,6 +286,11 @@ The management interface for ``idrac-redfish`` supports:
Import and export configuration Import and export configuration
------------------------------- -------------------------------
.. warning::
This feature has been deprecated and is anticipated to be removed once
Ironic has a generalized interface for doing step template articulation
for aspects beyond just "deployment" of baremetal nodes.
The clean and deploy steps provided in this section allow to configure the The clean and deploy steps provided in this section allow to configure the
system and collect the system inventory using configuration mold files. system and collect the system inventory using configuration mold files.

View File

@ -29,6 +29,9 @@ LOG = logging.getLogger(__name__)
CONF = cfg.CONF CONF = cfg.CONF
# NOTE(TheJulia): Deprecated after the 2024.1 PTG in favor of
# a future step templating interface.
def save_configuration(task, url, data): def save_configuration(task, url, data):
"""Store configuration mold to indicated location. """Store configuration mold to indicated location.
@ -57,6 +60,9 @@ def save_configuration(task, url, data):
response.raise_for_status() response.raise_for_status()
# NOTE(TheJulia): Deprecated after the 2024.1 PTG in favor of
# a future step templating interface.
def get_configuration(task, url): def get_configuration(task, url):
"""Gets configuration mold from indicated location. """Gets configuration mold from indicated location.
@ -98,6 +104,9 @@ def get_configuration(task, url):
response.raise_for_status() response.raise_for_status()
# NOTE(TheJulia): Deprecated after the 2024.1 PTG in favor of
# a future step templating interface.
def _get_auth_header(task): def _get_auth_header(task):
"""Based on setup of configuration mold storage gets authentication header """Based on setup of configuration mold storage gets authentication header

View File

@ -366,7 +366,7 @@ class DracRedfishManagement(redfish_management.RedfishManagement):
@base.clean_step(priority=0, argsinfo=EXPORT_CONFIGURATION_ARGSINFO, @base.clean_step(priority=0, argsinfo=EXPORT_CONFIGURATION_ARGSINFO,
requires_ramdisk=False) requires_ramdisk=False)
def export_configuration(self, task, export_configuration_location): def export_configuration(self, task, export_configuration_location):
"""Export the configuration of the server. """(Deprecated) Export the configuration of the server.
Exports the configuration of the server against which the step is run Exports the configuration of the server against which the step is run
and stores it in specific format in indicated location. and stores it in specific format in indicated location.
@ -416,7 +416,7 @@ class DracRedfishManagement(redfish_management.RedfishManagement):
@base.clean_step(priority=0, argsinfo=IMPORT_CONFIGURATION_ARGSINFO, @base.clean_step(priority=0, argsinfo=IMPORT_CONFIGURATION_ARGSINFO,
requires_ramdisk=False) requires_ramdisk=False)
def import_configuration(self, task, import_configuration_location): def import_configuration(self, task, import_configuration_location):
"""Import and apply the configuration to the server. """(Deprecated) Import and apply the configuration to the server.
Gets pre-created configuration from storage by given location and Gets pre-created configuration from storage by given location and
imports that into given server. Uses Dell's Server Configuration imports that into given server. Uses Dell's Server Configuration

View File

@ -0,0 +1,10 @@
---
deprecations:
- |
The ``idrac`` hardware type management interface steps
``import_configuration`` and ``export_configuration`` steps are
deprecated, and will be removed once a formalized generic step
templating mechanism has been created within Ironic. The Ironic
community is open to reconsidering this decision should the
overall bulk configuration reset/templating model become adopted
by DMTF Redfish as a standardized cross-vendor feature.