Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[vote] rename IoT and yurt-device-controller: seeking suggestion for new names #1508

Closed
Rui-Gan opened this issue Jun 1, 2023 · 7 comments
Closed
Labels
kind/feature kind/feature

Comments

@Rui-Gan
Copy link
Member

Rui-Gan commented Jun 1, 2023

What would you like to be added:
The yurt-iot-manager project provides a CRD/controller for managing IoT devices. The IoT resource serves as an abstraction of a device management platform, enabling the deployment, updates, and removal of various device management platforms. However, the current naming convention for the resource's group and kind, "IoT" and "device" respectively, is ambiguous. This is because "device" is just one component of the broader IoT ecosystem. Therefore, it is recommended to rename the group and kind of this component to better reflect its purpose and scope.

The name of the yurt-device-controller component is also under review as it may cause confusion. The current name, "yurt-device-controller," includes "controller," which could be mistaken for the Kubernetes controller. However, it actually serves as a component that connects the cloud and edge management platforms. It can synchronize modifications of device properties in the cloud to the end devices, thereby affecting physical devices in the real world. Furthermore, the name "yurt-device-controller" is too generic and lacks specificity. Therefore, a new name is needed to better reflect its function and distinguish it from other components.

Several candidate names have been proposed for the IoT CRD group and kind, including:
Group: iot, Kind: IoTPlatform
Group: iot, Kind: Platform
Group: iot, Kind: LifecycleManager
Group: iot, Kind: IoTOpsManager

We invite suggestions for a new name for the yurt-device-controller. Please feel free to propose your favorite name or provide a suitable name in response to this issue.

@Rui-Gan Rui-Gan added the kind/feature kind/feature label Jun 1, 2023
@JameKeal
Copy link
Member

JameKeal commented Jun 1, 2023

I have some confuse, i remember yurt-device-controller has device. deviceprofile and deviceservice CRDs, and this issue only talk about devce, what's about others?

And i see the kind you provide it's all about management of iot, it has any other kind for iot? If it has, you can show us the details, so we can judge better.

@zzguang
Copy link
Member

zzguang commented Jun 1, 2023

Below are the proposed names that come to my mind by now, just take them as a reference please:
yurt-device-shim
yurt-device-adaptor

@LavenderQAQ
Copy link
Member

LavenderQAQ commented Jun 1, 2023

@JameKeal There may be some ambiguity here. yurt-device-controller is used for synchronizing three CRDs of device, deviceprofile, deviceservice. This issue actually involves two things, and I'll just add to that:

  • The previous yurt-edgex-manager is used to deploy edgex, the edge computing platform, and the corresponding kind of crd is called edgex. Later, we may consider accessing other edge computing platforms, so the kind of crd needs to be changed. In addition, our group name was previously called device.openyurt.io (where you might find the confusion, the device mentioned above is not the crd's device), which may cause confusion among users, so we need to replace two names in total here.
  • yurt-device-controller was used to synchronize the device management information of edgex, but this name didn't seem appropriate in merging it into openyurt (it needed to be on the edge and deployed in a different mode than the normal controller), so we needed to change the name for it.

I hope my supplement can answer your questions.

@rambohe-ch
Copy link
Member

@Rui-Gan Because this crd will be used by controller to manage edge platform including the deployment, updates, and removal, etc. so i want to post a new name for CRD as following:

Group: IoT, Kind: PlatformAdmin

and the new name for yurt-device-controller, combing the comments from @JameKeal and @zzguang , I also want to post a new name as following:

yurt-iot-platform-shim

@Rui-Gan
Copy link
Member Author

Rui-Gan commented Jun 2, 2023

Group: IoT, Kind: PlatformAdmin +1
yurt-device-shim +1

@LavenderQAQ
Copy link
Member

LavenderQAQ commented Jun 2, 2023

I have opened two polls in the discussion. Please vote for the names listed above. Thank you!!!
[vote] rename IoT crd and group: #1511
[vote] rename yurt-device-controller: #1512

@LavenderQAQ
Copy link
Member

LavenderQAQ commented Jun 7, 2023

Both polls are closed, the results are in, and the final plan is:
IoT crd and group rename to Group: iot, Kind: PlatformAdmin
yurt-device-controller rename to yurt-device-shim
@rambohe-ch @Rui-Gan

refer:
[vote] rename IoT crd and group: #1511
[vote] rename yurt-device-controller: #1512

@Rui-Gan Rui-Gan closed this as completed Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature kind/feature
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants