Phone-home documentation is lacking

Bug #1959149 reported by Tobias de Bruijn
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Fix Released
Undecided
Unassigned

Bug Description

From: https://cloudinit.readthedocs.io/en/latest/topics/modules.html#phone-home

There is no documentation present on how the server receiving the phone-home call can expect the data. What fields are present, what does each key give the server, what data format is used etc.

I think this is a problem that should be addressed to make it easier for developers, like me, who want to build a server which is phone-home'd to by cloud-init. This should be documented, rather than require the developer to figure it out by trial and error.

The provided reporting guidelines do not apply to this bug report, as it is not a bug in cloud-init itself.

Revision history for this message
James Falcon (falcojr) wrote :

Thanks Tobias. This request makes sense. I created https://github.com/canonical/cloud-init/pull/1218 to address it.

Changed in cloud-init:
status: New → In Progress
James Falcon (falcojr)
Changed in cloud-init:
status: In Progress → Fix Committed
Revision history for this message
Brett Holman (holmanb) wrote : Fixed in cloud-init version 22.1.

This bug is believed to be fixed in cloud-init in version 22.1. If this is still a problem for you, please make a comment and set the state back to New

Thank you.

Changed in cloud-init:
status: Fix Committed → Fix Released
Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.