[CLI] Move hostname, mgmt interface/vrf config to hostcfgd #2173

fastiuk · 2022-05-18T15:30:06Z

Why I did it

To be able to configure the management interface and hostname standalone by changing database config at runtime.
From the CLI perspective fo view, the following behavior is the same. But now you have two ways of configuring it: CLI, directly through the database.

How I did it

Moved configuration part of the interface and hostname to "hostcfgd".

How to verify it

Built an image
Flash it to the switch
Run CLI commands

# Set IP address: verify address is set on the iface
sudo config interface ip add eth0 10.210.25.127/22 10.210.24.1
ip address show eth0
# 2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
#     link/ether 98:03:9b:a2:be:80 brd ff:ff:ff:ff:ff:ff
#     inet 10.210.25.127/22 brd 10.210.27.255 scope global eth0
#        valid_lft forever preferred_lft forever
#     inet6 fe80::9a03:9bff:fea2:be80/64 scope link
#       valid_lft forever preferred_lft forever

# Remove IP address: verify you received address form DHCP
sudo config interface ip remove eth0 10.210.25.127/22
ip address show eth0
# 2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
#     link/ether 98:03:9b:a2:be:80 brd ff:ff:ff:ff:ff:ff
#     inet 10.210.25.127/22 brd 10.210.27.255 scope global eth0
#        valid_lft forever preferred_lft forever
#     inet6 fe80::9a03:9bff:fea2:be80/64 scope link
#       valid_lft forever preferred_lft forever

# Enable/disable mgmt VRF
ip address show mgmt
# Device "mgmt" does not exist.

sudo config vrf add mgmt
ip address show mgmt
# 72: mgmt: <NOARP,MASTER,UP,LOWER_UP> mtu 65575 qdisc noqueue state UP group default qlen 1000
#     link/ether fa:9b:ad:7b:1e:83 brd ff:ff:ff:ff:ff:ff

sudo config vrf del mgmt
ip address show mgmt
# Device "mgmt" does not exist.

# Setting the hostname
admin@r-anaconda-27:~$ sudo config hostname bla
# Login / Logout
admin@bla:~$

Description for the changelog

Moved management interface configuration to hostcfgd.
Moved management VRF configuration to hostcfgd.
Moved hostname configuration to hostcfgd.

ghost · 2022-05-18T15:30:19Z

All CLA requirements met.

dgsudharsan

Please add UT for the hostname add. Else the coverage will fail.

liat-grozovik · 2022-06-14T07:15:20Z

@fastiuk when do you think UT will be avaialble so we can review and signoff?

fastiuk · 2022-06-20T02:01:12Z

@fastiuk when do you think UT will be avaialble so we can review and signoff?

Done

fastiuk · 2022-06-21T18:29:59Z

@dgsudharsan Please take a look at this one as well. It is part of the same changes: sonic-net/sonic-buildimage#10868

qiluo-msft · 2022-07-17T22:37:29Z

config/main.py

-    clicommon.run_command("sudo monit reload")
-
-    click.echo("Please note loaded setting will be lost after system reboot. To preserve setting, run `config save`.")
+    click.echo('Please note loaded setting will be lost after system reboot. To'


(

Could you use click.wrap_text() to wrap long line instead of manually wrap? #Closed

I am wrapping just the code string here. The log line in runtime will be the same as it was before this change.

prsunny · 2022-07-20T00:57:47Z

config/main.py

@@ -2671,22 +2664,6 @@ def warm_restart_bgp_eoiu(ctx, enable):
    db = ctx.obj['db']
    db.mod_entry('WARM_RESTART', 'bgp', {'bgp_eoiu': enable})

-def mvrf_restart_services():


I see that the code to restart services are moved to hostcfgd. What is the benefit that we are getting by this approach? What is missing in the current approach?

The benefit here is that you can configure your switch without the cli, by just writing configuration data at runtime to the Redis DB.
With the current approach, the only way to load a new MGMT iface config was using sonic cli.
The new approach will allow you to configure it without calling sonic cli. You just write config to DB and voila, everything will be configured.

I don't think that is expected to be supported. We use CLI to configure the DB and there are multiple validations done at the CLI level (For e.g, validate IP address corrrectness etc). So why should not we use the CLI here?

I disagree.
Example: SONiC has the ability to configure syslog servers. It has a dedicated table for it but doesn't have cli to do such configuration. That means that the only way to configure it is through the DB.
Another example: What if you don't need CLI at all? You have SNMP server and it configures your switch. It won't be possible if commands which are required to make configuration reside here in cli.

afaik, there is CLI for syslog, you can also refer this. #2191. The point is, if there is a need for configuring after the initial config, then it should ideally have a CLI. We don't need CLI for those configs that can be applied at startup (via config_db.json or equivalent..) and not to be changed later.

The point is, if there is a need for configuring after the initial config, then it should ideally have a CLI.

Agree. But we can do it without CLI as well, right? It is not prohibited, SONiC is an open Linux system, so why a user can't just use it the way it wants?

We don't need CLI for those configs that can be applied at startup (via config_db.json or equivalent..)

Agree, so that is why I proposing those changes. It allows users to have yet another way to configure its switch. The CLI is still here, so you can still configure your switch via CLI (And most users will do so).

Signed-off-by: Yevhen Fastiuk <[email protected]>

prsunny

Discussed offline on the use-case. Signing-off from my side.

liat-grozovik · 2022-08-08T12:27:18Z

/easycla

linux-foundation-easycla · 2022-08-08T12:27:22Z

The committers listed above are authorized under a signed CLA.

✅ login: fastiuk / name: Yevhen Fastiuk (39cb45c, 26866a2, 64bca6e)

fastiuk · 2022-08-08T12:35:16Z

/easycla

Update sonic-utilities submodule pointer to include the following: * Convert IPv6 addresses to lowercase in apply-patch ([sonic-net#2299](sonic-net/sonic-utilities#2299)) * [CLI] Move hostname, mgmt interface/vrf config to hostcfgd ([sonic-net#2173](sonic-net/sonic-utilities#2173)) * [config][muxcable] add support to enable/disable ycable telemetry ([sonic-net#2297](sonic-net/sonic-utilities#2297)) Signed-off-by: dprital <[email protected]>

Update sonic-utilities submodule pointer to include the following: * Convert IPv6 addresses to lowercase in apply-patch ([#2299](sonic-net/sonic-utilities#2299)) * [CLI] Move hostname, mgmt interface/vrf config to hostcfgd ([#2173](sonic-net/sonic-utilities#2173)) * [config][muxcable] add support to enable/disable ycable telemetry ([#2297](sonic-net/sonic-utilities#2297)) Signed-off-by: dprital <[email protected]>

This PR depends on sonic-net/sonic-utilities#2173 #### Why I did it To be able to configure the management interface and hostname standalone by changing database config at runtime. From the CLI perspective fo view, the following behavior is the same. But now you have two ways of configuring it: CLI, directly through the database. #### How I did it Moved configuration part of the interface and hostname to "hostcfgd". #### How to verify it * Built an image * Flash it to the switch * Run CLI commands ``` # Set IP address: verify address is set on the iface sudo config interface ip add eth0 10.210.25.127/22 10.210.24.1 ip address show eth0 # 2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000 # link/ether 98:03:9b:a2:be:80 brd ff:ff:ff:ff:ff:ff # inet 10.210.25.127/22 brd 10.210.27.255 scope global eth0 # valid_lft forever preferred_lft forever # inet6 fe80::9a03:9bff:fea2:be80/64 scope link # valid_lft forever preferred_lft forever # Remove IP address: verify you received address form DHCP sudo config interface ip remove eth0 10.210.25.127/22 ip address show eth0 # 2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000 # link/ether 98:03:9b:a2:be:80 brd ff:ff:ff:ff:ff:ff # inet 10.210.25.127/22 brd 10.210.27.255 scope global eth0 # valid_lft forever preferred_lft forever # inet6 fe80::9a03:9bff:fea2:be80/64 scope link # valid_lft forever preferred_lft forever # Enable/disable mgmt VRF ip address show mgmt # Device "mgmt" does not exist. sudo config vrf add mgmt ip address show mgmt # 72: mgmt: <NOARP,MASTER,UP,LOWER_UP> mtu 65575 qdisc noqueue state UP group default qlen 1000 # link/ether fa:9b:ad:7b:1e:83 brd ff:ff:ff:ff:ff:ff sudo config vrf del mgmt ip address show mgmt # Device "mgmt" does not exist. # Setting the hostname admin@r-anaconda-27:~$ sudo config hostname bla # Login / Logout admin@bla:~$ ``` #### Description for the changelog * Moved management interface configuration to hostcfgd. * Moved management VRF configuration to hostcfgd. * Moved hostname configuration to hostcfgd. #### Submodules PR's : | Repo | PR title | State | | ----------------- | ----------------- | ----------------- | | sonic-utilities | [[CLI] Move hostname, mgmt interface/vrf config to hostcfgd](sonic-net/sonic-utilities#2173) | ![GitHub issue/pull request detail](https://img.shields.io/github/pulls/detail/state/Azure/sonic-utilities/2173) |

…#2173) - Why I did it To be able to configure the management interface and hostname standalone by changing database config at runtime. From the CLI perspective fo view, the following behavior is the same. But now you have two ways of configuring it: CLI, directly through the database. - How I did it Moved configuration part of the interface and hostname to "hostcfgd". - How to verify it Built an image Flash it to the switch Run CLI commands Signed-off-by: Yevhen Fastiuk <[email protected]>

fastiuk mentioned this pull request May 18, 2022

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd sonic-net/sonic-buildimage#10868

Closed

6 tasks

fastiuk changed the title ~~Move cli to hostcfgd~~ [CLI] Move hostname, mgmt interface/vrf config to hostcfgd May 19, 2022

dgsudharsan suggested changes May 21, 2022

View reviewed changes

dgsudharsan previously approved these changes Jun 21, 2022

View reviewed changes

qiluo-msft reviewed Jul 17, 2022

View reviewed changes

qiluo-msft requested a review from prsunny July 17, 2022 22:57

prsunny requested changes Jul 20, 2022

View reviewed changes

fastiuk added 3 commits July 20, 2022 17:25

Move hostname handling to hostcfgd

39cb45c

Signed-off-by: Yevhen Fastiuk <[email protected]>

Move mgmt handling to hostcfgd

26866a2

Signed-off-by: Yevhen Fastiuk <[email protected]>

Add test for hostname setting

64bca6e

Signed-off-by: Yevhen Fastiuk <[email protected]>

fastiuk dismissed dgsudharsan’s stale review via 64bca6e July 20, 2022 14:34

fastiuk force-pushed the dev-move-cli-to-hostcfgd branch from 7c3e28b to 64bca6e Compare July 20, 2022 14:34

fastiuk mentioned this pull request Jul 20, 2022

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd sonic-net/sonic-host-services#2

Merged

6 tasks

prsunny approved these changes Jul 25, 2022

View reviewed changes

qiluo-msft approved these changes Jul 25, 2022

View reviewed changes

liat-grozovik merged commit 14c483f into sonic-net:master Aug 10, 2022

dprital mentioned this pull request Aug 11, 2022

[submodule] Advance sonic-utilities pointer sonic-net/sonic-buildimage#11698

Merged

7 tasks

fastiuk deleted the dev-move-cli-to-hostcfgd branch August 30, 2022 07:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd #2173

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd #2173

fastiuk commented May 18, 2022 •

edited

Loading

ghost commented May 18, 2022 •

edited by ghost

Loading

dgsudharsan left a comment

liat-grozovik commented Jun 14, 2022

fastiuk commented Jun 20, 2022

fastiuk commented Jun 21, 2022

qiluo-msft Jul 17, 2022 •

edited

Loading

fastiuk Jul 20, 2022

prsunny Jul 20, 2022

fastiuk Jul 20, 2022

prsunny Jul 20, 2022

fastiuk Jul 21, 2022

prsunny Jul 21, 2022

fastiuk Jul 22, 2022

prsunny left a comment

liat-grozovik commented Aug 8, 2022

linux-foundation-easycla bot commented Aug 8, 2022 •

edited

Loading

fastiuk commented Aug 8, 2022

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd #2173

[CLI] Move hostname, mgmt interface/vrf config to hostcfgd #2173

Conversation

fastiuk commented May 18, 2022 • edited Loading

Why I did it

How I did it

How to verify it

ghost commented May 18, 2022 • edited by ghost Loading

dgsudharsan left a comment

Choose a reason for hiding this comment

liat-grozovik commented Jun 14, 2022

fastiuk commented Jun 20, 2022

fastiuk commented Jun 21, 2022

qiluo-msft Jul 17, 2022 • edited Loading

Choose a reason for hiding this comment

fastiuk Jul 20, 2022

Choose a reason for hiding this comment

prsunny Jul 20, 2022

Choose a reason for hiding this comment

fastiuk Jul 20, 2022

Choose a reason for hiding this comment

prsunny Jul 20, 2022

Choose a reason for hiding this comment

fastiuk Jul 21, 2022

Choose a reason for hiding this comment

prsunny Jul 21, 2022

Choose a reason for hiding this comment

fastiuk Jul 22, 2022

Choose a reason for hiding this comment

prsunny left a comment

Choose a reason for hiding this comment

liat-grozovik commented Aug 8, 2022

linux-foundation-easycla bot commented Aug 8, 2022 • edited Loading

fastiuk commented Aug 8, 2022

fastiuk commented May 18, 2022 •

edited

Loading

ghost commented May 18, 2022 •

edited by ghost

Loading

qiluo-msft Jul 17, 2022 •

edited

Loading

linux-foundation-easycla bot commented Aug 8, 2022 •

edited

Loading