luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #11945 from hashicorp/docs/exported-services-language-issues 

tweaks to the language used in the requirements section
This commit is contained in:
trujillo-adam 2022-01-06 07:26:39 -08:00 committed by GitHub
parent dcda97cdcc ea2ae4b637
commit 1769d2594d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
website/content/docs/connect/config-entries/exported-services.mdx
View File

@ -22,17 +22,16 @@ You can configure the settings defined in the `exported-services` configuration
## Requirements ## Requirements
* A Consul Enterprise binary - A Consul Enterprise binary
* A partition that corresponds to the configuration entry. As in, the exported services config entry for partition "frontend" requires that the "frontend" partition exists - A corresponding partition that the configuration entry can export to. For example, the `exported-services` configuration entry for a partition named `frontend` requires an existing `frontend` partition.
## Usage ## Usage
1. Verify that your datacenter meets the conditions specified in the [Requirements](#requirements). 1. Verify that your datacenter meets the conditions specified in the [Requirements](#requirements).
1. Specify the `exported-services` configuration in the agent configuration file (see [`config_entries`](/docs/agent/options#config_entries)) as described in [Configuration](#configuration). 1. Specify the `exported-services` configuration in the agent configuration file (see [`config_entries`](/docs/agent/options#config_entries)) as described in [Configuration](#configuration).
1. Apply the configuration using one of the following methods: 1. Apply the configuration using one of the following methods:
* Kubernetes CRD: Refer to the [Custom Resource Definitions](/docs/k8s/crds) documentation for details. - Kubernetes CRD: Refer to the [Custom Resource Definitions](/docs/k8s/crds) documentation for details.
* Issue the `consul config write` command: Refer to the [Consul Config Write](/commands/config/write) documentation for details. - Issue the `consul config write` command: Refer to the [Consul Config Write](/commands/config/write) documentation for details.
## Configuration ## Configuration
@ -57,6 +56,7 @@ Services = [
} }
] ]
``` ```
</CodeBlockConfig> </CodeBlockConfig>
<CodeBlockConfig> <CodeBlockConfig>
@ -67,11 +67,12 @@ metadata:
name: <partition containing services to export> name: <partition containing services to export>
spec: spec:
services: services:
- name: <name of service to export> - name: <name of service to export>
namespace: <namespace in the partition containing the service to export> namespace: <namespace in the partition containing the service to export>
consumers: consumers:
- partition: <name of the partition that will dial the exported service> - partition: <name of the partition that will dial the exported service>
``` ```
</CodeBlockConfig> </CodeBlockConfig>
<CodeBlockConfig> <CodeBlockConfig>
@ -91,6 +92,7 @@ spec:
} }
] ]
``` ```
</CodeBlockConfig> </CodeBlockConfig>
</CodeTabs> </CodeTabs>
@ -98,21 +100,21 @@ spec:
The following table describes the parameters associated with the `exported-services` configuration entry. The following table describes the parameters associated with the `exported-services` configuration entry.
| Parameter | Description | Required | Default | | Parameter | Description | Required | Default |
| --- | --- | --- | --- | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| `Kind` | String value that enables the configuration entry. The value should always be `exported-services` (HCL and JSON) or `ExportedServices` (YAML) | Required | None | | `Kind` | String value that enables the configuration entry. The value should always be `exported-services` (HCL and JSON) or `ExportedServices` (YAML) | Required | None |
| `Partition` | String value that specifies the name of the partition that contains the services you want to export. | Required | None | | `Partition` | String value that specifies the name of the partition that contains the services you want to export. | Required | None |
| `Name` | String value that specifies the name of the partition that contains the services you want to export. | Required | None | | `Name` | String value that specifies the name of the partition that contains the services you want to export. | Required | None |
| `Services` | List of objects that specify which services to export. See [`Services`](#services) for details. | Required | None| | `Services` | List of objects that specify which services to export. See [`Services`](#services) for details. | Required | None |
| `Meta` | Object that defines a map of the max 64 key/value pairs. | Optional | None | | `Meta` | Object that defines a map of the max 64 key/value pairs. | Optional | None |
### Services ### Services
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: 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. - `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 namespace 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. - `Consumers`: Specifies one ore more objects that identify a destination partition for the exported services.
## Example ## Example
@ -161,15 +163,15 @@ metadata:
name: finance name: finance
spec: spec:
services: services:
- name: mesh-gateway - name: mesh-gateway
namespace: default namespace: default
consumers: consumers:
- partition: default - partition: default
- name: billing - name: billing
namespace: default namespace: default
consumers: consumers:
- partition: frontend - partition: frontend
- partition: backend - partition: backend
``` ```
</CodeBlockConfig> </CodeBlockConfig>