Reset factory hld #1231

Mohammedz93 · 2023-01-23T11:17:56Z

This PR provides high level design for Reset factory.

PR title	state	context
[sonic-buildimage] Support Reset factory
[sonic-mgmt] Reset factory tests

Initial HLD of reset factory feature

into reset_factory_hld

skg-net

Thanks for the HLD.

Can you elaborate on the keep-basic? I see you have mentioned few tables, how the dependencies between the tables will be addressed. Is there a guideline which tables are allowed etc?
Can you add details how ssh keys will be handled during factory reset?
I assume the users will also be deleted during factory reset, in that case I'm not sure why to retain the home directory.
Is there a clear logs command in SONiC? if yes, how is keep-all-config different from clear logs command?

jeffhtgt · 2023-01-24T16:26:54Z

doc/reset_factory/ResetFactoryHLD.md

+
+## 4 <a name='CLI'></a>CLI
+
+#### reset-factory


From an implementation/design perspective, can the command be "reset factory" (no hyphen) and implemented like the current cli/click commands (config, show, etc.)? This would allow the ability to add different reset sub-commands in the future.

"reset" is already utilized in Linux for terminal initialization. please see reset
The idea was to implement it as bash script ( same as config-setup) for better performances, as we are going only to clear files and run Linux shell commands.

venkatmahalingam · 2023-01-24T16:45:20Z

doc/reset_factory/ResetFactoryHLD.md

+```
+==============================================================================
+root@host:~$ sudo reset-factory --help
+ Usage:  reset-factory < keep-all-config | only-config | keep-basic >


Add 'none' or 'default' option as well.

I think it would be confusing to print something like:
Usage: reset-factory < none | keep-all-config | only-config | keep-basic >
I will explain about the default flow before the parameters (line 185)

venkatmahalingam · 2023-01-24T16:50:20Z

doc/reset_factory/ResetFactoryHLD.md

+         Create factory default configuration and save it to
+         to ${CONFIG_DB_JSON}.
+
+         keep-basic  - Preserves basic configurations only.


keep-basic name doesnot look right, is it possible to have a default 'filter-list' with tables (e.g MGMT_PORT,MGMT_INTERFACE,PASSW_HARDENING), hope user can dynamically provide the tables to filter in a file as an option during factory-reset command execution..

Please see my comment
We need to take into account the user use case.
We want to allow the user to reset the system to factory settings without losing basic configurations.
I feel that "keep-basic" suits the use case and it explains the functionality of the command better than "filter-list".
Vendor can still extend/replace this list by changing "config-setup.conf" as explained in the design.

madhupalu · 2023-01-24T16:24:30Z

doc/reset_factory/ResetFactoryHLD.md

+###  3.1 <a name='Reset-Factory'></a>Reset-Factory
+
+##### Default
+It will generate the default config_db.json file by running command:<br/>


What is really factory reset means? How is different from brand new device vs the factory reset device?
Ex: Use case - if RMA device or send device back to vendor wanted to delete all the data for security reasons?

Remove /etc/sonic files

users & passwd

dockers overlay filesystem

There are a few use cases:

System was tested in the vendor's lab prior to shipment to customer. before shipment any configuration should be deleted. but software installation should remain as is.

Customer got to configuration conflict and wishes to start from scratch.

Wiping information for security reason, before moving the system (including the case of shipping back to the vendor).

I would say that we want the system to function as a newly manufactured system.
This does not mean that the file system must be in the same state.
We want to achieve that by:

Resetting configurations to defaults (config_db.json)

Clear files that may potentially affect the functionality or user experience :
This is very challenging as sudo user can change almost any file/directory in the system.
We will try to cover the files that might be changed by the system.
If the user choose to change the file system directly rather than using the CLI/official APIs, then the responsibility falls on him.

Remove /etc/sonic files:
I believe we can clear the /etc/sonic directory under the upperdir of overlayfs (e.g. /host/image*/rw/etc/sonic)
but I need to test it in different scenarios first.

users & passwd:
This will be handled by User MGMT feature.
but since Reset Factory might be merged before User MGMT, we will handle this also.
We will delete non-default users and configure the default password for default users (e.g. admin )

dockers overlay filesystem:
As discussed in the HLD review meeting, this will be covered by removing all docker containers on system.

I will update this HLD with the latest changes very soon,

madhupalu · 2023-01-24T16:27:15Z

doc/reset_factory/ResetFactoryHLD.md

+#### reset-factory
+```
+==============================================================================
+root@host:~$ sudo reset-factory --help


Please support yang model for this new configurations.

Why we need yang model ? isn't only for DB tables ?
We add any new DB table.

madhupalu · 2023-01-24T16:28:32Z

doc/reset_factory/ResetFactoryHLD.md

+config-setup factory<br/>
+It will clear system logs and files.
+
+##### Keep-basic


what are the use cases and the scope addressed by this design?

We want to allow the user to preserve a basic set of configurations that he will likely always want to to preserve and settings necessary for the box to be reachable from the outside.
So user won't need to reconfigure his MGMT interface, ssh servers and users of the system ( in future).

In this design, we are defining the default basic tables that we will preserve in the new "config_db.json" file. but vendors might choose to overwrite/extend this list by changing "config-setup..conf" file.

madhupalu · 2023-01-24T16:43:15Z

doc/reset_factory/ResetFactoryHLD.md

+##### Only-config
+It will generate the default config_db.json file by running command:<br/>
+config-setup factory only-config<br/>
+It won't clear system logs and files.


Does design handles bgp-frr-config which stored in BGP docker mounted to /etc/sonic?

Please see my comment
I believe this will cover it.
But I would like to know that exact flow and path of folder, Can you please share the relevant HLD/File ?

madhupalu · 2023-01-24T16:51:45Z

doc/reset_factory/ResetFactoryHLD.md

+  - Run reset-factory without parameters
+  - Run reset-factory with keep-all-config/only-config/keep-basic
+  - Run config-setup factory without parameters
+  - Run config-setup factory with keep-basic


Can this HLD handle a warm reboot scenario where synd has files mounted to sda3 ?

Are you referring to files under "/host/warmboot" ?
If so, I believe we can just clear this directory as we are going also to clear the reboot-cause folder "/host/reboot-cause"

liat-grozovik · 2023-02-05T11:01:13Z

@madhupalu @venkatmahalingam please review HLD fixes following your comments.

liat-grozovik · 2023-02-27T09:20:27Z

@madhupalu please review comments reply. if you have no further concern please approve the PR.
@venkatmahalingam and further comments from your side?

Note: if no other comments provided by end of this week, the HLD PR will be merged.

liat-grozovik · 2023-03-09T12:17:35Z

@venkatmahalingam any further comment? if, not please approve so we can merge the HLD and start with the code PR review.

liat-grozovik · 2023-03-16T10:47:28Z

@zhangyanzhao I suggest to merge this HLD as of approval and no additional comments in the last 2 weeks.

qiluo-msft · 2023-05-15T07:34:56Z

@rajendra-dendukuri Could you help review (even it is already merged)?

doc/reset_factory/ResetFactoryHLD.md

#### Why I did it Support reset factory in Sonic OS [Reset Factory HLD](sonic-net/SONiC#1231) [Sonic-mgmt tests](sonic-net/sonic-mgmt#7652) #### How I did it - Added new script "/usr/bin/reset-factory" * It generates a new config_db.json files with factory configurations * It clears system files and logs * It removes all docker containers on system except database * It clears non-default users and restores default users password - Dump the default users info to a new file during build "/etc/sonic/default_users.json" - Supported new type "Keep-basic" in "config-setup factory" - Add new conf file for config-setup "/etc/config-setup/config-setup.conf #### How to verify it - Run reset-factory script with all types: < none | keep-all-config | only-config | keep-basic > - Run config-setup factory with parameters < none | keep-basic > #### Description for the changelog Support reset factory in Sonic OS #### Ensure to add label/tag for the feature raised. example - PR#2174 under sonic-utilities repo. where, Generic Config and Update feature has been labelled as GCU.

skg-net · 2024-02-06T00:32:02Z

@Mohammedz93 Can you please update the Quality Metric (Alpha/Beta/GA) for the feature either in this PR comments or in HLD itself based on https://github.com/sonic-net/SONiC/blob/master/doc/SONiC%20feature%20quality%20definition.md
Thanks

Mohammedz93 added 6 commits January 5, 2023 16:20

Reset Factory HLD

87a2bd0

Initial HLD of reset factory feature

HLD Fixes

2c43fa5

Add error flow + fixes

6e7fe8a

Merge branch 'master' into reset_factory_hld

2dab30a

Typo fix

77276b2

Merge branch 'reset_factory_hld' of https://github.com/Mohammedz93/SONiC

903a1a3

into reset_factory_hld

Mohammedz93 mentioned this pull request Jan 23, 2023

Factory reset #1170

Open

skg-net reviewed Jan 23, 2023

View reviewed changes

Mohammedz93 added 2 commits January 24, 2023 15:24

Change diagram

4e0fafa

Fix diagram

77e26df

jeffhtgt reviewed Jan 24, 2023

View reviewed changes

venkatmahalingam reviewed Jan 24, 2023

View reviewed changes

madhupalu reviewed Jan 24, 2023

View reviewed changes

Mohammedz93 added 2 commits February 3, 2023 10:21

Merge branch 'master' into reset_factory_hld

4cbf1f3

HLD Fixes

02dbd98

madhupalu approved these changes Feb 27, 2023

View reviewed changes

Mohammedz93 mentioned this pull request Mar 6, 2023

Support Reset factory sonic-net/sonic-buildimage#14105

Merged

Merge branch 'master' into reset_factory_hld

ee884d9

venkatmahalingam approved these changes Mar 17, 2023

View reviewed changes

skg-net approved these changes Mar 17, 2023

View reviewed changes

jeffhtgt approved these changes Mar 21, 2023

View reviewed changes

Merge branch 'master' into reset_factory_hld

9057607

liat-grozovik approved these changes Apr 13, 2023

View reviewed changes

liat-grozovik merged commit 04c208a into sonic-net:master Apr 13, 2023

qiluo-msft reviewed Jul 3, 2023

View reviewed changes

doc/reset_factory/ResetFactoryHLD.md Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reset factory hld #1231

Reset factory hld #1231

Mohammedz93 commented Jan 23, 2023 •

edited

Loading

skg-net left a comment •

edited

Loading

jeffhtgt Jan 24, 2023

Mohammedz93 Jan 26, 2023

venkatmahalingam Jan 24, 2023

Mohammedz93 Jan 26, 2023 •

edited

Loading

venkatmahalingam Jan 24, 2023

Mohammedz93 Jan 26, 2023

madhupalu Jan 24, 2023

Mohammedz93 Jan 26, 2023

madhupalu Jan 24, 2023

Mohammedz93 Jan 26, 2023

madhupalu Jan 24, 2023

Mohammedz93 Jan 26, 2023

madhupalu Jan 24, 2023

Mohammedz93 Jan 26, 2023

madhupalu Jan 24, 2023

Mohammedz93 Jan 26, 2023

liat-grozovik commented Feb 5, 2023

liat-grozovik commented Feb 27, 2023

liat-grozovik commented Mar 9, 2023

liat-grozovik commented Mar 16, 2023

qiluo-msft commented May 15, 2023

skg-net commented Feb 6, 2024

Reset factory hld #1231

Reset factory hld #1231

Conversation

Mohammedz93 commented Jan 23, 2023 • edited Loading

skg-net left a comment • 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

Mohammedz93 Jan 26, 2023 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liat-grozovik commented Feb 5, 2023

liat-grozovik commented Feb 27, 2023

liat-grozovik commented Mar 9, 2023

liat-grozovik commented Mar 16, 2023

qiluo-msft commented May 15, 2023

skg-net commented Feb 6, 2024

Mohammedz93 commented Jan 23, 2023 •

edited

Loading

skg-net left a comment •

edited

Loading

Mohammedz93 Jan 26, 2023 •

edited

Loading