mirror of https://github.com/status-im/consul.git
docs: Replace unicode quotes with ASCII quotes (#18950)
Replaces unicode quotation marks with ASCII quotation marks. For code examples, this fixes HCL decoding errors that would otherwise be raised when attempting to read the file.
This commit is contained in:
Blake Covarrubias
GitHub
parent
4e1e18fe66
commit
5d0edec01f
|
|
@ -25,11 +25,11 @@ Service discovery provides benefits for all organizations, ranging from simplifi
|
|||
|
||||
Service discovery uses a service's identity instead of traditional access information (IP address and port). This allows you to dynamically map services and track any changes within a service catalog. Service consumers (users or other services) then use DNS to dynamically retrieve other service's access information from the service catalog. The lifecycle of a service may look like the following:
|
||||
|
||||
A service consumer communicates with the “Web” service via a unique Consul DNS entry provided by the service catalog.
|
||||
A service consumer communicates with the "Web" service via a unique Consul DNS entry provided by the service catalog.
|
||||
|
||||
|
||||
|
||||
A new instance of the “Web” service registers itself to the service catalog with its IP address and port. As new instances of your services are registered to the service catalog, they will participate in the load balancing pool for handling service consumer requests.
|
||||
A new instance of the "Web" service registers itself to the service catalog with its IP address and port. As new instances of your services are registered to the service catalog, they will participate in the load balancing pool for handling service consumer requests.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -431,7 +431,7 @@ EnvoyExtensions = [
|
|||
Required = true
|
||||
Arguments = {
|
||||
Protocol = "tcp"
|
||||
ListenerType = “inbound”
|
||||
ListenerType = "inbound"
|
||||
PluginConfig = {
|
||||
VmConfig = {
|
||||
Code = {
|
||||
|
|
@ -463,7 +463,7 @@ EnvoyExtensions = [
|
|||
Name = "builtin/wasm"
|
||||
Arguments = {
|
||||
Protocol = "http"
|
||||
ListenerType = “inbound”
|
||||
ListenerType = "inbound"
|
||||
PluginConfig = {
|
||||
VmConfig = {
|
||||
Code = {
|
||||
|
|
|
|||
|
|
@ -17,13 +17,13 @@ Consul-Terraform-Sync executes one or more automation tasks with an appropriate
|
|||
|
||||
[](/img/nia-highlevel-diagram.svg)
|
||||
|
||||
-> Please note that the above indicated solution is a “push” based method and is not the only way to integrate network devices with Consul and drive Network Infrastructure Automation Integration. If your preferred method is to directly integrate with Consul without using Terraform, then please use [Consul Integration Program](/consul/docs/integrate/partnerships).
|
||||
-> Please note that the above indicated solution is a "push" based method and is not the only way to integrate network devices with Consul and drive Network Infrastructure Automation Integration. If your preferred method is to directly integrate with Consul without using Terraform, then please use [Consul Integration Program](/consul/docs/integrate/partnerships).
|
||||
|
||||
## NIA Program Steps
|
||||
|
||||
The NIA Integration Program has six steps. By following these steps, Consul-Terraform-Sync compatible Terraform modules can be developed. They are then published as “verified” Consul-Terraform-Sync modules on the [NIA page consul.io](https://www.consul.io/use-cases/network-infrastructure-automation).
|
||||
The NIA Integration Program has six steps. By following these steps, Consul-Terraform-Sync compatible Terraform modules can be developed. They are then published as "verified" Consul-Terraform-Sync modules on the [NIA page consul.io](https://www.consul.io/use-cases/network-infrastructure-automation).
|
||||
|
||||
-> **Note:** A prerequisite to be eligible for NIA Integration program includes having a “verified” provider on Terraform registry for the appropriate technology. Please follow the guidelines to enroll in the Terraform Provider Development Program if you do not presently have a “verified” provider.
|
||||
-> **Note:** A prerequisite to be eligible for NIA Integration program includes having a "verified" provider on Terraform registry for the appropriate technology. Please follow the guidelines to enroll in the Terraform Provider Development Program if you do not presently have a "verified" provider.
|
||||
|
||||
[](/img/nia-integration-program.png)
|
||||
|
||||
|
|
|
|||
|
|
@ -194,7 +194,7 @@ For detailed instructions on how to configure zero-trust networking with intenti
|
|||
|
||||
## Deploying your application to Kubernetes
|
||||
|
||||
Now you will deploy a sample application which echoes “hello world”
|
||||
Now you will deploy a sample application which echoes "hello world"
|
||||
|
||||
<CodeBlockConfig filename="static-server.yaml">
|
||||
|
||||
|
|
|
|||
|
|
@ -232,7 +232,7 @@ Set `AllowEnablingPermissiveMutualTLS=false` and `MeshDestinationsOnly=true` in
|
|||
<CodeTabs heading="Disable non-mTLS traffic">
|
||||
|
||||
```hcl
|
||||
Kind = “mesh”
|
||||
Kind = "mesh"
|
||||
|
||||
AllowEnablingPermissiveMutualTLS = false
|
||||
TransparentProxy {
|
||||
|
|
|
|||
|
|
@ -256,10 +256,10 @@ Define the following environment variables in your Lambda functions to configure
|
|||
| Variable | Description | Default |
|
||||
| --- | --- | --- |
|
||||
| `CONSUL_MESH_GATEWAY_URI` | Specifies the URI where the mesh gateways that the plugin makes requests are running. The mesh gateway should be registered in the same Consul datacenter and partition that the service is running in. For optimal performance, this mesh gateway should run in the same AWS region. | none |
|
||||
| <nobr>`CONSUL_EXTENSION_DATA_PREFIX`</nobr> | Specifies the prefix that the plugin pulls configuration data from. The data must be located in the following directory: <br/>`“${CONSUL_EXTENSION_DATA_PREFIX}/${CONSUL_SERVICE_PARTITION}/${CONSUL_SERVICE_NAMESPACE}/<lambda-function-name>”` | none |
|
||||
| <nobr>`CONSUL_EXTENSION_DATA_PREFIX`</nobr> | Specifies the prefix that the plugin pulls configuration data from. The data must be located in the following directory: <br/>`"${CONSUL_EXTENSION_DATA_PREFIX}/${CONSUL_SERVICE_PARTITION}/${CONSUL_SERVICE_NAMESPACE}/<lambda-function-name>"` | none |
|
||||
| `CONSUL_SERVICE_NAMESPACE` | Specifies the Consul namespace the service is registered into. | `default` |
|
||||
| `CONSUL_SERVICE_PARTITION` | Specifies the Consul partition the service is registered into. | `default` |
|
||||
| `CONSUL_REFRESH_FREQUENCY` | Specifies the amount of time the extension waits before re-pulling data from the Parameter Store. Use [Go `time.Duration`](https://pkg.go.dev/time@go1.19.1#ParseDuration) string values, for example, `”30s”`. <br/>The time is added to the duration configured in the Lambda registrator `sync_frequency_in_minutes` configuration. Refer to [Lambda registrator configuration options](/consul/docs/lambda/registration/automate#lambda-registrator-configuration-options). The combined configurations determine how stale the data may become. Lambda functions can run for up to 14 hours, so we recommend configuring a value that results in acceptable staleness for certificates. | `“5m”` |
|
||||
| `CONSUL_REFRESH_FREQUENCY` | Specifies the amount of time the extension waits before re-pulling data from the Parameter Store. Use [Go `time.Duration`](https://pkg.go.dev/time@go1.19.1#ParseDuration) string values, for example, `"30s"`. <br/>The time is added to the duration configured in the Lambda registrator `sync_frequency_in_minutes` configuration. Refer to [Lambda registrator configuration options](/consul/docs/lambda/registration/automate#lambda-registrator-configuration-options). The combined configurations determine how stale the data may become. Lambda functions can run for up to 14 hours, so we recommend configuring a value that results in acceptable staleness for certificates. | `"5m"` |
|
||||
| `CONSUL_SERVICE_UPSTREAMS` | Specifies a comma-separated list of upstream services that the Lambda function can call. Specify the value as an unlabelled annotation according to the [`consul.hashicorp.com/connect-service-upstreams` annotation format](/consul/docs/k8s/annotations-and-labels#consul-hashicorp-com-connect-service-upstreams) in Consul on Kubernetes. For example, `"[service-name]:[port]:[optional-datacenter]"` | none |
|
||||
|
||||
## Invoke the Lambda function
|
||||
|
|
|
|||
|
|
@ -140,10 +140,10 @@ The registrator also requires the following IAM permissions to access the parame
|
|||
source = "hashicorp/consul-lambda/consul-lambda-registrator"
|
||||
version = "x.y.z"
|
||||
name = "consul-lambda-registrator"
|
||||
consul_http_addr = “https://aecfe39d629774e348a9844439f5e3c1-1471365273.us-east-1.elb.amazonaws.com:8501”
|
||||
consul_http_addr = "https://aecfe39d629774e348a9844439f5e3c1-1471365273.us-east-1.elb.amazonaws.com:8501"
|
||||
ca_cert_path = aws_ssm_parameter.ca-cert.name
|
||||
http_token_path = aws_ssm_parameter.acl-token.name
|
||||
consul_extension_data_prefix = “/lambda_extension_data”
|
||||
consul_extension_data_prefix = "/lambda_extension_data"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -564,7 +564,7 @@ task {
|
|||
cron = "* * * * Mon"
|
||||
}
|
||||
|
||||
module_input “services” {
|
||||
module_input "services" {
|
||||
regexp = "^web.*"
|
||||
datacenter = "dc1"
|
||||
namespace = "default"
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ We are pleased to announce the following Consul updates.
|
|||
|
||||
Consul's API gateway is the recommended alternative to ingress gateway. For ingress gateway features not currently supported by API gateway, equivalent functionality will be added to API gateway over the next several releases of Consul.
|
||||
|
||||
- **Legacy API Gateway:** The Consul AP Gateway that was previously packaged (`consul-api-gateway`) and released separately from Consul K8s is now deprecated. This is referred to as the “legacy” API Gateway.
|
||||
- **Legacy API Gateway:** The Consul AP Gateway that was previously packaged (`consul-api-gateway`) and released separately from Consul K8s is now deprecated. This is referred to as the "legacy" API Gateway.
|
||||
|
||||
The legacy API Gateway (v0.5.4) is supported with this version of Consul on Kubernetes in order to simplify the process of migrating from legacy to native API gateways.
|
||||
|
||||
|
|
|
|||
|
|
@ -176,7 +176,7 @@ environment and adapt these configurations accordingly.
|
|||
deployed within Consul.
|
||||
|
||||
- **🏷 Namespace** <EnterpriseAlert inline /> - a named, logical scoping of Consul Enterprise resources, typically to
|
||||
enable multi-tenant environments. Consul OSS clusters always operate within the “default” namespace.
|
||||
enable multi-tenant environments. Consul OSS clusters always operate within the "default" namespace.
|
||||
|
||||
- **Gossip Encryption** - A shared, base64-encoded 32-byte symmetric key is required to [encrypt Serf gossip
|
||||
communication](/consul/tutorials/security/gossip-encryption-secure?utm_source=consul.io&utm_medium=docs) within a cluster using
|
||||
|
|
|
|||
Loading…
Reference in New Issue