From 17f1ea1c712c5c57671bae9da9a585628a58f7b0 Mon Sep 17 00:00:00 2001 From: Pete Cornish Date: Fri, 17 Nov 2023 23:20:33 +0000 Subject: [PATCH] docs: adds links to bundled config steps from config description. --- docs/config_location.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/config_location.md b/docs/config_location.md index 838ca12a8..a89f32fc3 100644 --- a/docs/config_location.md +++ b/docs/config_location.md @@ -2,9 +2,11 @@ Imposter can load configuration files from a directory or an S3 bucket. +By default, configuration files with the suffix `-config.json`, `-config.yaml` or `-config.yml` are loaded from the configuration directory. + This section describes how to load from these sources, depending on [how you run Imposter](getting_started.md). -> See [configuration discovery](config_discovery.md) for file naming and recursive loading rules. +> Also see [recursive configuration discovery](config_discovery.md) rules. ## Using the CLI @@ -47,6 +49,10 @@ You can load configuration from an S3 bucket by setting the `IMPOSTER_CONFIG_DIR docker run -e IMPOSTER_CONFIG_DIR=s3://my-bucket/path/to/config/dir outofcoffee/imposter ``` +### Bundled configuration + +See the Bundled Configuration section of the [deployment patterns](deployment_patterns.md#bundled-configuration) page for more information. + --- ## Using Lambda @@ -63,6 +69,8 @@ IMPOSTER_CONFIG_DIR=s3://my-bucket/path/to/config/dir It is not possible to load configuration files from a directory when using Lambda. Instead, bundle configuration files into a ZIP file. +### Bundled configuration + To do this, use the `imposter bundle` CLI command: ```bash @@ -71,6 +79,8 @@ imposter bundle -t awslambda /path/to/config/dir This will create a ZIP file in the current working directory, which can be [deployed to Lambda](run_imposter_aws_lambda.md). The bundle contains both the Imposter engine and the configuration files. +> See the Bundled Configuration section of the [deployment patterns](deployment_patterns.md#bundled-configuration) page for more information. + --- ## Using the JAR