From b5edf5cd10537871c21b2954e7e3542a4bbaebf2 Mon Sep 17 00:00:00 2001 From: cskh Date: Tue, 5 Dec 2023 14:21:52 -0500 Subject: [PATCH] doc: clarify the portNames used in trafficpermission V2 (#19807) * doc: clarify the portNames used in trafficpermission V2 and fix broken links and examples --- .../reference/trafficpermissions.mdx | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/website/content/docs/k8s/multiport/reference/trafficpermissions.mdx b/website/content/docs/k8s/multiport/reference/trafficpermissions.mdx index 0eae49e88b..19e8a20ace 100644 --- a/website/content/docs/k8s/multiport/reference/trafficpermissions.mdx +++ b/website/content/docs/k8s/multiport/reference/trafficpermissions.mdx @@ -24,10 +24,10 @@ The following list outlines field hierarchy, language-specific data types, and r - [`identityName`](#spec-destination-identityname): string - [`action`](#spec-action): string - [`permissions`](#spec-permissions): list of maps - - [`sources`](#spec-permissions-sources): map + - [`sources`](#spec-permissions-sources): list of maps - [`identityName`](#spec-permissions-sources-identityname): string - - [`destinationRules`](#spec-permissions-destinationrules): - - [`portNames`](#spec-permissions-destinationrules-portNames): array of strings + - [`destinationRules`](#spec-permissions-destinationrules): list of maps + - [`portNames`](#spec-permissions-destinationrules-portnames): array of strings ## Complete configuration @@ -45,10 +45,10 @@ spec: action: allow permissions: - sources: - identityName: - destinationRules: - portNames: - - + - identityName: + destinationRules: + - portNames: + - ``` ## Specification @@ -163,7 +163,7 @@ To specify wildcard references in this block using `*`, omit all other fields. F #### Values - Default: None -- Data type: Map +- Data type: List of maps ### `spec.permissions.sources.identityName` @@ -172,7 +172,7 @@ Specifies the Workload identity for the service that originates the request. #### Values - Default: None -- Data type: Map +- Data type: String ### `spec.permissions.destinationRules` @@ -185,11 +185,11 @@ When [`spec.action`](#spec-action) _denies traffic_, Consul denies authorization #### Values - Default: None -- Data type: Map +- Data type: List of maps ### `spec.permissions.destinationRules.portNames` -Specifies a port name that the Kubernetes Service exposes at the destination. +Specifies a port name that the Kubernetes Pod's container exposes at the destination. #### Values