Update docs with Source.Peer field (#13463)

This commit is contained in:
Chris S. Kim 2022-06-16 09:30:05 -04:00 committed by GitHub
parent 082bc3632b
commit 4b0ffb227a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 10 deletions

View File

@ -446,25 +446,35 @@ spec:
}, },
}, },
{ {
name: 'Namespace', name: 'Peer',
enterprise: true, type: 'string: ""',
type: 'string',
description: { description: {
hcl: hcl:
"The namespace of the source service. Defaults to the namespace of the destination service (i.e. the config entry's namespace)", "Specifies the [peer](/docs/connect/cluster-peering/index.mdx) of the source service. `Peer` is mutually exclusive with `Partition`.",
yaml: yaml:
'The namespace of the source service. Defaults to the namespace of the destination service (i.e. `spec.destination.namespace`)', "Specifies the [peer](/docs/connect/cluster-peering/index.mdx) of the source service. `peer` is mutually exclusive with `partition`.",
},
},
{
name: 'Namespace',
enterprise: true,
type: 'string: ""',
description: {
hcl:
"The namespace of the source service. If `Peer` is empty, `Namespace` defaults to the namespace of the destination service (i.e. the config entry's namespace).",
yaml:
'The namespace of the source service. If `peer` is empty, `namespace` defaults to the namespace of the destination service (i.e. `spec.destination.namespace`).',
}, },
}, },
{ {
name: 'Partition', name: 'Partition',
enterprise: true, enterprise: true,
type: 'string', type: 'string: ""',
description: { description: {
hcl: hcl:
"Specifies the admin partition of the source service. Defaults to the destination service's partition, i.e., the configuration entry's partition", "Specifies the admin partition of the source service. If `Peer` is empty, `Partition` defaults to the destination service's partition (i.e. the configuration entry's partition). `Partition` is mutually exclusive with `Peer`.",
yaml: yaml:
"Specifies the admin partition of the source service. Defaults to the destination service's partition, i.e. `spec.destination.partition`", "Specifies the admin partition of the source service. If `peer` is empty, `partition` defaults to the destination service's partition (i.e. `spec.destination.partition`). `partition` is mutually exclusive with `peer`.",
}, },
}, },
{ {