software/ors-amarisoft: add option for public websocket

software/ors-amarisoft/buildout.hash.cfg

@@ -36,11 +36,11 @@ md5sum = b34fe47a73890097fbc6ea6374aeb38d
 
 [template-enb]
 _update_hash_filename_ = instance-enb.jinja2.cfg
-md5sum = c3a4934e67856568f3d86b5e4e473c2e
+md5sum = 62252527eb4998de5bb23058dbbdbd75
 
 [template-gnb]
 _update_hash_filename_ = instance-gnb.jinja2.cfg
-md5sum = f0f5e45f6316894ac9fde4e3078b1026
+md5sum = b4d7406d9d7df7fafbbf0ddbc792f5fb
 
 [template-core-network]
 _update_hash_filename_ = instance-core-network.jinja2.cfg
@@ -64,7 +64,7 @@ md5sum = dcaac06553a3222b14c0013a13f4a149
 
 [enb.jinja2.cfg]
 filename = config/enb.jinja2.cfg
-md5sum = 1490a80f446c8a9e18ea268350dc8a35
+md5sum = 1680fde9d6d5f8c1678fb11d7a891191
 
 [sib23.jinja2.asn]
 filename = config/sib23.jinja2.asn
@@ -72,7 +72,7 @@ md5sum = 0af07bba51f8d4e773f9bfef4f2ca535
 
 [gnb.jinja2.cfg]
 filename = config/gnb.jinja2.cfg
-md5sum = 322affd5986b049fa6a1a96ece7108cf
+md5sum = f1e7f37a9c0866c08237b03cecdcd2c7
 
 [ltelogs.jinja2.sh]
 filename = ltelogs.jinja2.sh

software/ors-amarisoft/config/enb.jinja2.cfg

@@ -109,7 +109,14 @@
   tx_gain: {{ tx_gain }},
   rx_gain: {{ rx_gain }},
 {% endif %}
+  {%- if slapparameter_dict.get('websocket_password', '') %}
+  com_addr: "[{{ gtp_addr_v6 }}]:9001",
+  com_auth: {
+    password: "{{ slapparameter_dict['websocket_password'] }}",
+  },
+  {%- else %}
   com_addr: "127.0.1.2:9001",
+  {%- endif %}
 
   mme_list: [
 {% if slapparameter_dict.get('mme_list', '') %}

software/ors-amarisoft/config/gnb.jinja2.cfg

@@ -53,7 +53,14 @@
   tx_gain: {{ tx_gain }},
   rx_gain: {{ rx_gain }},
 {% endif %}
+  {%- if slapparameter_dict.get('websocket_password', '') %}
+  com_addr: "[{{ gtp_addr_v6 }}]:9001",
+  com_auth: {
+    password: "{{ slapparameter_dict['websocket_password'] }}",
+  },
+  {%- else %}
   com_addr: "127.0.1.2:9001",
+  {%- endif %}
   amf_list: [
 {% if slapparameter_dict.get('amf_list', '') %}
 {%- for i, k in enumerate(slapparameter_dict['amf_list']) %}

software/ors-amarisoft/instance-enb-input-schema.json.jinja2

@@ -359,6 +359,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-enb.jinja2.cfg

@@ -175,7 +175,11 @@ drb_stats_logspec =
 {%- endif %}
 rotatespec = 100MB.9
 logspec = ${:stats_logspec} ${:drb_stats_logspec}
+{%- if slapparameter_dict.get("websocket_password", "") %}
+websock = ws://[${slap-configuration:ipv6-random}]:9001
+{%- else %}
 websock = ws://127.0.1.2:9001
+{%- endif %}
 xamari = {{ buildout_directory }}/bin/xamari
 logfile = ${monitor-directory:public}/enb.xlog
 inline =
@@ -371,6 +375,9 @@ extra-context =
 [publish-connection-information]
 <= monitor-publish
 recipe = slapos.cookbook:publish.serialised
+{%- if slapparameter_dict.get("websocket_password", "") %}
+websocket_url = ws://[${slap-configuration:ipv6-random}]:9001
+{%- endif %}
 enb-ipv6 = ${slap-configuration:ipv6-random}
 enb-ipv4 = {{ lan_ipv4 }}
 ors-version = {{ ors_version['ors-version'] }}

software/ors-amarisoft/instance-fdd-enb-input-schema.json

@@ -191,6 +191,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-fdd-gnb-input-schema.json

@@ -246,6 +246,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-fdd-lopcomm-enb-input-schema.json

@@ -285,6 +285,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-fdd-lopcomm-gnb-input-schema.json

@@ -246,6 +246,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-fdd-ors-enb-input-schema.json

@@ -186,6 +186,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-fdd-ors-gnb-input-schema.json

@@ -246,6 +246,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-gnb-input-schema.json.jinja2

@@ -267,6 +267,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-gnb.jinja2.cfg

@@ -143,7 +143,11 @@ drb_stats_logspec =
 rotatespec = 100MB.9
 logspec = ${:stats_logspec} ${:drb_stats_logspec}
 logspec = ${:stats_logspec} ${:drb_stats_logspec}
+{% if slapparameter_dict.get("websocket_password", "") %}
+websock = ws://[${slap-configuration:ipv6-random}]:9001
+{% else %}
 websock = ws://127.0.1.2:9001
+{% endif %}
 xamari = {{ buildout_directory }}/bin/xamari
 logfile = ${monitor-directory:public}/gnb.xlog
 inline =
@@ -272,6 +276,9 @@ output = ${directory:etc}/gnb.cfg
 [publish-connection-information]
 <= monitor-publish
 recipe = slapos.cookbook:publish.serialised
+{%- if slapparameter_dict.get("websocket_password", "") %}
+websocket_url = ws://[${slap-configuration:ipv6-random}]:9001
+{%- endif %}
 gnb-ipv6 = ${slap-configuration:ipv6-random}
 gnb-ipv4 = {{ lan_ipv4 }}
 ors-version = {{ ors_version['ors-version'] }}

software/ors-amarisoft/instance-tdd-enb-input-schema.json

@@ -201,6 +201,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-tdd-gnb-input-schema.json

@@ -257,6 +257,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-tdd-m2ru-enb-input-schema.json

@@ -239,6 +239,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-tdd-m2ru-gnb-input-schema.json

@@ -257,6 +257,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-tdd-ors-enb-input-schema.json

@@ -196,6 +196,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

software/ors-amarisoft/instance-tdd-ors-gnb-input-schema.json

@@ -257,6 +257,11 @@
       "type": "object",
       "default": {}
     },
+    "websocket_password": {
+      "title": "Websocket password",
+      "description": "Activates websocket for remote control and sets password",
+      "type": "string"
+    },
     "inactivity_timer": {
       "title": "Inactivity Timer",
       "description": "Send RRC connection release after this time (in ms) of network inactivity.",

[Lu Xu]

Hello @jhuge , Have you noticed that adding a websocket entrance causes the websocket used for obtaining amarisoft-stats/rf information to disconnect?

/cc @kirr

[Kirill Smelkov]

Lu, thanks for noticing. Indeed amarisoft-rf-info.jinja2.py and amarisoft-stats.jinja2.py have ws://127.0.1.2:9001 hardcoded.

[Joanne Hugé]

Hello, we already discussed this with @lu.xu but just for the record we think this is not an issue because websocket API allows full direct control on amarisoft config and so there might not be much sense in keeping the promises anymore since we go into a "sandbox" mode. This websocket_password option should not be used during deployment, at least we don't support it, it is just for quick testing.

[Kirill Smelkov]

Joanne, thanks for the update. I see. Since websocket_password is exposed in public JSON schemas of the SR I suggest to indicate this status clearly there.