From 04a52a58642323a8f42d068f4be3c4900d7bbf0d Mon Sep 17 00:00:00 2001 From: Jeff Mitchell Date: Wed, 17 Nov 2021 17:21:20 -0500 Subject: [PATCH] Add plugins configuration section to docs (#1727) Co-authored-by: Michael Gaffney --- website/content/docs/configuration/index.mdx | 3 +++ .../content/docs/configuration/plugins.mdx | 26 +++++++++++++++++++ website/data/docs-nav-data.json | 4 +++ 3 files changed, 33 insertions(+) create mode 100644 website/content/docs/configuration/plugins.mdx diff --git a/website/content/docs/configuration/index.mdx b/website/content/docs/configuration/index.mdx index 0cb7bb6da2..f19ef7b3d6 100644 --- a/website/content/docs/configuration/index.mdx +++ b/website/content/docs/configuration/index.mdx @@ -11,6 +11,7 @@ description: Boundary configuration reference. [controller]: /docs/configuration/controller [worker]: /docs/configuration/worker [kms]: /docs/configuration/kms +[plugins]: /docs/configuration/plugins Outside of development mode, Boundary controllers and workers are configured using a file. The format of this file is [HCL](https://github.com/hashicorp/hcl). In this section you'll find @@ -39,6 +40,8 @@ After the configuration is written, use the `-config` flag to specify a local pa - [`kms`](/docs/configuration/kms): Configures KMS blocks [for various purposes](/docs/concepts/security/data-encryption). +- [`plugins`](/docs/configuration/plugins): Configures options for plugins. + - `disable_mlock` `(bool: false)` – Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to disk. This is fine for local development and testing; in production, it is not recommended diff --git a/website/content/docs/configuration/plugins.mdx b/website/content/docs/configuration/plugins.mdx new file mode 100644 index 0000000000..069e7acb63 --- /dev/null +++ b/website/content/docs/configuration/plugins.mdx @@ -0,0 +1,26 @@ +--- +layout: docs +page_title: Plugins - Configuration +description: |- + The plugins stanza configures plugin-specific parameters. +--- + +# `plugin` Stanza + +The `plugin` stanza configures plugin-specific parameters. The plugin system was +introduced in Boundary 0.7.0 and is currently internal; over time, the intent is +to provide a mechanism for third-party plugins to be able to be used. Available +plugins are currently bundled with Boundary and executed automatically. + +There is currently one configuration parameter available: + +```hcl +plugins { + execution_dir = "/var/run/boundary/plugin-exec" +} +``` + +- `execution_dir` - Specifies a directory that Boundary can use to write and + execute its built-in plugins. This directory must be writeable by the Boundary + user. If not set, Boundary will attempt to create a suitable directory in the + system temporary folder. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 4a0d6fc64b..dedc2805f7 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -326,6 +326,10 @@ "path": "configuration/events/stderr" } ] + }, + { + "title": "plugins", + "path": "configuration/plugins" } ] },