[ Impact ]
`cloud-init status` introduced a new exit code of 2 with the meaning of recoverable errors / warnings.
Without this fix, status exited with 2 in cases where previously did it with 0, potentially breaking consumers (scripts or other programs) of `cloud-init status`.
The fix is to include a quilt patch retaining the exit code of 0 for recoverable errors / warnings for stable releases.
[ Test Plan ]
```sh
#!/usr/bin/bash -ux
NAME=lp2048522
RELEASE=jammy
# This cloud-config includes a deprecated key which is a recoverable warning
cat <<EOF > /tmp/user-data
#cloud-config
apt_update: false
EOF
lxc delete -f $NAME 2>/dev/null || true
lxc launch ubuntu-daily:$RELEASE $NAME -c user.user-data="$(cat /tmp/user-data)"
sleep 1
lxc exec $NAME -- cloud-init status --wait
lxc exec $NAME -- sh -c 'cat <<EOF >"/etc/apt/sources.list.d/ubuntu-$(lsb_release -cs)-proposed.list"
# Install proposed cloud-init, clean and reboot
deb http://archive.ubuntu.com/ubuntu/ $(lsb_release -cs)-proposed restricted main multiverse universe
EOF'
lxc exec $NAME -- sh -c "apt update && apt install cloud-init/${RELEASE}-proposed"
lxc exec $NAME -- cloud-init --version
lxc exec $NAME -- cloud-init clean --logs --reboot
sleep 2
lxc exec $NAME -- cloud-init status --wait
if lxc exec $NAME -- cloud-init status --long --format json; then
echo Test passed
exit 0
else
echo Test not passed
exit 1
fi
```
[ Where problems could occur ]
* Limited risk, as the quilt patch is a one liner substituting the exit code of 2 by 0.
[ Original description ]
Taken from https://bugs.launchpad.net/ubuntu/+source/cloud-init/+bug/2045582/comments/8:
In the cases where there are recoverable warnings/errors, users checking status by exit code will start failing without changes on their end to accommodate the new behavior. We suspect this will be an issue for deployments where some of the warnings/errors are considered "normal".
Consider a customer using the Ubuntu minimal images (on Azure) which is currently missing "eject" and an error is being emitted. I believe if cloud-init 23.4 rolls out as-is, the status checks will start failing 100% of the time.
```
cpatterson@temp-vm-cpatterson-eastus-t20240105174837:~$ cloud-init status --wait
status: done
cpatterson@temp-vm-cpatterson-eastus-t20240105174837:~$ echo $?
2
cpatterson@temp-vm-cpatterson-eastus-t20240105174837:~$ cloud-init --version
/usr/bin/cloud-init 23.4-0ubuntu1~22.04.1
cpatterson@temp-vm-cpatterson-eastus-t20240105174837:~$ cloud-init status --wait --format json
{
"_schema_version": "1",
"boot_status_code": "enabled-by-generator",
"datasource": "azure",
"detail": "DataSourceAzure [seed=/dev/sr0]",
"errors": [],
"extended_status": "degraded done",
"init": {
"errors": [],
"finished": 1704494973.501599,
"recoverable_errors": {},
"start": 1704494969.534187
},
"init-local": {
"errors": [],
"finished": 1704494968.0249393,
"recoverable_errors": {
"ERROR": [
"Failed ejecting the provisioning iso: Unexpected error while running command.\nCommand: ['eject', '/dev/sr0']\nExit code: -\nReason: [Errno 2] No such file or directory: b'eject'\nStdout: -\nStderr: -"
]
},
"start": 1704494956.9926035
},
"last_update": "Fri, 05 Jan 2024 22:49:35 +0000",
"modules-config": {
"errors": [],
"finished": 1704494975.1977916,
"recoverable_errors": {},
"start": 1704494974.6474068
},
"modules-final": {
"errors": [],
"finished": 1704494975.8049285,
"recoverable_errors": {},
"start": 1704494975.5019412
},
"recoverable_errors": {
"ERROR": [
"Failed ejecting the provisioning iso: Unexpected error while running command.\nCommand: ['eject', '/dev/sr0']\nExit code: -\nReason: [Errno 2] No such file or directory: b'eject'\nStdout: -\nStderr: -"
]
},
"schemas": {
"1": {
"boot_status_code": "enabled-by-generator",
"datasource": "azure",
"detail": "DataSourceAzure [seed=/dev/sr0]",
"errors": [],
"extended_status": "degraded done",
"init": {
"errors": [],
"finished": 1704494973.501599,
"recoverable_errors": {},
"start": 1704494969.534187
},
"init-local": {
"errors": [],
"finished": 1704494968.0249393,
"recoverable_errors": {
"ERROR": [
"Failed ejecting the provisioning iso: Unexpected error while running command.\nCommand: ['eject', '/dev/sr0']\nExit code: -\nReason: [Errno 2] No such file or directory: b'eject'\nStdout: -\nStderr: -"
]
},
"start": 1704494956.9926035
},
"last_update": "Fri, 05 Jan 2024 22:49:35 +0000",
"modules-config": {
"errors": [],
"finished": 1704494975.1977916,
"recoverable_errors": {},
"start": 1704494974.6474068
},
"modules-final": {
"errors": [],
"finished": 1704494975.8049285,
"recoverable_errors": {},
"start": 1704494975.5019412
},
"recoverable_errors": {
"ERROR": [
"Failed ejecting the provisioning iso: Unexpected error while running command.\nCommand: ['eject', '/dev/sr0']\nExit code: -\nReason: [Errno 2] No such file or directory: b'eject'\nStdout: -\nStderr: -"
]
},
"stage": null,
"status": "done"
}
},
"stage": null,
"status": "done"
}
```
I mark the current devel release as `Fix Committed` but no fix is required as this is a new behavior that we want to patch out for stable releases.