clarify call-home service and requirements #564
Conversation
fernandinand
requested review from
PeterPetrik,
alex-cit and
mostlyAtNight
and removed request for
PeterPetrik and
alex-cit
src/server/administer/index.md
Outdated
| It is legally required by <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License. | ||
| It is legally required by <EnterprisePlatformName /> servers to send usage information (`call-home` service) to monitor the usage of the License. | ||
|
|
||
| This service runs on background via `TCP` port `443`, hence it needs to be enabled on firewall side in order to comply with <EnterprisePlatformName /> terms. |
There was a problem hiding this comment.
This should not be part of the warning - warning is about legal bit - port is description how to set it up
There was a problem hiding this comment.
In terms of the technical requirement, it should say that it requires outgoing https access to https://api.merginmaps.com/monitoring on TCP port 443
I think this page has some wider issues though - it looks like it's written as a call to action to disable monitoring (which we don't want). I would instead recommend:
- changing the title so it describes monitoring, not how to disable it
- update the example to show monitoring enabled
- detail the technical requirements above
- say what it's for (making mm better and required for monitoring of enterprise edition licence usage)
- describe how to disable it if desired in the community edition while noting that this is now allowed in EE
src/server/administer/index.md
Outdated
| It is legally required by <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License. | ||
| It is legally required by <EnterprisePlatformName /> servers to send usage information (`call-home` service) to monitor the usage of the License. | ||
|
|
||
| This service runs on background via `TCP` port `443`, hence it needs to be enabled on firewall side in order to comply with <EnterprisePlatformName /> terms. |
There was a problem hiding this comment.
In terms of the technical requirement, it should say that it requires outgoing https access to https://api.merginmaps.com/monitoring on TCP port 443
I think this page has some wider issues though - it looks like it's written as a call to action to disable monitoring (which we don't want). I would instead recommend:
- changing the title so it describes monitoring, not how to disable it
- update the example to show monitoring enabled
- detail the technical requirements above
- say what it's for (making mm better and required for monitoring of enterprise edition licence usage)
- describe how to disable it if desired in the community edition while noting that this is now allowed in EE
mostlyAtNight
left a comment
mostlyAtNight
left a comment
There was a problem hiding this comment.
This looks much better - thank you.
One small change requested to make things clearer by removing the double-negative
|
Hey guys. Just wondering about this page https://merginmaps.com/docs/server/administer/environment/ and COLLECT_STATISTICS variable description. Could we add here some link to this Telemetry section or some short explanation of licensing related to 🔝 comments? @mostlyAtNight @fernandinand |
Sounds like a good idea - it would be good if everything reflected our recent discussions |
…thub.com:MerginMaps/docs into 548-adding-callback-network-requirements-to-docs
I added some info and link to the Telemetry section page @MarcelGeo |
alex-cit
left a comment
alex-cit
left a comment
There was a problem hiding this comment.
I have left two comment to consider :)
| <MainPlatformName /> telemetry service helps us gather some information about the usage of the platform, namely on-premise deployment. This information is very valuable to us to help us improve <MainPlatformName />. | ||
| Please consider enabling this functionality, even if you are using <CommunityPlatformName /> edition. For <EnterprisePlatformName /> deployments, as you'll check down below, this is <b>mandatory</b>. | ||
|
|
||
| The <MainPlatformName /> telemetry service (`call-home`) requires https access to `https://api.merginmaps.com/monitoring` on `TCP` port `443`. |
There was a problem hiding this comment.
Does this service has stable IP address so when client want's to whitelists the api?
There was a problem hiding this comment.
Let's finish the discussion on Slack and create a new PR if needed
tomasMizera
deleted the
548-adding-callback-network-requirements-to-docs
branch
PR for #548