removed Consul requirements from documentation as it may be confusing (#15958)
* removed Consul requirements from documentation as it may be confusing
This commit is contained in:
Michael Wilkerson
GitHub
parent
04673cb6e4
commit
d224744f6a
|
|
@ -18,8 +18,6 @@ To configure Consul to export services contained in a Consul Enterprise admin pa
|
|||
You can configure the settings defined in the `exported-services` configuration entry to apply to all namespaces in a Consul Enterprise admin partition.
|
||||
|
||||
## Requirements
|
||||
|
||||
- A 1.11.0+ Consul Enterprise binary or a 1.13.0+ Consul OSS binary.
|
||||
- **Enterprise Only**: A corresponding partition that the configuration entry can export from. For example, the `exported-services` configuration entry for a partition named `frontend` requires an existing `frontend` partition.
|
||||
|
||||
## Usage
|
||||
|
|
@ -661,7 +659,7 @@ The following example queries the `finance` peer for the imported `payments` ser
|
|||
```shell-session
|
||||
$ curl 'localhost:8500/v1/health/service/payments?peer=finance'
|
||||
```
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
- `service:write` permissions for any service.
|
||||
- `service:read` and `node:read` for all services and nodes, respectively.
|
||||
|
||||
|
|
@ -695,7 +693,7 @@ node_prefix "" {
|
|||
}
|
||||
}
|
||||
|
||||
## OR
|
||||
## OR
|
||||
|
||||
{
|
||||
"service_prefix": {
|
||||
|
|
@ -724,7 +722,7 @@ The following example queries the `finance` partition for the imported `payments
|
|||
$ curl 'localhost:8500/v1/health/service/payments?partition=finance'
|
||||
```
|
||||
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
- `service:write` permissions for any service in the partition where the query is made.
|
||||
- `service:read` and `node:read` for all services and nodes, respectively, in any namespace and the exact partition where the query is made.
|
||||
|
||||
|
|
@ -775,7 +773,7 @@ partition "frontend" {
|
|||
}
|
||||
}
|
||||
|
||||
## OR
|
||||
## OR
|
||||
|
||||
{
|
||||
"partition": {
|
||||
|
|
@ -812,7 +810,7 @@ The following example queries the `finance` peer for the imported `payments` ser
|
|||
$ curl 'localhost:8500/v1/health/service/payments?peer=finance'
|
||||
```
|
||||
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
An ACL token with either of the following permissions is required in the cluster where the query is made:
|
||||
- `service:write` permissions for any service in the partition where the query is made.
|
||||
- `service:read` and `node:read` for all services and nodes, respectively, in any namespace and the exact partition where the query is made.
|
||||
|
||||
|
|
@ -863,7 +861,7 @@ partition "frontend" {
|
|||
}
|
||||
}
|
||||
|
||||
## OR
|
||||
## OR
|
||||
|
||||
{
|
||||
"partition": {
|
||||
|
|
|
|||
|
|
@ -17,11 +17,6 @@ Refer to the [Kubernetes Ingress Gateway](/docs/k8s/connect/ingress-gateways) do
|
|||
|
||||
For other platforms, see [Ingress Gateway](/docs/connect/gateways/ingress-gateway).
|
||||
|
||||
## Requirements
|
||||
|
||||
- Consul versions 1.8.4+ is required to use the `IngressGateway` custom resource on Kubernetes.
|
||||
- Consul versions 1.8.0+ is required to use the `ingress-gateway` custom resource on all other platforms.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Verify that your datacenter meets the conditions specified in the [Requirements](#requirements).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ description: >-
|
|||
The `proxy-defaults` configuration entry (`ProxyDefaults` on Kubernetes) allows you to globally configure passthrough Envoy settings for proxies in the service mesh, including both sidecars and gateways.
|
||||
It is different from the [`mesh` configuration entry](/docs/connect/config-entries/mesh), which sets Consul features for cluster peering, transparent proxy, and TLS behavior that also affect Consul servers.
|
||||
|
||||
Only one global entry is supported.
|
||||
Only one global entry is supported.
|
||||
For Consul Enterprise, only the global entry in the `default` partition is recognized.
|
||||
|
||||
## Introduction
|
||||
|
|
@ -22,12 +22,6 @@ with the [`service-defaults`](/docs/connect/config-entries/service-defaults)
|
|||
configuration entry `kind` or for individual proxy instances in their [sidecar
|
||||
service definitions](/docs/connect/registration/sidecar-service).
|
||||
|
||||
## Requirements
|
||||
|
||||
The following Consul binaries are supported:
|
||||
* Consul 1.8.4+ on Kubernetes.
|
||||
* Consul 1.5.0+ on other platforms.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Verify that your datacenter meets the conditions specified in the [Requirements](#requirements).
|
||||
|
|
@ -480,7 +474,7 @@ spec:
|
|||
{
|
||||
name: 'AccessLogs',
|
||||
type: 'AccessLogsConfig: <optional>',
|
||||
description: `Controls the configuration of [Envoy's access logging](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/access_logging.html?highlight=access%20logs)
|
||||
description: `Controls the configuration of [Envoy's access logging](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/access_logging.html?highlight=access%20logs)
|
||||
for all proxies in the mesh, including gateways. It also configures access logs on [Envoy's administration interface](https://www.envoyproxy.io/docs/envoy/latest/operations/admin.html?highlight=administration%20logs).`,
|
||||
children: [
|
||||
{
|
||||
|
|
@ -510,15 +504,15 @@ spec:
|
|||
type: 'string: (default as follows)',
|
||||
description: `A JSON-formatted string that represents the format of each emitted access log.
|
||||
By default, it is set to the [default access log format](/consul/docs/connect/observability/access-logs#default-log-format).
|
||||
You can use Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) to customize the emitted data.
|
||||
Nesting is supported.
|
||||
You can use Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) to customize the emitted data.
|
||||
Nesting is supported.
|
||||
Invalid if a custom format is specified with TextFormat.`,
|
||||
},
|
||||
{
|
||||
name: 'TextFormat',
|
||||
type: 'string: ""',
|
||||
description: `A formatted string that represents the format of each emitted access log.
|
||||
Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used to customize the data emitted.
|
||||
Envoy [command operators](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators) can be used to customize the data emitted.
|
||||
A new line is added to the string automatically.
|
||||
Invalid when a custom JSONFormat is already specified.`,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,10 +6,6 @@ description: >-
|
|||
---
|
||||
|
||||
# Service Defaults Configuration Entry
|
||||
|
||||
-> **v1.8.4+:** On Kubernetes, the `ServiceDefaults` custom resource is supported in Consul versions 1.8.4+.<br />
|
||||
**v1.5.0+:** On other platforms, this config entry is supported in Consul versions 1.5.0+.
|
||||
|
||||
The `service-defaults` config entry kind (`ServiceDefaults` on Kubernetes) controls default global values for a
|
||||
service, such as its protocol.
|
||||
|
||||
|
|
|
|||
|
|
@ -18,11 +18,6 @@ service of the same name.
|
|||
|
||||
- Consul [service mesh connect](/docs/connect/configuration) enabled services
|
||||
- Service to service communication over the protocol `http`
|
||||
- Consul 1.8.4+ on Kubernetes.
|
||||
- Consul 1.5.0+ on other platforms.
|
||||
|
||||
-> **v1.8.4+:** On Kubernetes, the `ServiceRouter` custom resource is supported in Consul versions 1.8.4+.<br />
|
||||
**v1.6.0+:** On other platforms, this config entry is supported in Consul versions 1.6.0+.
|
||||
|
||||
## Interaction with other Config Entries
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue