Config setting to disable auto-registration of entities #2490

PradeepKiruvale · 2023-11-30T09:50:01Z

Proposed changes

Document configurable auto-registration

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
Documentation Update (if none of the other choices apply)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#2483

Checklist

I have read the CONTRIBUTING doc
I have signed the CLA (in all commits with git commit -s)
I ran cargo fmt as mentioned in CODING_GUIDELINES
I used cargo clippy as mentioned in CODING_GUIDELINES
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

Further comments

github-actions · 2023-11-30T10:19:08Z

Robot Results

✅ Passed	❌ Failed	⏭️ Skipped	Total	Pass %	⏱️ Duration
380	0	3	380	100	53m22.669999999s

albinsuresh

LGTM. Have given some rewording suggestions, though.

docs/src/references/mappers/c8y-mapper.md

albinsuresh · 2023-11-30T10:43:01Z

docs/src/references/mappers/c8y-mapper.md

+The auto-registration can be enabled/disabled using the `tedge` tool.
+
+The auto-registration can be disabled as below


Suggested change

The auto-registration can be enabled/disabled using the `tedge` tool.

The auto-registration can be disabled as below

The auto-registration can be disabled/enabled using the `tedge config` command as follows:

albinsuresh · 2023-11-30T10:45:47Z

docs/src/references/mappers/c8y-mapper.md

+The auto-registration can be enabled as below
+
+```sh
+sudo tedge config set c8y.entity_store.auto_register true
+```
+Or
+
+```sh
+sudo tedge config unset c8y.entity_store.auto_register
+```


Suggested change

The auto-registration can be enabled as below

```sh

sudo tedge config set c8y.entity_store.auto_register true

```

Or

```sh

sudo tedge config unset c8y.entity_store.auto_register

```

I'd just drop that to reduce the verbosity, as the previous example is clear enough. Especially since it is just a boolean value with only two possible values.

Something seems to be wrong. If the default is false then unset will disable auto registration. Isn't it?

By default, the auto-registration is enabled. Here unset means to set the value to the default value.

Okay, the default is true.

albinsuresh · 2023-11-30T10:47:28Z

docs/src/references/mappers/c8y-mapper.md

+```sh
+sudo tedge config unset c8y.entity_store.auto_register
+```
+:::note


I'd move this note immediately after the config setting example. It can even be merged with the previous comment, but as the very first statement.

didier-wenzek

The content is here, but it could be clearer.

didier-wenzek · 2023-11-30T14:48:17Z

docs/src/references/mappers/c8y-mapper.md

+The auto-registration can be enabled as below
+
+```sh
+sudo tedge config set c8y.entity_store.auto_register true
+```
+Or
+
+```sh
+sudo tedge config unset c8y.entity_store.auto_register
+```


Something seems to be wrong. If the default is false then unset will disable auto registration. Isn't it?

didier-wenzek · 2023-11-30T14:50:05Z

docs/src/references/mappers/c8y-mapper.md

+## Auto Registration of Entities
+
+Before any data messages from an entity can be processed, the entity has to be registered first.
+The entities can be registered either explicitly, or implicitly.


Suggested change

The entities can be registered either explicitly, or implicitly.

The entities can be registered either explicitly, or implicitly,

depending on the auto-registration mode set with `c8y.entity_store.auto_register`.

didier-wenzek · 2023-11-30T14:58:44Z

docs/src/references/mappers/c8y-mapper.md

+To register an entity explicitly, an entity registration message has to be sent.
+
+But, if the auto-registration is enabled, sending any data message on a topic following the default topic scheme (`te/device/<device-id>/service/<service-id>/...`),
+results in the auto-registration of that target entity.
+
+For example, sending a measurement message to `te/device/child1///m/temperature`,
+will result in the auto-registration of the entity with topic id: `device/child1//` and the auto-generated external id: `<main-device-id>:device:child1`, derived from the topic id.
+Similarly, a measurement message on `te/device/child1/service/my-service/m/temperature`,
+results in the auto-registration of both the device entity: `device/child1//` and the service entity: `device/child1/service/my-service` with their respective auto-generated external IDs, in that order.
+
+The auto-registration can be disabled/enabled using the `tedge config` command as follows:


This text is difficult to read because going back and forth from auto-registration to explicit registration.

I would clearly separate the two:

The simpler is to use auto-registration which is the also the default behavior. ... all the details, pros and cons about auto-registration Explicit registration allows to work around the limitations of auto-registration. ... how to turn it on, link to the doc on how to register an entity, what are the impacts (i.e. lost measurements till the appropriate registration is received).

albinsuresh · 2023-12-01T07:31:09Z

docs/src/references/mappers/c8y-mapper.md

+When the auto registration is disabled, and if the device is not already registered.
+Then the c8y-mapper will not forward the incoming telemetry/health-status messages to the c8y cloud.
+But, logs/publishes an error message on the `te/errors` topic telling the entity is not registered.


Suggested change

When the auto registration is disabled, and if the device is not already registered.

Then the c8y-mapper will not forward the incoming telemetry/health-status messages to the c8y cloud.

But, logs/publishes an error message on the `te/errors` topic telling the entity is not registered.

Auto-registration is enabled, by default.

When the auto registration is disabled, and if the device is not explicitly registered,

then the c8y-mapper will just ignore all the data messages received from that device,

logging that error message on the `te/errors` topic indicating that the entity is not registered.

Reasons for rewording:

The first sentence was ending abruptly.

The messages are not limited to telemetry and health-status messages.

didier-wenzek

Approved. This is really well written and clear. Thank you.

Signed-off-by: Pradeep Kumar K J <pkj@softwareag.com>

PradeepKiruvale requested a review from albinsuresh November 30, 2023 09:50

PradeepKiruvale temporarily deployed to Test Pull Request November 30, 2023 09:56 — with GitHub Actions Inactive

albinsuresh approved these changes Nov 30, 2023

View reviewed changes

PradeepKiruvale force-pushed the auto_reg_doc branch from 910e5a1 to 24717b1 Compare November 30, 2023 13:21

PradeepKiruvale had a problem deploying to Test Pull Request November 30, 2023 13:28 — with GitHub Actions Failure

didier-wenzek requested changes Nov 30, 2023

View reviewed changes

PradeepKiruvale temporarily deployed to Test Pull Request December 1, 2023 03:56 — with GitHub Actions Inactive

albinsuresh reviewed Dec 1, 2023

View reviewed changes

PradeepKiruvale temporarily deployed to Test Pull Request December 1, 2023 13:22 — with GitHub Actions Inactive

didier-wenzek approved these changes Dec 1, 2023

View reviewed changes

auto registration document

b14aa2a

Signed-off-by: Pradeep Kumar K J <pkj@softwareag.com>

PradeepKiruvale force-pushed the auto_reg_doc branch from 17ec9b0 to b14aa2a Compare December 1, 2023 14:35

PradeepKiruvale temporarily deployed to Test Pull Request December 1, 2023 14:42 — with GitHub Actions Inactive

PradeepKiruvale merged commit 4363edf into thin-edge:main Dec 4, 2023
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Config setting to disable auto-registration of entities #2490

Config setting to disable auto-registration of entities #2490

PradeepKiruvale commented Nov 30, 2023

github-actions bot commented Nov 30, 2023 •

edited

albinsuresh left a comment

albinsuresh Nov 30, 2023

albinsuresh Nov 30, 2023

didier-wenzek Nov 30, 2023

PradeepKiruvale Dec 1, 2023

didier-wenzek Dec 1, 2023

albinsuresh Nov 30, 2023

didier-wenzek left a comment

didier-wenzek Nov 30, 2023

didier-wenzek Nov 30, 2023

PradeepKiruvale Dec 1, 2023 •

edited

didier-wenzek Nov 30, 2023

albinsuresh Dec 1, 2023 •

edited

didier-wenzek left a comment

		The auto-registration can be enabled/disabled using the `tedge` tool.

		The auto-registration can be disabled as below

	The entities can be registered either explicitly, or implicitly.
	The entities can be registered either explicitly, or implicitly,
	depending on the auto-registration mode set with `c8y.entity_store.auto_register`.

-When the auto registration is disabled, and if the device is not already registered.
-Then the c8y-mapper will not forward the incoming telemetry/health-status messages to the c8y cloud.
-But, logs/publishes an error message on the `te/errors` topic telling the entity is not registered.
+Auto-registration is enabled, by default.
+When the auto registration is disabled, and if the device is not explicitly registered,
+then the c8y-mapper will just ignore all the data messages received from that device,
+logging that error message on the `te/errors` topic indicating that the entity is not registered.

Config setting to disable auto-registration of entities #2490

Config setting to disable auto-registration of entities #2490

Conversation

PradeepKiruvale commented Nov 30, 2023

Proposed changes

Types of changes

Paste Link to the issue

Checklist

Further comments

github-actions bot commented Nov 30, 2023 • edited

Robot Results

albinsuresh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

didier-wenzek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PradeepKiruvale Dec 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

albinsuresh Dec 1, 2023 • edited

Choose a reason for hiding this comment

didier-wenzek left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 30, 2023 •

edited

PradeepKiruvale Dec 1, 2023 •

edited

albinsuresh Dec 1, 2023 •

edited