ifran 0.0.6__py3-none-any.whl

ansible/requirements.yaml

@@ -0,0 +1,6 @@
+collections:
+  - name: ansible.posix
+  - name: community.general
+  - name: kubernetes.core
+  - name: ansible.mysql
+  - name: community.mongodb

ansible/roles/database/subscriber/add/free5gc/tasks/for_gnb.yaml

@@ -0,0 +1,153 @@
+---
+- name: Add UE '{{ ue_name }}' to Free5GC 'subscriptionData.provisionedData.amData' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("subscriptionData.provisionedData.amData").updateOne(
+        {
+          "ueId": "imsi-{{ ue_config.supi }}",
+          "servingPlmnId": "{{ item.plmnId.plmnId }}",
+        },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "servingPlmnId": "{{ item.plmnId.plmnId }}",
+            "subscribedUeAmbr": {
+              "uplink": "{{ ue_config.ueAmbr.uplink }} bps",
+              "downlink": "{{ ue_config.ueAmbr.downlink }} bps",
+            },
+            "nssai": {
+              "singleNssais": [],
+              "defaultSingleNssais": [
+              {% for subscription in ue_config.subscriptions %}
+                {
+                  "sst": {{ subscription.snssai.sst }},
+                {% if subscription.snssai.sd %}
+                  "sd": "{{ subscription.snssai.sd }}",
+                {% endif %}
+                },
+              {% endfor %}
+              ],
+            },
+          }
+        },
+        { "upsert": true }
+      )
+  loop: "{{ gnb_item.config.plmnList }}"
+  loop_control:
+    label: "GNB: {{ gnb_item }}, PLMN ID: {{ item.plmnId.plmnId }}"
+
+- name: Add UE '{{ ue_name }}' to Free5GC 'subscriptionData.provisionedData.smData' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    debug: true
+    eval: |
+      {% set subscription = ue_config.subscriptions[item.1.subscriptionIndex] %}
+      db.getCollection("subscriptionData.provisionedData.smData").updateOne(
+        {
+          "ueId": "imsi-{{ ue_config.supi }}",
+          "servingPlmnId": "{{ item.0.plmnId.plmnId }}",
+          "singleNssai": {
+            "sst": {{ subscription.snssai.sst }},
+          {% if subscription.snssai.sd %}
+            "sd": "{{ subscription.snssai.sd }}",
+          {% endif %}
+          },
+        },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "servingPlmnId": "{{ item.0.plmnId.plmnId }}",
+            "singleNssai": {
+              "sst": {{ subscription.snssai.sst }},
+            {% if subscription.snssai.sd %}
+              "sd": "{{ subscription.snssai.sd }}",
+            {% endif %}
+            },
+            "dnnConfigurations": {
+              "{{ subscription.dnn.name }}": {
+                "pduSessionTypes": {
+                  "defaultSessionType": "{{ subscription.dnn.pduSessionType | upper }}",
+                  "allowedSessionTypes": ["{{ subscription.dnn.pduSessionType | upper }}"],
+                },
+                sscModes: {
+                  defaultSscMode: "{{ item.1.sscMode | upper }}",
+                  allowedSscModes: [
+                    "SSC_MODE_1",
+                    "SSC_MODE_2",
+                    "SSC_MODE_3",
+                  ],
+                },
+                "sessionAmbr": {
+                  "uplink": "{{ subscription.dnn.aggregateMaximumBitRate.uplink }} bps",
+                  "downlink": "{{ subscription.dnn.aggregateMaximumBitRate.downlink }} bps",
+                },
+              {% if subscription.dnn.qosFlows %}
+                "5gQosProfile": {
+                  "5qi": {{ subscription.dnn.qosFlows[0].fiveQI }},
+                  "arp": {
+                    "priorityLevel": {{ subscription.dnn.qosFlows[0].arp.priorityLevel }},
+                    "preemptCap": "{{ subscription.dnn.qosFlows[0].arp.preemptionCapability | upper }}",
+                    "preemptVuln": "{{ subscription.dnn.qosFlows[0].arp.preemptionVulnerability | upper }}",
+                  },
+                  "priorityLevel": {{ subscription.dnn.qosFlows[0].arp.priorityLevel }},
+                },
+              {% endif %}
+                staticIpAddress: [
+                {% if item.1.ueIPv4Address %}
+                  { "ipv4Addr": "{{ item.1.ueIPv4Address }}" },
+                {% endif %}
+                {% if item.1.ueIPv6Address %}
+                  { "ipv6Addr": "{{ item.1.ueIPv6Address }}" },
+                {% endif %}
+                ],
+              },
+            },
+          }
+        },
+        { "upsert": true }
+      )
+  loop: "{{ gnb_item.config.plmnList | product(ue_config.pduSessions) | list }}"
+  loop_control:
+    label: "GNB: {{ gnb_item }}, PLMN ID: {{ item.0.plmnId.plmnId }}, Session Index: {{ item.1.subscriptionIndex }}"
+
+- name: Add UE '{{ ue_name }}' to Free5GC 'subscriptionData.provisionedData.smfSelectionSubscriptionData' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("subscriptionData.provisionedData.smfSelectionSubscriptionData").updateOne(
+        {
+          "ueId": "imsi-{{ ue_config.supi }}",
+          "servingPlmnId": "{{ item.plmnId.plmnId }}",
+        },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "servingPlmnId": "{{ item.plmnId.plmnId }}",
+            "subscribedSnssaiInfos": {
+            {% for subscription in ue_config.subscriptions %}
+              {% set snssai = '%02d' | format(subscription.snssai.sst) ~ subscription.snssai.sd if subscription.snssai.sd else '%02d' | format(subscription.snssai.sst) %}
+              "{{ snssai }}": {
+                "dnnInfos": [{ "dnn": "{{ subscription.dnn.name }}" } ],
+              },
+            {% endfor %}
+            }
+          }
+        },
+        { "upsert": true }
+      )
+  loop: "{{ gnb_item.config.plmnList }}"
+  loop_control:
+    label: "GNB: {{ gnb_item }}, PLMN ID: {{ item.plmnId.plmnId }}"

ansible/roles/database/subscriber/add/free5gc/tasks/main.yaml

@@ -0,0 +1,130 @@
+# Role to add a subscriber to Free5GC database (mongodb)
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Add UE '{{ ue_name }}' to Free5GC 'subscriptionData.authenticationData.authenticationSubscription' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("subscriptionData.authenticationData.authenticationSubscription").updateOne(
+        { "ueId": "imsi-{{ ue_config.supi }}" },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "authenticationMethod": "{{ ue_config.authenticationData.authenticationMethod }}",
+            "encPermanentKey": "{{ ue_config.authenticationData.k }}",
+            "encOpcKey": "{{ ue_config.authenticationData.opc }}",
+            "authenticationManagementField": "{{ ue_config.authenticationData.amf }}",
+            "sequenceNumber": {
+              "sqn": "{{ ue_config.authenticationData.sqn | lower }}",
+              "sqnScheme": "GENERAL",
+            }
+          }
+        },
+        { "upsert": true }
+      )
+
+- name: Add UE '{{ ue_name }}' to Free5GC 'subscriptionData.authenticationData.webAuthenticationSubscription' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("subscriptionData.authenticationData.webAuthenticationSubscription").updateOne(
+        { "ueId": "imsi-{{ ue_config.supi }}" },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "authenticationMethod": "{{ ue_config.authenticationData.authenticationMethod }}",
+            "authenticationManagementField": "{{ ue_config.authenticationData.amf }}",
+            "sequenceNumber": "{{ ue_config.authenticationData.sqn | lower }}",
+            "permanentKey": {
+              "permanentKeyValue": "{{ ue_config.authenticationData.k }}",
+              "encryptionKey": 0,
+              "encryptionAlgorithm": 0,
+            },
+            "opc": {
+              "opcValue": "{{ ue_config.authenticationData.opc }}",
+              "encryptionKey": 0,
+              "encryptionAlgorithm": 0,
+            },
+            "milenage": {
+              "op": {
+                "opValue": "{{ ue_config.authenticationData.op }}",
+                "encryptionKey": 0,
+                "encryptionAlgorithm": 0,
+              },
+            },
+          }
+        },
+        { "upsert": true }
+      )
+
+- name: Add UE '{{ ue_name }}' to Free5GC 'policyData.ues.amData' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("policyData.ues.amData").updateOne(
+        { "ueId": "imsi-{{ ue_config.supi }}" },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "subscCats": [ "free5gc" ],
+          }
+        },
+        { "upsert": true }
+      )
+
+- name: Add UE '{{ ue_name }}' to Free5GC 'policyData.ues.smData' collection
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("policyData.ues.smData").updateOne(
+        { "ueId": "imsi-{{ ue_config.supi }}" },
+        {
+          "$set": {
+            "ueId": "imsi-{{ ue_config.supi }}",
+            "smPolicySnssaiData": {
+            {% for subscription in ue_config.subscriptions %}
+              {% set snssai = '%02d' | format(subscription.snssai.sst) ~ subscription.snssai.sd if subscription.snssai.sd else '%02d' | format(subscription.snssai.sst) %}
+              "{{ snssai }}": {
+                "snssai": {
+                  "sst": {{ subscription.snssai.sst }},
+                {% if subscription.snssai.sd %}
+                  "sd": "{{ subscription.snssai.sd }}",
+                {% endif %}
+                },
+                "smPolicyDnnData": { "{{ subscription.dnn.name }}": { "dnn": "{{ subscription.dnn.name }}" } }
+              },
+            {% endfor %}
+            }
+          }
+        },
+        { "upsert": true }
+      )
+
+- name: Add UE '{{ ue_name }}' entries for each gNB
+  ansible.builtin.include_tasks: for_gnb.yaml
+  loop: "{{ ue_config.gnbs }}"
+  loop_control:
+    loop_var: gnb_item
+    label: "GNB: {{ gnb_item }}"

ansible/roles/database/subscriber/add/oai/tasks/for_gnb.yaml

@@ -0,0 +1,65 @@
+---
+- name: Add UE '{{ ue_name }}' to OAI 'SessionManagementSubscriptionData' table
+  ansible.mysql.mysql_query:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_db: oai_db
+    query: |
+      INSERT IGNORE INTO SessionManagementSubscriptionData (
+        ueid,
+        servingPlmnid,
+        singleNssai,
+        dnnConfigurations
+      )
+      VALUES (
+        {% set subscription = ue_config.subscriptions[item.1.subscriptionIndex] %}
+        '{{ ue_config.supi }}',
+        '{{ item.0.plmnId.plmnId }}',
+        '{{ {
+          "sst": subscription.snssai.sst,
+          "sd": subscription.snssai.sd if subscription.snssai.sd else "FFFFFF"
+        } | to_json }}',
+        '{{ {
+          subscription.dnn.name: {
+            "pduSessionTypes": {
+              "defaultSessionType": subscription.dnn.pduSessionType | upper
+            },
+            "sscModes": {
+              "defaultSscMode": "{{ item.1.sscMode | upper }}",
+            },
+            "5gQosProfile": {
+              "5qi": subscription.dnn.qosFlows[0].fiveQI,
+              "arp": {
+                "priorityLevel": subscription.dnn.qosFlows[0].arp.priorityLevel,
+                "preemptCap": subscription.dnn.qosFlows[0].arp.preemptionCapability | upper,
+                "preemptVuln": subscription.dnn.qosFlows[0].arp.preemptionVulnerability | upper
+              },
+              "priorityLevel": subscription.dnn.qosFlows[0].arp.priorityLevel
+            } if subscription.dnn.qosFlows else {},
+            "sessionAmbr": {
+              "uplink": item.1.sessionAmbr.uplink ~ "bps",
+              "downlink": item.1.sessionAmbr.downlink ~ "bps"
+            } if item.1.sessionAmbr else {
+              "uplink": subscription.dnn.aggregateMaximumBitRate.uplink ~ "bps",
+              "downlink": subscription.dnn.aggregateMaximumBitRate.downlink ~ "bps"
+            },
+            "staticIpAddress": (
+              [
+                {
+                  "ipv4Addr": item.1.ueIPv4Address
+                }
+              ] if item.1.ueIPv4Address else []
+              ) + (
+              [
+                {
+                  "ipv6Addr": item.1.ueIPv6Address
+                }
+              ] if item.1.ueIPv6Address else []
+            )
+          }
+        } | to_json }}'
+      );
+  loop: "{{ gnb_item.config.plmnList | product(ue_config.pduSessions) | list }}"
+  loop_control:
+    label: "GNB: {{ gnb_item }}, PLMN ID: {{ item.0.plmnId.plmnId }}, Session Index: {{ item.1.subscriptionIndex }}"

ansible/roles/database/subscriber/add/oai/tasks/main.yaml

@@ -0,0 +1,53 @@
+# Role to add a subscriber to OAI dataabse (mysql)
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Add UE '{{ ue_name }}' to OAI 'AuthenticationSubscription' table
+  ansible.mysql.mysql_query:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_db: oai_db
+    query: |
+      INSERT IGNORE INTO AuthenticationSubscription (
+        ueid,
+        authenticationMethod,
+        encPermanentKey,
+        protectionParameterId,
+        sequenceNumber,
+        authenticationManagementField,
+        algorithmId,
+        encOpcKey,
+        encTopcKey,
+        vectorGenerationInHss,
+        n5gcAuthMethod,
+        rgAuthenticationInd,
+        supi
+      )
+      VALUES (
+        '{{ ue_config.supi }}',
+        '{{ ue_config.authenticationData.authenticationMethod | upper }}',
+        '{{ ue_config.authenticationData.k }}',
+        '{{ ue_config.authenticationData.k }}',
+        '{{ {"sqn": ue_config.authenticationData.sqn, "sqnScheme": "NON_TIME_BASED", "lastIndexes": {"ausf": 0}} | to_json }}',
+        '{{ ue_config.authenticationData.amf }}',
+        'milenage',
+        '{{ ue_config.authenticationData.opc }}',
+        NULL,
+        NULL,
+        NULL,
+        NULL,
+        '{{ ue_config.supi }}'
+      );
+
+- name: Add 'SessionManagementSubscriptionData' entry for UE '{{ ue_name }}' for each gNB
+  ansible.builtin.include_tasks: for_gnb.yaml
+  loop: "{{ ue_config.gnbs }}"
+  loop_control:
+    loop_var: gnb_item
+    label: "GNB: {{ gnb_item }}"

ansible/roles/database/subscriber/add/open5gs/tasks/main.yaml

@@ -0,0 +1,125 @@
+# Role to add a subscriber to Open5GS database (mongodb)
+
+# Reference: https://github.com/open5gs/open5gs/blob/d261bd43d859ec3d9c9f95a441dc295ce0814a7b/webui/server/models/subscriber.js
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Add UE '{{ ue_name }}' to Open5GS database
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: open5gs
+    eval: |
+      db.subscribers.updateOne(
+        { "imsi": "{{ ue_config.supi }}" },
+        {
+          $setOnInsert: {
+            "schema_version": 1,
+
+            "imsi": "{{ ue_config.supi }}",
+
+            "security": {
+              "k": "{{ ue_config.authenticationData.k }}",
+            {% if ue_config.authenticationData.op %}
+              "op": "{{ ue_config.authenticationData.op }}",
+            {% endif %}
+              "opc": "{{ ue_config.authenticationData.opc }}",
+              "amf": "{{ ue_config.authenticationData.amf }}",
+              "sqn": Long("0x{{ ue_config.authenticationData.sqn }}"),
+            },
+
+            "ambr": {
+              "downlink": {
+                "value": {{ ue_config.ueAmbr.downlink }},
+                "unit": 0,
+              },
+              "uplink": {
+                "value": {{ ue_config.ueAmbr.uplink }},
+                "unit": 0,
+              },
+            },
+
+            "slice": [
+            {% for subscription in ue_config.subscriptions %}
+              {% set subscription_index = loop.index0 %}
+              {
+                "sst": {{ subscription.snssai.sst }},
+              {% if subscription.snssai.sd %}
+                "sd": "0x{{ subscription.snssai.sd }}",
+              {% endif %}
+                "default_indicator": {{ "true" if loop.first else "false" }},
+                "session": [
+              {% for pdu_session in ue_config.pduSessions %}
+                {% if pdu_session.subscriptionIndex == subscription_index %}
+                  {% set dnn = subscription.dnn %}
+                  {
+                    "name": "{{ dnn.name }}",
+                  {% if dnn.pduSessionType == "ipv4" %}
+                    "type": 1,
+                  {% elif dnn.pduSessionType == "ipv6" %}
+                    "type": 2,
+                  {% elif dnn.pduSessionType == "ipv4v6" %}
+                    "type": 3,
+                  {% elif dnn.pduSessionType == "ethernet" %}
+                    "type": 4,
+                  {% elif dnn.pduSessionType == "unstructured" %}
+                    "type": 5,
+                  {% endif %}
+                  {% if dnn.qosFlows %}
+                    {% set qos = dnn.qosFlows[0] %}
+                    "qos": {
+                      "index":{{ qos.fiveQI }},
+                      "arp": {
+                        "priority_level": {{ qos.arp.priorityLevel }},
+                        "pre_emption_capability": {{ 1 if qos.arp.preemptionCapability == "not_preempt" else 2 }},
+                        "pre_emption_vulnerability": {{ 1 if qos.arp.preemptionVulnerability == "not_preemptable" else 2 }},
+                      }
+                    },
+                  {% endif %}
+                    "ambr": {
+                    {% if pdu_session.sessionAmbr %}
+                      {% set uplink = pdu_session.sessionAmbr.uplink %}
+                      {% set downlink = pdu_session.sessionAmbr.downlink %}
+                    {% else %}
+                      {% set uplink = dnn.aggregateMaximumBitRate.uplink %}
+                      {% set downlink = dnn.aggregateMaximumBitRate.downlink %}
+                    {% endif %}
+                      "downlink": {
+                        "value": {{ downlink }},
+                        "unit": 0,
+                      },
+                      "uplink": {
+                        "value": {{ uplink }},
+                        "unit": 0,
+                      },
+                    },
+                  {% if pdu_session.ueIPv4Address or pdu_session.ueIPv6Address %}
+                    "ue": {
+                    {% if pdu_session.ueIPv4Address %}
+                      "ipv4": "{{ pdu_session.ueIPv4Address }}",
+                    {% endif %}
+                    {% if pdu_session.ueIPv6Address %}
+                      "ipv6": "{{ pdu_session.ueIPv6Address }}",
+                    {% endif %}
+                    },
+                  {% endif %}
+                  },
+                {% endif %}
+              {% endfor %}
+                ]
+              },
+            {% endfor %}
+            ],
+
+            "__v": 0
+          }
+        },
+        { upsert: true },
+      )

ansible/roles/database/subscriber/remove/free5gc/tasks/main.yaml

@@ -0,0 +1,24 @@
+# Role to add a subscriber to Free5GC dataabse (mongodb)
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Remove UE '{{ ue_name }}' from Free5GC database
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: free5gc
+    eval: |
+      db.getCollection("subscriptionData.authenticationData.authenticationSubscription").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("subscriptionData.authenticationData.webAuthenticationSubscription").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("subscriptionData.provisionedData.amData").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("subscriptionData.provisionedData.smData").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("subscriptionData.provisionedData.smfSelectionSubscriptionData").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("policyData.ues.amData").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" }),
+      db.getCollection("policyData.ues.smData").deleteMany({ "ueId": "imsi-{{ ue_config.supi }}" })

ansible/roles/database/subscriber/remove/oai/tasks/main.yaml

@@ -0,0 +1,32 @@
+# Role to remove a subscriber from OAI dataabse (mysql)
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Remove all mentions of UE '{{ ue_name }}' from OAI database
+  ansible.mysql.mysql_query:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_db: oai_db
+    query:
+      - DELETE FROM AccessAndMobilitySubscriptionData WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM Amf3GppAccessRegistration WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM AuthenticationStatus WHERE ueid = '{{ ue_config.supi }}';
+
+      # explicitly added
+      - DELETE FROM AuthenticationSubscription WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM SdmSubscriptions WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM SessionManagementSubscriptionData WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM SmfRegistrations WHERE ueid = '{{ ue_config.supi }}';
+
+      - DELETE FROM SmfSelectionSubscriptionData WHERE ueid = '{{ ue_config.supi }}';

ansible/roles/database/subscriber/remove/open5gs/tasks/main.yaml

@@ -0,0 +1,22 @@
+# Role to remove a subscriber from Open5GS dataabse (mongodb)
+
+# Reference: https://github.com/open5gs/open5gs/blob/d261bd43d859ec3d9c9f95a441dc295ce0814a7b/webui/server/models/subscriber.js
+
+# Input:
+# - ue_name: str
+# - ue_config: UEConfiguration
+# - database_ip: IPvAnyAddress
+
+# Output: None
+---
+- name: Remove UE '{{ ue_name }}' from Open5GS database
+  community.mongodb.mongodb_shell:
+    login_host: "{{ database_ip }}"
+    login_user: test
+    login_password: test
+    login_database: admin
+    db: open5gs
+    eval: |
+      db.subscribers.deleteOne({
+        "imsi": "{{ ue_config.supi }}"
+      })

ansible/roles/helm/copy/tasks/main.yaml

@@ -0,0 +1,63 @@
+# Role to copy a file to or from a pod for a deployed Helm chart on a Kubernetes cluster
+
+# A chart-specific temporary directory prevents the staging path from adding an unwanted directory level when uploading.
+
+# Downloads are staged on the managed node before being fetched back to the controller.
+
+# Input:
+# - chart_name: str
+# - component: Deployed5GComponent
+# - local_path: str
+# - remote_path: str
+# - direction: str
+
+# Output: None
+---
+- name: Get Pod for '{{ chart_name }}' Helm chart
+  kubernetes.core.k8s_info:
+    kind: Pod
+    namespace: "{{ component.namespace }}"
+    label_selectors:
+      - "app.kubernetes.io/instance={{ chart_name }}"
+  register: chart_pods
+
+- name: Create temporary staging directory on master node for '{{ chart_name }}'
+  ansible.builtin.file:
+    path: "/tmp/{{ chart_name }}-{{ local_path | basename }}"
+    state: directory
+
+- name: Stage local '{{ local_path }}' to master node for '{{ chart_name }}'
+  ansible.builtin.copy:
+    src: "{{ local_path }}"
+    dest: "/tmp/{{ chart_name }}-{{ local_path | basename }}/"
+    mode: preserve
+  when: direction == 'to_pod'
+
+- name: Copy '{{ local_path }}' {{ direction | replace('_', ' ') }} '{{ chart_name }}'
+  kubernetes.core.k8s_cp:
+    namespace: "{{ component.namespace }}"
+    pod: "{{ chart_pods.resources[0].metadata.name }}"
+    # kubernetes.core.k8s_cp does not automatically select Kubernetes' default-container annotation
+    container: >-
+      {{
+        (chart_pods.resources[0].metadata.annotations | default({}))
+        .get(
+          'kubectl.kubernetes.io/default-container',
+          chart_pods.resources[0].spec.containers[0].name
+        )
+      }}
+    local_path: "/tmp/{{ chart_name }}-{{ local_path | basename }}/{{ local_path | basename }}"
+    remote_path: "{{ remote_path }}"
+    state: "{{ direction }}"
+
+- name: Fetch '{{ local_path }}' from master node to local for '{{ chart_name }}'
+  ansible.builtin.fetch:
+    src: "/tmp/{{ chart_name }}-{{ local_path | basename }}/{{ local_path | basename }}"
+    dest: "{{ local_path }}"
+    flat: true
+  when: direction == 'from_pod'
+
+- name: Clean up temporary staged '{{ local_path }}' on master node for '{{ chart_name }}'
+  ansible.builtin.file:
+    path: "/tmp/{{ chart_name }}-{{ local_path | basename }}"
+    state: absent