Add principal attributes description to Rule-based Auto-tagging documentation #11158
Conversation
ruai0511
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
In progress
ruai0511
force-pushed
the
security-attr
branch
from
802871f to
803cdde
Compare
ruai0511
force-pushed
the
security-attr
branch
from
803cdde to
485185f
Compare
|
|
||
| | Attribute | Data type | Description | Priority | | ||
| |:---------------------|:----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------| | ||
| | `principal.username` | List | A list of strings used to specify the usernames that should be matched to this rule. This attribute can only be used when the domain enables security plugin and only support exact matching. | 1 | |
There was a problem hiding this comment.
Giving the priority might be confusing since user never sets it rather it is implicit, hence I think rephrasing it with something like following table defines the priority order of the attributes in decreasing order. The priority here is implicit and can't be modified by the user
ruai0511
force-pushed
the
security-attr
branch
from
485185f to
f258cc9
Compare
kolchfa-aws
added
Tech review
|
Lets also add couple of examples around tie breaking mechanism in the autotagging guide |
Signed-off-by: Ruirui Zhang <[email protected]>
ruai0511
force-pushed
the
security-attr
branch
from
f258cc9 to
6eb4da2
Compare
kolchfa-aws
added
Doc review
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
added
Editorial review
_tuning-your-cluster/availability-and-recovery/rule-based-autotagging/autotagging.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/rule-based-autotagging/autotagging.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/rule-based-autotagging/autotagging.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/workload-management/workload-group-rules.md
Outdated
Show resolved
Hide resolved
_tuning-your-cluster/availability-and-recovery/workload-management/workload-group-rules.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Nathan Bower <[email protected]>
4 participants
Description
Currently Rule-based Auto-tagging documentation page only contains documentation for index_pattern attribute. We're adding new principal attributes in OS 3.3, so this PR update the documentation to reflect this.
Issues Resolved
Closes #11134
Version
3.3+
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.