luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity
open-vault/website/source/guides/operations/index.html.md

83 lines
3.7 KiB
Markdown
Raw Normal View History

Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
---
layout: "guides"
Incorporated review comments
2018-02-01 17:50:59 +00:00
page_title: "Vault Operations - Guides"
Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
sidebar_current: "guides-operations"
description: |-
Vault architecture guide covers Vault infrastructure discussions including
installation.
---
Incorporated review comments
2018-02-01 17:50:59 +00:00
# Vault Operations
Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
Incorporated review comments
2018-02-01 17:50:59 +00:00
Vault Operations guides address Vault infrastructure discussions. These
Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
guides are designed to help the operations team to plan and install a Vault
cluster that meets your organization's needs.
Transit rewrap (#4091) * Adding new guides * Replaced backend with engine * Grammar for the encryption guide * Grammar and Markdown style for the Transite Rewrap guide See https://github.com/hashicorp/engineering-docs/blob/master/writing/markdown.md for notes on numbered Markdown lists. * grammar and wording updates for ref arch guide * Updating replication diagram * Removing multi-tenant pattern guide * Added a note 'Enterprise Only' * Removing multi-tenant pattern guide * Modified the topic order * Grammar and Markdown formatting * Grammar, Markdown syntax, and phrasing * Grammar and Markdown syntax * Replaced 'backend' with appropriate terms * Added a note clarifying that replication is an enterprise-only feature * Updated the diagram & added additional resource links * update some grammar and ordering * Removed the inaccurate text in index for EaaS
2018-03-19 21:56:45 +00:00
- [Vault Reference Architecture](/guides/operations/reference-architecture.html)
guide provides guidance in the best practices of _Vault Enterprise_ implementations
through use of a reference architecture. This example is to convey a general
architecture, which is likely to be adapted to accommodate the specific needs of
each implementation.
Vault HA with Consul guide (#4187) * Vault HA guide draft * Fixed node_id to say node_name based on Brian's input * Fixed the unwanted hyperlink * Vault HA guide * Updated the description of the Vault HA guide * Typo fixes * Added a reference to Vault HA with Consule guide * Incorporated Teddy's feedback * Fixed an env var name * Vault configuration has been updated: 'api_addr'
2018-04-04 15:25:06 +00:00
Added Deployment Guide in the index (#5211)
2018-08-28 17:55:30 +00:00
- [Vault Deployment Guide](/guides/operations/deployment-guide.html) covers the
steps required to install and configure a single HashiCorp Vault cluster as
defined in the Vault Reference Architecture.
Vault HA with Consul guide (#4187) * Vault HA guide draft * Fixed node_id to say node_name based on Brian's input * Fixed the unwanted hyperlink * Vault HA guide * Updated the description of the Vault HA guide * Typo fixes * Added a reference to Vault HA with Consule guide * Incorporated Teddy's feedback * Fixed an env var name * Vault configuration has been updated: 'api_addr'
2018-04-04 15:25:06 +00:00
- [Vault HA with Consul](/guides/operations/vault-ha-consul.html) guide
walks you through a simple Vault HA cluster implementation which is backed by
[HashiCorp Consul](https://www.consul.io/intro/index.html).
Fixing docs links and adding redirects for new guides (#3939) * updating links * updating links * updating links * updating links * updating links * adding redirects
2018-02-08 00:29:07 +00:00
- [Production Hardening](/guides/operations/production.html) guide provides
guidance on best practices for a production hardened deployment of Vault.
Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
The recommendations are based on the [security model](/docs/internals/security.html)
and focus on defense in depth.
Vault HA with Consul guide (#4187) * Vault HA guide draft * Fixed node_id to say node_name based on Brian's input * Fixed the unwanted hyperlink * Vault HA guide * Updated the description of the Vault HA guide * Typo fixes * Added a reference to Vault HA with Consule guide * Incorporated Teddy's feedback * Fixed an env var name * Vault configuration has been updated: 'api_addr'
2018-04-04 15:25:06 +00:00
Vault DR Replication Setup Guide (#4790) * WIP DR setup guide * Fix typos * Added the steps to demote & disable primary * Clarified some of the explanation
2018-06-21 15:42:35 +00:00
- [Root Token Generation](/guides/operations/generate-root.html) guide
demonstrates the workflow of regenerating root tokens. It is considered to be a
best practice not to persist the initial **root** token. If a root token needs
to be regenerated, this guide helps you walk through the task.
- [Rekeying & Rotating](/guides/operations/rekeying-and-rotating.html) guide
provides a high-level overview of Shamir's Secret Sharing Algorithm, and how to
perform _rekey_ and _rotate_ operations in Vault.
- [Building Plugin Backends](/guides/operations/plugin-backends.html) guide
provides steps to build, register, and mount non-database external plugin
backends.
## Vault Enterprise
- [Replication Setup & Guidance](/guides/operations/replication.html)
Re-categorized the guides on the navigation
2018-01-26 23:13:15 +00:00
walks you through the commands to activate the Vault servers in replication mode.
Please note that [Vault Replication](/docs/vault-enterprise/replication/index.html)
is a Vault Enterprise feature.
Vault HA with Consul guide (#4187) * Vault HA guide draft * Fixed node_id to say node_name based on Brian's input * Fixed the unwanted hyperlink * Vault HA guide * Updated the description of the Vault HA guide * Typo fixes * Added a reference to Vault HA with Consule guide * Incorporated Teddy's feedback * Fixed an env var name * Vault configuration has been updated: 'api_addr'
2018-04-04 15:25:06 +00:00
Vault DR Replication Setup Guide (#4790) * WIP DR setup guide * Fix typos * Added the steps to demote & disable primary * Clarified some of the explanation
2018-06-21 15:42:35 +00:00
- [Disaster Recovery Replication Setup](/guides/operations/disaster-recovery.html)
guide provides step-by-step instruction of setting up a disaster recovery (DR)
cluster.
- [Mount Filter](/guides/operations/mount-filter.html)
Mount Filters guide (#4536) * WIP: Mount filter guide * WIP * Mount filter guide for CLI, API, and UI * updated the next step * Updated the verification steps * Added a note about the unseal key on secondaries * Added more details * Added a reference to mount filter guide * Added a note about generating a new root token * Added a note about local secret engine
2018-05-22 15:57:36 +00:00
guide demonstrates how to selectively filter out secret engines from being
replicated across clusters. This feature can help organizations to comply with
Seal Wrap / FIPS 140-2 Compliance guide (#4558) * WIP - Seal Wrap guide * WIP: Seal Wrap guide * Added a brief description about the Seal Wrap guide * Incorporated feedbacks * Updated FIPS language Technically everything looks great. I've updated some of the language here as "compliance" could be interpreted to mean that golang's crypto and xcrypto libraries have been certified compliant with FIPS. Unfortunately they have not, and Leidos' cert is only about how Vault can operate in tandem with FIPS-certified modules. It's a very specific update, but it's an important one for some VE customers. Looks great - thanks! * Removed 'Compliance' from title * typo fix
2018-05-22 18:23:11 +00:00
***General Data Protection Regulation (GDPR)***.
Mount Filters guide (#4536) * WIP: Mount filter guide * WIP * Mount filter guide for CLI, API, and UI * updated the next step * Updated the verification steps * Added a note about the unseal key on secondaries * Added more details * Added a reference to mount filter guide * Added a note about generating a new root token * Added a note about local secret engine
2018-05-22 15:57:36 +00:00
fixing feature name
2018-08-22 15:40:48 +00:00
- [Multi-Tenant Pattern with Namespaces](/guides/operations/multi-tenant.html) guide discuss a pattern to
[Guide] Multi-Tenant Pattern with ACL Namespaces (0.11) (#5103) * WIP - ACL Namespace * WIP - ACL Namepaces * WIP * WIP * WIP * WIP * WIP * Added UI screenshots * Added summary at the end * Added the Web UI steps in Step 5 * Update multi-tenant.html.md Updated text to ensure that we use the final "ship" name of namespaces (namespaces vs. ACL Namespaces) and introduced some industry-specific terminology (highlighting this is about Secure Multi-Tenancy)
2018-08-16 23:51:53 +00:00
isolate secrets using ACL Namespaces.
Vault DR Replication Setup Guide (#4790) * WIP DR setup guide * Fix typos * Added the steps to demote & disable primary * Clarified some of the explanation
2018-06-21 15:42:35 +00:00
- [Vault Auto-unseal using AWS Key Management Service (KMS)](/guides/operations/autounseal-aws-kms.html) guide demonstrates an example of
Versioned KV secret engine (kv-v2) tutorial (#4367) * Added versioned kv secret engine tutorial * Added check-and-set feature * Fixed archived -> deleted * Incorporated all suggested changes
2018-04-17 21:42:14 +00:00
how to use Terraform to provision an instance that utilizes an encryption key
Auto Unseal with AWS KMS guide (#4277) * WIP * Added auto unseal * Converting to a guide * Added little more explanations * Minor fixes * Fixed a typo * Fixed a typo * Changed auto unseal to auto-unseal * Found more typo... fixed
2018-04-05 20:28:39 +00:00
from AWS Key Management Service (KMS).
Vault DR Replication Setup Guide (#4790) * WIP DR setup guide * Fix typos * Added the steps to demote & disable primary * Clarified some of the explanation
2018-06-21 15:42:35 +00:00
- [Seal Wrap / FIPS 140-2](/guides/operations/seal-wrap.html)
Seal Wrap / FIPS 140-2 Compliance guide (#4558) * WIP - Seal Wrap guide * WIP: Seal Wrap guide * Added a brief description about the Seal Wrap guide * Incorporated feedbacks * Updated FIPS language Technically everything looks great. I've updated some of the language here as "compliance" could be interpreted to mean that golang's crypto and xcrypto libraries have been certified compliant with FIPS. Unfortunately they have not, and Leidos' cert is only about how Vault can operate in tandem with FIPS-certified modules. It's a very specific update, but it's an important one for some VE customers. Looks great - thanks! * Removed 'Compliance' from title * typo fix
2018-05-22 18:23:11 +00:00
guide demonstrates how Vault's seal wrap feature works to encrypt your secrets
leveraging FIPS 140-2 certified HSM.
[Guide] Vault Cluster Monitoring Guide (#5084) * Vault cluster monitoring guide * Updated the download link * Fixed broken link
2018-08-10 20:52:02 +00:00
- [Vault Cluster Monitoring Guide](/guides/operations/monitoring.html) walks
you through Vault cluster monitoring with telemetry collected by
[Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) and
forwarded to
[InfluxDB](https://www.influxdata.com/time-series-platform/influxdb/) and
[Grafana](https://grafana.com/) for analysis.
Reference in a new issue Copy permalink