docs: Remove YAML service registration examples (#18877)

Remove YAML service registration examples and replace them with JSON. This is because YAML is not a supported configuration format for the Consul's agent configuration, nor is it supported by the HTTP API. This commit replaces the YAML examples with JSON and adds additional JSON examples where they were missing.
hashicorp · Sep 19, 2023 · a62c75f · a62c75f
1 parent 70e738c
commit a62c75f
Show file tree

Hide file tree

Showing 4 changed files with 246 additions and 137 deletions.
diff --git a/website/content/docs/connect/gateways/mesh-gateway/index.mdx b/website/content/docs/connect/gateways/mesh-gateway/index.mdx
@@ -103,6 +103,17 @@ spec:
   meshGateway:
     mode: local
 ```
+
+```json
+{
+  "Kind": "proxy-defaults",
+  "Name": "global",
+  "MeshGateway": {
+    "Mode": "local"
+  }
+}
+```
+
 </CodeTabs>
 
 ### Enabling Gateways Per Service
@@ -129,6 +140,16 @@ spec:
     mode: local
 ```
 
+```json
+{
+  "Kind": "service-defaults",
+  "Name": "web",
+  "MeshGateway": {
+    "Mode": "local"
+  }
+}
+```
+
 </CodeTabs>
 
 ### Enabling Gateways for a Service Instance
@@ -167,7 +188,7 @@ service {
     sidecar_service {
       proxy {
         mesh_gateway {
-         mode = "remote"
+          mode = "remote"
         }
         upstreams = [
           {
@@ -182,19 +203,27 @@ service {
 }
 ```
 
-```yaml
-service:
-- kind: connect-proxy
-  name: web-sidecar-proxy
-  port: 8181
-  proxy:
-  - destination_service_name: web
-    mesh_gateway:
-    - mode: remote
-    upstreams:
-    - datacenter: secondary
-      destination_name: api
-      local_bind_port: 100
+```json
+{
+  "service": {
+    "kind": "connect-proxy",
+    "name": "web-sidecar-proxy",
+    "port": 8181,
+    "proxy": {
+      "destination_service_name": "web",
+      "mesh_gateway": {
+        "mode": "remote"
+      },
+      "upstreams": [
+        {
+          "destination_name": "api",
+          "datacenter": "secondary",
+          "local_bind_port": 10000
+        }
+      ]
+    }
+  }
+}
 ```
 
 </CodeTabs>
@@ -241,25 +270,39 @@ service {
   }
 }
 ```
-```yaml
-service:
-- kind: connect-proxy
-  name: web-sidecar-proxy
-  port: 8181
-  proxy:
-  - destination_service_name: web
-    upstreams:
-    - destination_name: api
-      local_bind_port: 10000
-      mesh_gateway:
-      - mode: remote
-    - destination_name: db
-      local_bind_port: 10001
-      mesh_gateway:
-      - mode: local
-    - destination_name: logging
-      local_bind_port: 10002
-      mesh_gateway:
-      - mode: none
-  ```
+```json
+{
+  "service": {
+    "kind": "connect-proxy",
+    "name": "web-sidecar-proxy",
+    "port": 8181,
+    "proxy": {
+      "destination_service_name": "web",
+      "upstreams": [
+        {
+          "destination_name": "api",
+          "local_bind_port": 10000,
+          "mesh_gateway": {
+            "mode": "remote"
+          }
+        },
+        {
+          "destination_name": "db",
+          "local_bind_port": 10001,
+          "mesh_gateway": {
+            "mode": "local"
+          }
+        },
+        {
+          "destination_name": "logging",
+          "local_bind_port": 10002,
+          "mesh_gateway": {
+            "mode": "none"
+          }
+        }
+      ]
+    }
+  }
+}
+```
   </CodeTabs>
diff --git a/...nt/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions.mdx b/...nt/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions.mdx
@@ -98,6 +98,16 @@ spec:
     mode: local
 ```
 
+```json
+{
+  "Kind": "proxy-defaults",
+  "Name": "global",
+  "MeshGateway": {
+    "Mode": "local"
+  }
+}
+```
+
 </CodeTabs>
 
 ### Enabling Gateways Per Service
@@ -123,14 +133,25 @@ spec:
   meshGateway:
     mode: local
 ```
+
+```json
+{
+  "Kind": "service-defaults",
+  "Name": "web",
+  "MeshGateway": {
+    "Mode": "local"
+  }
+}
+```
+
 </CodeTabs>
 
 ### Enabling Gateways for a Service Instance
 
 The following [proxy service configuration](/consul/docs/connect/proxies/deploy-service-mesh-proxies)
 enables gateways for `web` service instances in the `finance` partition.
 
-<CodeTabs heading="Example: Enabling gateways for a service instance.">
+<CodeTabs heading="Example: Enabling gateways for a service instance">
 
 ```hcl
 service {
@@ -155,29 +176,37 @@ service {
 }
 ```
 
-```yaml
-service:
-- kind: connect-proxy
-  name: web-sidecar-proxy
-  port: 8181
-  proxy:
-  - destination_service_name: web
-    mesh_gateway:
-    - mode: local
-    upstreams:
-    - destination_name: billing
-      destination_namespace: default
-      destination_partition: finance
-      destination_type: service
-      local_bind_port: 9090
+```json
+{
+  "service": {
+    "kind": "connect-proxy",
+    "name": "web-sidecar-proxy",
+    "port": 8181,
+    "proxy": {
+      "destination_service_name": "web",
+      "mesh_gateway": {
+        "mode": "local"
+      },
+      "upstreams": [
+        {
+          "destination_name": "billing",
+          "destination_namespace": "default",
+          "destination_partition": "finance",
+          "destination_type": "service",
+          "local_bind_port": 9090
+        }
+      ]
+    }
+  }
+}
 ```
 </CodeTabs>
 
 ### Enabling Gateways for a Proxy Upstream
 
 The following service definition will enable gateways in `local` mode for three different partitions. Note that each service exists in the same namespace, but are separated by admin partition.
 
-<CodeTabs heading="Example: Enabling gateways for a proxy upstream.">
+<CodeTabs heading="Example: Enabling gateways for a proxy upstream">
 
 ```hcl
 service {
@@ -219,31 +248,45 @@ service {
 }
 ```
 
-```yaml
-service:
-- kind: connect-proxy
-  name: web-sidecar-proxy
-  port: 8181
-  proxy:
-  - destination_service_name: web
-    upstreams:
-    - destination_name: api
-      destination_namespace: dev
-      destination_partition: api
-      local_bind_port: 10000
-      mesh_gateway:
-      - mode: local
-    - destination_name: db
-      destination_namespace: dev
-      destination_partition: db
-      local_bind_port: 10001
-      mesh_gateway:
-      - mode: local
-    - destination_name: logging
-      destination_namespace: dev
-      destination_partition: logging
-      local_bind_port: 10002
-      mesh_gateway:
-      - mode: local
+```json
+{
+  "service": {
+    "kind": "connect-proxy",
+    "name": "web-sidecar-proxy",
+    "port": 8181,
+    "proxy": {
+      "destination_service_name": "web",
+      "upstreams": [
+        {
+          "destination_name": "api",
+          "destination_namespace": "dev",
+          "destination_partition": "api",
+          "local_bind_port": 10000,
+          "mesh_gateway": {
+            "mode": "local"
+          }
+        },
+        {
+          "destination_name": "db",
+          "destination_namespace": "dev",
+          "destination_partition": "db",
+          "local_bind_port": 10001,
+          "mesh_gateway": {
+            "mode": "local"
+          }
+        },
+        {
+          "destination_name": "logging",
+          "destination_namespace": "dev",
+          "destination_partition": "logging",
+          "local_bind_port": 10002,
+          "mesh_gateway": {
+            "mode": "local"
+          }
+        }
+      ]
+    }
+  }
+}
 ```
 </CodeTabs>