Skip to content

Commit 9e06354

Browse files
committed
Update wording
1 parent 38002fd commit 9e06354

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

doc/mgmt/gnmi/save_on_set.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Add the option for enabling the SONiC gNMI implementation to save its in-memory
4545
- [gNMI](https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md) - Google Network Management Interface
4646
- UMF - Unified Management Framework
4747

48-
4948
### Overview
5049

5150
Having configuration be persistant across switch reboot is a useful feature that is not currently implemented by UMF.
@@ -60,6 +59,7 @@ For this reason and for more versatility the save-on-set behavior should be able
6059
### Requirements
6160

6261
This feature should be off by default to avoid interfering with legacy switches.
62+
6363
### Architecture Design
6464

6565
This feature does not change the SONiC Architecture
@@ -106,9 +106,12 @@ This feature does not change the SONiC Architecture
106106
#### Required Changes
107107

108108
##### Telemetry Executable
109+
109110
A new command-line parameter will be added to control the behavior of the save-on-set functionality. By default, i.e. when the option is not specified, the gNMI server will behave as it did before this change - the configuration will not be saved to a file without explicit action from the administrator for example by execution of a command via ssh connection.
110111

111-
The new parameter will be: --with-save-on-set and when present it will configure a function pointer variable gnmi.SaveOnSet to point to a function that actually performs the save operation.
112+
The telemetry.sh startup script will be modified to read `TELEMETRY|gnmi|save_on_set` and pass the value along during startup. Any changes to this value will only take effect after restarting telemetry.
113+
114+
The new parameter will be: --with-save-on-set and when present it will configure a function pointer variable gnmi.SaveOnSet to point to a function that initiates the save operation.
112115

113116
```go
114117
var (
@@ -123,7 +126,8 @@ if *withSaveOnSet {
123126
```
124127

125128
##### Call to Save ConfigDB
126-
A function to initial the backup located in the sonic-mgmt-framework.
129+
130+
A function to initialize the backup located in the sonic-mgmt-framework.
127131

128132
```go
129133
// SaveConfig initiates the operation of saving the current content of
@@ -212,7 +216,8 @@ No effect on warm/fast boot
212216
#### Unit Test cases
213217

214218
- No behavior change if the feature is not enabled.
215-
- A gNMI.Set() call should generate a signal to save ConfigDB.
219+
- A gNMI.Set() call should generate a message to save ConfigDB on the DBUS when enabled.
220+
216221
#### System Test cases
217222

218223
- A gNMI.Set() call should result in an update to the ConfigDB backup file.

0 commit comments

Comments
 (0)