New Proposal - Customer Premise Equipment Management

[caubut-charter]

This API manages fixed devices provided by network operators that reside at customer premises. The core functionality includes requesting service sites and devices associated with a customer account, managing Wi-Fi BSSs, and rebooting devices.

The API is designed to support simple use cases, such as allowing a developer to set up a guest Wi-Fi network, and more complex use cases, such as allowing management of multiple devices across several service sites. The design also allows for extension to support future use cases such as setting up Thread networks or managing mobile hot-spots not attached to a service site.

We have chosen to use the terminology “Customer Premise Equipment” (CPE) but are open to the use of a different term. Due to some of the complexities regarding potential naming conventions this API could support (e.g., router, switch, access point, modem, fixed wireless, gateway, border router, devices that support multiple functions, etc.), we felt it best to work with CAMARA to address proper terminology.

yaml - GitHub - yaml - Swagger Editor - slides - GitHub

[caubut-charter]

PR camaraproject/WorkingGroups#379.

[TEF-RicardoSerr]

@caubut-charter Can you please provide the codeowners GitHub User?

[TEF-RicardoSerr]

Thank you @caubut-charter I understand that the only CODEOWNER for this API will be yourself. As the TSC decission was to integrate this API proposal within the HomeDevicesQoD this is not a further issue. Anyhow if there is any other CODEOWNER please tell.

On the other hand I will also need the list of initial MAINTAINERS. Could you take action to query the API supporters to paste their GitHub user in a comment within this camaraproject/APIBacklog#21 issue

[caubut-charter]

@TEF-RicardoSerr

CableLabs: Randy Levensalor (https://github.com/RandyLevensalor) Vodafone: Mayur Channegowda (https://github.com/mayur007)

Both have also offered to also be a CODEOWNER to review pull requests if we need additional owners, otherwise MAINTAINER.

I am waiting on a resource from Liberty Global's CPE team. My contact on their mobile side is reaching out to this team to identity that resource. I will update when I get a response.

Additional MAINTAINERS: Charter: Justin Pace (https://github.com/justin-pace-charter)

[caubut-charter]

TEF-RicardoSerr,

cc: @RandyLevensalor @mayur007

I sent out the following email to the other contributors of this API asking for consensus on a new name: Home Devices - Network Access Management. Sharing here, before the consensus deadline I set, as I do not think "HomeDevicesManagement" is a great fit from the "[TSC] New API proposal taken for approval at next TSC meeting" thread since "Home Devices" from the family and "Equipment" in this API have different meanings. The new name addresses the double "Device" reference and removes the telco "CPE" term. I would like to give until this Friday as @mayur007 is out of office.

Putting together an out-of-band thread with the companies that have expressed interest in the development of this API. Included on this thread are Charter, CableLabs, Liberty Global, and Vodafone.

Future communications will occur in-band through the CAMARA mailing list.

One of the asks to create the mailing list and GitHub repository is to align with the Home Devices family. Another is to avoid telco specific terminology since API consumers may be from other industries.

I'd like to propose the following name change: Home Devices - Network Access Management.

This is broad enough to cover future use cases:

Devices: Fixed Wireless Gateways, Routers, Switches, Border Routers, Access Points, etc... Protocols: 5G, Thread, Bluetooth, HaLow, physical mediums, etc...

I contemplated Network Access Device or Access Device, but decided to drop Device completely since the API does not require referencing a device in the simplest of use cases. The intent is to expose management APIs for home devices accessing a network. Reboot is inclusive in this naming as a troubleshooting tool for providing network access to home devices.

If I could get consensus on this change from Randy and Mayur as code owners, I'll update the issue on GitHub.

For those CC'd, you are invited to weigh-in as your past and future contributions are valued. I will hold on submitting the name change until Friday morning of next week (April 5th) to allow time for feedback.

[caubut-charter]

@TEF-RicardoSerr

I have consensus from the other code owners to move forward with proposing Home Devices - Network Access Management to the TSC as the new name for this API.

[TEF-RicardoSerr]

GitHub Repository have been created here, this issue can be closed

[hdamker]

@TEF-RicardoSerr APIBacklog.md need to be updated as well.