Skip to content

Commit 7b9a56f

Browse files
committed
Add documentation backreferences.
1 parent 7805d4d commit 7b9a56f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This example uses the [root module](https://registry.terraform.io/modules/source
1414

1515
The following variables must be supplied:
1616

17+
**Note**: these variables must be set in tandem with changes to the target [Sourcegraph deployment](https://docs.sourcegraph.com/admin/deploy_executors).
18+
1719
- `executor_sourcegraph_external_url`: The URL from which the target Sourcegraph instance is accessible from the executor instances.
1820
- `executor_sourcegraph_executor_proxy_username`: The shared executor username defined on the Sourcegraph deployment.
19-
- `executor_sourcegraph_executor_proxy_password`: The shared executor password defined on the Sourcegraph deployment.
21+
- `executor_sourcegraph_executor_proxy_password`: The shared executor password defined on the Sourcegraph deployment. The username and password values must be the same as the `EXECUTOR_FRONTEND_USERNAME` and `FRONTEND_USERNAME_PASSWORD` environment variables described in [Configuring executors and instance communication](https://docs.sourcegraph.com/admin/deploy_executors#configuring-executors-and-instance-communication).
2022
- `executor_queue_name`: The name of the target queue to process (e.g., `codeintel`, `batches`).
21-
- `executor_metrics_environment_label`: The name of the target environment (e.g., `staging`, `prod`).
22-
- `executor_instance_tag`: Compute instances are tagged by this value by the key `executor_tag`. We recommend this value take the form `{executor_queue_name}-{executor_metrics_environment_label}`.
23-
24-
<!-- TODO(efritz) - reference product docs here when they exist -->
23+
- `executor_metrics_environment_label`: The name of the target environment (e.g., `staging`, `prod`). This value must be the same as the `EXECUTOR_METRIC_ENVIRONMENT_LABEL` environment variable as described in [Configuring auto scaling](https://docs.sourcegraph.com/admin/deploy_executors#aws).
24+
- `executor_instance_tag`: Compute instances are tagged by this value by the key `executor_tag`. We recommend this value take the form `{executor_queue_name}-{executor_metrics_environment_label}`. This value must be the same as `INSTANCE_TAG` as described in [Configuring observability](https://docs.sourcegraph.com/admin/deploy_executors#aws-1).
2525

2626
All of this module's variables are defined in [variables.tf](./variables.tf).
2727

0 commit comments

Comments
 (0)