a3dfde5cec
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Vault Agent"
|
|
sidebar_title: "Vault Agent"
|
|
sidebar_current: "docs-agent"
|
|
description: |-
|
|
Vault Agent is a client-side daemon that can be used to perform some Vault
|
|
functionality automatically.
|
|
---
|
|
|
|
# Vault Agent
|
|
|
|
Vault Agent is a client daemon that can perform useful tasks.
|
|
|
|
To get help, run:
|
|
|
|
```text
|
|
$ vault agent -h
|
|
```
|
|
## Auto-Auth
|
|
|
|
Vault Agent allows for easy authentication to Vault in a wide variety of
|
|
environments. Please see the [Auto-Auth docs](/docs/agent/autoauth/index.html)
|
|
for information.
|
|
|
|
Auto-Auth functionality takes place within an `auto_auth` configuration stanza.
|
|
|
|
## Configuration
|
|
|
|
These are the currently-available general configuration option:
|
|
|
|
- `pid_file` `(string: "")` - Path to the file in which the agent's Process ID
|
|
(PID) should be stored
|
|
|
|
- `exit_after_auth` `(bool: false)` - If set to `true`, the agent will exit
|
|
with code `0` after a single successful auth, where success means that a
|
|
token was retrieved and all sinks successfully wrote it
|
|
|
|
## Example Configuration
|
|
|
|
An example configuration, with very contrived values, follows:
|
|
|
|
```python
|
|
pid_file = "./pidfile"
|
|
|
|
auto_auth {
|
|
method "aws" {
|
|
mount_path = "auth/aws-subaccount"
|
|
config = {
|
|
role = "foobar"
|
|
}
|
|
}
|
|
|
|
sink "file" {
|
|
config = {
|
|
path = "/tmp/file-foo"
|
|
}
|
|
}
|
|
|
|
sink "file" {
|
|
wrap_ttl = "5m"
|
|
aad_env_var = "TEST_AAD_ENV"
|
|
dh_type = "curve25519"
|
|
dh_path = "/tmp/file-foo-dhpath2"
|
|
config = {
|
|
path = "/tmp/file-bar"
|
|
}
|
|
}
|
|
}
|
|
```
|