mirror of https://github.com/status-im/consul.git
docs: Fix spelling errors (#21204)
Fix spelling errors across docs site.
This commit is contained in:
parent
b2a618ba8a
commit
6f02144a14
|
@ -32,7 +32,7 @@ The table below shows this endpoint's support for
|
|||
|
||||
### Link API vs. configuration-based linking
|
||||
|
||||
The Link API described here is an alternative method to accomplish the same thing as [configuration-based linking](/consul/docs/agent/config/config-files#self-managed-hcp-parameters). You should generally only choose one method or the other for linking your cluster, not both. If you do use both methods, they interract in the following ways:
|
||||
The Link API described here is an alternative method to accomplish the same thing as [configuration-based linking](/consul/docs/agent/config/config-files#self-managed-hcp-parameters). You should generally only choose one method or the other for linking your cluster, not both. If you do use both methods, they interact in the following ways:
|
||||
|
||||
* When Consul is started, values set in the `cloud` configuration will take precedence over what was previously set by the API or CLI.
|
||||
* Clusters can only be unlinked from HCP Consul Central by the API or CLI, regardless of if they were established via configuration, API, or CLI.
|
||||
|
|
|
@ -56,7 +56,7 @@ See [Kubernetes Custom Resource Definitions](/consul/docs/k8s/crds).
|
|||
Configuration entries outside of Kubernetes should be managed with the Consul
|
||||
[CLI](/consul/commands/config) or [API](/consul/api-docs/config). Additionally, as a
|
||||
convenience for initial cluster bootstrapping, configuration entries can be
|
||||
specified in all of the Consul servers's
|
||||
specified in all of the Consul server
|
||||
[configuration files](/consul/docs/agent/config/config-files#config_entries_bootstrap)
|
||||
|
||||
### Managing Configuration Entries with the CLI
|
||||
|
|
|
@ -50,7 +50,7 @@ Consul uses [Raft for consensus protocol](/consul/docs/architecture/consensus).
|
|||
|
||||
A short multiplier minimizes failure detection and election time but may trigger frequently in high latency situations. This can cause constant leadership churn and associated unavailability. A high multiplier reduces the chances that spurious failures will cause leadership churn but it does this at the expense of taking longer to detect real failures and thus takes longer to restore Consul cluster availability.
|
||||
|
||||
Wide networks with higher latency will perform better with larger `raft_multipler` values.
|
||||
Wide networks with higher latency will perform better with larger `raft_multiplier` values.
|
||||
|
||||
Raft uses BoltDB for storing data and maintaining its own state. Refer to the [Bolt DB performance metrics](/consul/docs/agent/telemetry#bolt-db-performance) when you are troubleshooting Raft performance issues.
|
||||
|
||||
|
@ -77,7 +77,7 @@ annotations:
|
|||
consul.hashicorp.com/envoy-extra-args: '--log-level debug --disable-hot-restart'
|
||||
```
|
||||
|
||||
Refer to the [Enable logging on Envoy sidecar pods](/consul/docs/k8s/annotations-and-labels#consul-hashicorp-com-envoy-extra-args) documention for more information.
|
||||
Refer to the [Enable logging on Envoy sidecar pods](/consul/docs/k8s/annotations-and-labels#consul-hashicorp-com-envoy-extra-args) documentation for more information.
|
||||
|
||||
#### Envoy Admin Interface
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ The v2 catalog API is available alongside the existing v1 catalog API, but the c
|
|||
|
||||
## Catalog structure
|
||||
|
||||
Consul v1.17 introduces a new version of the catalog API designed to bridge differences between the Consul and Kubernetes data models. The v2 catalog API continues to track services and nodes for Consul, but it replaces service instances with _workloads_ and _workload identites_.
|
||||
Consul v1.17 introduces a new version of the catalog API designed to bridge differences between the Consul and Kubernetes data models. The v2 catalog API continues to track services and nodes for Consul, but it replaces service instances with _workloads_ and _workload identities_.
|
||||
|
||||
### Catalog resources
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: Consul v2 architecture
|
||||
description: Learn about version 2 of Consul's internal architecture, which replaces services and service instances with workloads and workload identies.
|
||||
description: Learn about version 2 of Consul's internal architecture, which replaces services and service instances with workloads and workload identities.
|
||||
---
|
||||
|
||||
<Warning>
|
||||
|
|
|
@ -659,7 +659,7 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
|
|||
- Default: None
|
||||
- Data type: Map containing the following parameters:
|
||||
- [`checks`](#expose-checks)
|
||||
- [`aths`](#expose-paths)
|
||||
- [`paths`](#expose-paths)
|
||||
|
||||
### `spec.expose{}.checks`
|
||||
|
||||
|
|
|
@ -87,7 +87,7 @@ $ export VERSION=1.0.0 && \
|
|||
Refer to the following documentation for Consul on ECS workloads:
|
||||
|
||||
- [Deploy Consul with the Terraform module](/consul/docs/ecs/deploy/terraform)
|
||||
- [Deploy Consul manually](/consul/ecs/install-manul)
|
||||
- [Deploy Consul manually](/consul/docs/ecs/deploy/manual)
|
||||
|
||||
</Tab>
|
||||
|
||||
|
|
|
@ -155,7 +155,7 @@ You can specify the following strings:
|
|||
* `trace`
|
||||
|
||||
### mapPrivilegedContainerPorts
|
||||
Specifies a value that Consul adds to privileged ports defined in the gateway. Privileged ports are port numbers less than 1024 and some platforms, such as Red Hat OpenShift, explicitly configure Kubernetes to avoid running containers on privileged ports. The total value of the configured port number and the `mapPriviledgedContainerPorts` value must not exceed 65535, which is the highest possible TCP port number allowed.
|
||||
Specifies a value that Consul adds to privileged ports defined in the gateway. Privileged ports are port numbers less than 1024 and some platforms, such as Red Hat OpenShift, explicitly configure Kubernetes to avoid running containers on privileged ports. The total value of the configured port number and the `mapPrivilegedContainerPorts` value must not exceed 65535, which is the highest possible TCP port number allowed.
|
||||
for gateway containers
|
||||
* Type: Integer
|
||||
* Required: optional
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: docs
|
||||
page_title: GatewayPolicy configuration reference
|
||||
description: Learn about the configuration options for the GatewayPolicy configuration resource. GatewayPolicy resources define API gateway polcies for Consul service mesh on Kubernetes.
|
||||
description: Learn about the configuration options for the GatewayPolicy configuration resource. GatewayPolicy resources define API gateway policies for Consul service mesh on Kubernetes.
|
||||
---
|
||||
|
||||
# GatewayPolicy
|
||||
|
@ -53,7 +53,7 @@ spec:
|
|||
targetRef:
|
||||
name: gateway
|
||||
kind: Gateway
|
||||
group: gateway.networking.kuberenetes.io
|
||||
group: gateway.networking.kubernetes.io
|
||||
sectionName: <name of a specific listener the policy applies>
|
||||
override:
|
||||
jwt:
|
||||
|
@ -153,7 +153,7 @@ The following table describes the members of the `targetRef` map:
|
|||
| `namespace` | Specifies the namespace that the target reference is a member of. | String | `default` |
|
||||
| `name` | Specifies the name of the API gateway that the policy attaches to. | String | None |
|
||||
| `kind` | Specifies the type of resource that the policy attaches to. Must be set to `Gateway`. | String | None |
|
||||
| `group` | Specifies the resource group. Must be set to `gateway.networking.kuberenetes.io`. | String | None |
|
||||
| `group` | Specifies the resource group. Must be set to `gateway.networking.kubernetes.io`. | String | None |
|
||||
| `sectionName` | Specifies a part of the gateway that the policy applies to. | String | None |
|
||||
|
||||
### `spec.override`
|
||||
|
@ -237,7 +237,7 @@ spec:
|
|||
targetRef:
|
||||
name: gateway
|
||||
kind: Gateway
|
||||
group: gateway.networking.kuberenetes.io
|
||||
group: gateway.networking.kubernetes.io
|
||||
sectionName: to-server
|
||||
override:
|
||||
jwt:
|
||||
|
|
|
@ -50,9 +50,9 @@ The following outline shows how to format the configurations for the `Route` obj
|
|||
- [`replacePrefixMatch`](#rules-filters-urlrewrite-path): string | required
|
||||
- [`type`](#rules-filters-urlrewrite-path): string | required
|
||||
- [`extensionRef`](#rules-filters-extensionref): map
|
||||
- [`group`](#rultes-filters-extensionref): string | must be set to `consul.hashicorp.com`
|
||||
- [`kind`](#rultes-filters-extensionref): string | must be set to `RouteAuthFilter`
|
||||
- [`name`](#rultes-filters-extensionref): string | must be set to `consul.hashicorp.com`
|
||||
- [`group`](#rules-filters-extensionref): string | must be set to `consul.hashicorp.com`
|
||||
- [`kind`](#rules-filters-extensionref): string | must be set to `RouteAuthFilter`
|
||||
- [`name`](#rules-filters-extensionref): string | must be set to `consul.hashicorp.com`
|
||||
- [`matches`](#rules-matches): array of objects | optional
|
||||
- [`path`](#rules-matches-path): list of objects | optional
|
||||
- [`type`](#rules-matches-path): string | required
|
||||
|
|
|
@ -31,7 +31,7 @@ Define route configurations and bind them to listeners configured on the gateway
|
|||
|
||||
1. Create a configuration file and specify the following fields:
|
||||
|
||||
- `apiVersion`: Specifies the Kuberenetes API gateway version. This must be set to `gateway.networking.k8s.io/v1beta1`
|
||||
- `apiVersion`: Specifies the Kubernetes API gateway version. This must be set to `gateway.networking.k8s.io/v1beta1`
|
||||
- `kind`: Set to `HTTPRoute` or `TCPRoute`.
|
||||
- `metadata.name`: Specify a name for the route. The name is metadata that you can use to reference the configuration when performing Consul operations.
|
||||
- `spec.parentRefs.name`: Specifies a list of API gateways that the route binds to.
|
||||
|
|
|
@ -41,7 +41,7 @@ Create a `GatewayPolicy` values file and configure the following fields to defin
|
|||
- `metadata.name`: Specifies a name for the policy.
|
||||
- `spec.targetRef.name`: Specifies the name of the API gateway to attach the policy to.
|
||||
- `spec.targetRef.kind`: Specifies the kind of resource to attach to the policy to. Must be set to `Gateway`.
|
||||
- `spec.targetRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kuberenetes.io`.
|
||||
- `spec.targetRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kubernetes.io`.
|
||||
- `spec.targetRef.sectionName`: Specifies a part of the gateway that the policy applies to.
|
||||
- `spec.targetRef.override.jwt.providers`: Specifies a list of providers and claims used to verify requests to the gateway. The override settings take precedence over the default and route-specific JWT verification settings.
|
||||
- `spec.targetRef.default.jwt.providers`: Specifies a list of default providers and claims used to verify requests to the gateway.
|
||||
|
@ -60,7 +60,7 @@ Create an `RouteAuthFilter` values file and configure the following fields. Refe
|
|||
In the `filters` field of your HTTP route configuration, add the following fields. Refer to the [`extensionRef` configuration reference](/consul/docs/connect/gateways/api-gateway/configuration/routes#rules-filters-extensionref) for details:
|
||||
|
||||
- `type: extensionRef`: Declare list of extension references.
|
||||
- `extensionRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kuberenetes.io`.
|
||||
- `extensionRef.group`: Specifies the resource group. Unless you have created a custom group, this should be set to `gateway.networking.kubernetes.io`.
|
||||
- `extensionRef.kind`: Specifies the type of extension reference to attach to the route. Must be `RouteAuthFilter`
|
||||
- `extensionRef.name`: Specifies the name of the auth filter.
|
||||
|
||||
|
|
|
@ -74,7 +74,7 @@ Refer to the [release notes](/consul/docs/release-notes) for your version of Con
|
|||
|
||||
## Supported Kubernetes gateway specification features
|
||||
|
||||
Consul API gateways for Kuberentes support a subset of the Kubernetes Gateway API specification. For a complete list of features, including the list of gateway and route statuses and an explanation on how they
|
||||
Consul API gateways for Kubernetes support a subset of the Kubernetes Gateway API specification. For a complete list of features, including the list of gateway and route statuses and an explanation on how they
|
||||
are used, refer to the [documentation in our GitHub repo](https://github.com/hashicorp/consul-api-gateway/blob/main/dev/docs/supported-features.md):
|
||||
|
||||
### `GatewayClass`
|
||||
|
|
|
@ -6,7 +6,7 @@ description: You can configure sameness groups so that when a service instance f
|
|||
|
||||
# Failover with sameness groups
|
||||
|
||||
This page describes how to use sameness groups to automatically redirect service traffic to healthy instances in failover scenarios. Sameness groups are a user-defined set of Consul admin partitions with identical registered services. These admin paritions typically belong to Consul datacenters in different cloud regions, which enables sameness groups to participate in several service failover configuration strategies.
|
||||
This page describes how to use sameness groups to automatically redirect service traffic to healthy instances in failover scenarios. Sameness groups are a user-defined set of Consul admin partitions with identical registered services. These admin partitions typically belong to Consul datacenters in different cloud regions, which enables sameness groups to participate in several service failover configuration strategies.
|
||||
|
||||
To create a sameness group and configure each Consul datacenter to allow traffic from other members of the group, refer to [create sameness groups](/consul/docs/connect/cluster-peering/usage/create-sameness-groups).
|
||||
|
||||
|
|
|
@ -261,7 +261,7 @@ Consul configures Envoy's built-in [`overprovisioning_factor`](https://www.envoy
|
|||
|
||||
To verify that locality-aware routing and failover configurations, you can inspect Envoy's xDS configuration dump for a downstream proxy. Refer to the [consul-k8s CLI docs](https://developer.hashicorp.com/consul/docs/k8s/k8s-cli#proxy-read) for details on how to obtain the xDS configuration dump on Kubernetes. For other workloads, use the Envoy [admin interface](https://www.envoyproxy.io/docs/envoy/latest/operations/admin) and ensure that you [include EDS](https://www.envoyproxy.io/docs/envoy/latest/operations/admin#get--config_dump?include_eds).
|
||||
|
||||
Inspect the [priority](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/priority#arch-overview-load-balancing-priority-levels) on each set of endpoints under the upstream `ClusterLoadAssignment` in the `EndpointsConfigDump`. Alternatively, the same priorities should be visibile within the output of the [`/clusters?format=json`](https://www.envoyproxy.io/docs/envoy/latest/operations/admin#get--clusters?format=json) admin endpoint.
|
||||
Inspect the [priority](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/priority#arch-overview-load-balancing-priority-levels) on each set of endpoints under the upstream `ClusterLoadAssignment` in the `EndpointsConfigDump`. Alternatively, the same priorities should be visible within the output of the [`/clusters?format=json`](https://www.envoyproxy.io/docs/envoy/latest/operations/admin#get--clusters?format=json) admin endpoint.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
@ -31,7 +31,7 @@ If you want to define global passthrough settings for all Envoy proxies, create
|
|||
1. Create a proxy defaults configuration entry and specify the following parameters:
|
||||
- `Kind`: Must be set to `proxy-defaults`
|
||||
- `Name`: Must be set to `global`
|
||||
1. Configure any additional settings you want to apply to all proxies. Refer to [Proxy defaults configuration entry reference](/consul/docs/connect/config-entries/proxy-defaults) for details about all settings available in the configuraiton entry.
|
||||
1. Configure any additional settings you want to apply to all proxies. Refer to [Proxy defaults configuration entry reference](/consul/docs/connect/config-entries/proxy-defaults) for details about all settings available in the configuration entry.
|
||||
1. Apply the configuration by either calling the [`/config` HTTP API endpoint](/consul/api-docs/config) or running the [`consul config write` CLI command](/consul/commands/config/write). The following example writes a proxy defaults configuration entry from a local HCL file using the CLI:
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -32,7 +32,7 @@ If you want to define global passthrough settings for all Envoy proxies, create
|
|||
1. Create a proxy defaults configuration entry and specify the following parameters:
|
||||
- `Kind`: Must be set to `proxy-defaults`
|
||||
- `Name`: Must be set to `global`
|
||||
1. Configure any additional settings you want to apply to all proxies. Refer to [Proxy defaults configuration entry reference](/consul/docs/connect/config-entries/proxy-defaults) for details about all settings available in the configuraiton entry.
|
||||
1. Configure any additional settings you want to apply to all proxies. Refer to [Proxy defaults configuration entry reference](/consul/docs/connect/config-entries/proxy-defaults) for details about all settings available in the configuration entry.
|
||||
1. Apply the configuration by either calling the [`/config` API endpoint](/consul/api-docs/config) or running the [`consul config write` CLI command](/consul/commands/config/write). The following example writes a proxy defaults configuration entry from a local HCL file using the CLI:
|
||||
|
||||
```shell-session
|
||||
|
|
|
@ -18,7 +18,7 @@ You should have some familiarity with AWS ECS. Refer to [What is Amazon Elastic
|
|||
You must meet the following requirements and prerequisites to enable security features in Consul service mesh:
|
||||
|
||||
- Enable [TLS encryption](https://developer.hashicorp.com/consul/docs/security/encryption#rpc-encryption-with-tls) on your Consul servers so that they can communicate security with Consul dataplane containers over gRPC.
|
||||
- Enable [access control lists (ACLs)](/consul/docs/security/acl) on your Consul servers. ALCs provide authentication and authorization for access to Consul servers on the mesh.
|
||||
- Enable [access control lists (ACLs)](/consul/docs/security/acl) on your Consul servers. ACLs provide authentication and authorization for access to Consul servers on the mesh.
|
||||
- You should be familiar with specifying sensitive data on ECS. Refer to [Passing sensitive data to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the AWS documentation for additional information.
|
||||
|
||||
You should be familiar with configuring Consul's secure features, including how to create ACL tokens and policies. Refer to the following resources:
|
||||
|
@ -210,7 +210,7 @@ Provide Consul server connection settings to the mesh task module so that the mo
|
|||
}
|
||||
|
||||
```
|
||||
1. Add an `environment` block to the control-plane and ECS controller containers definition
|
||||
1. Add an `environment` block to the control-plane and ECS controller containers definition.
|
||||
1. Set the `environment.name` field to the `CONSUL_ECS_CONFIG_JSON` environment variable and the value to `local.encoded_config`.
|
||||
|
||||
```hcl
|
||||
|
|
|
@ -93,7 +93,7 @@ module "my_task" {
|
|||
Note the following differences:
|
||||
|
||||
- The `execution_role_arn` and `task_role_arn` fields are removed. The `mesh-task` module creates the task and execution roles by default. If you need to use existing IAM roles, set the `task_role` and `execution_role` fields to pass in existing roles.
|
||||
- The `port` field specifes the port that your application listens on. If your application has no listening port, set `outbound_only = true` and remove the `port` field.
|
||||
- The `port` field specifies the port that your application listens on. If your application has no listening port, set `outbound_only = true` and remove the `port` field.
|
||||
- The `jsonencode()` function is removed from the `container_definitions` field.
|
||||
|
||||
The `mesh-task` module creates a new version of your task definition with the necessary dataplane containers so you can delete your existing `aws_ecs_task_definition` resource.
|
|
@ -34,7 +34,7 @@ After defining your Terraform configuration, use `terraform apply` to deploy Con
|
|||
You must meet the following requirements and prerequisites to enable security features in Consul service mesh:
|
||||
|
||||
- Enable [TLS encryption](/consul/docs/security/encryption#rpc-encryption-with-tls) on your Consul servers so that they can communicate securely with Consul containers over gRPC.
|
||||
- Enable [access control lists (ACLs)](/consul/docs/security/acl) on your Consul servers. ALCs provide authentication and authorization for access to Consul servers on the mesh.
|
||||
- Enable [access control lists (ACLs)](/consul/docs/security/acl) on your Consul servers. ACLs provide authentication and authorization for access to Consul servers on the mesh.
|
||||
- You should be familiar with specifying sensitive data on ECS. Refer to [Passing sensitive data to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the AWS documentation for additional information.
|
||||
|
||||
Additionally, Consul requires a unique IAM role for each ECS task family. Task IAM roles cannot be shared by different task families because the task family is unique to each Consul service.
|
||||
|
@ -127,7 +127,7 @@ Provide Consul server connection settings to the mesh task module so that the mo
|
|||
|
||||
To start a task using the task definition, add the `aws_ecs_service` resource to your configuration to create an ECS service. [ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) are one of the most common ways to start tasks using a task definition.
|
||||
|
||||
Reference the `mesh-task` module's `task_definition_arn` output value in your `aws_ecs_service` resource. The following example adds an ECS service for a task definition referenced in as `module.my_task.task_defintion_arn`:
|
||||
Reference the `mesh-task` module's `task_definition_arn` output value in your `aws_ecs_service` resource. The following example adds an ECS service for a task definition referenced in as `module.my_task.task_definition_arn`:
|
||||
|
||||
<CodeBlockConfig filename="mesh-task.tf" highlight="6-12">
|
||||
|
||||
|
|
|
@ -33,11 +33,11 @@ The following list describes the attributes, data types, and default values, if
|
|||
|
||||
## Specification
|
||||
|
||||
This section provides details about the attribes in the `config.tf` file.
|
||||
This section provides details about the attributes in the `config.tf` file.
|
||||
|
||||
### `consulServers`
|
||||
|
||||
Parent-level attribute containing all of the server configurations. All other configuraitons in the file are children of the `consulServers` attribute.
|
||||
Parent-level attribute containing all of the server configurations. All other configurations in the file are children of the `consulServers` attribute.
|
||||
|
||||
#### Values
|
||||
|
||||
|
|
|
@ -47,7 +47,7 @@ The server's DNS port does not need to be open when DNS queries are sent to Cons
|
|||
|
||||
If you configure recursors in Consul to upstream DNS servers, then you need outbound access to those servers on port `53`.
|
||||
|
||||
To resolve Consul DNS requests when using HCP Consul Dedicated, we recommend running Consul clients and resolving DNS against the clients. If your use case cannot accomodate this recommendation, open a support ticket.
|
||||
To resolve Consul DNS requests when using HCP Consul Dedicated, we recommend running Consul clients and resolving DNS against the clients. If your use case cannot accommodate this recommendation, open a support ticket.
|
||||
|
||||
### HTTP
|
||||
|
||||
|
|
|
@ -465,4 +465,4 @@ Use of this method maps to Datadog as described in [Mapping Prometheus Metrics t
|
|||
|
||||
The integration, by default, uses a wildcard (`".*"`) to collect **_all_** metrics emitted from the `/v1/agent/metrics` endpoint.
|
||||
|
||||
Please refer to the [Agent Telemetry](https://developer.hashicorp.com/consul/docs/agent/telemetry) documentation for a full list and desription of the metrics data collected.
|
||||
Please refer to the [Agent Telemetry](https://developer.hashicorp.com/consul/docs/agent/telemetry) documentation for a full list and description of the metrics data collected.
|
||||
|
|
|
@ -269,7 +269,7 @@ Specifies the type of resource that the configuration applies to. To reference a
|
|||
| Parameter | Description | Data type | Default |
|
||||
| :------------ | :------------------------------------------------------------------- | :-------- | :------- |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object the resource applies to. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules`
|
||||
|
@ -353,7 +353,7 @@ Specifies the type of resource that the configuration routes traffic to. To refe
|
|||
| Parameter | Description | Data type | Default |
|
||||
| --- | --- | --- | --- |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object for the resource. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules.backendRefs.filters`
|
||||
|
@ -634,7 +634,7 @@ Specifies Envoy conditions that cause an automatic retry attempt.
|
|||
- Default: None
|
||||
- Data type: Map of strings
|
||||
|
||||
### `spec.rules.retries.onConnnectFailure`
|
||||
### `spec.rules.retries.onConnectFailure`
|
||||
|
||||
Enables an automatic retry attempt when a connection failure error occurs.
|
||||
|
||||
|
|
|
@ -277,7 +277,7 @@ Specifies the type of resource that the configuration applies to. To reference a
|
|||
| Parameter | Description | Data type | Default |
|
||||
| :------------ | :------------------------------------------------------------------- | :-------- | :------- |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object the resource applies to. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules`
|
||||
|
@ -360,7 +360,7 @@ Specifies the type of resource that the configuration routes traffic to. To refe
|
|||
|
||||
| Parameter | Description | Data type | Default |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object for the resource. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules.backendRefs.filters`
|
||||
|
@ -687,7 +687,7 @@ Specifies Envoy conditions that cause an automatic retry attempt.
|
|||
- Default: None
|
||||
- Data type: Map of strings
|
||||
|
||||
### `spec.rules.retries.onConnnectFailure`
|
||||
### `spec.rules.retries.onConnectFailure`
|
||||
|
||||
Enables an automatic retry attempt when a connection failure error occurs.
|
||||
|
||||
|
|
|
@ -196,7 +196,7 @@ Specifies the type of resource that the configuration applies to. To reference a
|
|||
| Parameter | Description | Data type | Default |
|
||||
| :------------ | :------------------------------------------------------------------- | :-------- | :------- |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object the resource applies to. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules`
|
||||
|
@ -280,7 +280,7 @@ Specifies the type of resource that the configuration routes traffic to. To refe
|
|||
| Parameter | Description | Data type | Default |
|
||||
| :------------ | :------------------------------------------------------------------- | :-------- | :------- |
|
||||
| `group` | Specifies a group for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `catalog`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubenretes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `groupVersion` | Specifies a groupVersion for the resource type within the Kubernetes cluster. To reference a service in the Consul catalog, set this parameter to `v2beta1`. | String | None |
|
||||
| `kind` | Specifies the kind of the Kubernetes object for the resource. To reference a service in the Consul catalog, set this parameter to `Service`. | String | None |
|
||||
|
||||
### `spec.rules.backendRefs.weight`
|
||||
|
|
|
@ -15,7 +15,7 @@ We are pleased to announce the following Consul updates.
|
|||
|
||||
The v2 Catalog API is currently available for Consul on Kubernetes deployments only. Refer to [Consul v2 architecture](/consul/docs/architecture/v2) for more information.
|
||||
|
||||
<Note> The v2 Catalog API and the Traffic Permssions API are in beta and under active development, so we do not recommend using them in production. </Note>
|
||||
<Note> The v2 Catalog API and the Traffic Permissions API are in beta and under active development, so we do not recommend using them in production. </Note>
|
||||
|
||||
- **Consul Long Term Support (LTS) (Enterprise):** Consul Enterprise users can now receive Long Term Support for approximately 2 years on some Consul releases, starting with Consul Enterprise v1.15. During the LTS window, eligible fixes are provided through a new minor release on the affected LTS release branch.
|
||||
|
||||
|
|
|
@ -62,7 +62,7 @@ Roles may contain the following attributes:
|
|||
- `Name`: A unique meaningful name for the role. You can specify the role `Name` when linking it to tokens.
|
||||
- `Description`: (Optional) A human-readable description of the role.
|
||||
- `Policies`: Specifies a the list of policies that are applicable for the role. The object can reference the policy `ID` or `Name` attribute.
|
||||
- `TemplatedPolicies`: Specifies a list of templated polcicies that are applicable for the role. See [Templated Policies](#templated-policies) for details.
|
||||
- `TemplatedPolicies`: Specifies a list of templated policies that are applicable for the role. See [Templated Policies](#templated-policies) for details.
|
||||
- `ServiceIdentities`: Specifies a list of services that are applicable for the role. See [Service Identities](#service-identities) for details.
|
||||
- `NodeIdentities`: Specifies a list of nodes that are applicable for the role. See [Node Identities](#node-identities) for details.
|
||||
- `Namespace`: <EnterpriseAlert inline /> The namespace that the policy resides in. Roles can only be linked to policies that are defined in the same namespace. See [Namespaces](/consul/docs/enterprise/namespaces) for additional information. Requires Consul Enterprise 1.7.0+
|
||||
|
|
|
@ -638,7 +638,7 @@ Read access to all imported nodes is granted when either of the following rule s
|
|||
- `service:write` is granted to any service.
|
||||
- `node:read` is granted to all nodes.
|
||||
|
||||
For Consul Enterprise, either set of rules must be scoped to the requesting services's partition and at least one namespace.
|
||||
For Consul Enterprise, either set of rules must be scoped to the requesting service's partition and at least one namespace.
|
||||
|
||||
You may need similarly scoped [Service Rules](#reading-imported-services) to read Consul data, depending on the endpoint (e.g. `/v1/health/service/:name`).
|
||||
These permissions are satisfied when using a [service identity](/consul/docs/security/acl/acl-roles#service-identities).
|
||||
|
@ -877,7 +877,7 @@ Read access to all imported services is granted when either of the following rul
|
|||
- `service:write` is granted to any service.
|
||||
- `service:read` is granted to all services.
|
||||
|
||||
For Consul Enterprise, either set of rules must be scoped to the requesting services's partition and at least one namespace.
|
||||
For Consul Enterprise, either set of rules must be scoped to the requesting service's partition and at least one namespace.
|
||||
|
||||
You may need similarly scoped [Node Rules](#reading-imported-nodes) to read Consul data, depending on the endpoint (e.g. `/v1/health/service/:name`).
|
||||
These permissions are satisfied when using a [service identity](/consul/docs/security/acl/acl-roles#service-identities).
|
||||
|
|
Loading…
Reference in New Issue