Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some broken links/clarify some things in the Vault Proxy docs #21262

Merged
merged 3 commits into from
Jun 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/agent-and-proxy/proxy/apiproxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/agent-and-proxy/proxy/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/commands/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
9 changes: 9 additions & 0 deletions website/content/docs/commands/proxy.mdx
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wasn't highlighted in the testing, but I spotted this was missing and thought I'd add it.

Original file line number Diff line number Diff line change
@@ -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).
28 changes: 14 additions & 14 deletions website/content/docs/get-started/developer-qs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -62,8 +62,8 @@ Let's install the Vault client library for your language of choice.
<Tab heading="Go" group="go">

[Go](https://pkg.go.dev/github.com/hashicorp/vault/api) (official) client library:
```shell-session

```shell-session
$ go get github.com/hashicorp/vault/api
```

Expand All @@ -80,10 +80,10 @@ import vault "github.com/hashicorp/vault/api"
</Tab>
<Tab heading="Ruby" group="ruby">


[Ruby](https://github.com/hashicorp/vault-ruby) (official) client library:
```shell-session

```shell-session
$ gem install vault
```

Expand All @@ -100,9 +100,9 @@ require "vault"
</Tab>
<Tab heading="C#" group="cs">


[C#](https://github.com/rajanadar/VaultSharp) client library:

```shell-session
$ dotnet add package VaultSharp
```
Expand All @@ -123,10 +123,10 @@ using VaultSharp.V1.Commons;
</Tab>
<Tab heading="Python" group="python">


[Python](https://github.com/hvac/hvac) client library:

```shell-session
```shell-session
$ pip install hvac
```

Expand All @@ -143,9 +143,9 @@ import hvac
</Tab>
<Tab heading="Java" group="java">


[Java (Spring)](https://spring.io/projects/spring-vault) client library:

Add the following to pom.xml:

```xml
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
5 changes: 5 additions & 0 deletions website/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -774,6 +774,11 @@
"title": "<code>print</code>",
"path": "commands/print"
},

{
"title": "<code>proxy</code>",
"path": "commands/proxy"
},
{
"title": "<code>read</code>",
"path": "commands/read"
Expand Down