scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-10-30 02:02:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update the title & description for SEO improvement (#29115)

Browse Source 
* Update the title & description for SEO improvement

* Minor updates for style consistency

* Revert back the change

* Update website/content/docs/secrets/aws.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
This commit is contained in:
Yoko Hyakuna
2024-12-18 15:37:38 -08:00
committed by GitHub
parent 8aa6fa3a90
commit f975259267
19 changed files with 65 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
website/content/docs/secrets/alicloud.mdx
View File

@@ -1,11 +1,8 @@
--- ---
layout: docs layout: docs
page_title: AliCloud - Secrets Engines page_title: AliCloud secrets engine
description: >- description: >-
The AliCloud secrets engine for Vault generates access tokens or STS Dynamically generate access tokens or STS credentials based on RAM policies or roles with the AliCloud secrets engine plugin.
credentials
dynamically based on RAM policies or roles.
--- ---
# AliCloud secrets engine # AliCloud secrets engine

7
website/content/docs/secrets/aws.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: AWS - Secrets Engines page_title: AWS secrets engine
description: |- description: >-
The AWS secrets engine for Vault generates access keys dynamically based on Dynamically generate access keys based on IAM policies with the AWS secrets engine plugin.
IAM policies.
--- ---
# AWS secrets engine # AWS secrets engine

7
website/content/docs/secrets/azure.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Azure - Secrets Engine page_title: Azure secrets engine
description: |- description: >-
The Azure Vault secrets engine dynamically generates Azure Dynamically generate Azure service principals and role assignments with the Azure secrets engine plugin.
service principals and role assignments.
--- ---
# Azure secrets engine # Azure secrets engine

4
website/content/docs/secrets/consul.mdx
View File

@@ -1,7 +1,7 @@
--- ---
layout: docs layout: docs
page_title: Consul - Secrets Engines page_title: Consul secrets engine
description: The Consul secrets engine for Vault generates tokens for Consul dynamically. description: Dynamically generate Consul tokens with the Consul secrets engine plugin.
--- ---
# Consul secrets engine # Consul secrets engine

5
website/content/docs/secrets/cubbyhole.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Cubbyhole - Secrets Engines page_title: Cubbyhole secrets engine
description: >- description: >-
The cubbyhole secrets engine can store arbitrary secrets scoped to a single Store arbitrary secrets scoped to a single client token with the Cubbyhole secrets engine plugin.
token.
--- ---
# Cubbyhole secrets engine # Cubbyhole secrets engine

7
website/content/docs/secrets/gcp.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Google Cloud - Secrets Engines page_title: Google Cloud secrets engine
description: |- description: >-
The Google Cloud secrets engine for Vault dynamically generates Google Cloud Dynamically generate Google Cloud service account keys and OAuth tokens based on IAM policies with the Google Cloud secrets engine plugin.
service account keys and OAuth tokens based on IAM policies.
--- ---
# Google Cloud secrets engine # Google Cloud secrets engine

6
website/content/docs/secrets/gcpkms.mdx
View File

@@ -1,8 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Google Cloud KMS - Secrets Engines page_title: Google Cloud KMS secrets engine
description: |- description: >-
The Google Cloud KMS secrets engine for Vault interfaces with Google Cloud The Google Cloud KMS secrets engine plugin interfaces with Google Cloud
KMS for encryption/decryption of data and KMS key management through Vault. KMS for encryption/decryption of data and KMS key management through Vault.
--- ---

4
website/content/docs/secrets/index.mdx
View File

@@ -1,7 +1,7 @@
--- ---
layout: docs layout: docs
page_title: Secrets Engines page_title: Secrets engines
description: Secrets engines are mountable engines that store or generate secrets in Vault. description: Secrets engines are mountable plugins that store or generate secrets in Vault.
--- ---
# Secrets engines # Secrets engines

2
website/content/docs/secrets/kmip-profiles.mdx
View File

@@ -1,7 +1,7 @@
--- ---
layout: docs layout: docs
page_title: KMIP - Profiles Support page_title: KMIP - Profiles Support
description: |- description: >-
The KMIP profiles define the use of KMIP objects, attributes, operations, message elements The KMIP profiles define the use of KMIP objects, attributes, operations, message elements
and authentication methods within specific contexts of KMIP server and client interaction. and authentication methods within specific contexts of KMIP server and client interaction.
These profiles define a set of normative constraints for employing KMIP within a particular These profiles define a set of normative constraints for employing KMIP within a particular

4
website/content/docs/secrets/kmip.mdx
View File

@@ -1,7 +1,7 @@
--- ---
layout: docs layout: docs
page_title: KMIP - Secrets Engines page_title: KMIP secrets engine
description: |- description: >-
The KMIP secrets engine allows Vault to act as a KMIP server provider and The KMIP secrets engine allows Vault to act as a KMIP server provider and
handle the lifecycle of its KMIP managed objects. handle the lifecycle of its KMIP managed objects.
--- ---

5
website/content/docs/secrets/kubernetes.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: Kubernetes - Secrets Engines page_title: Kubernetes secrets engine
description: >- description: >-
The Kubernetes secrets engine for Vault generates Kubernetes service account Dynamically generate Kubernetes service account tokens, service accounts, role bindings, and roles with the Kubernetes secrets engine plugin.
tokens, service accounts, role bindings, and roles dynamically.
--- ---
# Kubernetes secrets engine # Kubernetes secrets engine

4
website/content/docs/secrets/ldap.mdx
View File

@@ -1,8 +1,8 @@
--- ---
layout: docs layout: docs
page_title: LDAP - Secrets Engine page_title: LDAP secrets engine
description: >- description: >-
The LDAP secret engine manages LDAP entry passwords. Dynamically create and manage LDAP entry passwords with the LDAP secret engine plugin.
--- ---
# LDAP secrets engine # LDAP secrets engine

7
website/content/docs/secrets/mongodbatlas.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: MongoDB Atlas - Secrets Engines page_title: MongoDB atlas secrets engine
description: |- description: >-
The MongoDB Atlas secrets engine for Vault generates MongoDB Atlas Dynamically generate MongoDB Atlas Programmatic API Keys with the MongoDB Atlas secrets engine plugin.
Programmatic API Keys dynamically.
--- ---
# MongoDB atlas secrets engine # MongoDB atlas secrets engine

7
website/content/docs/secrets/nomad.mdx
View File

@@ -1,15 +1,14 @@
--- ---
layout: docs layout: docs
page_title: Nomad Secrets Engine page_title: Nomad secrets engine
description: The Nomad secrets engine for Vault generates tokens for Nomad dynamically. description: >-
Dynamically generate Nomad tokens with the Nomad secrets engine plugin.
--- ---
# Nomad secrets engine # Nomad secrets engine
@include 'x509-sha1-deprecation.mdx' @include 'x509-sha1-deprecation.mdx'
Name: `Nomad`
Nomad is a simple, flexible scheduler and workload orchestrator. The Nomad secrets engine for Vault generates [Nomad](https://www.nomadproject.io/) Nomad is a simple, flexible scheduler and workload orchestrator. The Nomad secrets engine for Vault generates [Nomad](https://www.nomadproject.io/)
ACL tokens dynamically based on pre-existing Nomad ACL policies. ACL tokens dynamically based on pre-existing Nomad ACL policies.

5
website/content/docs/secrets/rabbitmq.mdx
View File

@@ -1,9 +1,8 @@
--- ---
layout: docs layout: docs
page_title: RabbitMQ - Secrets Engines page_title: RabbitMQ secrets engine
description: >- description: >-
The RabbitMQ secrets engine for Vault generates user credentials to access Dynamically generate user credentials to access RabbitMQ with the RabbitMQ secrets engine plugin.
RabbitMQ.
--- ---
# RabbitMQ secrets engine # RabbitMQ secrets engine

45
website/content/docs/secrets/terraform.mdx
View File

@@ -1,15 +1,14 @@
--- ---
layout: docs layout: docs
page_title: Terraform Cloud Secret Backend page_title: HCP Terraform secrets engine
description: The Terraform Cloud secret backend for Vault generates tokens for Terraform Cloud dynamically. description: >-
Dynamically generate HCP Terraform API tokens with the HCP Terraform secrets engine plugin.
--- ---
# Terraform Cloud secret backend # HCP Terraform secrets engine
Name: `Terraform Cloud` The HCP Terraform secrets engine for Vault generates
[HCP Terraform](https://cloud.hashicorp.com/products/terraform)
The Terraform Cloud secret backend for Vault generates
[Terraform Cloud](https://cloud.hashicorp.com/products/terraform)
API tokens dynamically for Organizations, Teams, and Users. API tokens dynamically for Organizations, Teams, and Users.
This page will show a quick start for this backend. For detailed documentation This page will show a quick start for this backend. For detailed documentation
@@ -26,17 +25,17 @@ Most secrets engines must be configured in advance before they can perform their
functions. These steps are usually completed by an operator or configuration functions. These steps are usually completed by an operator or configuration
management tool. management tool.
1. Enable the Terraform Cloud secrets engine: 1. Enable the HCP Terraform secrets engine:
```shell-session ```shell-session
$ vault secrets enable terraform $ vault secrets enable terraform
Success! Enabled the terraform cloud secrets engine at: terraform/ Success! Enabled the terraform secrets engine at: terraform/
``` ```
By default, the secrets engine will mount at the name of the engine. To By default, the secrets engine will mount at the name of the engine. To
enable the secrets engine at a different path, use the `-path` argument. enable the secrets engine at a different path, use the `-path` argument.
2. Configure Vault to connect and authenticate to Terraform Cloud: 2. Configure Vault to connect and authenticate to HCP Terraform:
```shell-session ```shell-session
$ vault write terraform/config \ $ vault write terraform/config \
@@ -44,17 +43,17 @@ management tool.
Success! Data written to: terraform/config Success! Data written to: terraform/config
``` ```
See [Terraform Cloud's documentation on API See [HCP Terraform's documentation on API
tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens) tokens](/terraform/cloud-docs/users-teams-organizations/api-tokens)
to determine the appropriate API token for use with the secret engine. In to determine the appropriate API token for use with the secret engine. In
order to perform all operations, a User API token is recommended. order to perform all operations, a User API token is recommended.
3. Configure a role that maps a name in Vault to a Terraform Cloud User. At 3. Configure a role that maps a name in Vault to a HCP Terraform user. At
this time the Terraform Cloud API does not allow dynamic user generation. As this time the HCP Terraform API does not allow dynamic user generation. As
a result this secret engine creates dynamic API tokens for an existing user, a result this secret engine creates dynamic API tokens for an existing user,
and manages the lifecycle of that API token. You will need to know the User and manages the lifecycle of that API token. You will need to know the User
ID in order to generate User API tokens for that user. You can use the ID in order to generate User API tokens for that user. You can use the
Terraform Cloud [Account HCP Terraform [Account
API](/terraform/cloud-docs/api-docs/account) to find the API](/terraform/cloud-docs/api-docs/account) to find the
desired User ID. desired User ID.
@@ -84,14 +83,14 @@ token_id at-123acbdfask
## Organization, team, and user roles ## Organization, team, and user roles
Terraform Cloud supports three distinct types of API tokens; Organizations, HCP Terraform supports three distinct types of API tokens; Organizations,
Teams, and Users. Each token type has distinct access levels and generation Teams, and Users. Each token type has distinct access levels and generation
workflows. A given Vault role can manage any one of the three types at a time, workflows. A given Vault role can manage any one of the three types at a time,
however there are important differences to be aware of. however there are important differences to be aware of.
### Organization and team roles ### Organization and team roles
The Terraform Cloud API limits both Organization and Team roles to **one active The HCP Terraform API limits both Organization and Team roles to **one active
token at any given time**. Generating a new Organization or Team API token by token at any given time**. Generating a new Organization or Team API token by
reading the credentials in Vault or otherwise generating them on reading the credentials in Vault or otherwise generating them on
[app.terraform.io](https://app.terraform.io/session) will effectively revoke **any** [app.terraform.io](https://app.terraform.io/session) will effectively revoke **any**
@@ -128,10 +127,10 @@ token_id at-fqvtdTQ5kQWcjUfG
### User roles ### User roles
Traditionally, Vault secret engines create dynamic users and dynamic credentials Traditionally, Vault secret engines create dynamic users and dynamic credentials
along with them. At the time of writing, the Terraform Cloud API does not allow along with them. At the time of writing, the HCP Terraform API does not allow
for creating dynamic users. Instead, the Terraform Cloud secret engine creates for creating dynamic users. Instead, the HCP Terraform secret engine creates
dynamic User API tokens by configuring a Vault role to manage an existing dynamic User API tokens by configuring a Vault role to manage an existing
Terraform Cloud user. The lifecycle of these tokens is managed by Vault and HCP Terraform user. The lifecycle of these tokens is managed by Vault and
will auto expire according to the configured TTL and max TTL of the Vault will auto expire according to the configured TTL and max TTL of the Vault
role. role.
@@ -154,18 +153,18 @@ token <example token>
token_id at-fqvtdTQ5kQWcjUfG token_id at-fqvtdTQ5kQWcjUfG
``` ```
Please see the [Terraform Cloud API Please see the [HCP Terraform API
Token documentation for more Token documentation for more
information](/terraform/cloud-docs/users-teams-organizations/api-tokens). information](/terraform/cloud-docs/users-teams-organizations/api-tokens).
## Tutorial ## Tutorial
Refer to [Terraform Cloud Secrets Refer to [HCP Terraform Secrets
Engine](/vault/tutorials/secrets-management/terraform-secrets-engine) Engine](/vault/tutorials/secrets-management/terraform-secrets-engine)
for a step-by-step tutorial. for a step-by-step tutorial.
## API ## API
The Terraform Cloud secrets engine has a full HTTP API. Please see the The HCP Terraform secrets engine has a full HTTP API. Please see the
[Terraform Cloud secrets engine API](/vault/api-docs/secret/terraform) for more [HCP Terraform secrets engine API](/vault/api-docs/secret/terraform) for more
details. details.

5
website/content/docs/secrets/totp.mdx
View File

@@ -1,7 +1,8 @@
--- ---
layout: docs layout: docs
page_title: TOTP - Secrets Engines page_title: TOTP secrets engine
description: The TOTP secrets engine for Vault generates time-based one-time use passwords. description: >-
Generate time-based one-time use passwords with the TOTP secrets engine plugin.
--- ---
# TOTP secrets engine # TOTP secrets engine

7
website/content/docs/secrets/venafi.mdx
View File

@@ -1,10 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Venafi - Secrets Engines page_title: Venafi secrets engine
description: The Venafi integrated secrets engine for Vault. description: >-
Dynamically generate short-lived SSL/TLS certificates using Venafi secrets engine.
--- ---
# Venafi secrets engine for HashiCorp Vault # Venafi secrets engine
The Venafi Machine Identity Secrets Engine provides applications with the The Venafi Machine Identity Secrets Engine provides applications with the
ability to dynamically generate SSL/TLS certificates that serve as machine ability to dynamically generate SSL/TLS certificates that serve as machine

2
website/data/docs-nav-data.json
View File

@@ -1768,7 +1768,7 @@
] ]
}, },
{ {
"title": "Terraform Cloud", "title": "HCP Terraform",
"path": "secrets/terraform" "path": "secrets/terraform"
}, },
{ {