From 51aa31070af9936ca6afa41678344cc4368359ef Mon Sep 17 00:00:00 2001
From: Dmitry Tantsur <dtantsur@protonmail.com>
Date: Mon, 17 May 2021 18:02:56 +0200
Subject: [PATCH] Do not serialize command_params

The command params can be huge when configdrive is used. There is no
point in sending them back, Ironic does not use them anyhow.

Story: #2008904
Task: #42479
Change-Id: I6e3db5db2042ca3fb5dafacfacf036fd7fc2fc4c
---
 ironic_python_agent/extensions/base.py                  | 2 +-
 ironic_python_agent/tests/unit/test_agent.py            | 6 ------
 releasenotes/notes/command_params-869fa547b5be2236.yaml | 5 +++++
 3 files changed, 6 insertions(+), 7 deletions(-)
 create mode 100644 releasenotes/notes/command_params-869fa547b5be2236.yaml

diff --git a/ironic_python_agent/extensions/base.py b/ironic_python_agent/extensions/base.py
index 23e47c466..a158ee3c5 100644
--- a/ironic_python_agent/extensions/base.py
+++ b/ironic_python_agent/extensions/base.py
@@ -42,7 +42,7 @@ class AgentCommandStatus(object):
 class BaseCommandResult(encoding.SerializableComparable):
     """Base class for command result."""
 
-    serializable_fields = ('id', 'command_name', 'command_params',
+    serializable_fields = ('id', 'command_name',
                            'command_status', 'command_error', 'command_result')
 
     def __init__(self, command_name, command_params):
diff --git a/ironic_python_agent/tests/unit/test_agent.py b/ironic_python_agent/tests/unit/test_agent.py
index 22b010dd5..646a852ed 100644
--- a/ironic_python_agent/tests/unit/test_agent.py
+++ b/ironic_python_agent/tests/unit/test_agent.py
@@ -742,9 +742,6 @@ class TestBaseAgent(ironic_agent_base.IronicAgentTest):
         expected_result = {
             'id': result.id,
             'command_name': 'foo_command',
-            'command_params': {
-                'fail': False,
-            },
             'command_status': 'RUNNING',
             'command_result': None,
             'command_error': None,
@@ -766,9 +763,6 @@ class TestBaseAgent(ironic_agent_base.IronicAgentTest):
         expected_result = {
             'id': result.id,
             'command_name': 'foo_command',
-            'command_params': {
-                'fail': True,
-            },
             'command_status': 'RUNNING',
             'command_result': None,
             'command_error': None,
diff --git a/releasenotes/notes/command_params-869fa547b5be2236.yaml b/releasenotes/notes/command_params-869fa547b5be2236.yaml
new file mode 100644
index 000000000..2526b39ce
--- /dev/null
+++ b/releasenotes/notes/command_params-869fa547b5be2236.yaml
@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    The command params no longer appear in the command results. See `story
+    2008904 <https://storyboard.openstack.org/#!/story/2008904>`_ for details.