Phone-home documentation is lacking

[ubuntu-server-builder]

This bug was originally filed in Launchpad as LP: #1959149

Launchpad details

affected_projects = []
assignee = None
assignee_name = None
date_closed = 2022-02-15T21:54:41.455965+00:00
date_created = 2022-01-26T22:44:34.006124+00:00
date_fix_committed = 2022-01-28T03:32:20.791903+00:00
date_fix_released = 2022-02-15T21:54:41.455965+00:00
id = 1959149
importance = undecided
is_complete = True
lp_url = https://bugs.launchpad.net/cloud-init/+bug/1959149
milestone = None
owner = tobiasdebruijn
owner_name = Tobias de Bruijn
private = False
status = fix_released
submitter = tobiasdebruijn
submitter_name = Tobias de Bruijn
tags = []
duplicates = []

Launchpad user Tobias de Bruijn(tobiasdebruijn) wrote on 2022-01-26T22:44:34.006124+00:00

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.

[ubuntu-server-builder]

Launchpad user James Falcon(falcojr) wrote on 2022-01-27T14:41:51.286492+00:00

Thanks Tobias. This request makes sense. I created #1218 to address it.

[ubuntu-server-builder]

Launchpad user Brett Holman(holmanb) wrote on 2022-02-15T21:54:41.235047+00:00

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.