mgmtd: missing docs

[eqvinox]

frr/doc/user/mgmtd.rst

Lines 73 to 79 in 06f54ff

	- Startup Database:
	- Consists of configuration data items only.
	- This is a copy of Running database that is stored in persistent
	storage and is used to load configurations on Running database during
	MGMT daemon startup.
	- Data cannot be edited/retrieved directly via Frontend interface.

There needs to be a little more documentation here, mostly regarding frr_startup.json. (It's mentioned further down, but not sufficient.)

Could you please explain:

• when exactly is frr_startup.json written. Is it only mgmt commit-apply?
• when is it read? Only at startup?
• is it necessary for the user to back up this file? What happens when the file is lost or corrupted?
• what happens when the user deletes all config in /etc/frr but leaves/forgets frr_startup.json - will config come back even though it was removed from /etc/frr? Can there be a conflict?
• how does frr version X.Y & frr profile <datacenter|traditional> work?

---

(accidentally commented this on #10000)

[manojvn]

frr/doc/user/mgmtd.rst

Lines 73 to 79 in 06f54ff

	- Startup Database:
	- Consists of configuration data items only.
	- This is a copy of Running database that is stored in persistent
	storage and is used to load configurations on Running database during
	MGMT daemon startup.
	- Data cannot be edited/retrieved directly via Frontend interface.

There needs to be a little more documentation here, mostly regarding frr_startup.json. (It's mentioned further down, but not sufficient.)

Could you please explain:

• when exactly is frr_startup.json written. Is it only mgmt commit-apply?
• when is it read? Only at startup?
• is it necessary for the user to back up this file? What happens when the file is lost or corrupted?
• what happens when the user deletes all config in /etc/frr but leaves/forgets frr_startup.json - will config come back even though it was removed from /etc/frr? Can there be a conflict?
• how does frr version X.Y & frr profile <datacenter|traditional> work?

(accidentally commented this on #10000)

Hi,

Please find the comments/response for your queries below.

The config tree is written to the frr_startup.json file only when commits are
merged successfully in other words when mgmt commit-apply returns success or
in case of commands with implicit commits when they return success without
any errors.

The frr_startup.json is read every-time when MGMTd comes up during the initialisation
stage. In case if the file is not present a new running configs is created with
empty configurations.

The frr_startup.json is config read file for MGMTd, so even if the frr.conf or
daemon related confs are deleted MGMT will still have frr_startup.json which
can reload these configuration.

As of now there are no changes in frr configuration versioning and profiling.
MGMTd commit does not make any changes for these, the config show commands like
show running-configs still work in traditional ways.

if the above explanations are good and clear all the doubts then I will move ahead and raise PR
with these response in the documentation file.

if there any other queries please let me know, I will update them as well.

[manojvn]

Since its decided to not to support for frr_startup.json, no additional information is needed relating to frr_startup.json.
So we can close this issue. we will add the proper documentation when/if we ever decided to support the frr_startup.json.

we have raised separate pull request to remove the present documentation related to frr_startup.json.
pr link : #13254

can you please close this bug, thanks

[github-actions]

This issue is stale because it has been open 180 days with no activity. Comment or remove the autoclose label in order to avoid having this issue closed.

[frrbot]

This issue will be automatically closed in the specified period unless there is further activity.