status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Fix HCL, JSON, and YAML syntax errors (#18879) 

This commit fixes syntax errors in HCL, JSON, and YAML example
configurations. In some cases, it replaces the code example with the
proper format for the code block.

Also fixes HCL formatting and misc opportunistic updates to codeblock.

Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
This commit is contained in:
Blake Covarrubias 2023-09-19 08:39:26 -07:00 committed by GitHub
parent 170417ac97
commit f3bf3295f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 158 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
website/content/docs/connect/config-entries/control-plane-request-limit.mdx
View File

@ -41,30 +41,34 @@ When every field is defined, a control plane request limit configuration entry h
```hcl ```hcl
kind = "control-plane-request-limit" kind = "control-plane-request-limit"
mode = "permissive"
name = "<name-for-the-entry>" name = "<name-for-the-entry>"
mode = "permissive"
read_rate = 100 read_rate = 100
write_rate = 100 write_rate = 100
kv = { kv = {
read_rate = 100 read_rate = 100
write_rate = 100 write_rate = 100
} }
acl = { acl = {
read_rate = 100 read_rate = 100
write_rate = 100 write_rate = 100
mode = "permissive" }
}
catalog = { catalog = {
read_rate = 100 read_rate = 100
write_rate = 100 write_rate = 100
} }
``` ```
```json ```json
{ {
"kind": "control-plane-request-limit", "kind": "control-plane-request-limit",
"mode": "permissive",
"name": "<name-for-the-entry>", "name": "<name-for-the-entry>",
"mode": "permissive",
"read_rate": 100, "read_rate": 100,
"write_rate": 100, "write_rate": 100,
"kv": { "kv": {
@ -75,7 +79,7 @@ catalog = {
"read_rate": 100, "read_rate": 100,
"write_rate": 100 "write_rate": 100
}, },
"catalog: { "catalog": {
"read_rate": 100, "read_rate": 100,
"write_rate": 100 "write_rate": 100
} }

235
website/content/docs/connect/config-entries/jwt-provider.mdx
View File

@ -132,74 +132,74 @@ Kind = "jwt-provider" # required
Name = "<name-of-provider-configuration-entry>" # required Name = "<name-of-provider-configuration-entry>" # required
Issuer = "<jwt-issuer>" # required Issuer = "<jwt-issuer>" # required
JSONWebKeySet = { # required JSONWebKeySet = { # required
Local = { # cannot specify with JWKS{}.Remote Local = { # cannot specify with JWKS{}.Remote
JWKS = "<JWKS-as-base64-string>" # cannot specify with JWKS{}.Local{}.Filename JWKS = "<JWKS-as-base64-string>" # cannot specify with JWKS{}.Local{}.Filename
Filename = "<path/to/JWKS/file>" # cannot specify with JWKS{}.Local{}.String Filename = "<path/to/JWKS/file>" # cannot specify with JWKS{}.Local{}.String
} }
} }
JSONWebKeySet = { JSONWebKeySet = {
Remote = { # cannot specify with JWKS{}.Local Remote = { # cannot specify with JWKS{}.Local
URI = "<uniform-resource-identifier>" URI = "<uniform-resource-identifier>"
RequestTimeoutMs = 1500 RequestTimeoutMs = 1500
CacheDuration = "5m" CacheDuration = "5m"
FetchAsynchronously = false FetchAsynchronously = false
RetryPolicy = { RetryPolicy = {
NumRetries = 0 NumRetries = 0
RetryPolicyBackoff = { RetryPolicyBackoff = {
BaseInterval = "1s" BaseInterval = "1s"
MaxInterval = "10s" MaxInterval = "10s"
} }
} }
JWKSCluster = { JWKSCluster = {
DiscoveryType = "STATIC" DiscoveryType = "STATIC"
ConnectTimeout = "10s" ConnectTimeout = "10s"
# specify only one child: TrustedCA or CaCertificateProviderInstance # specify only one child: TrustedCA or CaCertificateProviderInstance
TLSCertificates = { TLSCertificates = {
# specify only one child: Filename, EnvironmentVariable, InlineString or InlineBytes # specify only one child: Filename, EnvironmentVariable, InlineString or InlineBytes
TrustedCA = { TrustedCA = {
Filename = "<path/to/cert/file>" Filename = "<path/to/cert/file>"
EnvironmentVariable = "<env-variable>" EnvironmentVariable = "<env-variable>"
InlineString = "<inline-string>" InlineString = "<inline-string>"
InlineBytes = "\302\000\302\302\302\302" InlineBytes = "\302\000\302\302\302\302"
}
}
TLSCertificates = {
CaCertificateProviderInstance = {
InstanceName = "<instance-name>"
CertificateName = "<certificate-name>"
}
}
}
} }
} }
TLSCertificates = {
CaCertificateProviderInstance = {
InstanceName = "<instance-name>"
CertificateName = "<certificate-name>"
}
}
}
}
}
Audiences = ["<aud-claims>"] Audiences = ["<aud-claims>"]
Locations = [ Locations = [
{ {
Header = { Header = {
Name = "<name-of-header-with-token>" Name = "<name-of-header-with-token>"
ValuePrefix = "<prefix-in-header-before-token>" ValuePrefix = "<prefix-in-header-before-token>"
Forward = false Forward = false
}
},
{
QueryParam = {
Name = "<name-of-query-parameter-with-token>"
}
},
{
Cookie = {
Name = "<name-of-cookie-with-token>"
}
} }
},
{
QueryParam = {
Name = "<name-of-query-parameter-with-token>"
}
},
{
Cookie = {
Name = "<name-of-cookie-with-token>"
}
}
] ]
Forwarding = { Forwarding = {
HeaderName = "<name-appended-to-forwarding-header>" HeaderName = "<name-appended-to-forwarding-header>"
PadForwardPayloadHeader = false PadForwardPayloadHeader = false
} }
ClockSkewSeconds = 30 ClockSkewSeconds = 30
CacheConfig = { CacheConfig = {
Size = 0 Size = 0
} }
``` ```
@ -209,77 +209,78 @@ CacheConfig = {
```json ```json
{ {
"Kind": "jwt-provider", // required "Kind": "jwt-provider", // required
"Name": "<name-of-provider-configuration-entry>", // required "Name": "<name-of-provider-configuration-entry>", // required
"Issuer": "<jwt-issuer>", // required "Issuer": "<jwt-issuer>", // required
"JSONWebKeySet": { // required "JSONWebKeySet": { // required
"Local": { // cannot specify with JWKS.Remote "Local": { // cannot specify with JWKS.Remote
"JWKS": "<JWKS-as-base64-string>", // cannot specify with JWKS.Local.Filename "JWKS": "<JWKS-as-base64-string>", // cannot specify with JWKS.Local.Filename
"Filename": "<path/to/JWKS/file>" // cannot specify with JWKS.Local.String "Filename": "<path/to/JWKS/file>" // cannot specify with JWKS.Local.String
} }
}, },
"JSONWebKeySet": { "JSONWebKeySet": {
"Remote": { // cannot specify with JWKS.Local "Remote": { // cannot specify with JWKS.Local
"URI": "<uniform-resource-identifier>", "URI": "<uniform-resource-identifier>",
"RequestTimeoutMs": "1500", "RequestTimeoutMs": "1500",
"CacheDuration": "5m", "CacheDuration": "5m",
"FetchAsynchronously": "false", "FetchAsynchronously": "false",
"RetryPolicy": { "RetryPolicy": {
"NumRetries": "0", "NumRetries": "0",
"RetryPolicyBackOff": { "RetryPolicyBackOff": {
"BaseInterval": "1s", "BaseInterval": "1s",
"MaxInterval": "10s" "MaxInterval": "10s"
} }
},
"JWKSCluster": {
"DiscoveryType": "STATIC",
"ConnectTimeout": "10s",
// specify only one child: TrustedCA or CaCertificateProviderInstance
"TLSCertificates": {
// specify only one child: Filename, EnvironmentVariable, InlineString or InlineBytes
"TrustedCA": {
"Filename": "<path/to/cert/file>",
"EnvironmentVariable": "<env-variable>",
"InlineString": "<inline-string>",
"InlineBytes": "\302\000\302\302\302\302"
}, },
"JWKSCluster": { },
"DiscoveryType": "STATIC", "TLSCertificates": {
"ConnectTimeout": "10s", "CaCertificateProviderInstance": {
// specify only one child: TrustedCA or CaCertificateProviderInstance "InstanceName": "<instance-name>",
"TLSCertificates": { "CertificateName": "<certificate-name>"
// specify only one child: Filename, EnvironmentVariable, InlineString or InlineBytes
"TrustedCA": {
"Filename": "<path/to/cert/file>",
"EnvironmentVariable": "<env-variable>",
"InlineString": "<inline-string>",
"InlineBytes": "\302\000\302\302\302\302"
},
"TLSCertificates": {
"CaCertificateProviderInstance": {
"InstanceName": "<instance-name>",
"CertificateName": "<certificate-name>"
}
}
} }
} }
}, }
"Audiences": ["<aud-claims>"],
"Locations": [
{
"Header": {
"Name": "<name-of-header-with-token>",
"ValuePrefix": "<prefix-in-header-before-token>",
"Forward": "false"
}
},
{
"QueryParam": {
"Name":"<name-of-query-parameter-with-token>",
}
},
{
"Cookie": {
"Name": "<name-of-cookie-with-token>"
}
} }
], },
"Forwarding": { "Audiences": ["<aud-claims>"],
"Locations": [
{
"Header": {
"Name": "<name-of-header-with-token>",
"ValuePrefix": "<prefix-in-header-before-token>",
"Forward": "false"
}
},
{
"QueryParam": {
"Name":"<name-of-query-parameter-with-token>",
}
},
{
"Cookie": {
"Name": "<name-of-cookie-with-token>"
}
}
],
"Forwarding": {
"HeaderName": "<name-appended-to-forwarding-header>", "HeaderName": "<name-appended-to-forwarding-header>",
"PadForwardPayloadHeader": "false" "PadForwardPayloadHeader": "false"
}, },
"ClockSkewSeconds": "30", "ClockSkewSeconds": "30",
"CacheConfig": { "CacheConfig": {
"Size": "0" "Size": "0"
} }
} }
``` ```

20
website/content/docs/connect/proxies/envoy-extensions/configuration/property-override.mdx
View File

@ -177,16 +177,16 @@ EnvoyExtensions = [
ProxyType = "connect-proxy", ProxyType = "connect-proxy",
Patches = [ Patches = [
{ {
"ResourceFilter" = { ResourceFilter = {
"ResourceType" = "cluster", ResourceType = "cluster"
"TrafficDirection" = "outbound", TrafficDirection = "outbound"
"Service" = { Service = {
"Name" = "other-svc" Name = "other-svc"
}, }
}, }
"Op" = "add", Op = "add"
"Path" = "/respect_dns_ttl", Path = "/respect_dns_ttl"
"Value" = true, Value = true
} }
] ]
} }

39
website/content/docs/k8s/connect/transparent-proxy/enable-transparent-proxy.mdx
View File

@ -43,8 +43,8 @@ connectInject:
Apply the `consul.hashicorp.com/transparent-proxy=true` label to enable transparent proxy for a Kubernetes namespace. The label overrides the `connectInject.transparentProxy.defaultEnabled` Helm value and defines the default behavior of Pods in the namespace. The following example enables transparent proxy for Pods in the `my-app` namespace: Apply the `consul.hashicorp.com/transparent-proxy=true` label to enable transparent proxy for a Kubernetes namespace. The label overrides the `connectInject.transparentProxy.defaultEnabled` Helm value and defines the default behavior of Pods in the namespace. The following example enables transparent proxy for Pods in the `my-app` namespace:
```bash ```shell-session
kubectl label namespaces my-app "consul.hashicorp.com/transparent-proxy=true" $ kubectl label namespaces my-app "consul.hashicorp.com/transparent-proxy=true"
``` ```
### Individual service ### Individual service
@ -121,12 +121,11 @@ The [`consul.hashicorp.com/transparent-proxy-exclude-inbound-ports`](/consul/doc
<CodeBlockConfig heading="Exclude inbound port numbers from redirection"> <CodeBlockConfig heading="Exclude inbound port numbers from redirection">
```yaml ```yaml
"metadata": { metadata:
"annotations": { annotations:
"consul.hashicorp.com/transparent-proxy-exclude-inbound-ports" : "8200, 8201” consul.hashicorp.com/transparent-proxy-exclude-inbound-ports: "8200, 8201"
}
}
``` ```
</CodeBlockConfig> </CodeBlockConfig>
### Exclude outbound ports ### Exclude outbound ports
@ -136,11 +135,9 @@ The [`consul.hashicorp.com/transparent-proxy-exclude-outbound-ports`](/consul/do
<CodeBlockConfig heading="Exclude outbound port numbers from redirection"> <CodeBlockConfig heading="Exclude outbound port numbers from redirection">
```yaml ```yaml
"metadata": { metadata:
"annotations": { annotations":
"consul.hashicorp.com/transparent-proxy-exclude-outbound-ports" : "8200, 8201” consul.hashicorp.com/transparent-proxy-exclude-outbound-ports: "8200, 8201"
}
}
``` ```
</CodeBlockConfig> </CodeBlockConfig>
@ -154,11 +151,9 @@ In the following example, services in the `3.3.3.3/24` IP range are not redirect
<CodeBlockConfig heading="Exclude outbound CIDR blocks from redirection"> <CodeBlockConfig heading="Exclude outbound CIDR blocks from redirection">
```yaml ```yaml
"metadata": { metadata:
"annotations": { annotations:
"consul.hashicorp.com/transparent-proxy-exclude-outbound-cidrs" : "3.3.3.3,3.3.3.3/24" consul.hashicorp.com/transparent-proxy-exclude-outbound-cidrs: "3.3.3.3,3.3.3.3/24"
}
}
``` ```
</CodeBlockConfig> </CodeBlockConfig>
@ -171,9 +166,9 @@ In the following example, services with the IDs `4444 ` and `44444 ` are not red
<CodeBlockConfig heading="Exclude user IDs from redirection"> <CodeBlockConfig heading="Exclude user IDs from redirection">
```yaml ```yaml
"metadata": { metadata:
"annotations": { annotations:
"consul.hashicorp.com/transparent-proxy-exclude-uids" : "4444,44444” consul.hashicorp.com/transparent-proxy-exclude-uids: "4444,44444"
} }
} }
``` ```
@ -201,7 +196,7 @@ then you must configure services in one Kubernetes cluster to explicitly dial a
The following example configures the service to dial an upstream service called `my-service` in datacenter `dc2` on port `1234`: The following example configures the service to dial an upstream service called `my-service` in datacenter `dc2` on port `1234`:
```yaml ```yaml
"consul.hashicorp.com/connect-service-upstreams": "my-service:1234:dc2" consul.hashicorp.com/connect-service-upstreams: "my-service:1234:dc2"
``` ```
If your Consul cluster is deployed to a [single datacenter spanning multiple Kubernetes clusters](/consul/docs/k8s/deployment-configurations/single-dc-multi-k8s), If your Consul cluster is deployed to a [single datacenter spanning multiple Kubernetes clusters](/consul/docs/k8s/deployment-configurations/single-dc-multi-k8s),
@ -210,7 +205,7 @@ then you must configure services in one Kubernetes cluster to explicitly dial a
The following example configures the service to dial an upstream service called `my-service` in another Kubernetes cluster on port `1234`: The following example configures the service to dial an upstream service called `my-service` in another Kubernetes cluster on port `1234`:
```yaml ```yaml
"consul.hashicorp.com/connect-service-upstreams": "my-service:1234" consul.hashicorp.com/connect-service-upstreams: "my-service:1234"
``` ```
You do not need to configure services to explicitly dial upstream services if your Consul clusters are connected with a [peering connection](/consul/docs/connect/cluster-peering). You do not need to configure services to explicitly dial upstream services if your Consul clusters are connected with a [peering connection](/consul/docs/connect/cluster-peering).

2
website/content/docs/nia/cli/task.mdx
View File

@ -34,7 +34,7 @@ task_example.hcl:
task { task {
name = "task_a" name = "task_a"
description = "" description = ""
enabled = true, enabled = true
providers = [] providers = []
module = "org/example/module" module = "org/example/module"
version = "1.0.0" version = "1.0.0"

2
website/content/docs/nia/configuration.mdx
View File

@ -277,7 +277,7 @@ A `task` block configures which task to execute in automation. Use the `conditi
task { task {
name = "taskA" name = "taskA"
description = "" description = ""
enabled = true, enabled = true
providers = [] providers = []
module = "org/example/module" module = "org/example/module"
version = "1.0.0" version = "1.0.0"