diff --git a/website/content/docs/nia/configuration.mdx b/website/content/docs/nia/configuration.mdx index 94eda86843..517823a6db 100644 --- a/website/content/docs/nia/configuration.mdx +++ b/website/content/docs/nia/configuration.mdx @@ -178,7 +178,7 @@ See [Task Execution: Catalog Services Condition](/docs/nia/tasks#catalog-service task { name = "catalog_service_condition_task" description = "execute on service de/registrations with name matching 'web.*'" - source = "path/to/catalog-service-module" + source = "path/to/catalog-services-module" providers = ["my-provider"] // configure depending on module. provides detailed information for these diff --git a/website/content/docs/nia/tasks.mdx b/website/content/docs/nia/tasks.mdx index 2b39afa712..834e92e7c1 100644 --- a/website/content/docs/nia/tasks.mdx +++ b/website/content/docs/nia/tasks.mdx @@ -72,11 +72,11 @@ Below is an example configuration for a task that will execute when a service wi ```hcl task { name = "catalog_service_condition_task" - source = "path/to/catalog-service-module" + source = "path/to/catalog-services-module" providers = ["my-provider"] services = ["web-api"] - condition "catalog-service" { + condition "catalog-services" { datacenter = "dc1" regexp = "web.*" source_includes_var = false diff --git a/website/content/docs/nia/terraform-modules.mdx b/website/content/docs/nia/terraform-modules.mdx index a97b16c308..b877bd9d4b 100644 --- a/website/content/docs/nia/terraform-modules.mdx +++ b/website/content/docs/nia/terraform-modules.mdx @@ -101,7 +101,7 @@ variable "services" { ### Catalog Services Variable -If you are creating a module for a [catalog-service condition](/docs/nia/tasks#catalog-services-condition), then you have the option to add the `catalog_services` variable, which contains service registration and tag information. If your module would benefit from consuming this information, you can copy the `catalog_services` variable declaration to your `variables.tf` file in addition to the other variables. +If you are creating a module for a [catalog-services condition](/docs/nia/tasks#catalog-services-condition), then you have the option to add the `catalog_services` variable, which contains service registration and tag information. If your module would benefit from consuming this information, you can copy the `catalog_services` variable declaration to your `variables.tf` file in addition to the other variables. ```hcl variable "catalog_services" { @@ -112,7 +112,7 @@ variable "catalog_services" { The keys of the `catalog_services` map are the names of the services that are registered with Consul at the given datacenter. The value for each service name is a list of all known tags for that service. -We recommend that if you make a module with with a catalog-service condition, that you document this in the README. This way, users that want to configure a task with your module will know to configure a catalog-services [condition](/docs/nia/configuration#condition) block. +We recommend that if you make a module with with a catalog-services condition, that you document this in the README. This way, users that want to configure a task with your module will know to configure a catalog-services [condition](/docs/nia/configuration#condition) block. Similarly, if you include the `catalog_services` variable in your module, we recommend that you also document this usage in the README. Users of your module will then know to set the catalog-services condition [`source_includes_var`](/docs/nia/configuration#source_includes_var) configuration to be true. When this field is set to true, Consul-Terraform-Sync will declare the `catalog_services` variable in the generated root module, and pass the variable to a child module. Therefore, if this field is configured inconsistently, Consul-Terraform-Sync will error and exit.