From 41f392c43ff4c9077deb1d1640349b8ba867d139 Mon Sep 17 00:00:00 2001 From: Violet Hynes Date: Fri, 16 Jun 2023 08:47:29 -0400 Subject: [PATCH] Fix some broken links/clarify some things in the Vault Proxy docs (#21262) * Fix some broken links/clarify some things * More docs fixes * More docs fixes --- .../agent-and-proxy/agent/caching/index.mdx | 3 +- .../docs/agent-and-proxy/proxy/apiproxy.mdx | 2 +- .../agent-and-proxy/proxy/caching/index.mdx | 3 +- .../docs/agent-and-proxy/proxy/index.mdx | 4 +-- website/content/docs/commands/agent.mdx | 2 +- website/content/docs/commands/proxy.mdx | 9 ++++++ .../content/docs/get-started/developer-qs.mdx | 28 +++++++++---------- website/data/docs-nav-data.json | 4 +++ 8 files changed, 35 insertions(+), 20 deletions(-) create mode 100644 website/content/docs/commands/proxy.mdx diff --git a/website/content/docs/agent-and-proxy/agent/caching/index.mdx b/website/content/docs/agent-and-proxy/agent/caching/index.mdx index da970d1847e5..81baef4ac202 100644 --- a/website/content/docs/agent-and-proxy/agent/caching/index.mdx +++ b/website/content/docs/agent-and-proxy/agent/caching/index.mdx @@ -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, 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 should be created or restored from. diff --git a/website/content/docs/agent-and-proxy/proxy/apiproxy.mdx b/website/content/docs/agent-and-proxy/proxy/apiproxy.mdx index 3b4d7ece762c..85f143cbf5dc 100644 --- a/website/content/docs/agent-and-proxy/proxy/apiproxy.mdx +++ b/website/content/docs/agent-and-proxy/proxy/apiproxy.mdx @@ -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 the value `force` for the `use_auto_auth_token` option. This configuration 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. diff --git a/website/content/docs/agent-and-proxy/proxy/caching/index.mdx b/website/content/docs/agent-and-proxy/proxy/caching/index.mdx index fbd3bfb962ae..948de6dafc5e 100644 --- a/website/content/docs/agent-and-proxy/proxy/caching/index.mdx +++ b/website/content/docs/agent-and-proxy/proxy/caching/index.mdx @@ -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, 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 should be created or restored from. diff --git a/website/content/docs/agent-and-proxy/proxy/index.mdx b/website/content/docs/agent-and-proxy/proxy/index.mdx index 8f4abc810f56..17bf746e81d7 100644 --- a/website/content/docs/agent-and-proxy/proxy/index.mdx +++ b/website/content/docs/agent-and-proxy/proxy/index.mdx @@ -52,7 +52,7 @@ Please see the [Caching docs][caching] for information. ### Quit 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. | Method | Path | @@ -342,7 +342,7 @@ listener "tcp" { ``` [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 [apiproxy]: /vault/docs/agent-and-proxy/proxy/apiproxy [persistent-cache]: /vault/docs/agent-and-proxy/proxy/caching/persistent-caches diff --git a/website/content/docs/commands/agent.mdx b/website/content/docs/commands/agent.mdx index 196fb4fe0a96..4888316c3b27 100644 --- a/website/content/docs/commands/agent.mdx +++ b/website/content/docs/commands/agent.mdx @@ -6,4 +6,4 @@ description: The "agent" command is used to start Vault 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). diff --git a/website/content/docs/commands/proxy.mdx b/website/content/docs/commands/proxy.mdx new file mode 100644 index 000000000000..4a1d0e4f0a2c --- /dev/null +++ b/website/content/docs/commands/proxy.mdx @@ -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). diff --git a/website/content/docs/get-started/developer-qs.mdx b/website/content/docs/get-started/developer-qs.mdx index c969ca89aa00..d0ae87f993b9 100644 --- a/website/content/docs/get-started/developer-qs.mdx +++ b/website/content/docs/get-started/developer-qs.mdx @@ -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**: -```shell-session +```shell-session $ 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. [Go](https://pkg.go.dev/github.com/hashicorp/vault/api) (official) client library: - -```shell-session + +```shell-session $ go get github.com/hashicorp/vault/api ``` @@ -80,10 +80,10 @@ import vault "github.com/hashicorp/vault/api" - + [Ruby](https://github.com/hashicorp/vault-ruby) (official) client library: - -```shell-session + +```shell-session $ gem install vault ``` @@ -100,9 +100,9 @@ require "vault" - + [C#](https://github.com/rajanadar/VaultSharp) client library: - + ```shell-session $ dotnet add package VaultSharp ``` @@ -123,10 +123,10 @@ using VaultSharp.V1.Commons; - + [Python](https://github.com/hvac/hvac) client library: -```shell-session +```shell-session $ pip install hvac ``` @@ -143,9 +143,9 @@ import hvac - + [Java (Spring)](https://spring.io/projects/spring-vault) client library: - + Add the following to pom.xml: ```xml @@ -209,7 +209,7 @@ $ nuget install HashiCorp.Vault -Version "0.1.0-beta" **Or:** ```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. @@ -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)). -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. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index b2bce7b4c135..3e23c86733a4 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -774,6 +774,10 @@ "title": "print", "path": "commands/print" }, + { + "title": "proxy", + "path": "commands/proxy" + }, { "title": "read", "path": "commands/read"