a43e292424
* 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
3.4 KiB
layout, page_title, sidebar_title, sidebar_current, description
| layout | page_title | sidebar_title | sidebar_current | description |
|---|---|---|---|---|
| docs | GCP Cloud KMS - Seals - Configuration | GCP Cloud KMS <sup>ENT</sup> | docs-configuration-seal-gcpckms | The GCP Cloud KMS seal configures Vault to use GCP Cloud KMS as the seal wrapping mechanism. |
gcpckms Seal
The GCP Cloud KMS seal configures Vault to use GCP Cloud KMS as the seal wrapping mechanism. Vault Enterprise's GCP Cloud KMS seal is activated by one of the following:
- The presence of a
seal "gcpckms"block in Vault's configuration file. - The presence of the environment variable
VAULT_SEAL_TYPEset togcpckms. If enabling via environment variable, all other required values specific to Cloud KMS (i.e.VAULT_GCPCKMS_SEAL_KEY_RING, etc.) must be also supplied, as well as all other GCP-related environment variables that lends to successful authentication (i.e.GOOGLE_PROJECT, etc.).
gcpckms Example
This example shows configuring GCP Cloud KMS seal through the Vault configuration file by providing all the required values:
seal "gcpckms" {
credentials = "/usr/vault/vault-project-user-creds.json"
project = "vault-project"
region = "global"
key_ring = "vault-keyring"
crypto_key = "vault-key"
}
gcpckms Parameters
These parameters apply to the seal stanza in the Vault configuration file:
-
credentials(string: <required>): The path to the credentials JSON file to use. May be also specified by theGOOGLE_CREDENTIALSorGOOGLE_APPLICATION_CREDENTIALSenvironment variable or set automatically if running under Google App Engine, Google Compute Engine or Google Kubernetes Engine. -
project(string: <required>): The GCP project ID to use. May also be specified by theGOOGLE_PROJECTenvironment variable. -
region(string: "us-east-1"): The GCP region/location where the key ring lives. May also be specified by theGOOGLE_REGIONenvironment variable. -
key_ring(string: <required>): The GCP CKMS key ring to use. May also be specified by theVAULT_GCPCKMS_SEAL_KEY_RINGenvironment variable. -
crypto_key(string: <required>): The GCP CKMS crypto key to use for encryption and decryption. May also be specified by theVAULT_GCPCKMS_SEAL_CRYPTO_KEYenvironment variable.
Authentication
Authentication-related values must be provided, either as environment variables or as configuration parameters.
GCP authentication values:
* `GOOGLE_CREDENTIALS` or `GOOGLE_APPLICATION_CREDENTIALS`
* `GOOGLE_PROJECT`
* `GOOGLE_REGION`
Note: The client uses the official Google SDK and will use the specified credentials, environment credentials, or application default credentials in that order, if the above GCP specific values are not provided.
gcpckms Environment Variables
Alternatively, the GCP Cloud KMS seal can be activated by providing the following environment variables:
* `VAULT_SEAL_TYPE`
* `VAULT_GCPCKMS_SEAL_KEY_RING`
* `VAULT_GCPCKMS_SEAL_CRYPTO_KEY`
Key Rotation
This seal supports rotating keys defined in Google Cloud KMS doc. Both scheduled rotation and manual rotation is supported for CKMS since the key information. Old keys version must not be disabled or deleted and are used to decrypt older data. Any new or updated data will be encrypted with the primary key version.