status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-09 13:26:07 +00:00
Code Issues Projects Releases Wiki Activity

applied freddy's feedback

Browse Source
This commit is contained in:
trujillo-adam 2021-11-16 10:44:21 -08:00
parent 91e44f488d
commit 756e65cbcb
3 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
website/content/docs/connect/config-entries/partition-exports.mdx
View File

@ -3,8 +3,7 @@ layout: docs
page_title: 'Configuration Entry Kind: Partition Exports'
description: >-
The partition-exports configuration entry enables you to export services from a single file.
Settings in this config entry apply across all namespaces and federated datacenters.
Write access to the mesh resource is required.
Settings in this configuration entry can apply to services in any namespace of the specified partition. Write access to the mesh resource is required.
---
# Partition Exports
@ -15,23 +14,25 @@ This topic describes the `partition-exports` configuration entry type. The `part
## Introduction
You can configure Consul to export services contained in an admin partition to one or more additional partitions by declaring the `partition-exports` configuration entry in the `kind` field. This enables you to route traffic between services in different clusters when a single set of Consul servers running on each cluster are jonied using WAN federation.
You can configure Consul to export services contained in an admin partition to one or more additional partitions by declaring the `partition-exports` configuration entry in the `kind` field. This enables you to route traffic between services in different clusters that share a single set of Consul servers.
The settings defined in the `partition-exports` configuration entry apply to all namespaces and federated datacenters.
TO DO: More background info and info about the use case(s).
You can configure the settings defined in the `partition-exports` configuration entry to apply to all namespaces and federated datacenters.
## Requirements
The consumer partition must have an `upstream` configuration that specifies the destination for the services. Refer to the [Upstream Configuration Reference](/docs/connect/registration/service-registration#upstream-configuration-reference) for information on how to configure the upstream.
* A Consul Enterprise binary
* A partition that corresponds to the configuration entry. As in, the partition exports config entry for partition "frontend" requires that the "frontend" partition exists
## Usage
1. Verify that your datacenter meets the conditions specified in the [Requirements](#requirements).
1. Specify the `partition-exports` configuration in the agent configuration file as described in [Configuration](#configuration).
1. Deploy the configuration per your runtime:
* [VM](/docs/install)
* [Kubernetes](/docs/k8s/installation/install)
* [VM](docs/install)
* [Kubernetes](docs/k8s/installation/install)
* [HTTP API](api-docs/config#apply-configuration)
* [CLI](commands/config/write)
## Configuration
@ -46,7 +47,7 @@ Partition = "<partition containing services to export>"
Services = [
{
Name = "<name of service to export>"
Namespace = "<namespace of namespace in the partition>"
Namespace = "<namespace in the partition containing the service to export>"
Consumers = [
{
Partition = "<name of destination partition>"
@ -66,7 +67,7 @@ Services:
- Consumers:
- Partition: <name of destination partition>
Name: <name of service to export>
Namespace: <namespace of namespace in the partition>
Namespace: <namespace in the partition containing the service to export>
```
</CodeBlockConfig>
<CodeBlockConfig>
@ -78,11 +79,11 @@ Services:
{
"Consumers": [
{
"Partition": "<name of destination partition>"
"Partition": "<name of partition that will dial the exported service>"
}
],
"Name": "<name of service to export>",
"Namespace": "<namespace of namespace in the partition>"
"Namespace": "<namespace in the partition containing the service to export>"
}
]
```
@ -105,7 +106,7 @@ The following table describes the parameters associated with the `partition-expo
The `Services` parameter contains one or more lists of parameters that specify which services to export, which namespaces the services reside, and the destination partition for the exported services. Each list in the `Services` block must contain the following parameters:
* `Name`: Specifies the name of the service to export. You can use a asterisk wildcard (`*`) to include all services in the namespace.
* `Namespace`: Specifies the name space containing the services to export. You can use a asterisk wildcard (`*`) to include all namespaces in the partition.
* `Namespace`: Specifies the namespace containing the services to export. You can use a asterisk wildcard (`*`) to include all namespaces in the partition.
* `Consumers`: Specifies one ore more objects that identify a destination partition for the exported services.
## Example
@ -204,4 +205,8 @@ When an exported service has been imported to another partition, you can use the
$ curl 'localhost:8500/v1/health/connect/billing?partition=finance'
```
An ACL token with `service:write` permissions is required for the partition from which the query is made. If the call in the previous example is made from a service named `web` in a partition named `frontend`, then the request will require a token with `write` permissions to `web` in the `frontend` partition.
Exports are available to all services in the consumer partition. In the previous example, any service with `write` permissions for the `frontend` partition will be able to read exports.
See [Health HTTP Endpoing](/api-docs/health) for additional information.

7
website/content/docs/connect/registration/service-registration.mdx
View File

@ -9,7 +9,7 @@ description: >-
# Proxy Service Registration
This topic describes how to declare a proxy as a `connect-proxy` in service definitions. The type must be declared and information about the service they represent must be provided to function as a Consul service mesh proxy.
This topic describes how to declare a proxy as a `connect-proxy` in service definitions. The `kind` must be declared and information about the service they represent must be provided to function as a Consul service mesh proxy.
## Configuration
@ -22,7 +22,7 @@ Configure a service mesh proxy using the following syntax:
name = <name of the service>
kind = "connect-proxy"
proxy = {
destination_service_name = "<name of the services that the proxy represents>"
destination_service_name = "<name of the service that the proxy represents>"
<additional proxy parameters> = "<additional parameter values>"
}
port = <port where services can discover and connect to proxied services>
@ -36,7 +36,8 @@ port = <port where services can discover and connect to proxied services>
"name": "<name of the service>",
"kind": "connect-proxy",
"proxy": {
"destination_service_name": "<name of the services that the proxy represents>","<additional proxy parameters>" : "<additional parameter values>"
"destination_service_name": "<name of the service that the proxy represents>",
"<additional proxy parameters>" : "<additional parameter values>"
},
"port": <port where services can discover and connect to proxied services>
}

2
website/content/docs/enterprise/admin-partitions.mdx
View File

@ -55,7 +55,7 @@ Values specified for [`proxy-defaults`](docs/connect/config-entries/proxy-defaul
### Cross-partition Networking
You can configure services to be discoverable and accessible by upstream services in any partition within the datacenter. Specify upstream services contained in other partitions by configuring the `partition-exports` configuration entry for the agent in the source partition. Refer to the [`partition-exports` documentation](docs/connect/config-entries/partition-exports) for details.
You can configure services to be discoverable and accessible by downstream services in any partition within the datacenter. Specify the upstream services that you want to be available for discovery by configuring the `partition-exports` configuration entry in the partition where the services are registered. Refer to the [`partition-exports` documentation](docs/connect/config-entries/partition-exports) for details.
Additionally, the `upstreams` configuration for proxies in the source partition must specify the name of the destination partition so that listeners can be created. Refer to the [Upstreamd Configuration Reference](docs/connect/registration/service-registration#upstream-configuration-reference) for additional information.