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

Merge pull request #11839 from hashicorp/export-config-name-docs 

docs: Update exported-services page to include required Name field
This commit is contained in:
Kyle Havlovitz 2021-12-14 12:30:06 -08:00 committed by GitHub
parent 6a97a5d02e e964cb37cf
commit 8701ff7a62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -42,6 +42,7 @@ Configure the following parameters to define a `exported-services` configuration
```hcl ```hcl
Kind = "exported-services" Kind = "exported-services"
Partition = "<partition containing services to export>" Partition = "<partition containing services to export>"
Name = "<partition containing services to export>"
Services = [ Services = [
{ {
Name = "<name of service to export>" Name = "<name of service to export>"
@ -61,6 +62,7 @@ Services = [
apiVersion: consul.hashicorp.com/v1alpha1 apiVersion: consul.hashicorp.com/v1alpha1
Kind: ExportedServices Kind: ExportedServices
Partition: <partition containing services to export> Partition: <partition containing services to export>
Name: <partition containing services to export>
Services: Services:
- Consumers: - Consumers:
- Partition: <name of the partition that will dial the exported service> - Partition: <name of the partition that will dial the exported service>
@ -73,6 +75,7 @@ Services:
```json ```json
"Kind": "exported-services", "Kind": "exported-services",
"Partition": "<partition containing services to export>", "Partition": "<partition containing services to export>",
"Name": "<partition containing services to export>",
"Services": [ "Services": [
{ {
"Consumers": [ "Consumers": [
@ -96,6 +99,7 @@ The following table describes the parameters associated with the `exported-servi
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `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 |
| `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 |
@ -117,6 +121,7 @@ The following example configures the agent to export the `billing` service from
```hcl ```hcl
Kind = "exported-services" Kind = "exported-services"
Partition = "finance" Partition = "finance"
Name = "finance"
Services = [ Services = [
{ {
@ -149,6 +154,7 @@ Services = [
```yaml ```yaml
Kind: exported-services Kind: exported-services
Partition: finance Partition: finance
Name: finance
Services: Services:
- Consumers: - Consumers:
- Partition: frontend - Partition: frontend
@ -167,6 +173,7 @@ Services:
```json ```json
"Kind": "exported-services", "Kind": "exported-services",
"Partition": "finance", "Partition": "finance",
"Name": "finance",
"Services": [ "Services": [
{ {
"Consumers": [ "Consumers": [