mirror of
https://github.com/kemko/nomad.git
synced 2026-01-02 16:35:44 +03:00
ffb34319d5
* Docs SEO: Update Configuration section to improve search engine opt CE-775 * Add enterprise only back to audit * Update descriptions and add intro paragraph * Fix typo * replace "below" and "see" * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
42 lines
1.3 KiB
Plaintext
42 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: plugin Block in Agent Configuration
|
|
description: Configure task driver and device driver plugins in the `plugin` block of a Nomad agent configuration. Specify arguments to pass to the plugin. Configure values specific to the plugin.
|
|
---
|
|
|
|
# `plugin` Block in Agent Configuration
|
|
|
|
<Placement groups={['plugin']} />
|
|
|
|
This page provides reference information for configuring task driver and device
|
|
driver plugins in the `plugin` block of a Nomad agent configuration. Specify
|
|
arguments to pass to the plugin. Configure values specific to the plugin.
|
|
|
|
Refer to the [Nomad plugins guide](/nomad/plugins) for details on specific task
|
|
driver and device plugins.
|
|
|
|
```hcl
|
|
plugin "example-plugin" {
|
|
args = ["-my-flag"]
|
|
config {
|
|
foo = "bar"
|
|
bam {
|
|
baz = 1
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
The name of the plugin is the plugin's executable name relative to to the
|
|
[plugin_dir](/nomad/docs/configuration#plugin_dir). If the plugin has a
|
|
suffix, such as `.exe`, this should be omitted.
|
|
|
|
## `plugin` Parameters
|
|
|
|
- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
|
|
plugin binary when it is executed.
|
|
|
|
- `config` `(hcl/json: nil)` - Specifies configuration values for the plugin
|
|
either as HCL or JSON. The accepted values are plugin specific. Please refer
|
|
to the individual plugin's documentation.
|