ENT-4244: Added the Host cleanup API documentation & updated Settings api fields#3649
ENT-4244: Added the Host cleanup API documentation & updated Settings api fields#3649aleksandrychev wants to merge 2 commits into
Conversation
|
@cf-bottom jenkins please |
|
Alright, I triggered a build: Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/30/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-30/output/_site/ |
Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
|
@cf-bottom jenkins please |
|
Sure, I triggered a build: Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/31/ Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-31/output/_site/ |
| Disables all AI features, including the [AI chat][AI chat API] endpoint. | ||
| Default value: `false` | ||
| - **allowLlmViewAccessToAttributesNames** _(boolean)_ | ||
| Allows the LLM used by the [AI chat][AI chat API] to receive the names of inventory attributes when generating SQL queries. When `false`, the AI chat operates without knowledge of attribute names defined on the hub. |
There was a problem hiding this comment.
"Allows the LLM to be used by"...
| Configuration for the duplicate-hostname stage of the [Host cleanup API][Host cleanup API]. Object shape: `{ "enabled": boolean, "completelyClear": boolean }`. When `completelyClear` is `true`, deleted duplicates are also permanently removed in the same run. | ||
| Default value: `{ "enabled": false, "completelyClear": false }` | ||
| - **duplicateIpHostsCleanup** _(object)_ | ||
| Configuration for the duplicate-IP stage of the [Host cleanup API][Host cleanup API]. Object shape: `{ "enabled": boolean, "completelyClear": boolean }`. |
There was a problem hiding this comment.
for completeness do you want to include the same description of completelyClear for this and following instnaces? e.g. copy
When
completelyClearistrue, deleted duplicates are also permanently removed in the same run.
several times? That way copy/paste/mods are more likely to always include the explanation instead of relying on the order of things as-is.
| Configuration for the group stage of the [Host cleanup API][Host cleanup API]. Object shape: `{ "enabled": boolean, "groupId": integer, "completelyClear": boolean }`. Every host in the given shared group is deleted when enabled. | ||
| Default value: `{ "enabled": false, "groupId": "", "completelyClear": false }` | ||
| - **inactiveHostsCleanup** _(object)_ | ||
| Configuration for the inactivity stage of the [Host cleanup API][Host cleanup API]. Object shape: `{ "enabled": boolean, "days": integer, "completelyClear": boolean }`. Hosts that have not reported in for `days` days are deleted when enabled. |
There was a problem hiding this comment.
maybe change to "Hosts that have not reported for days days are deleted when enabled."
No description provided.