kdump-remote feature in hostcfgd by muhammadalihussnain · Pull Request #166 · sonic-net/sonic-host-services

muhammadalihussnain · 2024-09-18T12:15:56Z

we want to add three new features to the KDUMP table and enable the KDUMP feature remotely.

muhammadalihussnain · 2024-09-19T05:43:10Z

This PR is related to or dependent on sonic-net/SONiC#1714.

muhammadalihussnain · 2024-10-02T05:06:34Z

@venkatmahalingam Hi! we have updated the code. Please Help us review the Code PRs. Thanks

ridahanif96 · 2024-10-28T10:44:37Z

@venkatmahalingam Hi! we have updated the code. Please Help us review the Code PRs. Thanks in advance , target is 202411

venkatmahalingam · 2024-11-11T17:37:45Z

scripts/hostcfgd

        for row in self.kdump_defaults:
            value = self.kdump_defaults.get(row)
            if not kdump_conf.get(row):
-                self.config_db.mod_entry("KDUMP", "config", {row : value})


Why do we need this change?

This change is still there, it is not removed. Added Detail for remote configs here in kdump table

venkatmahalingam · 2024-11-26T08:27:22Z

scripts/hostcfgd

+            ssh_path = self.kdump_defaults["SSH_PATH"]
+            if data.get("SSH_PATH") is not None:
+                ssh_path = data.get("SSH_PATH")
+            run_cmd(["sonic-kdump-config", "--ssh_path", ssh_path])


Why should we execute run_cmd with following defaults when KDUMP remote is not desired by the user?
SSH_KEY": "user@server", # New feature: SSH key, default value
"SSH_PATH": ""

Hi @venkatmahalingam i have update the code as suggested above .

wajahatrazi · 2024-12-04T07:37:06Z

Hi @venkatmahalingam , please help merge this PR. Regards

wajahatrazi · 2024-12-10T07:50:11Z

Hi @qiluo-msft

PR has been reviewed by the reviewer with all checks passed, please help merge this.

ridahanif96 · 2024-12-14T20:04:03Z

@qiluo-msft help merge this PR, pending for long

wajahatrazi

LGTM

zhangyanzhao · 2025-01-21T04:00:23Z

Can we merge this PR? Thanks.

hdwhdw · 2025-02-06T18:10:49Z

This commit is not able to be merged into sonic-buildimage:
https://elastictest.org/scheduler/testplan/67a4e6f5f5a74203a8e1b8e8?testcase=show_techsupport%2Ftest_auto_techsupport.py&type=console

Match Messages:
E               2025 Feb  6 17:30:13.904639 vlab-03 ERR sonic_yang: All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])
E               
E               2025 Feb  6 17:30:13.904667 vlab-03 ERR sonic_yang: exceptionList:[]
E               
E               2025 Feb  6 17:30:13.904691 vlab-03 ERR sonic_yang: Data Loading Failed:All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])#012exceptionList:[]
E               
E               2025 Feb  6 17:30:13.904715 vlab-03 ERR ConfigMgmt: Data Loading Failed#012All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])#012exceptionList:[]

Merge PR sonic-net/sonic-buildimage#21565 I think the test fails on KVM.

hdwhdw · 2025-02-06T18:13:47Z

@FengPan-Frank @qiluo-msft for viz

wen587 · 2025-02-07T00:33:39Z

Hi @muhammadalihussnain , the error message indicates that ['SSH_KEY', 'SSH_PATH', 'remote'] missing in YANG fails the validation.
The YANG model file need to be updated first before modification on the related table: sonic-kdump.yang does not have these leaf
sonic-buildimage/src/sonic-yang-models/yang-models/sonic-kdump.yang at master · sonic-net/sonic-buildimage

This commit is not able to be merged into sonic-buildimage: https://elastictest.org/scheduler/testplan/67a4e6f5f5a74203a8e1b8e8?testcase=show_techsupport%2Ftest_auto_techsupport.py&type=console

Match Messages:
E               2025 Feb  6 17:30:13.904639 vlab-03 ERR sonic_yang: All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])
E               
E               2025 Feb  6 17:30:13.904667 vlab-03 ERR sonic_yang: exceptionList:[]
E               
E               2025 Feb  6 17:30:13.904691 vlab-03 ERR sonic_yang: Data Loading Failed:All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])#012exceptionList:[]
E               
E               2025 Feb  6 17:30:13.904715 vlab-03 ERR ConfigMgmt: Data Loading Failed#012All Keys are not parsed in KDUMP#012dict_keys(['SSH_KEY', 'SSH_PATH', 'remote'])#012exceptionList:[]

Merge PR sonic-net/sonic-buildimage#21565 I think the test fails on KVM.

wajahatrazi · 2025-02-10T13:27:26Z

Hi @wen587

Following the YANG model PR that we have created to reflect these changes, is Kdump Remote ssh yang enhancements sonic-buildimage#19540. This YANG PR has not been merged yet.
All PRs related to Kdump remote SSH support are available at: Kdump_Remote_SSH_Support SONiC#1714

@muhammadalihussnain

Kindly look into the Updated Key and Path #209 to reflect the YANG model leaf variables into the hostcfg.

hdwhdw · 2025-02-10T20:48:25Z

@wajahatrazi @wen587 We should probably revert this since it is blocking integration of other sonic-host-services features. Once the dependencies are in, we can revert the revert.

Or does #209 fix the aforementioned error?

wajahatrazi · 2025-02-11T07:31:31Z

Hi @hdwhdw @wen587 . Following are the details:

We have tried to fix the problem, with hope that no errors comes up now :)

Details:

There were variables error in the HostCfgd for KDUMP, which were not reflecting with the YANG model.
@muhammadalihussnain created the PR#209, to fix the above reflection of variables, but there was a typo.
Now to fix everything as a whole, this new PR#216 has been created. This last PR has been created by to sync YANG model with the hostcfgd, replacing "ssh_key" with "ssh_string" as per YANG model.

Call 2 Action:

If we merge this PR#216, hostcfgd will fully reflect YANG, which may fix the errors.

Kindly suggest

Link to all PRs for the feature & HLD:
KDUMP_remote_ssh_enhancement

hdwhdw · 2025-02-11T18:58:52Z

@wajahatrazi I merged #216 and have a new PR sonic-net/sonic-buildimage#21708 to track if the merge to sonic-buildimage:master is successful.

hdwhdw · 2025-02-12T19:57:17Z

@wajahatrazi the build has failed with the following message:

12/02/2025 17:53:01 base._run                                L0108 DEBUG  | /var/src/sonic-mgmt/tests/common/devices/multi_asic.py::_run_on_asics#136: [vlab-01] AnsibleModule::shell Result => {"failed": true, "changed": true, "stdout": "sonic_yang(3):Data Loading Failed:Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).\nData Loading Failed\nValue \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).\nError: Failed to validate configuration: ConfigMgmt Class creation failed", "stderr": "libyang[0]: Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern). (path: /sonic-kdump:sonic-kdump/KDUMP/config/ssh_path)\nAborted!", "rc": 1, "cmd": "sudo config auto-techsupport global  rate-limit-interval 0", "start": "2025-02-12 17:53:00.240895", "end": "2025-02-12 17:53:01.298306", "delta": "0:00:01.057411", "msg": "non-zero return code", "invocation": {"module_args": {"_raw_params": "sudo config auto-techsupport global  rate-limit-interval 0", "_uses_shell": true, "warn": false, "stdin_add_newline": true, "strip_empty_ends": true, "argv": null, "chdir": null, "executable": null, "creates": null, "removes": null, "stdin": null}}, "stdout_lines": ["sonic_yang(3):Data Loading Failed:Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).", "Data Loading Failed", "Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).", "Error: Failed to validate configuration: ConfigMgmt Class creation failed"], "stderr_lines": ["libyang[0]: Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern). (path: /sonic-kdump:sonic-kdump/KDUMP/config/ssh_path)", "Aborted!"], "_ansible_no_log": null}

In particular:

"sonic_yang(3):Data Loading Failed:Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).", "Data Loading Failed", "Value \"<path>\" does not satisfy the constraint \"(/([a-zA-Z0-9._-]+|\\.)+)+\" (range, length, or pattern).",

This is from these two lines:

            "ssh_string": "<user@server>",   # New feature: SSH key, default value
            "ssh_path": "<path>"          # New feature: SSH path, default value

Can you fix it? Say leave the default value empty?

wajahatrazi · 2025-02-13T11:40:51Z

@hdwhdw As per the YANG model, we can set the default value as follows:

ssh_string : user@localhost
ssh_path : a/b/c

If there is some alternative name that can is preferable, kindly suggest

We cannot set default values as empty because of constraints

           ` leaf ssh_string {
                type string {
                    pattern "([a-zA-Z0-9._%+-]+@([a-zA-Z0-9.-]+|[0-9]{1,3}(\\.[0-9]{1,3}){3}))";
                }
                description  "Remote ssh connection string";

            }

            leaf ssh_path {
                type string {
                    pattern "(/([a-zA-Z0-9._-]+|\\.)+)+";
                }
                description  "Remote ssh private key path";

            }`

bingwang-ms · 2025-04-16T20:09:45Z

Hi @wajahatrazi @muhammadalihussnain , we saw some new error logs in virtual testbed. The errors are blocking PR test. Can you help take a look?

E               2025 Apr 16 02:31:12.765084 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--disable'] - failed: return code - 1, output:#012None
E               
E               2025 Apr 16 02:31:13.437314 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--memory', '0M-2G:256M,2G-4G:320M,4G-8G:384M,8G-:448M'] - failed: return code - 1, output:#012None
E               
E               2025 Apr 16 02:31:14.202462 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--num_dumps', '3'] - failed: return code - 1, output:#012None
E               
E               2025 Apr 16 02:31:15.166080 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--remote', 'false'] - failed: return code - 2, output:#012None
E               
E               2025 Apr 16 02:31:16.601173 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--ssh_string', 'user@localhost'] - failed: return code - 1, output:#012None
E               
E               2025 Apr 16 02:31:19.068750 vlab-01 ERR hostcfgd: ['sonic-kdump-config', '--ssh_path', '/a/b/c'] - failed: return code - 1, output:#012None

wajahatrazi · 2025-04-16T20:43:12Z

@muhammadalihussnain

wajahatrazi · 2025-05-05T08:00:32Z

Hi @bingwang-ms,

We have made changes to fix the errors. Can you please review these?

Thanks

kdump-remote feature in hostcfgd

2b481a4

muhammadalihussnain mentioned this pull request Sep 19, 2024

Kdump_Remote_SSH_Support sonic-net/SONiC#1714

Merged

venkatmahalingam reviewed Nov 11, 2024

View reviewed changes

venkatmahalingam reviewed Nov 26, 2024

View reviewed changes

muhammadalihussnain added 3 commits November 26, 2024 12:24

set values if remote enable

3f60bda

set values if remote enable

be93fd2

set values if remote enable

3417b5f

venkatmahalingam approved these changes Dec 2, 2024

View reviewed changes

wajahatrazi approved these changes Dec 16, 2024

View reviewed changes

FengPan-Frank approved these changes Jan 21, 2025

View reviewed changes

FengPan-Frank merged commit ca9d329 into sonic-net:master Jan 21, 2025

muhammadalihussnain mentioned this pull request Feb 11, 2025

Fixed: Reverted "ssh_key" to "ssh_string" #216

Merged

muhammadalihussnain mentioned this pull request Feb 13, 2025

Fix: Set default values for kdump enhancement #217

Merged

prabhataravind mentioned this pull request Apr 16, 2025

Bug: Kdump related errors seen during config reload on kvm testbeds sonic-net/sonic-buildimage#22346

Open

muhammadalihussnain mentioned this pull request Apr 21, 2025

KDUMP_REMOTE_BUG_FIX #244

Open

arista-nwolfe mentioned this pull request Oct 24, 2025

[action] [PR:237] [kdump-config] Update kdump default config with pre-defined value in /proc/cmdline (installer.conf) #315

Merged

10 tasks

Conversation

muhammadalihussnain commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

muhammadalihussnain commented Sep 19, 2024

Uh oh!

muhammadalihussnain commented Oct 2, 2024

Uh oh!

ridahanif96 commented Oct 28, 2024

Uh oh!

venkatmahalingam Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

ridahanif96 Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

venkatmahalingam Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

muhammadalihussnain Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

wajahatrazi commented Dec 4, 2024

Uh oh!

wajahatrazi commented Dec 10, 2024

Uh oh!

ridahanif96 commented Dec 14, 2024

Uh oh!

wajahatrazi left a comment

Choose a reason for hiding this comment

Uh oh!

zhangyanzhao commented Jan 21, 2025

Uh oh!

hdwhdw commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hdwhdw commented Feb 6, 2025

Uh oh!

wen587 commented Feb 7, 2025

Uh oh!

wajahatrazi commented Feb 10, 2025

Uh oh!

hdwhdw commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wajahatrazi commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hdwhdw commented Feb 11, 2025

Uh oh!

hdwhdw commented Feb 12, 2025

Uh oh!

wajahatrazi commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bingwang-ms commented Apr 16, 2025

Uh oh!

wajahatrazi commented Apr 16, 2025

Uh oh!

wajahatrazi commented May 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

muhammadalihussnain commented Sep 18, 2024 •

edited

Loading

hdwhdw commented Feb 6, 2025 •

edited

Loading

hdwhdw commented Feb 10, 2025 •

edited

Loading

wajahatrazi commented Feb 11, 2025 •

edited

Loading

wajahatrazi commented Feb 13, 2025 •

edited

Loading