mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-02 19:47:54 +00:00
website: fixes redirected links (#17574)
* fixes redirected links * fix broken link to key wrapping guide
This commit is contained in:
@@ -360,7 +360,7 @@ $ vault read azure/creds/my-role
|
|||||||
|
|
||||||
## Revoking/Renewing Secrets
|
## Revoking/Renewing Secrets
|
||||||
|
|
||||||
See docs on how to [renew](/api/system/leases#renew-lease) and [revoke](/api-docs/system/leases#revoke-lease) leases.
|
See docs on how to [renew](/api-docs/system/leases#renew-lease) and [revoke](/api-docs/system/leases#revoke-lease) leases.
|
||||||
|
|
||||||
[docs]: /docs/secrets/azure
|
[docs]: /docs/secrets/azure
|
||||||
[roles]: /docs/secrets/azure#roles
|
[roles]: /docs/secrets/azure#roles
|
||||||
|
|||||||
@@ -160,11 +160,11 @@ To create a client token with service identities attached:
|
|||||||
- `token_type` <sup>DEPRECATED (1.11)</sup> `(string: "client")` - Specifies the type of token to create
|
- `token_type` <sup>DEPRECATED (1.11)</sup> `(string: "client")` - Specifies the type of token to create
|
||||||
when using this role. Valid values are `"client"` or `"management"`. If a `"management"`
|
when using this role. Valid values are `"client"` or `"management"`. If a `"management"`
|
||||||
token, the `policy` parameter is not required. Defaults to `"client`". [Deprecated from Consul as of 1.4 and
|
token, the `policy` parameter is not required. Defaults to `"client`". [Deprecated from Consul as of 1.4 and
|
||||||
removed as of Consul 1.11.](https://www.consul.io/api-docs/acl/legacy)
|
removed as of Consul 1.11.](https://developer.hashicorp.com/consul/api-docs/acl/legacy)
|
||||||
|
|
||||||
- `policy` <sup>DEPRECATED (1.11)</sup> `(string: "")` – Specifies the base64-encoded ACL policy.
|
- `policy` <sup>DEPRECATED (1.11)</sup> `(string: "")` – Specifies the base64-encoded ACL policy.
|
||||||
This is required unless the `token_type` is `"management"`. [Deprecated from Consul as of 1.4 and
|
This is required unless the `token_type` is `"management"`. [Deprecated from Consul as of 1.4 and
|
||||||
removed as of Consul 1.11.](https://www.consul.io/api-docs/acl/legacy)
|
removed as of Consul 1.11.](https://developer.hashicorp.com/consul/api-docs/acl/legacy)
|
||||||
|
|
||||||
- `policies` <sup>DEPRECATED (1.11)</sup> `(list: <policy or policies>)` - Same as `consul_policies`.
|
- `policies` <sup>DEPRECATED (1.11)</sup> `(list: <policy or policies>)` - Same as `consul_policies`.
|
||||||
Deprecated in favor of using `consul_policies`.
|
Deprecated in favor of using `consul_policies`.
|
||||||
@@ -200,7 +200,7 @@ To create a client token with policies defined in Consul:
|
|||||||
|
|
||||||
- `policy` <sup>DEPRECATED (1.11)</sup> `(string: <policy>)` – Specifies the base64-encoded ACL policy. The
|
- `policy` <sup>DEPRECATED (1.11)</sup> `(string: <policy>)` – Specifies the base64-encoded ACL policy. The
|
||||||
ACL format can be found in the [Consul ACL
|
ACL format can be found in the [Consul ACL
|
||||||
documentation](https://www.consul.io/docs/security/acl/acl-legacy). This is
|
documentation](https://developer.hashicorp.com/consul/docs/security/acl/acl-legacy). This is
|
||||||
required unless the `token_type` is `"management"`.
|
required unless the `token_type` is `"management"`.
|
||||||
|
|
||||||
### Sample Payload
|
### Sample Payload
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ configured roles for the Cassandra database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Secrets Engine](/api/secret/databases#configure-connection), this plugin
|
Secrets Engine](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ configured roles for Elasticsearch.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the HANA database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [database
|
In addition to the parameters defined by the [database
|
||||||
secrets engine](/api/secret/databases#configure-connection), this plugin
|
secrets engine](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path | Produces |
|
| Method | Path | Produces |
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ configured roles for the Influxdb database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Secrets Engine](/api/secret/databases#configure-connection), this plugin
|
Secrets Engine](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ configured roles for the MongoDB database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ configured roles.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the MSSQL database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ configured roles for the MySQL database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the Oracle database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the PostgreSQL database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ $ curl \
|
|||||||
Statements are configured during role creation and are used by the plugin to
|
Statements are configured during role creation and are used by the plugin to
|
||||||
determine what is sent to the database on user creation, renewing, and
|
determine what is sent to the database on user creation, renewing, and
|
||||||
revocation. For more information on configuring roles see the [Role
|
revocation. For more information on configuring roles see the [Role
|
||||||
API](/api/secret/databases#create-role) in the database secrets engine docs.
|
API](/api-docs/secret/databases#create-role) in the database secrets engine docs.
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the Redshift database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ configured roles for the Snowflake database.
|
|||||||
## Configure Connection
|
## Configure Connection
|
||||||
|
|
||||||
In addition to the parameters defined by the [Database
|
In addition to the parameters defined by the [Database
|
||||||
Backend](/api/secret/databases#configure-connection), this plugin
|
Backend](/api-docs/secret/databases#configure-connection), this plugin
|
||||||
has a number of parameters to further configure a connection.
|
has a number of parameters to further configure a connection.
|
||||||
|
|
||||||
| Method | Path |
|
| Method | Path |
|
||||||
|
|||||||
@@ -594,5 +594,5 @@ $ curl \
|
|||||||
|
|
||||||
## Revoking/Renewing Secrets
|
## Revoking/Renewing Secrets
|
||||||
|
|
||||||
See docs on how to [renew](/api/system/leases#renew-lease) and [revoke](/api-docs/system/leases#revoke-lease) leases.
|
See docs on how to [renew](/api-docs/system/leases#renew-lease) and [revoke](/api-docs/system/leases#revoke-lease) leases.
|
||||||
Note this only applies to service account keys.
|
Note this only applies to service account keys.
|
||||||
|
|||||||
@@ -115,7 +115,7 @@ increase read scalability.
|
|||||||
DR secondary and Performance secondary clusters have their own Autopilot configurations, managed
|
DR secondary and Performance secondary clusters have their own Autopilot configurations, managed
|
||||||
independently of their primary.
|
independently of their primary.
|
||||||
|
|
||||||
The [Autopilot API](/api/system/storage/raftautopilot) uses DR operation tokens for
|
The [Autopilot API](/api-docs/system/storage/raftautopilot) uses DR operation tokens for
|
||||||
authorization when executed against a DR secondary cluster.
|
authorization when executed against a DR secondary cluster.
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ components of that plan.
|
|||||||
Backups and restores are ideally performed while Vault is offline. If offline
|
Backups and restores are ideally performed while Vault is offline. If offline
|
||||||
backups are not feasible, we recommend using a storage backend that supports
|
backups are not feasible, we recommend using a storage backend that supports
|
||||||
atomic snapshots (such as
|
atomic snapshots (such as
|
||||||
[Consul](https://www.consul.io/commands/snapshot) or [Integrated
|
[Consul](https://developer.hashicorp.com/consul/commands/snapshot) or [Integrated
|
||||||
Storage](/docs/commands/operator/raft#snapshot)).
|
Storage](/docs/commands/operator/raft#snapshot)).
|
||||||
|
|
||||||
~> If your storage backend does not support atomic snapshots, we recommend only
|
~> If your storage backend does not support atomic snapshots, we recommend only
|
||||||
@@ -92,7 +92,7 @@ other storage backends, follow the documentation of that backend for taking and
|
|||||||
restoring backups.
|
restoring backups.
|
||||||
|
|
||||||
- Integrated Storage [snapshots](/docs/commands/operator/raft#snapshot)
|
- Integrated Storage [snapshots](/docs/commands/operator/raft#snapshot)
|
||||||
- Consul [snapshots](https://www.consul.io/commands/snapshot)
|
- Consul [snapshots](https://developer.hashicorp.com/consul/commands/snapshot)
|
||||||
|
|
||||||
#### Backing up Multiple Clusters
|
#### Backing up Multiple Clusters
|
||||||
|
|
||||||
|
|||||||
@@ -36,5 +36,5 @@ The sentinel stanza currently supports only one parameter, `additional_enabled_m
|
|||||||
could have performance and security implications in policies. Enabling the "http" import could cause your Vault
|
could have performance and security implications in policies. Enabling the "http" import could cause your Vault
|
||||||
servers to submit outbound requests to arbitrary endpoints.
|
servers to submit outbound requests to arbitrary endpoints.
|
||||||
See the
|
See the
|
||||||
[Sentinel HTTP Import](https://docs.hashicorp.com/sentinel/imports/http/)
|
[Sentinel HTTP Import](https://docs.hashicorp.com/sentinel/imports/http)
|
||||||
documentation for more information.
|
documentation for more information.
|
||||||
|
|||||||
@@ -91,17 +91,17 @@ connection. You can read more about encrypting Consul connections on the
|
|||||||
- `tls_ca_file` `(string: "")` – Specifies the path to the CA certificate used
|
- `tls_ca_file` `(string: "")` – Specifies the path to the CA certificate used
|
||||||
for Consul communication. This defaults to system bundle if not specified.
|
for Consul communication. This defaults to system bundle if not specified.
|
||||||
This should be set according to the
|
This should be set according to the
|
||||||
[`ca_file`](https://www.consul.io/docs/agent/options.html#ca_file) setting in
|
[`ca_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#ca_file) setting in
|
||||||
Consul.
|
Consul.
|
||||||
|
|
||||||
- `tls_cert_file` `(string: "")` (optional) – Specifies the path to the
|
- `tls_cert_file` `(string: "")` (optional) – Specifies the path to the
|
||||||
certificate for Consul communication. This should be set according to the
|
certificate for Consul communication. This should be set according to the
|
||||||
[`cert_file`](https://www.consul.io/docs/agent/options.html#cert_file) setting
|
[`cert_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#cert_file) setting
|
||||||
in Consul.
|
in Consul.
|
||||||
|
|
||||||
- `tls_key_file` `(string: "")` – Specifies the path to the private key for
|
- `tls_key_file` `(string: "")` – Specifies the path to the private key for
|
||||||
Consul communication. This should be set according to the
|
Consul communication. This should be set according to the
|
||||||
[`key_file`](https://www.consul.io/docs/agent/config/config-files#key_file) setting
|
[`key_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#key_file) setting
|
||||||
in Consul.
|
in Consul.
|
||||||
|
|
||||||
- `tls_min_version` `(string: "tls12")` – Specifies the minimum TLS version to
|
- `tls_min_version` `(string: "tls12")` – Specifies the minimum TLS version to
|
||||||
|
|||||||
@@ -74,7 +74,7 @@ and [`cluster_addr`][cluster-addr] ([example][listener-example]).
|
|||||||
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
- `max_parallel` `(string: "128")` – Specifies the maximum number of concurrent
|
||||||
requests to Consul. Make sure that your Consul agents are configured to
|
requests to Consul. Make sure that your Consul agents are configured to
|
||||||
support this level of parallelism, see
|
support this level of parallelism, see
|
||||||
[http_max_conns_per_client](https://www.consul.io/docs/agent/options.html#http_max_conns_per_client).
|
[http_max_conns_per_client](https://developer.hashicorp.com/consul/docs/agent/config/config-files#http_max_conns_per_client).
|
||||||
|
|
||||||
- `path` `(string: "vault/")` – Specifies the path in Consul's key-value store
|
- `path` `(string: "vault/")` – Specifies the path in Consul's key-value store
|
||||||
where Vault data will be stored.
|
where Vault data will be stored.
|
||||||
@@ -120,17 +120,17 @@ connection. You can read more about encrypting Consul connections on the
|
|||||||
- `tls_ca_file` `(string: "")` – Specifies the path to the CA certificate used
|
- `tls_ca_file` `(string: "")` – Specifies the path to the CA certificate used
|
||||||
for Consul communication. This defaults to system bundle if not specified.
|
for Consul communication. This defaults to system bundle if not specified.
|
||||||
This should be set according to the
|
This should be set according to the
|
||||||
[`ca_file`](https://www.consul.io/docs/agent/options.html#ca_file) setting in
|
[`ca_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#ca_file) setting in
|
||||||
Consul.
|
Consul.
|
||||||
|
|
||||||
- `tls_cert_file` `(string: "")` (optional) – Specifies the path to the
|
- `tls_cert_file` `(string: "")` (optional) – Specifies the path to the
|
||||||
certificate for Consul communication. This should be set according to the
|
certificate for Consul communication. This should be set according to the
|
||||||
[`cert_file`](https://www.consul.io/docs/agent/options.html#cert_file) setting
|
[`cert_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#cert_file) setting
|
||||||
in Consul.
|
in Consul.
|
||||||
|
|
||||||
- `tls_key_file` `(string: "")` – Specifies the path to the private key for
|
- `tls_key_file` `(string: "")` – Specifies the path to the private key for
|
||||||
Consul communication. This should be set according to the
|
Consul communication. This should be set according to the
|
||||||
[`key_file`](https://www.consul.io/docs/agent/options.html#key_file) setting
|
[`key_file`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#key_file) setting
|
||||||
in Consul.
|
in Consul.
|
||||||
|
|
||||||
- `tls_min_version` `(string: "tls12")` – Specifies the minimum TLS version to
|
- `tls_min_version` `(string: "tls12")` – Specifies the minimum TLS version to
|
||||||
|
|||||||
@@ -65,10 +65,10 @@ Storage. Suppose you decide that the additional operational complexity of extern
|
|||||||
|
|
||||||
### Integrated Storage vs. Consul as Vault Storage
|
### Integrated Storage vs. Consul as Vault Storage
|
||||||
|
|
||||||
[HashiCorp Consul](https://www.consul.io/docs/intro) is a comprehensive
|
[HashiCorp Consul](https://developer.hashicorp.com/consul/docs/intro) is a comprehensive
|
||||||
multi-cloud service networking solution including service mesh, service
|
multi-cloud service networking solution including service mesh, service
|
||||||
discovery, and network infrastructure automation. Vault can leverage
|
discovery, and network infrastructure automation. Vault can leverage
|
||||||
Consul's [KV Store](https://www.consul.io/api-docs/kv) to persist Vault data.
|
Consul's [KV Store](https://developer.hashicorp.com/consul/api-docs/kv) to persist Vault data.
|
||||||
|
|
||||||
The table below highlights the differences between Integrated Storage and
|
The table below highlights the differences between Integrated Storage and
|
||||||
Consul.
|
Consul.
|
||||||
@@ -79,7 +79,7 @@ Consul.
|
|||||||
| Data location | Data is on disk. | All data is in memory. |
|
| Data location | Data is on disk. | All data is in memory. |
|
||||||
| System requirements | [System requirements](https://learn.hashicorp.com/tutorials/vault/raft-reference-architecture#system-requirements) | [System requirements](https://learn.hashicorp.com/tutorials/vault/reference-architecture#hardware-sizing-for-vault-servers) |
|
| System requirements | [System requirements](https://learn.hashicorp.com/tutorials/vault/raft-reference-architecture#system-requirements) | [System requirements](https://learn.hashicorp.com/tutorials/vault/reference-architecture#hardware-sizing-for-vault-servers) |
|
||||||
| Snapshots | Normal data backup strategy of your organization. | More frequent snapshots are necessary since data is in memory. |
|
| Snapshots | Normal data backup strategy of your organization. | More frequent snapshots are necessary since data is in memory. |
|
||||||
| Max message size | 1 MiB (Configurable using the [`max_entry_size`](/docs/configuration/storage/raft#max_entry_size) parameter) | 512 KiB (Configurable using the [`kv_max_value_size`](https://www.consul.io/docs/agent/config/config-files#kv_max_value_size) parameter) |
|
| Max message size | 1 MiB (Configurable using the [`max_entry_size`](/docs/configuration/storage/raft#max_entry_size) parameter) | 512 KiB (Configurable using the [`kv_max_value_size`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#kv_max_value_size) parameter) |
|
||||||
|
|
||||||
If you have a Vault cluster using Consul as its storage backend and wish to
|
If you have a Vault cluster using Consul as its storage backend and wish to
|
||||||
migrate to Integrated Storage, read the following tutorials:
|
migrate to Integrated Storage, read the following tutorials:
|
||||||
|
|||||||
@@ -113,4 +113,4 @@ Finally, when speaking of performance implications above, there are two kinds th
|
|||||||
|
|
||||||
### Q: Is this feature something I need with Consul Storage?
|
### Q: Is this feature something I need with Consul Storage?
|
||||||
|
|
||||||
Consul has a [default consistency model](https://www.consul.io/api-docs/features/consistency) and this feature is not relevant with Consul storage.
|
Consul has a [default consistency model](https://developer.hashicorp.com/consul/api-docs/features/consistency) and this feature is not relevant with Consul storage.
|
||||||
|
|||||||
@@ -164,7 +164,7 @@ counted as voters before they are capable of voting.
|
|||||||
|
|
||||||
As of Vault 1.7, a dead server cleanup capability is available. With this feature
|
As of Vault 1.7, a dead server cleanup capability is available. With this feature
|
||||||
enabled, unhealthy nodes are automatically removed from the Raft cluster without
|
enabled, unhealthy nodes are automatically removed from the Raft cluster without
|
||||||
manual operator intervention. This is enabled via the [Autopilot API](https://www.vaultproject.io/api/system/storage/raftautopilot).
|
manual operator intervention. This is enabled via the [Autopilot API](/api-docs/system/storage/raftautopilot).
|
||||||
If you wish to decommission a node manually, this can be done with the
|
If you wish to decommission a node manually, this can be done with the
|
||||||
`remove peer` [command](/docs/commands/operator/raft#remove-peer).
|
`remove peer` [command](/docs/commands/operator/raft#remove-peer).
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ by that backend.
|
|||||||
|
|
||||||
For the Consul storage backend, the default limit imposed by Consul is
|
For the Consul storage backend, the default limit imposed by Consul is
|
||||||
512 KiB. This may be configured via Consul’s
|
512 KiB. This may be configured via Consul’s
|
||||||
[`kv_max_value_size`](https://www.consul.io/docs/agent/config/config-files#kv_max_value_size) parameter, introduced in version 1.5.3.
|
[`kv_max_value_size`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#kv_max_value_size) parameter, introduced in version 1.5.3.
|
||||||
|
|
||||||
For the integrated storage backend, the default limit (introduced in
|
For the integrated storage backend, the default limit (introduced in
|
||||||
Vault 1.5.0) is 1 MiB. This may be configured via `max_entry_size` in
|
Vault 1.5.0) is 1 MiB. This may be configured via `max_entry_size` in
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ description: Guide to partnership integrations and creating plugins for Vault.
|
|||||||
|
|
||||||
# Vault Integration Program
|
# Vault Integration Program
|
||||||
|
|
||||||
The HashiCorp Vault Integration Program allows for partners to integrate their products to work with HashiCorp Vault (Open Source or Enterprise versions) or [HashiCorp Cloud Platform](https://cloud.hashicorp.com) (HCP) Vault. Vault covers a relatively large surface area and thereby a large set of possible integrations, some of which require the partner to build a Vault plugin or an integration that results in the partner’s solution working tightly with Vault.
|
The HashiCorp Vault Integration Program allows for partners to integrate their products to work with HashiCorp Vault (Open Source or Enterprise versions) or [HashiCorp Cloud Platform](https://cloud.hashicorp.com/) (HCP) Vault. Vault covers a relatively large surface area and thereby a large set of possible integrations, some of which require the partner to build a Vault plugin or an integration that results in the partner’s solution working tightly with Vault.
|
||||||
|
|
||||||
Partners integrating their solutions via the Vault Integration Process provide their customers a verified and seamless user experience.
|
Partners integrating their solutions via the Vault Integration Process provide their customers a verified and seamless user experience.
|
||||||
|
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ Any external database plugins that want to adopt multiplexing support will have
|
|||||||
|
|
||||||
### Consul Secrets Engine enhancements
|
### Consul Secrets Engine enhancements
|
||||||
|
|
||||||
Consul has supported [namespace](https://www.consul.io/docs/enterprise/namespaces), [admin partitions](https://www.consul.io/docs/enterprise/admin-partitions) and [ACL roles](https://www.consul.io/commands/acl/role) for some time now. In this release we have added enhancements to the Consul Secrets engine to support [namespace](<>) awareness and add admin partition and role support for Consul ACL tokens. This significantly simplifies the integrations for customers who want to achieve a zero trust security posture with both Vault and Consul.
|
Consul has supported [namespace](https://developer.hashicorp.com/consul/docs/enterprise/namespaces), [admin partitions](https://developer.hashicorp.com/consul/docs/enterprise/admin-partitions) and [ACL roles](https://developer.hashicorp.com/consul/commands/acl/role) for some time now. In this release we have added enhancements to the Consul Secrets engine to support [namespace](<>) awareness and add admin partition and role support for Consul ACL tokens. This significantly simplifies the integrations for customers who want to achieve a zero trust security posture with both Vault and Consul.
|
||||||
|
|
||||||
### Using sessionStorage instead of localStorage for the Vault UI
|
### Using sessionStorage instead of localStorage for the Vault UI
|
||||||
|
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ We are extending that support to the Vault Transform Secrets Engine in this rel
|
|||||||
|
|
||||||
#### MSSQL Support
|
#### MSSQL Support
|
||||||
|
|
||||||
An MSSQL store is now available to be used as an external storage engine with tokenization Transform Secrets Engine. Refer to the following documents, [Transform Secrets Engine(API)](/api-docs/secret/transform), [Transform Secrets Engine](/docs/secrets/transform/index), and [Tokenization Transform](/docs/secrets/transform/tokenization) for more information.
|
An MSSQL store is now available to be used as an external storage engine with tokenization Transform Secrets Engine. Refer to the following documents, [Transform Secrets Engine(API)](/api-docs/secret/transform), [Transform Secrets Engine](/docs/secrets/transform), and [Tokenization Transform](/docs/secrets/transform/tokenization) for more information.
|
||||||
|
|
||||||
#### Key Auto Rotation
|
#### Key Auto Rotation
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ description: The Consul secrets engine for Vault generates tokens for Consul dyn
|
|||||||
|
|
||||||
@include 'x509-sha1-deprecation.mdx'
|
@include 'x509-sha1-deprecation.mdx'
|
||||||
|
|
||||||
The Consul secrets engine generates [Consul](https://www.consul.io) API tokens
|
The Consul secrets engine generates [Consul](https://www.consul.io/) API tokens
|
||||||
dynamically based on Consul ACL policies.
|
dynamically based on Consul ACL policies.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
@@ -93,7 +93,7 @@ management tool.
|
|||||||
you will either provide a policy document and a token type, a list of policies or roles, or a set of
|
you will either provide a policy document and a token type, a list of policies or roles, or a set of
|
||||||
service or node identities. When users generate credentials, they are generated against this role.
|
service or node identities. When users generate credentials, they are generated against this role.
|
||||||
|
|
||||||
1. For Consul versions 1.8 and above, attach [a Consul node identity](https://www.consul.io/commands/acl/token/create#node-identity) to the role.
|
1. For Consul versions 1.8 and above, attach [a Consul node identity](https://developer.hashicorp.com/consul/commands/acl/token/create#node-identity) to the role.
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
$ vault write consul/roles/my-role \
|
$ vault write consul/roles/my-role \
|
||||||
@@ -102,7 +102,7 @@ management tool.
|
|||||||
Success! Data written to: consul/roles/my-role
|
Success! Data written to: consul/roles/my-role
|
||||||
```
|
```
|
||||||
|
|
||||||
1. For Consul versions 1.5 and above, attach either [a role in Consul](https://www.consul.io/api/acl/roles) or [a Consul service identity](https://www.consul.io/commands/acl/token/create#service-identity) to the role:
|
1. For Consul versions 1.5 and above, attach either [a role in Consul](https://developer.hashicorp.com/consul/api-docs/acl/roles) or [a Consul service identity](https://developer.hashicorp.com/consul/commands/acl/token/create#service-identity) to the role:
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
$ vault write consul/roles/my-role consul_roles="api-server"
|
$ vault write consul/roles/my-role consul_roles="api-server"
|
||||||
@@ -116,7 +116,7 @@ management tool.
|
|||||||
Success! Data written to: consul/roles/my-role
|
Success! Data written to: consul/roles/my-role
|
||||||
```
|
```
|
||||||
|
|
||||||
1. For Consul versions 1.4 and above, generate [a policy in Consul](https://www.consul.io/docs/guides/acl.html),
|
1. For Consul versions 1.4 and above, generate [a policy in Consul](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production),
|
||||||
and proceed to link it to the role:
|
and proceed to link it to the role:
|
||||||
|
|
||||||
```shell-session
|
```shell-session
|
||||||
@@ -125,7 +125,7 @@ management tool.
|
|||||||
```
|
```
|
||||||
|
|
||||||
1. For Consul versions below 1.4, the policy must be base64-encoded. The policy language is
|
1. For Consul versions below 1.4, the policy must be base64-encoded. The policy language is
|
||||||
[documented by Consul](https://www.consul.io/docs/security/acl/acl-legacy). Support for this method is
|
[documented by Consul](https://developer.hashicorp.com/consul/docs/security/acl/acl-legacy). Support for this method is
|
||||||
deprecated as of Vault 1.11.
|
deprecated as of Vault 1.11.
|
||||||
|
|
||||||
Write a policy and proceed to link it to the role:
|
Write a policy and proceed to link it to the role:
|
||||||
@@ -140,8 +140,8 @@ management tool.
|
|||||||
the lease duration by passing `-ttl=<duration>` to the command above where duration is a [duration format strings](/docs/concepts/duration-format).
|
the lease duration by passing `-ttl=<duration>` to the command above where duration is a [duration format strings](/docs/concepts/duration-format).
|
||||||
|
|
||||||
1. You may further limit a role's access by adding the optional parameters `consul_namespace` and
|
1. You may further limit a role's access by adding the optional parameters `consul_namespace` and
|
||||||
`partition`. Please refer to Consul's [namespace documentation](https://www.consul.io/docs/enterprise/namespaces) and
|
`partition`. Please refer to Consul's [namespace documentation](https://developer.hashicorp.com/consul/docs/enterprise/namespaces) and
|
||||||
[admin partition documentation](https://www.consul.io/docs/enterprise/admin-partitions) for further information about
|
[admin partition documentation](https://developer.hashicorp.com/consul/docs/enterprise/admin-partitions) for further information about
|
||||||
these features.
|
these features.
|
||||||
|
|
||||||
1. For Consul version 1.11 and above, link an admin partition to a role:
|
1. For Consul version 1.11 and above, link an admin partition to a role:
|
||||||
@@ -197,4 +197,4 @@ The Consul secrets engine has a full HTTP API. Please see the
|
|||||||
[Consul secrets engine API](/api-docs/secret/consul) for more
|
[Consul secrets engine API](/api-docs/secret/consul) for more
|
||||||
details.
|
details.
|
||||||
|
|
||||||
[consul-mgmt-token]: https://www.consul.io/api-docs/acl#acl_create
|
[consul-mgmt-token]: https://developer.hashicorp.com/consul/api-docs/acl#acl_create
|
||||||
|
|||||||
@@ -148,8 +148,8 @@ can leverage Vault as a source of identity using the OIDC protocol. See the foll
|
|||||||
for details on configuring OIDC authentication for other HashiCorp products:
|
for details on configuring OIDC authentication for other HashiCorp products:
|
||||||
|
|
||||||
- [Boundary](https://learn.hashicorp.com/tutorials/boundary/oidc-auth)
|
- [Boundary](https://learn.hashicorp.com/tutorials/boundary/oidc-auth)
|
||||||
- [Consul](https://www.consul.io/docs/security/acl/auth-methods/oidc)
|
- [Consul](https://developer.hashicorp.com/consul/docs/security/acl/auth-methods/oidc)
|
||||||
- [Waypoint](https://www.waypointproject.io/docs/server/auth/oidc)
|
- [Waypoint](https://developer.hashicorp.com/waypoint/docs/server/auth/oidc)
|
||||||
|
|
||||||
Otherwise, refer to the documentation of the specific OIDC relying party for usage details.
|
Otherwise, refer to the documentation of the specific OIDC relying party for usage details.
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ description: The Nomad secrets engine for Vault generates tokens for Nomad dynam
|
|||||||
Name: `Nomad`
|
Name: `Nomad`
|
||||||
|
|
||||||
Nomad is a simple, flexible scheduler and workload orchestrator. The Nomad
|
Nomad is a simple, flexible scheduler and workload orchestrator. The Nomad
|
||||||
secrets secrets engine for Vault generates [Nomad](https://www.nomadproject.io)
|
secrets 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.
|
||||||
|
|
||||||
This page will show a quick start for this secrets engine. For detailed documentation
|
This page will show a quick start for this secrets engine. For detailed documentation
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ description: The Terraform Cloud secret backend for Vault generates tokens for T
|
|||||||
Name: `Terraform Cloud`
|
Name: `Terraform Cloud`
|
||||||
|
|
||||||
The Terraform Cloud secret backend for Vault generates
|
The Terraform Cloud secret backend for Vault generates
|
||||||
[Terraform Cloud](https://www.terraform.io/cloud)
|
[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
|
||||||
@@ -45,7 +45,7 @@ management tool.
|
|||||||
```
|
```
|
||||||
|
|
||||||
See [Terraform Cloud's documentation on API
|
See [Terraform Cloud's documentation on API
|
||||||
tokens](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html)
|
tokens](https://www.terraform.io/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.
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ token_id at-fqvtdTQ5kQWcjUfG
|
|||||||
|
|
||||||
Please see the [Terraform Cloud API
|
Please see the [Terraform Cloud API
|
||||||
Token documentation for more
|
Token documentation for more
|
||||||
information](https://www.terraform.io/docs/cloud/users-teams-organizations/api-tokens.html).
|
information](https://www.terraform.io/cloud-docs/users-teams-organizations/api-tokens).
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|
||||||
|
|||||||
@@ -303,7 +303,7 @@ the ciphertext for the input of the `import` endpoint:
|
|||||||
- Base64 encode the result.
|
- Base64 encode the result.
|
||||||
|
|
||||||
For more details about wrapping the key for import into transit, see the
|
For more details about wrapping the key for import into transit, see the
|
||||||
[key wrapping guide](/docs/transit/key-wrapping-guide).
|
[key wrapping guide](/docs/secrets/transit/key-wrapping-guide).
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user