diff --git a/website/content/docs/configuration/index.mdx b/website/content/docs/configuration/index.mdx index 5a43b7662..f028f4d76 100644 --- a/website/content/docs/configuration/index.mdx +++ b/website/content/docs/configuration/index.mdx @@ -11,6 +11,7 @@ description: Boundary configuration reference. [worker]: /docs/configuration/worker [kms]: /docs/configuration/kms [plugins]: /docs/configuration/plugins +[events]: /docs/configuration/events Outside of development mode, Boundary controllers and workers are configured using a file. The format of this file is @@ -20,10 +21,13 @@ configuration block examples for Boundary controllers and workers. After the configuration is written, use the `-config` flag to specify a local path to the file. -## Parameters +## HCP Boundary-Only Parameters -- [`controller`](/docs/configuration/controller): Controller specific - configuration. If present, `boundary server` will start a Controller subprocess. +- `hcp_boundary_cluster_id` `(string)` - The ID of an HCP Boundary cluster. + Setting this allows discovery of upstream addresses for self-managed workers + to connect to the cluster. + +## Shared OSS and HCP Boundary Parameters - [`worker`](/docs/configuration/worker): Worker specific configuration. If present, `boundary server` will start a Worker subprocess. @@ -39,11 +43,11 @@ path to the file. Optionally, the `ops` purpose listener block serves as a higher-level listener where Boundary's operational endpoints live (eg: /health). - - [`kms`](/docs/configuration/kms): Configures KMS blocks [for various purposes](/docs/concepts/security/data-encryption). -- [`plugins`](/docs/configuration/plugins): Configures options for plugins. +- [`events`](/docs/configuration/events/overview): Configures event (observability, + audit, error) handling. - `disable_mlock` `(bool: false)` – Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to disk. This is @@ -76,6 +80,13 @@ path to the file. Specifies the log format to use; overridden by CLI and env var parameters. Supported log formats: `"standard"`, `"json"`. +## OSS-Only Parameters + +- [`controller`](/docs/configuration/controller)<: Controller specific + configuration. If present, `boundary server` will start a Controller subprocess. + +- [`plugins`](/docs/configuration/plugins): Configures options for plugins. + ## Example Configurations For complete example configurations see the sections for diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 8990412c2..636a85c42 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -48,13 +48,13 @@ "title": "Overview", "path": "configuration/worker/overview" }, - { - "title": "KMS Workers", - "path": "configuration/worker/kms-worker" - }, { "title": "PKI Workers", "path": "configuration/worker/pki-worker" + }, + { + "title": "KMS Workers OSS Only", + "path": "configuration/worker/kms-worker" } ] }, @@ -112,10 +112,6 @@ } ] }, - { - "title": "controller", - "path": "configuration/controller" - }, { "title": "events", "routes": [ @@ -138,7 +134,11 @@ ] }, { - "title": "plugins", + "title": "controller OSS Only", + "path": "configuration/controller" + }, + { + "title": "plugins OSS Only", "path": "configuration/plugins" } ]