mirror of
				https://github.com/optim-enterprises-bv/vault.git
				synced 2025-11-03 20:17:59 +00:00 
			
		
		
		
	Add build_date to CLI and API docs (#15268)
* update version cmd docs * update status cmd docs * update version-history cmd docs * update sys/seal-status docs * update sys/version-history docs
This commit is contained in:
		@@ -37,7 +37,8 @@ The "t" parameter is the threshold, and "n" is the number of shares.
 | 
			
		||||
  "n": 5,
 | 
			
		||||
  "progress": 2,
 | 
			
		||||
  "nonce": "",
 | 
			
		||||
  "version": "1.8.2",
 | 
			
		||||
  "version": "1.11.0",
 | 
			
		||||
  "build_date": "2022-05-03T08:34:11Z",
 | 
			
		||||
  "migration": false,
 | 
			
		||||
  "recovery_seal": false,
 | 
			
		||||
  "storage_type": "file"
 | 
			
		||||
@@ -55,7 +56,8 @@ Sample response when Vault is unsealed.
 | 
			
		||||
  "n": 5,
 | 
			
		||||
  "progress": 0,
 | 
			
		||||
  "nonce": "",
 | 
			
		||||
  "version": "1.8.2",
 | 
			
		||||
  "version": "1.11.0",
 | 
			
		||||
  "build_date": "2022-05-03T08:34:11Z",
 | 
			
		||||
  "migration": false,
 | 
			
		||||
  "cluster_name": "vault-cluster-336172e1",
 | 
			
		||||
  "cluster_id": "f94053ad-d80e-4270-2006-2efd67d0910a",
 | 
			
		||||
 
 | 
			
		||||
@@ -17,6 +17,7 @@ This endpoint returns the version history of the Vault. The response will contai
 | 
			
		||||
 | 
			
		||||
- `keys`: a list of installed versions in chronological order based on the time installed
 | 
			
		||||
- `key_info`: a map indexed by the versions found in the `keys` list containing the following subkeys:
 | 
			
		||||
  - `build_date`: the time (in UTC) at which the Vault binary used to run the Vault server was built. **Note: Only tracked from version 1.11.0 or greater**
 | 
			
		||||
  - `previous_version`: the version installed prior to this version or `null` if no prior version exists
 | 
			
		||||
  - `timestamp_installed`: the time (in UTC) at which the version was installed
 | 
			
		||||
 | 
			
		||||
@@ -36,19 +37,27 @@ $ curl \
 | 
			
		||||
 | 
			
		||||
```json
 | 
			
		||||
{
 | 
			
		||||
  "keys": ["1.9.0", "1.9.1", "1.9.2"],
 | 
			
		||||
  "keys": ["1.9.0", "1.9.1", "1.9.2", "1.11.0"],
 | 
			
		||||
  "key_info": {
 | 
			
		||||
    "1.9.0": {
 | 
			
		||||
      "build_date": null,
 | 
			
		||||
      "previous_version": null,
 | 
			
		||||
      "timestamp_installed": "2021-11-18T10:23:16Z"
 | 
			
		||||
    },
 | 
			
		||||
    "1.9.1": {
 | 
			
		||||
      "build_date": null,
 | 
			
		||||
      "previous_version": "1.9.0",
 | 
			
		||||
      "timestamp_installed": "2021-12-13T11:09:52Z"
 | 
			
		||||
    },
 | 
			
		||||
    "1.9.2": {
 | 
			
		||||
      "build_date": null,
 | 
			
		||||
      "previous_version": "1.9.1",
 | 
			
		||||
      "timestamp_installed": "2021-12-23T10:56:37Z"
 | 
			
		||||
    },
 | 
			
		||||
    "1.11.0": {
 | 
			
		||||
      "build_date": "2022-05-03T08:34:11Z",
 | 
			
		||||
      "previous_version": null,
 | 
			
		||||
      "timestamp_installed": "2022-05-03T13:16:04Z"
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -25,12 +25,14 @@ Check the status:
 | 
			
		||||
 | 
			
		||||
```shell-session
 | 
			
		||||
$ vault status
 | 
			
		||||
 | 
			
		||||
Sealed: false
 | 
			
		||||
Key Shares: 5
 | 
			
		||||
Key Threshold: 3
 | 
			
		||||
Unseal Progress: 0
 | 
			
		||||
Unseal Nonce:
 | 
			
		||||
Version: x.y.z
 | 
			
		||||
Build Date: 2022-05-03T08:34:11Z
 | 
			
		||||
Cluster Name: vault-cluster-49ffd45f
 | 
			
		||||
Cluster ID: d2dad792-fb99-1c8d-452e-528d073ba205
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -11,13 +11,14 @@ The `version-history` command prints the historical list of installed Vault vers
 | 
			
		||||
 | 
			
		||||
```shell-session
 | 
			
		||||
Note: Version tracking was added in 1.9.0. Earlier versions have not been tracked.
 | 
			
		||||
      The Build Date will only be available for versions 1.11.0 or greater.
 | 
			
		||||
 | 
			
		||||
Version   Installation Time
 | 
			
		||||
-------   -----------------
 | 
			
		||||
Version  Installation Time     Build Date
 | 
			
		||||
-------  -----------------     ----------
 | 
			
		||||
1.9.0    2021-11-18T10:23:16Z
 | 
			
		||||
1.9.1    2022-12-13T11:09:52Z
 | 
			
		||||
1.9.2    2021-12-23T10:56:37Z
 | 
			
		||||
```
 | 
			
		||||
1.11.0   2022-05-03T13:16:04Z  2022-05-03T08:34:11Z
 | 
			
		||||
 | 
			
		||||
## Usage
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -17,5 +17,5 @@ It can also be printed by adding the flags `--version` or `-v` to the `vault` co
 | 
			
		||||
 | 
			
		||||
```shell-session
 | 
			
		||||
$ vault -v
 | 
			
		||||
Vault v1.2.3
 | 
			
		||||
Vault v1.2.3, built 2022-05-03T08:34:11Z
 | 
			
		||||
```
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user