Skip to content

Commit 872fb52

Browse files
committed
NC | Lifecycle | Documentation
Signed-off-by: Romy <35330373+romayalon@users.noreply.github.com>
1 parent c7f6feb commit 872fb52

File tree

3 files changed

+649
-3
lines changed

3 files changed

+649
-3
lines changed

docs/NooBaaNonContainerized/Health.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ For more details about NooBaa RPM installation, see - [Getting Started](./Gettin
4444
- returns message if there is no ongoing upgrade and the config directory is unlocked
4545
- `Bucket event notifications connections health`
4646
- Sends out a test notification for each connection.
47+
- `Lifecycle worker last run health`
48+
- checks if the previous run of the lifecycle worker finished successfully.
4749

4850
* Health CLI requires root permissions.
4951

@@ -55,7 +57,7 @@ The `health` command is used to analyze NooBaa health with customizable options.
5557

5658
```sh
5759
noobaa-cli diagnose health [--deployment_type][--https_port]
58-
[--all_account_details][--all_bucket_details][--all_connection_details][--notif_storage_threshold][--config_root][--debug]
60+
[--all_account_details][--all_bucket_details][--all_connection_details][--notif_storage_threshold][--lifecycle][--config_root][--debug]
5961
```
6062
### Flags -
6163

@@ -89,6 +91,11 @@ noobaa-cli diagnose health [--deployment_type][--https_port]
8991
- Default: false
9092
- Description: Whether health ouput should check if notification storage FS is below threshold.
9193

94+
- `lifecycle`
95+
- Type: Boolean
96+
- Default: false
97+
- Description: Indicates if health output should contain lifecycle test result.
98+
9299
- `config_root`
93100
- Type: String
94101
- Description: Indicates the config directory (default config.NSFS_NC_DEFAULT_CONF_DIR). config_root flag should be used only for dev/tests envs.
@@ -182,6 +189,23 @@ The output of the Health CLI is a JSON object containing the following propertie
182189
- Description: An object that consists config directory information, config directory upgrade information etc.
183190
- Example: { "phase": "CONFIG_DIR_UNLOCKED", "config_dir_version": "1.0.0", "upgrade_package_version": "5.18.0", "upgrade_status": { "message": "there is no in-progress upgrade" }}
184191

192+
- `latest_lifecycle_run_status`
193+
- Type: Object { <br>
194+
"total_stats": { "num_objects_deleted": number, "num_objects_delete_failed": number, "objects_delete_errors": array, "num_mpu_aborted": number, "num_mpu_abort_failed": number, "mpu_abort_errors": array <br>}, <br>
195+
"lifecycle_run_times": Object {
196+
"run_lifecycle_start_time": number,
197+
"list_buckets_start_time": number,
198+
"list_buckets_end_time": number,
199+
"list_buckets_took_ms": number,
200+
"process_buckets_start_time": number,
201+
"process_buckets_end_time": number,
202+
"process_buckets_took_ms": number,
203+
"run_lifecycle_end_time": number,
204+
"run_lifecycle_took_ms": number <br>
205+
},<br>
206+
"errors": array <br> }.
207+
- Description: An object that consists total_stats information, lifecycle_run_times information and errors.
208+
- Example: see in [Health Output Example](./Lifecycle.md#health-cli)
185209
## Example
186210
```sh
187211
noobaa-cli diagnose health --all_account_details --all_bucket_details

0 commit comments

Comments
 (0)