backport of commit 41f392c43f (#21307)

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
This commit is contained in:
hc-github-team-secure-vault-core
2023-06-16 09:04:23 -04:00
committed by GitHub
parent 0610df0f6c
commit a14ff6e018
8 changed files with 35 additions and 20 deletions

View File

@@ -180,7 +180,8 @@ These are common configuration values that live within the `persist` block:
- `type` `(string: required)` - The type of the persistent cache to use, - `type` `(string: required)` - The type of the persistent cache to use,
e.g. `kubernetes`. _Note_: when using HCL this can be used as the key for e.g. `kubernetes`. _Note_: when using HCL this can be used as the key for
the block, e.g. `persist "kubernetes" {...}`. the block, e.g. `persist "kubernetes" {...}`. Currently, only `kubernetes`
is supported.
- `path` `(string: required)` - The path on disk where the persistent cache file - `path` `(string: required)` - The path on disk where the persistent cache file
should be created or restored from. should be created or restored from.

View File

@@ -40,7 +40,7 @@ request to the Vault server.
Vault Proxy can be configured to force the use of the auto-auth token by using Vault Proxy can be configured to force the use of the auto-auth token by using
the value `force` for the `use_auto_auth_token` option. This configuration the value `force` for the `use_auto_auth_token` option. This configuration
overrides the default behavior described above in [Using Auto-Auth overrides the default behavior described above in [Using Auto-Auth
Token](/vault/docs/proxy/apiproxy#using-auto-auth-token), and instead ignores any Token](/vault/docs/agent-and-proxy/proxy/apiproxy#using-auto-auth-token), and instead ignores any
existing Vault token in the request and instead uses the auto-auth token. existing Vault token in the request and instead uses the auto-auth token.

View File

@@ -165,7 +165,8 @@ These are common configuration values that live within the `persist` block:
- `type` `(string: required)` - The type of the persistent cache to use, - `type` `(string: required)` - The type of the persistent cache to use,
e.g. `kubernetes`. _Note_: when using HCL this can be used as the key for e.g. `kubernetes`. _Note_: when using HCL this can be used as the key for
the block, e.g. `persist "kubernetes" {...}`. the block, e.g. `persist "kubernetes" {...}`. Currently, only `kubernetes`
is supported.
- `path` `(string: required)` - The path on disk where the persistent cache file - `path` `(string: required)` - The path on disk where the persistent cache file
should be created or restored from. should be created or restored from.

View File

@@ -52,7 +52,7 @@ Please see the [Caching docs][caching] for information.
### Quit ### Quit
This endpoint triggers shutdown of the proxy. By default, it is disabled, and can This endpoint triggers shutdown of the proxy. By default, it is disabled, and can
be enabled per listener using the [`agent_api`][agent-api] stanza. It is recommended be enabled per listener using the [`proxy_api`][proxy-api] stanza. It is recommended
to only enable this on trusted interfaces, as it does not require any authorization to use. to only enable this on trusted interfaces, as it does not require any authorization to use.
| Method | Path | | Method | Path |
@@ -342,7 +342,7 @@ listener "tcp" {
``` ```
[vault]: /vault/docs/agent-and-proxy/proxy#vault-stanza [vault]: /vault/docs/agent-and-proxy/proxy#vault-stanza
[autoauth]: /vault/docs/agent-and-proxy/proxy/autoauth [autoauth]: /vault/docs/agent-and-proxy/autoauth
[caching]: /vault/docs/agent-and-proxy/proxy/caching [caching]: /vault/docs/agent-and-proxy/proxy/caching
[apiproxy]: /vault/docs/agent-and-proxy/proxy/apiproxy [apiproxy]: /vault/docs/agent-and-proxy/proxy/apiproxy
[persistent-cache]: /vault/docs/agent-and-proxy/proxy/caching/persistent-caches [persistent-cache]: /vault/docs/agent-and-proxy/proxy/caching/persistent-caches

View File

@@ -6,4 +6,4 @@ description: The "agent" command is used to start Vault Agent
# agent # agent
Please see the [Vault Agent documentation page](/vault/docs/agent). Please see the [Vault Agent documentation page](/vault/docs/agent-and-proxy/agent).

View File

@@ -0,0 +1,9 @@
---
layout: docs
page_title: proxy - Command
description: The "proxy" command is used to start Vault Proxy
---
# proxy
Please see the [Vault Proxy documentation page](/vault/docs/agent-and-proxy/proxy).

View File

@@ -35,7 +35,7 @@ Run the Vault server in a non-production "dev" mode in one of the following ways
**For Docker users, run this command**: **For Docker users, run this command**:
```shell-session ```shell-session
$ docker run -p 8200:8200 -e 'VAULT_DEV_ROOT_TOKEN_ID=dev-only-token' vault $ docker run -p 8200:8200 -e 'VAULT_DEV_ROOT_TOKEN_ID=dev-only-token' vault
``` ```
@@ -62,8 +62,8 @@ Let's install the Vault client library for your language of choice.
<Tab heading="Go" group="go"> <Tab heading="Go" group="go">
[Go](https://pkg.go.dev/github.com/hashicorp/vault/api) (official) client library: [Go](https://pkg.go.dev/github.com/hashicorp/vault/api) (official) client library:
```shell-session ```shell-session
$ go get github.com/hashicorp/vault/api $ go get github.com/hashicorp/vault/api
``` ```
@@ -80,10 +80,10 @@ import vault "github.com/hashicorp/vault/api"
</Tab> </Tab>
<Tab heading="Ruby" group="ruby"> <Tab heading="Ruby" group="ruby">
[Ruby](https://github.com/hashicorp/vault-ruby) (official) client library: [Ruby](https://github.com/hashicorp/vault-ruby) (official) client library:
```shell-session ```shell-session
$ gem install vault $ gem install vault
``` ```
@@ -100,9 +100,9 @@ require "vault"
</Tab> </Tab>
<Tab heading="C#" group="cs"> <Tab heading="C#" group="cs">
[C#](https://github.com/rajanadar/VaultSharp) client library: [C#](https://github.com/rajanadar/VaultSharp) client library:
```shell-session ```shell-session
$ dotnet add package VaultSharp $ dotnet add package VaultSharp
``` ```
@@ -123,10 +123,10 @@ using VaultSharp.V1.Commons;
</Tab> </Tab>
<Tab heading="Python" group="python"> <Tab heading="Python" group="python">
[Python](https://github.com/hvac/hvac) client library: [Python](https://github.com/hvac/hvac) client library:
```shell-session ```shell-session
$ pip install hvac $ pip install hvac
``` ```
@@ -143,9 +143,9 @@ import hvac
</Tab> </Tab>
<Tab heading="Java" group="java"> <Tab heading="Java" group="java">
[Java (Spring)](https://spring.io/projects/spring-vault) client library: [Java (Spring)](https://spring.io/projects/spring-vault) client library:
Add the following to pom.xml: Add the following to pom.xml:
```xml ```xml
@@ -209,7 +209,7 @@ $ nuget install HashiCorp.Vault -Version "0.1.0-beta"
**Or:** **Or:**
```shell-session ```shell-session
$ dotnet add package Hashicorp.Vault -version "0.1.0-beta" $ dotnet add package Hashicorp.Vault -version "0.1.0-beta"
``` ```
Now, let's add the import statements for the client library to the top of the file. Now, let's add the import statements for the client library to the top of the file.
@@ -628,4 +628,4 @@ For more secure examples of client authentication, see the auth snippets in the
For a runnable demo app that demonstrates more features, for example, how to keep your connection to Vault alive and how to connect to a database using Vault's dynamic database credentials, see the sample application hello-vault ([Go](https://github.com/hashicorp/hello-vault-go), [C#](https://github.com/hashicorp/hello-vault-dotnet)). For a runnable demo app that demonstrates more features, for example, how to keep your connection to Vault alive and how to connect to a database using Vault's dynamic database credentials, see the sample application hello-vault ([Go](https://github.com/hashicorp/hello-vault-go), [C#](https://github.com/hashicorp/hello-vault-dotnet)).
To learn how to integrate applications with Vault without needing to always change your application code, see the [Vault Agent](/vault/docs/agent) documentation. To learn how to integrate applications with Vault without needing to always change your application code, see the [Vault Agent](/vault/docs/agent-and-proxy/agent) documentation.

View File

@@ -774,6 +774,10 @@
"title": "<code>print</code>", "title": "<code>print</code>",
"path": "commands/print" "path": "commands/print"
}, },
{
"title": "<code>proxy</code>",
"path": "commands/proxy"
},
{ {
"title": "<code>read</code>", "title": "<code>read</code>",
"path": "commands/read" "path": "commands/read"