Support redis databases in multiple namespaces #567

lguohan · 2020-02-29T12:54:13Z

No description provided.

doc/database/multi_namespace_db_instances.md

lguohan · 2020-02-29T12:56:30Z

doc/database/multi_namespace_db_instances.md

+
+The file database_config.json contains the startup configuration which dictates the redis server host/port/unix_socket configurations + various available databases ( eg: APP_DB, CONFIG_DB ) etc. With the introduction of multiple namespaces, there is a need for separate database_config.json per namespace. This config file is created in the "working redis directories" during the database docker service startup. 
+
+The database docker service started in the linux network namespace {NS} will use the "/var/run/redis{NS}" as the "working redis directory" to create the various files like redis.sock, sonic-db/database_config.json etc. For "globalDB" database service it would be at "/var/run/redis".


the database docker service does not have to be started in the linux network namespace. suggest to change to "database service" for a NPU linux namespace should use /var/run/redis{NS{. as the working directory.

@lguohan Could you clarify "the database docker service does not have to be started in the linux network namespace" ?
If not in namespace, how to specify one database container instance?

For example, currently we are using sonic-db-cli STATE_DB hset, what will be new command link like? #Closed

The database docker service needs to be started in some network namespace. It could be a new "net_ns" which we create, or the linux host network namespace.

A new parameter is added to sonic-db-cli,
sonic-db-cli APPL_DB -namespace 'ns" HGET VLAN_TABLE:Vlan10 mtu

if we don't specify the namespace parameter, it executes the redis command in the DB instance in the database docker running that namespace where we executed the sonic-db-cli command.

Do let me know if we need more discussion on this.

lguohan · 2020-02-29T12:59:39Z

doc/database/multi_namespace_db_instances.md

+This is an example of the database_config.json with 3 external DB references in 3 namespaces refered with namespaceID "0", "1" & "2".
+
+```json
+{


the json file is not clean. I suggest to have only includes in the global database json. you can put the global db configuration into a separate file and use include to include it.

I have explicitly added details of the database_config.json file which will get generated for the global DB docker service and the NPU namespace DB docker service.

There is no particular file like global DB database_config.json file. The current approach I have taken is to generate the json file depending on where the database docker service is running (either in linux host, or NPU namesapce )

Please find that the "INCLUDES" section is only present for the globalDB database_config.json (created at /var/run/redis/sonic-db) as the applications like snmp,pmon running in the dockers in the Linux host needs to talk to DB in other NPU namespaces.

The database_config.json file for the NPU namespace docker won't have INCLUDES section. It will only have the default local DB instances, as the applications running in the namespace like swss, syncd, bgp etc will only talk to its local DB instances.

Is there a use case where the applications/dockers running in a “particular NPU namespace” will need to access the DB instances in the database dockers running in either “linux host namespace” OR “other NPU namespaces” ?

Currently my assumption is that only the applications running in the host, like snmp, CLI, pmon etc “needs to access” the DB instances running in other NPU namespaces.

Or should we make it more generic, like any application running in any docker in host/NPU namespace should be able to access the DB instance running in a different NPU namespace ? Please could you share your thoughts.

If Yes, then I understand your ask. I would change accordinly and update the doc. Thanks

example

{ [ { "config" : "../redis/sonic-db/database_config.json" }, { "namespace" : "0", "config" : "../redis0/sonic-db/database_config.json" }, { "namespace" : "1", "config" : "../redis1/sonic-db/database_config.json" }, ], "VERSION" : "1.1" }

Thanks for the example.

I have updated the document, by creating a new file "/var/run/redis/sonic-db/databases.json". This will contain the mapping between the namespace names and the database_config.json file references.

A change though is that, in this new file, I have removed the reference to global /var/run/redis/sonic-db/database_config.json.
{
"config" : "../redis/sonic-db/database_config.json"
},

If we have this entry, it will create a recursive reference to this file when I add it as the INCLUDES in the global database_config.json file /var/run/redis/sonic-db/database_config.json.

Please share your comments.

The document is updated, Please review.

lguohan · 2020-02-29T13:04:13Z

doc/database/multi_namespace_db_instances.md

+## Design of C++ Interface :  DBConnector()
+The C++ DBConnector interface is mainly used in the process context of swss/syncd etc in the dockers in their respective namespaces. In the namespaces currently we don't have any external DB refereces, hence not planning to extend the C++ DBConnector to handle multiple database_config.json files.
+
+Will be taken up as the next phase activity to get this class also at par with the python SonicDBConfig/SonicV2Connector modules.


this is a must because we are deprecating the pure swsssdk library and plan to python-swsscommon library for all python related applications.

Updated the doc, will take up the changes to DBConnector class as well and raise the PR for those changes.

Updates based on review comments

Minor format change

lguohan · 2020-03-04T19:27:40Z

doc/database/multi_namespace_db_instances.md

+    },
+    "INCLUDES" : [
+        {
+	    "namespace_id" : "0",


namespace_id -> namespace

Review comments update

Changes for review comments

doc/database/multi_namespace_db_instances.md

Updates based on review comment discussions.

Minor format change.

Updates based on review comments

Adding INCLUDES keyword and VERSION in database_global.json file.

qiluo-msft

I only reviewed the section of "Enhancements to Multi-DB design to support Multiple namespaces". Other sections is still under discussion and will probably refined in future.

This PR is the changes needed to support multiple namespaces for the Multi-ASIC devices. Multi-DB namespace PR --> (sonic-net/SONiC#567) The changes are mainly to these classes SonicDBConfig SonicV2Connector/ConfigDBConnector A new parameter "namespace" is added to the SonicV2Connector class init , to pass the namespace name. The default value is None representing empty namespace. class SonicV2Connector(DBInterface): def init(self, use_unix_socket_path=False, namespace=None, **kwargs): If the user don't explicitly set this parameter, namespace takes None as value, and connects to the db_name in the local context, which refers to the database docker running in the current namespace wherever you are running this application/script …. (It could be either Linux host or any specific network namespace ). In this way it is backward compatible and the existing behavior of APIs in these utility classes are maintained. In the SonicDBConfig, a new API is introduced load_sonic_global_db_config() which loads the /var/run/redis/sonic-db/database_global.json file if present. This file has the mapping between the namespace name and the corresponding database_config.json file.

judyjoseph and others added 13 commits February 24, 2020 16:36

Multiple namespace updated for Multi-DB

4d27f1d

Add files via upload

a1cb176

Update multi_namespace_db_instances.md

ca34a90

Update multi_namespace_db_instances.md

5bb738f

Update multi_namespace_db_instances.md

6df1652

Update multi_namespace_db_instances.md

9d4a9d3

Update multi_namespace_db_instances.md

e806f60

Update multi_namespace_db_instances.md

0f88846

Update multi_namespace_db_instances.md

73aec66

Update multi_namespace_db_instances.md

ff5ad36

Update multi_namespace_db_instances.md

fdc6ec9

Update multi_namespace_db_instances.md

e669ce9

Update multi_namespace_db_instances.md

b3fd8e0

lguohan commented Feb 29, 2020

View reviewed changes

doc/database/multi_namespace_db_instances.md Outdated Show resolved Hide resolved

lguohan commented Feb 29, 2020

View reviewed changes

judyjoseph added 2 commits March 2, 2020 00:16

Update multi_namespace_db_instances.md

3ca5e86

Updates based on review comments

Update multi_namespace_db_instances.md

8a964e4

Minor format change

lguohan commented Mar 4, 2020

View reviewed changes

judyjoseph added 2 commits March 4, 2020 19:19

Update multi_namespace_db_instances.md

c390344

Review comments update

Update multi_namespace_db_instances.md

982af1b

Changes for review comments

qiluo-msft reviewed Mar 6, 2020

View reviewed changes

doc/database/multi_namespace_db_instances.md Outdated Show resolved Hide resolved

qiluo-msft reviewed Mar 6, 2020

View reviewed changes

doc/database/multi_namespace_db_instances.md Outdated Show resolved Hide resolved

qiluo-msft reviewed Mar 6, 2020

View reviewed changes

doc/database/multi_namespace_db_instances.md Outdated Show resolved Hide resolved

judyjoseph added 5 commits March 8, 2020 10:22

Update multi_namespace_db_instances.md

cbb6341

Updates based on review comment discussions.

Update multi_namespace_db_instances.md

d7e36ba

Minor format change.

Update multi_namespace_db_instances.md

81260d7

Updates based on review comments

Update multi_namespace_db_instances.md

01d9bb3

Update multi_namespace_db_instances.md

22787c6

judyjoseph added 2 commits March 17, 2020 16:37

Update multi_namespace_db_instances.md

9c0d583

Adding INCLUDES keyword and VERSION in database_global.json file.

Update multi_namespace_db_instances.md

fb09a79

qiluo-msft approved these changes Mar 17, 2020

View reviewed changes

qiluo-msft assigned lguohan Mar 17, 2020

qiluo-msft approved these changes Mar 18, 2020

View reviewed changes

judyjoseph mentioned this pull request Apr 1, 2020

Namespace support for the python classes. sonic-net/sonic-py-swsssdk#63

Merged

judyjoseph added 3 commits April 1, 2020 17:35

Update multi_namespace_db_instances.md

96a3b5c

Update multi_namespace_db_instances.md

ceaa3ef

Update multi_namespace_db_instances.md

89cb5fc

lguohan changed the title ~~Multi db ns~~ Support redis databases in multiple namespaces Apr 29, 2020

lguohan merged commit 54f8524 into sonic-net:master Apr 29, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support redis databases in multiple namespaces #567

Support redis databases in multiple namespaces #567

lguohan commented Feb 29, 2020

lguohan Feb 29, 2020

qiluo-msft Mar 6, 2020 •

edited

Loading

judyjoseph Mar 6, 2020 •

edited

Loading

lguohan Feb 29, 2020

judyjoseph Mar 2, 2020

judyjoseph Mar 3, 2020

lguohan Mar 4, 2020

judyjoseph Mar 5, 2020 •

edited

Loading

judyjoseph Mar 17, 2020

lguohan Feb 29, 2020

judyjoseph Mar 6, 2020

lguohan Mar 4, 2020

judyjoseph Mar 6, 2020

qiluo-msft left a comment


		The file database_config.json contains the startup configuration which dictates the redis server host/port/unix_socket configurations + various available databases ( eg: APP_DB, CONFIG_DB ) etc. With the introduction of multiple namespaces, there is a need for separate database_config.json per namespace. This config file is created in the "working redis directories" during the database docker service startup.

		The database docker service started in the linux network namespace {NS} will use the "/var/run/redis{NS}" as the "working redis directory" to create the various files like redis.sock, sonic-db/database_config.json etc. For "globalDB" database service it would be at "/var/run/redis".

Support redis databases in multiple namespaces #567

Support redis databases in multiple namespaces #567

Conversation

lguohan commented Feb 29, 2020

Choose a reason for hiding this comment

qiluo-msft Mar 6, 2020 • edited Loading

Choose a reason for hiding this comment

judyjoseph Mar 6, 2020 • 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

judyjoseph Mar 5, 2020 • 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

qiluo-msft left a comment

Choose a reason for hiding this comment

qiluo-msft Mar 6, 2020 •

edited

Loading

judyjoseph Mar 6, 2020 •

edited

Loading

judyjoseph Mar 5, 2020 •

edited

Loading