mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 23:21:08 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
118 lines
2.8 KiB
Plaintext
118 lines
2.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: "agent generate-config - Vault CLI"
|
|
description: >-
|
|
Use vault agent generate-config to generate a basic Vault Agent configuration
|
|
file from secrets plugin data.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# `agent generate-config`
|
|
|
|
Use secrets plugin data to generate a basic
|
|
[configuration file](/vault/docs/agent-and-proxy/agent#configuration-file-options)
|
|
for running Vault Agent in [process supervisor mode](/vault/docs/agent-and-proxy/agent/process-supervisor).
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ vault agent generate-config -type <config_file_type> [options] [<file_path>]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
## Description
|
|
|
|
`agent generate-config` composes configuration details for Vault Agent
|
|
based on the configuration `type` and writes a local configuration file for
|
|
running Vault agent in process supervisor mode.
|
|
|
|
<Tip title="Related API endpoints">
|
|
|
|
- None
|
|
|
|
</Tip>
|
|
|
|
### Limitations and warnings
|
|
|
|
Limitations:
|
|
|
|
- Plugin support limited to KV plugins.
|
|
- Configuration type limited to environment variable templates.
|
|
|
|
<Warning title="Not appropriate for production">
|
|
|
|
The file created by `agent generate-config` includes an `auto_auth` section
|
|
configured to use the `token_file` authentication method.
|
|
|
|
Token files are convenient for local testing, but **are not** appropriates for
|
|
production use. Refer to the full list of Vault Agent
|
|
[autoAuth methods](/vault/docs/agent-and-proxy/autoauth/methods) for available
|
|
production-ready authentication methods.
|
|
|
|
</Warning>
|
|
|
|
## Arguments
|
|
|
|
<br />
|
|
|
|
@include 'cli/agent/args/file_path.mdx'
|
|
|
|
|
|
|
|
## Options
|
|
|
|
None.
|
|
|
|
|
|
|
|
## Command Flags
|
|
|
|
<br />
|
|
|
|
@include 'cli/agent/flags/exec.mdx'
|
|
|
|
<br /><hr /><br />
|
|
|
|
@include 'cli/agent/flags/path.mdx'
|
|
|
|
<br /><hr /><br />
|
|
|
|
@include 'cli/agent/flags/type.mdx'
|
|
|
|
|
|
|
|
## Global flags
|
|
|
|
<br />
|
|
|
|
@include 'cli/standard-settings/all-standard-flags-but-format.mdx'
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
Generate an environment variable template configuration for the `foo` secrets
|
|
plugin:
|
|
|
|
```shell-session
|
|
$ vault agent generate-config \
|
|
-type="env-template" \
|
|
-exec="./my-app arg1 arg2" \
|
|
-path="secret/foo"
|
|
|
|
Command output
|
|
```
|
|
|
|
Generate an environment variable template configuration for more than one
|
|
secrets plugin:
|
|
|
|
```shell-session
|
|
$ vault agent generate-config -type="env-template" \
|
|
-exec="./my-app arg1 arg2" \
|
|
-path="secret/foo" \
|
|
-path="secret/bar" \
|
|
-path="secret/my-app/*"
|
|
``` |