DB Schema Changes for NSSF

[acetcom]

Dear Community People,

Now I'm trying to add the NSSF. However, it seems that we need to change the current DB schema for this.

Here is the current DB schema.

const Subscriber = new Schema({
  imsi: { $type: String, unique: true, required: true },
  security: {
    k: String,
    op: String,
    opc: String,
    amf: String,
    rand: String,
    sqn: Schema.Types.Long
  },
....
....
  pdn: [{
    apn: { $type: String, required: true },
....
....
    pcc_rule: [{
      flow: [{
        direction: Number,
        description: String
      }],
....
....
    }]
  }]
}, { typeKey: '$type' });

First of all, I thought of adding the below NSSAI array to the current DB schema in order not to change the current structure.

const Subscriber = new Schema({
....
  nssai: [{
     sst: Number
     sd: String
     pdn: [{
       apn: String
     }]
  }]
....

However, if we just do this, we have to apply same QoS to S-NSSAIs with the same name DNN(e.g. internet).

So, I'm considering changes as below.

const Subscriber = new Schema({
  imsi: { $type: String, unique: true, required: true },
  security: {
    k: String,
    op: String,
    opc: String,
    amf: String,
    rand: String,
    sqn: Schema.Types.Long
  },
....
....
  nssai: [{
    sst: Number,
    sd: String,
    pdn: [{
      apn: { $type: String, required: true },
....
....
      pcc_rule: [{
        flow: [{
          direction: Number,
          description: String
        }],
....
....
      }]
    }]

  }]

}, { typeKey: '$type' });

Yes! The modified structure can contain multiple DNN per S-NSSAI. However, the changed DB cannot be used in the previous version. I don't like working this way, but I can't find another way.

If no other good method is presented, it seems to be changed from 2.2.x to the above DB schema.

And, for a smooth transition, I'll keep posting the progress here.

Feel free to raise any idea! It would be really good if we don't have to change the current DB schema.

Thanks and regards,
Sukchan

[s5uishida]

Hi @acetcom

Thank you very much for your wonderful plan!

By the way, sorry to ask something so elementary.

In this case, can 5GC and EPC use the same DB?
If so, I will agree that the DB schema will change.

Thank you very much for your efforts!

[acetcom]

@s5uishida

Of course! 5GC and EPC use the same DB. For EPC, APN information will only be retrieved at index 0 of the NSSAI array.

Thanks a lot!
Sukchan

[kbarlee]

Hey @acetcom

Doesn't bother me either way! But, a change to the schema does mean all existing MongoDB/HSS entries would become incompatible yeah? If that is the case, could I propose a script is created to 'translate' old records to the new format?

Thinking towards the future, if there is the chance of anything needing to change again, potentially it would be useful to have an 'Open5GS_schema_version' field or something, which could be tagged and used by the script to do the conversions.

Kenny

[acetcom]

@kbarlee

Yes! all existing DB entries are not compatible. I'm always welcome if you provide such a good script,

BTW, maybe, I will start working on the DB schema changes next week. At that time, I'll add the schema version. I'll keep you informed of any changes.

Thank you so much for your contribution.
Sukchan

[acetcom]

Dear Open5GS Community People

Now Open5GS DB Schema has been changed to support network slice function. The new subscription DB is not compatible with the old subscription DB. As such, please be careful to use the new version(v2.2.0).

Let me know if you have any questions about the new DB schema.

Happy Hacking!
Sukchan

[s5uishida]

It's excellent!

I will start learning while using Open5GS's NSSF.

Thank you very much for your efforts!

[Spectranis]

Hi Sukchan,

is it planned to update the files in "open5gs/misc/db" to be compatible with the new schema?

Marcel

[acetcom]

@Spectranis At this point, I have no plan to update the script. Pull request from contributors is welcome.