Support Reset factory #14105

Mohammedz93 · 2023-03-06T12:07:36Z

Why I did it

Support reset factory in Sonic OS
Reset Factory HLD
Sonic-mgmt tests

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.

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

linux-foundation-easycla · 2023-03-06T12:07:40Z

The committers listed above are authorized under a signed CLA.

✅ login: Mohammedz93 (75aff97, 4a90fca, dce4f6b, 71d5ae4, 275c013, 3ae528b, 9ba90d1, 4f11c0e, 251c47a, 8be655f, 837fd2b, 365e9c6)

liat-grozovik · 2023-03-21T11:25:51Z

@madhupalu @venkatmahalingam could you please help review the code PR following the HLD review?

liat-grozovik · 2023-03-21T11:26:30Z

@Mohammedz93 please check failures and if relevant to the changes you provided. if not, rerun

Mohammedz93 · 2023-04-16T12:18:20Z

@madhupalu @venkatmahalingam could you please review the PR ?

qiluo-msft · 2023-05-15T07:30:51Z

files/image_config/config-setup/config-setup

@@ -56,17 +57,31 @@ usage()
 EOF
 }

+# Factory command usage and help
+usage_factory()


usage_factory

Could you merge this function to above usage()? #Closed

Thanks for the comments.

usage_factory() is used for "config-setup factory" help command.
while useage() is used for "config-setup" help command.
Do you mean by merge, to combine the two functions into one function with parameter ?
if so, why do you think it is necessary ?

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

@rajendra-dendukuri Could you help review?

qiluo-msft · 2023-05-15T07:37:48Z

files/build_templates/sonic_debian_extension.j2

 j2 files/build_templates/config-setup.service.j2 | sudo tee $FILESYSTEM_ROOT_USR_LIB_SYSTEMD_SYSTEM/config-setup.service
 sudo cp $IMAGE_CONFIGS/config-setup/config-setup $FILESYSTEM_ROOT/usr/bin/config-setup
+sudo mkdir -p $FILESYSTEM_ROOT/etc/config-setup
+sudo cp $IMAGE_CONFIGS/config-setup/config-setup.conf $FILESYSTEM_ROOT/etc/config-setup/config-setup.conf


config-setup.conf

Let's remove all the filename if it is the same as source file. There is extreme corner case that there is a folder with the same name existing before copy, and the behavior is not expected. #Closed

I’m not sure if I am understanding correctly.
What do you mean by removing the filename ?
"/etc/config-setup" is a folder that was first introduced by by feature: SONiC-config-setup
It wasn't used until now but I think that this is correct path for locating the conf file
If the concern is that conf file name and folder name have the same prefix, we can change it to "config_setup.conf"

files/build_templates/default_users.json.j2

liat-grozovik · 2023-05-28T14:56:52Z

@qiluo-msft kindly reminder to review following comments handling

files/image_config/reset-factory/reset-factory

qiluo-msft · 2023-07-03T18:09:31Z

build_debian.sh

+export password_expire="$( [[ "$CHANGE_DEFAULT_PASSWORD" == "y" ]] && echo true || echo false )"
+export username="${USERNAME}"
+export password="$(sudo grep ^${USERNAME} $FILESYSTEM_ROOT/etc/shadow | cut -d: -f2)"
+j2 files/build_templates/default_users.json.j2 | sudo tee $FILESYSTEM_ROOT/etc/sonic/default_users.json


default_users.json.j2

Please check my comment on HLD PR: sonic-net/SONiC#1231 (review) #Closed

Please see my answer: sonic-net/SONiC#1231 (comment)

build_debian.sh

liat-grozovik · 2023-07-10T13:48:23Z

@dgsudharsan can you please review as well? if all good, I can move on and merge

dgsudharsan · 2023-07-11T22:25:27Z

@dgsudharsan can you please review as well? if all good, I can move on and merge

The changes look good. Please proceed with the merge

#### 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.

…sonic-buildimage into internal Fix conflict for rsyslog. Skip partial DNS unit test in internal branch after confirmed with Gang. Related work items: sonic-net#113, sonic-net#131, sonic-net#132, sonic-net#134, sonic-net#321, sonic-net#331, sonic-net#381, sonic-net#382, sonic-net#2525, sonic-net#2676, sonic-net#2698, sonic-net#2737, sonic-net#2789, sonic-net#2839, sonic-net#2845, sonic-net#2850, sonic-net#2882, sonic-net#2885, sonic-net#2887, sonic-net#2890, sonic-net#2895, sonic-net#13338, sonic-net#14105, sonic-net#15142, sonic-net#15223, sonic-net#15456, sonic-net#15487, sonic-net#15520, sonic-net#15726, sonic-net#15727, sonic-net#15758, sonic-net#15764, sonic-net#15765, sonic-net#15772, sonic-net#15779, sonic-net#15782, sonic-net#15785, sonic-net#15797, sonic-net#15798, sonic-net#15810, sonic-net#15811, sonic-net#15821

Mohammedz93 added 3 commits March 6, 2023 10:07

Support reset factory

75aff97

Add MGMT VRF table

4a90fca

Add expiration check for default passwords

dce4f6b

Mohammedz93 requested a review from lguohan as a code owner March 6, 2023 12:07

Mohammedz93 mentioned this pull request Mar 6, 2023

Reset factory hld sonic-net/SONiC#1231

Merged

Mohammedz93 changed the title ~~Reset factory~~ Support Reset factory Mar 6, 2023

Mohammedz93 closed this Mar 6, 2023

Mohammedz93 reopened this Mar 6, 2023

Mohammedz93 closed this Mar 21, 2023

Mohammedz93 reopened this Mar 21, 2023

Fix MAX UID and find command

71d5ae4

zhangyanzhao requested review from Prasanth-KV, baxia-lan and donNewtonIntel May 8, 2023 05:09

qiluo-msft reviewed May 15, 2023

View reviewed changes

files/build_templates/default_users.json.j2 Outdated Show resolved Hide resolved

Mohammedz93 and others added 2 commits May 16, 2023 14:21

Merge branch 'sonic-net:master' into reset_factory

275c013

Fix indentation in default users template

3ae528b

qiluo-msft previously approved these changes May 30, 2023

View reviewed changes

Mohammedz93 and others added 2 commits June 28, 2023 09:27

Merge branch 'sonic-net:master' into reset_factory

9ba90d1

Handle multiple database containers

4f11c0e

Mohammedz93 dismissed qiluo-msft’s stale review via 4f11c0e June 28, 2023 06:35

qiluo-msft reviewed Jul 2, 2023

View reviewed changes

files/image_config/reset-factory/reset-factory Outdated Show resolved Hide resolved

Mohammedz93 added 2 commits July 2, 2023 13:47

Fix containers removal print

251c47a

Use database pattern in containers removal

8be655f

qiluo-msft reviewed Jul 3, 2023

View reviewed changes

build_debian.sh Show resolved Hide resolved

Mohammedz93 and others added 2 commits July 4, 2023 17:10

Merge branch 'sonic-net:master' into reset_factory

837fd2b

Change the user and group of default users file

365e9c6

qiluo-msft approved these changes Jul 10, 2023

View reviewed changes

dgsudharsan approved these changes Jul 11, 2023

View reviewed changes

qiluo-msft merged commit 28b9299 into sonic-net:master Jul 11, 2023
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Reset factory #14105

Support Reset factory #14105

Mohammedz93 commented Mar 6, 2023 •

edited

Loading

linux-foundation-easycla bot commented Mar 6, 2023 •

edited

Loading

liat-grozovik commented Mar 21, 2023

liat-grozovik commented Mar 21, 2023

Mohammedz93 commented Apr 16, 2023

qiluo-msft May 15, 2023 •

edited

Loading

Mohammedz93 May 16, 2023

qiluo-msft commented May 15, 2023

qiluo-msft May 15, 2023 •

edited

Loading

Mohammedz93 May 16, 2023

liat-grozovik commented May 28, 2023

qiluo-msft Jul 3, 2023 •

edited

Loading

Mohammedz93 Jul 5, 2023

liat-grozovik commented Jul 10, 2023

dgsudharsan commented Jul 11, 2023

Support Reset factory #14105

Support Reset factory #14105

Conversation

Mohammedz93 commented Mar 6, 2023 • edited Loading

Why I did it

How I did it

How to verify it

Description for the changelog

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.

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

linux-foundation-easycla bot commented Mar 6, 2023 • edited Loading

liat-grozovik commented Mar 21, 2023

liat-grozovik commented Mar 21, 2023

Mohammedz93 commented Apr 16, 2023

qiluo-msft May 15, 2023 • edited Loading

Choose a reason for hiding this comment

Mohammedz93 May 16, 2023

Choose a reason for hiding this comment

qiluo-msft commented May 15, 2023

qiluo-msft May 15, 2023 • edited Loading

Choose a reason for hiding this comment

Mohammedz93 May 16, 2023

Choose a reason for hiding this comment

liat-grozovik commented May 28, 2023

qiluo-msft Jul 3, 2023 • edited Loading

Choose a reason for hiding this comment

Mohammedz93 Jul 5, 2023

Choose a reason for hiding this comment

liat-grozovik commented Jul 10, 2023

dgsudharsan commented Jul 11, 2023

Mohammedz93 commented Mar 6, 2023 •

edited

Loading

linux-foundation-easycla bot commented Mar 6, 2023 •

edited

Loading

qiluo-msft May 15, 2023 •

edited

Loading

qiluo-msft May 15, 2023 •

edited

Loading

qiluo-msft Jul 3, 2023 •

edited

Loading