Kdump_Remote_SSH_Support #1714

Ghulam-Bahoo · 2024-06-14T11:14:20Z

This HLD outlines the configuration and usage of the kdump remote feature with SSH for the SONiC network operating system. Kdump, a built-in Linux kernel feature, generates and stores a crash dump file in the event of a kernel panic. It extends beyond local storage by enabling remote dumps via SSH or NFS protocols, allowing you to transmit kernel crash data to a designated remote server. This functionality facilitates offline analysis by storing crash dump files remotely.

Repo	PR title	State
sonic-buildimage	Network_Setup for Kdump Remote Mode
sonic-utilities	kdump-Remote-SSH-Configurations
sonic-buildimage	YANG Model for KDUMP Remote SSH
sonic-host-services	kdump-remote feature in hostcfgd

zhangyanzhao · 2024-07-09T15:08:24Z

reviewed in community on 7/9/2024, recording can be found from https://zoom.us/rec/share/vlA3FUiC7lv0UK4edaEciUabfsFzyVRtTvB4-QmEZ33b-JOLcyuZCn8lsAOc9smz.Tqd4HaNLMQJQFHDM

zhangyanzhao · 2024-07-09T15:11:39Z

asked during the review meeting and keep a record here: current design only supports kdump to remote server over IPv4, no IPv6 support.

venkatmahalingam · 2024-07-09T15:55:03Z

doc/kdump/kdump_Remote_SSH_HLD.md

+leaf remote {
+   description "SSH Remote Config";
+
+					type string {


Can the type be boolean to represent true/false instead of string?

Yes, I will do this.

venkatmahalingam · 2024-07-09T15:57:30Z

doc/kdump/kdump_Remote_SSH_HLD.md

+
+    - Required for kdump_remote_ssh_dump: Initialize network interfaces and enable DHCP upon kernel crash. 
+
+2. files/scripts/network_setup.sh (New Addition)


Can you add some details for this new change? is this only for eth0 interface?

Yes, this script initializes the eth0 interface and enables dhcp on it.

venkatmahalingam · 2024-07-09T15:58:31Z

doc/kdump/kdump_Remote_SSH_HLD.md

+User be prompted to choose a location to save the key pair. By default, it saves the private key to ~/.ssh/id_rsa and the public key to ~/.ssh/id_rsa.pub.
+
+```
+admin@sonic: ssh-copy-id username@server_address


Is this the manual setup apart from configuring kdump CLI commands? can this be abstracted within kdump command?

Yes, it is a manual setup apart from kdump CLI commands. The manual setup ensures clarity and avoids the complexity and prompts that might arise from using kdump CLI commands.

Can you handle this as part of the Click command handler?

Yes, we can implement this through the CLI, but it would be more suitable for the user to generate the key and save it to the desired path, which can then be configured in the "kdump-tools" file

venkatmahalingam · 2024-07-09T16:01:21Z

doc/kdump/kdump_Remote_SSH_HLD.md

+					} 
+				}
+
+leaf ssh_connection_string {


Is it possible to add more than one remote IPs? e.g if one of the server is not reachable, is it possible to choose the alternate server to transfer the kdump data?

No this is not possible according to my understanding. There is variable #SSH in kdump-config file in /etc/default/kdump-tools directory, it allows you to add only one remote IP at a time.

venkatmahalingam · 2024-07-09T16:02:25Z

doc/kdump/kdump_Remote_SSH_HLD.md

+Kdump memory reservation: 512
+Maximum number of Kdump files: 3
+remote: true
+Kdump remote server user@ip/hostname: [email protected]


Have we tested the remote server reachability via mgmt VRF?

No, but I will test it and keep posted.

venkatmahalingam · 2024-07-09T16:07:05Z

asked during the review meeting and keep a record here: current design only supports kdump to remote server over IPv4, no IPv6 support.

IPv6 should work without any issues, we just need to validate this.

Ghulam-Bahoo · 2024-07-31T07:41:35Z

@venkatmahalingam We have edited the HLD please help review it and related code PR's.

Ghulam-Bahoo · 2024-07-31T10:28:10Z

asked during the review meeting and keep a record here: current design only supports kdump to remote server over IPv4, no IPv6 support.

This feature works fine with IPv6 as tested.

ridahanif96 · 2024-08-05T20:13:18Z

@venkatmahalingam Hi Venkat, Can you please help review HLD and its Linked PRs. Target is 202411

venkatmahalingam · 2024-08-09T06:36:08Z

@venkatmahalingam Hi Venkat, Can you please help review HLD and its Linked PRs. Target is 202411

Sure, will take a look next week.

venkatmahalingam · 2024-09-03T00:59:26Z

doc/kdump/kdump_Remote_SSH_HLD.md

+     type boolean;
+        }
+
+leaf ssh_stirng {


typo. string

venkatmahalingam · 2024-09-03T01:00:00Z

doc/kdump/kdump_Remote_SSH_HLD.md

+    type string;
+}
+
+leaf ssh_path {


Please add a description explaining the format for all fields.

Descriptions Added

venkatmahalingam · 2024-09-03T01:02:17Z

doc/kdump/kdump_Remote_SSH_HLD.md

+- CLI support for configuring remote kdump feature enable/disable via ssh.
+- CLI support for configuring username and hostname of ssh server (username@server_address).
+- CLI support for configuring SSH private key path for ssh server (SSH_private_Key_Path).
+- CLI support for displaying crededentials of ssh server.


typo. crededentials, please do a spell-checker for this HLD.

muhammadalihussnain · 2024-10-01T11:01:30Z

@venkatmahalingam Hi, We have updated daemon as per your suggestion. Please help review updated HLD and linked code PRs. Target is 202411. Thanks in advance

ridahanif96

LGTM

zhangyanzhao · 2024-12-10T05:17:42Z

code PRs are not merged yet, move to backlog

wajahatrazi · 2024-12-10T08:48:26Z

Hi @zhangyanzhao / @qiluo-msft

We have been requesting a merge of Code PRs for days before the release.

All code PRs pass checks and have been approved by the reviewers.

Every week, we are requesting for review and approval. Kindly help merge these PRs.

Thanks

ridahanif96 · 2024-12-10T19:44:46Z

code PRs are not merged yet, move to backlog

@zhangyanzhao Code PRs are done since long and approved but still awaiting for merge. We are already pushing hard for repo owner to merge it.

@qiluo-msft kindly merged these approved code PRs.

Ghulam-Bahoo added 3 commits June 14, 2024 16:11

initial version

f7cc192

initial version

28467ff

Made Enhancements

cdba0c9

venkatmahalingam reviewed Jul 9, 2024

View reviewed changes

Update kdump_Remote_SSH_HLD.md

31ad8b1

Update kdump_Remote_SSH_HLD.md

7695f58

venkatmahalingam reviewed Sep 3, 2024

View reviewed changes

fixed typos and leaf descriptions

40c6dec

muhammadalihussnain mentioned this pull request Sep 19, 2024

kdump-remote feature in hostcfgd sonic-net/sonic-host-services#166

Open

Added Hostcfg detail

2f05dc9

ridahanif96 mentioned this pull request Nov 11, 2024

Kdump Remote SSH Config Enhancements #1711

Closed

venkatmahalingam approved these changes Nov 11, 2024

View reviewed changes

ridahanif96 approved these changes Nov 13, 2024

View reviewed changes

ridahanif96 merged commit b546506 into sonic-net:master Nov 19, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kdump_Remote_SSH_Support #1714

Kdump_Remote_SSH_Support #1714

Ghulam-Bahoo commented Jun 14, 2024 •

edited by ridahanif96

Loading

zhangyanzhao commented Jul 9, 2024

zhangyanzhao commented Jul 9, 2024

venkatmahalingam Jul 9, 2024 •

edited

Loading

Ghulam-Bahoo Jul 11, 2024

venkatmahalingam Jul 9, 2024 •

edited

Loading

Ghulam-Bahoo Jul 10, 2024

venkatmahalingam Jul 9, 2024

Ghulam-Bahoo Jul 10, 2024

venkatmahalingam Aug 19, 2024

muhammadalihussnain Aug 19, 2024

venkatmahalingam Jul 9, 2024

Ghulam-Bahoo Jul 10, 2024

venkatmahalingam Jul 9, 2024

Ghulam-Bahoo Jul 10, 2024

venkatmahalingam commented Jul 9, 2024

Ghulam-Bahoo commented Jul 31, 2024

Ghulam-Bahoo commented Jul 31, 2024

ridahanif96 commented Aug 5, 2024

venkatmahalingam commented Aug 9, 2024

venkatmahalingam Sep 3, 2024

muhammadalihussnain Sep 6, 2024

venkatmahalingam Sep 3, 2024

muhammadalihussnain Sep 6, 2024 •

edited

Loading

venkatmahalingam Sep 3, 2024

muhammadalihussnain Sep 6, 2024

muhammadalihussnain commented Oct 1, 2024

ridahanif96 left a comment

zhangyanzhao commented Dec 10, 2024

wajahatrazi commented Dec 10, 2024

ridahanif96 commented Dec 10, 2024


		- Required for kdump_remote_ssh_dump: Initialize network interfaces and enable DHCP upon kernel crash.

		2. files/scripts/network_setup.sh (New Addition)

Kdump_Remote_SSH_Support #1714

Kdump_Remote_SSH_Support #1714

Conversation

Ghulam-Bahoo commented Jun 14, 2024 • edited by ridahanif96 Loading

zhangyanzhao commented Jul 9, 2024

zhangyanzhao commented Jul 9, 2024

venkatmahalingam Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

venkatmahalingam commented Jul 9, 2024

Ghulam-Bahoo commented Jul 31, 2024

Ghulam-Bahoo commented Jul 31, 2024

ridahanif96 commented Aug 5, 2024

venkatmahalingam commented Aug 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

muhammadalihussnain Sep 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

muhammadalihussnain commented Oct 1, 2024

ridahanif96 left a comment

Choose a reason for hiding this comment

zhangyanzhao commented Dec 10, 2024

wajahatrazi commented Dec 10, 2024

ridahanif96 commented Dec 10, 2024

Ghulam-Bahoo commented Jun 14, 2024 •

edited by ridahanif96

Loading

venkatmahalingam Jul 9, 2024 •

edited

Loading

venkatmahalingam Jul 9, 2024 •

edited

Loading

muhammadalihussnain Sep 6, 2024 •

edited

Loading