2017-09-08 02:07:45 +00:00
---
2020-01-18 00:18:09 +00:00
layout: docs
page_title: operator init - Command
2017-09-08 02:07:45 +00:00
description: |-
The "operator init" command initializes a Vault server. Initialization is the
process by which Vault's storage backend is prepared to receive data. Since
2019-10-11 15:12:38 +00:00
Vault servers share the same storage backend in HA mode, you only need to
2017-09-08 02:07:45 +00:00
initialize one Vault to initialize the storage backend.
---
# operator init
The `operator init` command initializes a Vault server. Initialization is the
process by which Vault's storage backend is prepared to receive data. Since
2019-10-11 15:12:38 +00:00
Vault servers share the same storage backend in HA mode, you only need to
2017-09-08 02:07:45 +00:00
initialize one Vault to initialize the storage backend.
2022-05-16 21:44:23 +00:00
This command cannot be run against already-initialized Vault cluster.
2017-09-08 02:07:45 +00:00
2022-05-16 21:44:23 +00:00
During initialization, Vault generates a root key, which is stored in the storage backend alongside all other Vault data. The root key itself is encrypted and requires an _unseal key_ to decrypt it.
2017-09-08 02:07:45 +00:00
2022-05-16 21:44:23 +00:00
The default Vault configuration uses [Shamir's Secret Sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing) to split the root key into a configured number of shards (referred as key shares, or unseal keys). A certain threshold of shards is required to reconstruct the root key, which is then used to decrypt the Vault's encryption key.
2017-09-08 02:07:45 +00:00
2023-01-26 00:12:15 +00:00
Refer to the [Seal/Unseal](/vault/docs/concepts/seal#seal-unseal) documentation for further details.
2017-09-08 02:07:45 +00:00
## Examples
Start initialization with the default options:
2020-05-21 17:18:17 +00:00
```shell-session
2017-09-08 02:07:45 +00:00
$ vault operator init
```
Initialize, but encrypt the unseal keys with pgp keys:
2020-05-21 17:18:17 +00:00
```shell-session
2017-09-08 02:07:45 +00:00
$ vault operator init \
-key-shares=3 \
-key-threshold=2 \
-pgp-keys="keybase:hashicorp,keybase:jefferai,keybase:sethvargo"
```
2021-03-04 23:57:47 +00:00
Initialize Auto Unseal with a non-default threshold and number of recovery keys, and encrypt the recovery keys with pgp keys:
2018-12-18 16:42:10 +00:00
2020-05-21 17:18:17 +00:00
```shell-session
2018-12-18 16:42:10 +00:00
$ vault operator init \
2021-03-04 23:57:47 +00:00
-recovery-shares=7 \
-recovery-threshold=4 \
-recovery-pgp-keys="keybase:jeff,keybase:chris,keybase:brian,keybase:calvin,keybase:matthew,keybase:vishal,keybase:nick"
2018-12-18 16:42:10 +00:00
```
2017-09-08 02:07:45 +00:00
Encrypt the initial root token using a pgp key:
2020-05-21 17:18:17 +00:00
```shell-session
2017-09-08 02:07:45 +00:00
$ vault operator init -root-token-pgp-key="keybase:hashicorp"
```
## Usage
The following flags are available in addition to the [standard set of
2023-01-26 00:12:15 +00:00
flags](/vault/docs/commands) included on all commands.
2017-09-08 02:07:45 +00:00
### Output Options
- `-format` `(string: "")` - Print the output in the given format. Valid formats
are "table", "json", or "yaml". The default is table. This can also be
specified via the `VAULT_FORMAT` environment variable.
### Common Options
- `-key-shares` `(int: 5)` - Number of key shares to split the generated master
key into. This is the number of "unseal keys" to generate. This is aliased as
`-n`.
- `-key-threshold` `(int: 3)` - Number of key shares required to reconstruct the
2022-03-17 05:01:38 +00:00
root key. This must be less than or equal to -key-shares. This is aliased as
2017-09-08 02:07:45 +00:00
`-t`.
- `-pgp-keys` `(string: "...")` - Comma-separated list of paths to files on disk
2021-11-08 18:04:59 +00:00
containing public PGP keys OR a comma-separated list of Keybase usernames
2018-08-07 17:34:35 +00:00
using the format `keybase:<username>`. When supplied, the generated unseal
2017-09-08 02:07:45 +00:00
keys will be encrypted and base64-encoded in the order specified in this list.
2019-11-26 21:57:51 +00:00
The number of entries must match -key-shares, unless -stored-shares are used.
2017-09-08 02:07:45 +00:00
- `-root-token-pgp-key` `(string: "")` - Path to a file on disk containing a
2021-11-08 18:04:59 +00:00
binary or base64-encoded public PGP key. This can also be specified as a
2018-08-07 17:34:35 +00:00
Keybase username using the format `keybase:<username>`. When supplied, the
2017-09-08 02:07:45 +00:00
generated root token will be encrypted and base64-encoded with the given
public key.
- `-status` `(bool": false)` - Print the current initialization status. An exit
code of 0 means the Vault is already initialized. An exit code of 1 means an
2018-09-04 21:44:41 +00:00
error occurred. An exit code of 2 means the Vault is not initialized.
2017-09-08 02:07:45 +00:00
### Consul Options
- `-consul-auto` `(bool: false)` - Perform automatic service discovery using
Consul in HA mode. When all nodes in a Vault HA cluster are registered with
Consul, enabling this option will trigger automatic service discovery based on
the provided -consul-service value. When Consul is Vault's HA backend, this
functionality is automatically enabled. Ensure the proper Consul environment
variables are set (CONSUL_HTTP_ADDR, etc). When only one Vault server is
discovered, it will be initialized automatically. When more than one Vault
server is discovered, they will each be output for selection. The default is
false.
- `-consul-service` `(string: "vault")` - Name of the service in Consul under
which the Vault servers are registered.
2018-12-18 16:42:10 +00:00
### HSM and KMS Options
2017-09-08 02:07:45 +00:00
- `-recovery-pgp-keys` `(string: "...")` - Behaves like `-pgp-keys`, but for the
2023-01-26 00:12:15 +00:00
recovery key shares. This is only available with [Auto Unseal](/vault/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
2017-09-08 02:07:45 +00:00
- `-recovery-shares` `(int: 5)` - Number of key shares to split the recovery key
2023-01-26 00:12:15 +00:00
into. This is only available with [Auto Unseal](/vault/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
2017-09-08 02:07:45 +00:00
- `-recovery-threshold` `(int: 3)` - Number of key shares required to
2023-01-26 00:12:15 +00:00
reconstruct the recovery key. This is only available with [Auto Unseal](/vault/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
2017-09-08 02:07:45 +00:00
- `-stored-shares` `(int: 0)` - Number of unseal keys to store on an HSM. This
must be equal to `-key-shares`.
2022-05-23 22:42:57 +00:00
-> **Recovery keys:** Refer to the
2023-01-26 00:12:15 +00:00
[Seal/Unseal](/vault/docs/concepts/seal#recovery-key) documentation to learn more
2022-05-23 22:42:57 +00:00
about recovery keys.