From c42ede51c639e37610d46c6fd4e68b24297d929a Mon Sep 17 00:00:00 2001 From: akshya96 Date: Fri, 24 Feb 2023 12:04:30 -0800 Subject: [PATCH 1/5] vault-issue-9185 --- website/content/docs/commands/status.mdx | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/website/content/docs/commands/status.mdx b/website/content/docs/commands/status.mdx index 48f520810180..d2cdc5ed3e34 100644 --- a/website/content/docs/commands/status.mdx +++ b/website/content/docs/commands/status.mdx @@ -49,3 +49,23 @@ flags](/vault/docs/commands) included on all commands. - `-format` `(string: "table")` - Print the output in the given format. Valid formats are "table", "json", or "yaml". This can also be specified via the `VAULT_FORMAT` environment variable. + +By default, the output is displayed in "table" format. + +#### Output Fields + +1. The field for unseal nonce is displayed as `"n"` instead of `n` in yaml outputs. +2. The following fields in "table" format are displayed only when relevant: + +- "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed. +- "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured. +- "Seal Migration in Progress" is displayed when it is in progress. +- "Cluster Name" and "Cluster ID" are displayed if they have a value +- "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero +- "Warnings" are displayed if they exist + +- The following fields are displayed only when HA mode is enabled and is unsealed: + - "HA Cluster" + - "HA Mode" + - "Active Since" is displayed if node is active and has valid active time + - "Performance Standby" Node and "Performance Standby Last Remote WAL" are displayed for performance standby nodes From a40a8349ebc175886d985449af425125518c772a Mon Sep 17 00:00:00 2001 From: akshya96 Date: Fri, 24 Feb 2023 13:01:23 -0800 Subject: [PATCH 2/5] removing new lines: --- website/content/docs/commands/status.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/website/content/docs/commands/status.mdx b/website/content/docs/commands/status.mdx index d2cdc5ed3e34..69d54e70dfb4 100644 --- a/website/content/docs/commands/status.mdx +++ b/website/content/docs/commands/status.mdx @@ -56,14 +56,12 @@ By default, the output is displayed in "table" format. 1. The field for unseal nonce is displayed as `"n"` instead of `n` in yaml outputs. 2. The following fields in "table" format are displayed only when relevant: - - "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed. - "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured. - "Seal Migration in Progress" is displayed when it is in progress. - "Cluster Name" and "Cluster ID" are displayed if they have a value - "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero - "Warnings" are displayed if they exist - - The following fields are displayed only when HA mode is enabled and is unsealed: - "HA Cluster" - "HA Mode" From b1c0f9a39487cb0226ecc635d9ca671665ee989d Mon Sep 17 00:00:00 2001 From: akshya96 Date: Fri, 24 Feb 2023 13:04:18 -0800 Subject: [PATCH 3/5] removing new space --- website/content/docs/commands/status.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/commands/status.mdx b/website/content/docs/commands/status.mdx index 69d54e70dfb4..f33f305e8608 100644 --- a/website/content/docs/commands/status.mdx +++ b/website/content/docs/commands/status.mdx @@ -57,7 +57,7 @@ By default, the output is displayed in "table" format. 1. The field for unseal nonce is displayed as `"n"` instead of `n` in yaml outputs. 2. The following fields in "table" format are displayed only when relevant: - "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed. -- "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured. +- "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured. - "Seal Migration in Progress" is displayed when it is in progress. - "Cluster Name" and "Cluster ID" are displayed if they have a value - "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero From 40f7e15681f25398dab62133e4c3838b1e650775 Mon Sep 17 00:00:00 2001 From: akshya96 Date: Fri, 24 Feb 2023 13:20:29 -0800 Subject: [PATCH 4/5] fix grammar --- website/content/docs/commands/status.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/website/content/docs/commands/status.mdx b/website/content/docs/commands/status.mdx index f33f305e8608..33193797d2b9 100644 --- a/website/content/docs/commands/status.mdx +++ b/website/content/docs/commands/status.mdx @@ -59,11 +59,11 @@ By default, the output is displayed in "table" format. - "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed. - "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured. - "Seal Migration in Progress" is displayed when it is in progress. -- "Cluster Name" and "Cluster ID" are displayed if they have a value -- "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero -- "Warnings" are displayed if they exist +- "Cluster Name" and "Cluster ID" are displayed if they have a value. +- "Raft Committed Index", "Raft Applied Index", "Last WAL" are diplayed if they are non-zero. +- "Warnings" are displayed if the warnings apply. - The following fields are displayed only when HA mode is enabled and is unsealed: - - "HA Cluster" - - "HA Mode" - - "Active Since" is displayed if node is active and has valid active time - - "Performance Standby" Node and "Performance Standby Last Remote WAL" are displayed for performance standby nodes + - "HA Cluster". + - "HA Mode". + - "Active Since" is displayed if the node is active and has a valid active time. + - "Performance Standby" Node and "Performance Standby Last Remote WAL" are displayed for performance standby nodes. From a7dd73262ed0360713a19f50795322350091b77d Mon Sep 17 00:00:00 2001 From: akshya96 Date: Mon, 27 Feb 2023 09:33:51 -0800 Subject: [PATCH 5/5] change field name --- website/content/docs/commands/status.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/commands/status.mdx b/website/content/docs/commands/status.mdx index 33193797d2b9..7c602346de53 100644 --- a/website/content/docs/commands/status.mdx +++ b/website/content/docs/commands/status.mdx @@ -54,7 +54,7 @@ By default, the output is displayed in "table" format. #### Output Fields -1. The field for unseal nonce is displayed as `"n"` instead of `n` in yaml outputs. +1. The field for total shares is displayed as `"n"` instead of `n` in yaml outputs. 2. The following fields in "table" format are displayed only when relevant: - "Unseal Progress" and "Unseal Nonce" are displayed when vault is sealed. - "HCP Link Status" and "HCP Link Resource ID" are displayed when HCP link is configured.