From c0b41f8537e0ddae6f8d6fd3badb5c1f48045a05 Mon Sep 17 00:00:00 2001 From: hc-github-team-consul-core Date: Thu, 21 Sep 2023 19:24:27 -0400 Subject: [PATCH] Backport of docs: Change heading to filename in CodeBlockConfig into release/1.15.x (#18968) Backport of docs: Change heading to filename in CodeBlockConfig to release/1.15.x backport of commit 4e1e18fe66f39fd06e384cd0eede39eb84ee1100 Co-authored-by: Blake Covarrubias --- .../ingress-gateways-tls-external-service.mdx | 18 +++++++++--------- .../connect/gateways/mesh-gateway/index.mdx | 3 ++- .../intentions/create-manage-intentions.mdx | 2 +- .../services/discovery/dns-dynamic-lookups.mdx | 4 ++++ .../docs/services/usage/define-services.mdx | 4 ++-- 5 files changed, 18 insertions(+), 13 deletions(-) diff --git a/website/content/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service.mdx b/website/content/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service.mdx index d33b8a68e135..f01bb7932c25 100644 --- a/website/content/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service.mdx +++ b/website/content/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service.mdx @@ -49,7 +49,7 @@ You must manually register the ingress gateway with Consul proxy to define extra In the following example, the `public-ingress` gateway includes a static cluster named `sds-cluster` that specifies paths to the SDS certificate and SDS certification validation files: - + ```hcl Services { @@ -112,7 +112,7 @@ EOF } ``` - + Refer to the [Envoy documentation](https://www.envoyproxy.io/docs/envoy/v1.17.2/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-field-config-bootstrap-v3-bootstrap-staticresources-clusters) for details about configuration parameters for SDS clusters. @@ -133,7 +133,7 @@ Store TLS client authentication files, certificate files, and keys on disk where The following example specifies certificate chain: - + ```json { @@ -154,10 +154,10 @@ The following example specifies certificate chain: } ``` - + The following example specifies the validation context: - + ```json { @@ -175,7 +175,7 @@ The following example specifies the validation context: } ``` - + ## Start Envoy @@ -208,7 +208,7 @@ Refer to [Ingress gateway configuration entry reference](/consul/docs/connect/co The following example directs Consul to retrieve `example.com-public-cert` certificates from an SDS cluster named `sds-cluster` and serve them to all listeners: - + ```hcl Kind = "ingress-gateway" @@ -230,7 +230,7 @@ Listeners = [ ] ``` - + ## Register the ingress gateway configuration entry @@ -242,4 +242,4 @@ The following example registers an ingress gateway configuration entry named `pu $ consul config write public-ingress-cfg.hcl ``` -The Envoy instance starts a listener on the port specified in the configuration entry and fetches the TLS certificate named from the SDS server. \ No newline at end of file +The Envoy instance starts a listener on the port specified in the configuration entry and fetches the TLS certificate named from the SDS server. diff --git a/website/content/docs/connect/gateways/mesh-gateway/index.mdx b/website/content/docs/connect/gateways/mesh-gateway/index.mdx index 8bd3ff945ab4..f168192e9da0 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/index.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/index.mdx @@ -299,4 +299,5 @@ service { } } ``` - + + diff --git a/website/content/docs/connect/intentions/create-manage-intentions.mdx b/website/content/docs/connect/intentions/create-manage-intentions.mdx index 80e68ce890ad..a862f4cdf6af 100644 --- a/website/content/docs/connect/intentions/create-manage-intentions.mdx +++ b/website/content/docs/connect/intentions/create-manage-intentions.mdx @@ -52,7 +52,7 @@ Refer to the `/connect/intentions/exact` [HTTP API endpoint documentation](/cons For L7 intentions, specify the `Permissions` in the request payload to configure attributes for dynamically enforcing intentions. In the following example payload, Consul allows HTTP GET requests if the request body is empty: - + ```json { diff --git a/website/content/docs/services/discovery/dns-dynamic-lookups.mdx b/website/content/docs/services/discovery/dns-dynamic-lookups.mdx index 436998ad9c74..71d52cd7d4c4 100644 --- a/website/content/docs/services/discovery/dns-dynamic-lookups.mdx +++ b/website/content/docs/services/discovery/dns-dynamic-lookups.mdx @@ -31,6 +31,8 @@ Refer to the [prepared query reference](/consul/api-docs/query#create-prepared-q 1. Specify the prepared query options in JSON format. The following prepared query targets all instances of the `redis` service in `dc1` and `dc2`: + + ```json { "Name": "my-query", @@ -58,6 +60,8 @@ Refer to the [prepared query reference](/consul/api-docs/query#create-prepared-q } ``` + + Refer to the [prepared query configuration reference](/consul/api-docs/query#create-prepared-query) for information about all available options. 1. Send the query in a POST request to the [`/query` API endpoint](/consul/api-docs/query). If the request is successful, Consul prints an ID for the prepared query. diff --git a/website/content/docs/services/usage/define-services.mdx b/website/content/docs/services/usage/define-services.mdx index a210d74741be..a08b28bbf434 100644 --- a/website/content/docs/services/usage/define-services.mdx +++ b/website/content/docs/services/usage/define-services.mdx @@ -44,7 +44,7 @@ For Kubernetes environments, you can enable the [`connectInject`](/consul/docs/ The following example defines a service named `redis` that is available on port `80`. By default, the service has the IP address of the agent node. - + ```hcl service { @@ -72,7 +72,7 @@ service { ``` - + ```json {