2018-09-26 17:55:04 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
|
|
|
page_title: "operator migrate - Command"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "migrate"
|
2018-09-26 17:55:04 +00:00
|
|
|
sidebar_current: "docs-commands-operator-migrate"
|
|
|
|
description: |-
|
|
|
|
The "operator migrate" command copies data between storage backends to facilitate
|
|
|
|
migrating Vault between configurations. It operates directly at the storage
|
|
|
|
level, with no decryption involved.
|
|
|
|
---
|
|
|
|
|
|
|
|
# operator migrate
|
|
|
|
|
|
|
|
The `operator migrate` command copies data between storage backends to facilitate
|
|
|
|
migrating Vault between configurations. It operates directly at the storage
|
|
|
|
level, with no decryption involved. Keys in the destination storage backend will
|
|
|
|
be overwritten. The source data is not modified, with the exception of a small lock
|
|
|
|
key added during migration.
|
|
|
|
|
|
|
|
This is intended to be an offline operation to ensure data consistency, and Vault
|
|
|
|
will not allow starting the server if a migration is in progress.
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
Migrate all keys:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault operator migrate -config migrate.hcl
|
|
|
|
|
|
|
|
2018-09-20T14:23:23.656-0700 [INFO ] copied key: data/core/seal-config
|
|
|
|
2018-09-20T14:23:23.657-0700 [INFO ] copied key: data/core/wrapping/jwtkey
|
|
|
|
2018-09-20T14:23:23.658-0700 [INFO ] copied key: data/logical/fd1bed89-ffc4-d631-00dd-0696c9f930c6/31c8e6d9-2a17-d98f-bdf1-aa868afa1291/archive/metadata
|
|
|
|
2018-09-20T14:23:23.660-0700 [INFO ] copied key: data/logical/fd1bed89-ffc4-d631-00dd-0696c9f930c6/31c8e6d9-2a17-d98f-bdf1-aa868afa1291/metadata/5kKFZ4YnzgNfy9UcWOzxxzOMpqlp61rYuq6laqpLQDnB3RawKpqi7yBTrawj1P
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
Migration is done in a consistent, sorted order. If the migration is halted or
|
|
|
|
exits before completion (e.g. due to a connection error with a storage backend),
|
|
|
|
it may be resumed from an arbitrary key prefix:
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault operator migrate -config migrate.hcl -start "data/logical/fd"
|
|
|
|
```
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
The `operator migrate` command uses a dedicated configuration file to specify the source
|
|
|
|
and destination storage backends. The format of the storage stanzas is identical
|
|
|
|
to that used to [configure Vault](/docs/configuration/storage/index.html),
|
|
|
|
with the only difference being that two stanzas are required: `storage_source` and `storage_destination`.
|
|
|
|
|
|
|
|
```hcl
|
|
|
|
storage_source "mysql" {
|
|
|
|
username = "user1234"
|
|
|
|
password = "secret123!"
|
|
|
|
database = "vault"
|
|
|
|
}
|
|
|
|
|
|
|
|
storage_destination "consul" {
|
|
|
|
address = "127.0.0.1:8500"
|
|
|
|
path = "vault"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
The following flags are available for the `operator migrate` command.
|
|
|
|
|
|
|
|
- `-config` `(string: <required>)` - Path to the migration configuration file.
|
|
|
|
|
|
|
|
- `-start` `(string: "")` - Migration starting key prefix. Only keys at or after this value will be copied.
|
|
|
|
|
|
|
|
- `-reset` - Reset the migration lock. A lock file is added during migration to prevent
|
|
|
|
starting the Vault server or another migration. The `-reset` option can be used to
|
|
|
|
remove a stale lock file if present.
|