Skip to content

Commit 8310030

Browse files
committed
Documentation : Transport action type strings.
1 parent f6c71ed commit 8310030

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/internal/GeneralArchitectureGuide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,10 +129,12 @@ The actions themselves sometimes dispatch downstream actions to other nodes in t
129129
> TransportActions' [ActionType] naming conventions encode semantic information about the role, scope, plugins, modules and behaviours.
130130
> [ActionType] instances are mapped to permission privileges via the [ClusterPrivilegeResolver]. Security interceptors enforce access
131131
> control by invoking RBACEngine.checkPrivileges().
132-
>
133132
> Indices-level [ActionType] strings generally follows the pattern: `indices:[data|admin|monitor]/[read|write|get]/[index|bulk|update]`.
134133
> Cluster-level [ActionType] strings are prefixed by `cluster:` are often followed by a domain-specific such as `autoscaling`, `logstash`, `ingest`,
135134
> `xpack`.
135+
> - `internal:` is meant to executed by `_system` user.
136+
> - `cluster:internal/xpack/..` [ActionType] strings are plugin specific.
137+
> - `internal:transport/proxy/indices:` [ActionType] strings are automatically wrapped actions when requests for CCR/CCS in proxy mode.
136138
137139
> [!NOTE]
138140
> The name [TransportAction] can be misleading, as it suggests they are all invoke-able and invoked via the TCP transport. In fact,

0 commit comments

Comments
 (0)