man: Document cloud-init error codes

canonical · Oct 26, 2023 · cd4bd0f · cd4bd0f
1 parent cf46b3f
commit cd4bd0f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/doc/man/cloud-init.1 b/doc/man/cloud-init.1
@@ -85,6 +85,16 @@ Run a single module.
 .B "status"
 Report cloud-init status or wait on completion.
 
+.SH EXIT STATUS
+
+.IP
+0 - Success
+.IP
+1 - Error - Cloud-init failed.
+.IP
+2 - Recoverable error - Cloud-init completed but experienced errors.
+
+
 .SH COPYRIGHT
 Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0
 

diff --git a/tests/unittests/cmd/test_status.py b/tests/unittests/cmd/test_status.py
@@ -416,13 +416,13 @@ def fakeexists(filepath):
                 1,
                 dedent(
                     """\
-                    status: error
-                    extended_status: error
-                    boot_status_code: enabled-by-kernel-cmdline
-                    last_update: Thu, 01 Jan 1970 00:02:05 +0000
-                    detail:
-                    DataSourceNoCloud [seed=/var/.../seed/nocloud-net][dsmode=net]
-                    """
+                status: error
+                extended_status: error
+                boot_status_code: enabled-by-kernel-cmdline
+                last_update: Thu, 01 Jan 1970 00:02:05 +0000
+                detail:
+                DataSourceNoCloud [seed=/var/.../seed/nocloud-net][dsmode=net]
+                """
                 ),
                 id="on_errors_long",
             ),
@@ -507,7 +507,6 @@ def fakeexists(filepath):
                     "datasource": "",
                     "detail": "Running in stage: init",
                     "errors": [],
-                    "last_update": "Thu, 01 Jan 1970 00:02:04 +0000",
                     "status": "running",
                     "extended_status": "running",
                     "init": {"finished": None, "start": 124.456},