mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Add docs for remote indices (#156510)
Resolves #155289 ~~Todo: Add link to ES remote indices docs once available (https://github.com/elastic/kibana/pull/154948#discussion_r1169266451)~~ Update: I don't think there's a better page to link to right now so will leave as is. We can always change it in the future.
This commit is contained in:
parent
2eb46924cb
commit
85595ca8ab
5 changed files with 84 additions and 100 deletions
|
@ -26,7 +26,7 @@ To use the create or update role API, you must have the `manage_security` cluste
|
|||
|
||||
`elasticsearch`::
|
||||
(Optional, object) {es} cluster and index privileges. Valid keys include
|
||||
`cluster`, `indices`, and `run_as`. For more information, see
|
||||
`cluster`, `indices`, `remote_indices`, and `run_as`. For more information, see
|
||||
{ref}/defining-roles.html[Defining roles].
|
||||
|
||||
`kibana`::
|
||||
|
@ -63,7 +63,7 @@ To use the create or update role API, you must have the `manage_security` cluste
|
|||
`204`::
|
||||
Indicates a successful call.
|
||||
|
||||
'409'::
|
||||
`409`::
|
||||
When `createOnly` is true, indicates a conflict with an existing role.
|
||||
|
||||
==== Examples
|
||||
|
@ -74,60 +74,32 @@ Grant access to various features in all spaces:
|
|||
--------------------------------------------------
|
||||
$ curl -X PUT api/security/role/my_kibana_role
|
||||
{
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
"metadata": {
|
||||
"version": 1
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ ],
|
||||
"indices" : [ ]
|
||||
"cluster": [ ],
|
||||
"indices": [ ]
|
||||
},
|
||||
"kibana": [
|
||||
{
|
||||
"base": [],
|
||||
"base": [ ],
|
||||
"feature": {
|
||||
"discover": [
|
||||
"all"
|
||||
],
|
||||
"visualize": [
|
||||
"all"
|
||||
],
|
||||
"dashboard": [
|
||||
"all"
|
||||
],
|
||||
"dev_tools": [
|
||||
"read"
|
||||
],
|
||||
"advancedSettings": [
|
||||
"read"
|
||||
],
|
||||
"indexPatterns": [
|
||||
"read"
|
||||
],
|
||||
"graph": [
|
||||
"all"
|
||||
],
|
||||
"apm": [
|
||||
"read"
|
||||
],
|
||||
"maps": [
|
||||
"read"
|
||||
],
|
||||
"canvas": [
|
||||
"read"
|
||||
],
|
||||
"infrastructure": [
|
||||
"all"
|
||||
],
|
||||
"logs": [
|
||||
"all"
|
||||
],
|
||||
"uptime": [
|
||||
"all"
|
||||
]
|
||||
"discover": [ "all" ],
|
||||
"visualize": [ "all" ],
|
||||
"dashboard": [ "all" ],
|
||||
"dev_tools": [ "read" ],
|
||||
"advancedSettings": [ "read" ],
|
||||
"indexPatterns": [ "read" ],
|
||||
"graph": [ "all" ],
|
||||
"apm": [ "read" ],
|
||||
"maps": [ "read" ],
|
||||
"canvas": [ "read" ],
|
||||
"infrastructure": [ "all" ],
|
||||
"logs": [ "all" ],
|
||||
"uptime": [ "all" ]
|
||||
},
|
||||
"spaces": [
|
||||
"*"
|
||||
]
|
||||
"spaces": [ "*" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -140,22 +112,20 @@ Grant dashboard-only access to only the Marketing space:
|
|||
--------------------------------------------------
|
||||
$ curl -X PUT api/security/role/my_kibana_role
|
||||
{
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
"metadata": {
|
||||
"version": 1
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ ],
|
||||
"indices" : [ ]
|
||||
"cluster": [ ],
|
||||
"indices": [ ]
|
||||
},
|
||||
"kibana": [
|
||||
{
|
||||
"base": [],
|
||||
"base": [ ],
|
||||
"feature": {
|
||||
"dashboard": ["read"]
|
||||
"dashboard": [ "read" ]
|
||||
},
|
||||
"spaces": [
|
||||
"marketing"
|
||||
]
|
||||
"spaces": [ "marketing" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -168,21 +138,18 @@ Grant full access to all features in the Default space:
|
|||
--------------------------------------------------
|
||||
$ curl -X PUT api/security/role/my_kibana_role
|
||||
{
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
"metadata": {
|
||||
"version": 1
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ ],
|
||||
"indices" : [ ]
|
||||
"cluster": [ ],
|
||||
"indices": [ ]
|
||||
},
|
||||
"kibana": [
|
||||
{
|
||||
"base": ["all"],
|
||||
"feature": {
|
||||
},
|
||||
"spaces": [
|
||||
"default"
|
||||
]
|
||||
"base": [ "all" ],
|
||||
"feature": { },
|
||||
"spaces": [ "default" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -195,30 +162,25 @@ Grant different access to different spaces:
|
|||
--------------------------------------------------
|
||||
$ curl -X PUT api/security/role/my_kibana_role
|
||||
{
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
"metadata": {
|
||||
"version": 1
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ ],
|
||||
"indices" : [ ]
|
||||
"cluster": [ ],
|
||||
"indices": [ ]
|
||||
},
|
||||
"kibana": [
|
||||
{
|
||||
"base": [],
|
||||
"base": [ ],
|
||||
"feature": {
|
||||
"discover": ["all"],
|
||||
"dashboard": ["all"]
|
||||
"discover": [ "all" ],
|
||||
"dashboard": [ "all" ]
|
||||
},
|
||||
"spaces": [
|
||||
"default"
|
||||
]
|
||||
"spaces": [ "default" ]
|
||||
},
|
||||
{
|
||||
"base": ["read"],
|
||||
"spaces": [
|
||||
"marketing",
|
||||
"sales"
|
||||
]
|
||||
"base": [ "read"] ,
|
||||
"spaces": [ "marketing", "sales" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -231,28 +193,30 @@ Grant access to {kib} and {es}:
|
|||
--------------------------------------------------
|
||||
$ curl -X PUT api/security/role/my_kibana_role
|
||||
{
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
"metadata": {
|
||||
"version": 1
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ "all" ],
|
||||
"indices" : [ {
|
||||
"names" : [ "index1", "index2" ],
|
||||
"privileges" : [ "all" ],
|
||||
"field_security" : {
|
||||
"grant" : [ "title", "body" ]
|
||||
},
|
||||
"query" : "{\"match\": {\"title\": \"foo\"}}"
|
||||
} ]
|
||||
"cluster": [ "all" ],
|
||||
"indices": [
|
||||
{
|
||||
"names": [ "index1", "index2" ],
|
||||
"privileges": [ "all" ]
|
||||
}
|
||||
],
|
||||
"remote_indices": [
|
||||
{
|
||||
"clusters": [ "remote_cluster1" ],
|
||||
"names": [ "remote_index1", "remote_index2" ],
|
||||
"privileges": [ "all" ]
|
||||
}
|
||||
]
|
||||
},
|
||||
"kibana": [
|
||||
{
|
||||
"base": ["all"],
|
||||
"feature": {
|
||||
},
|
||||
"spaces": [
|
||||
"default"
|
||||
]
|
||||
"base": [ "all" ],
|
||||
"feature": { },
|
||||
"spaces": [ "default" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
@ -75,6 +75,26 @@ NOTE: {kib} automatically surrounds your DLS query with a `query` block, so you
|
|||
[role="screenshot"]
|
||||
image::security/images/create-role-dls-example.png[Create role with DLS index privileges]
|
||||
|
||||
[[adding_remote_index_privileges]]
|
||||
==== Remote index privileges
|
||||
|
||||
If you have at least a platinum license, you can manage access to indices in remote clusters.
|
||||
|
||||
You can assign the same privileges, document-level, and field-level as for <<adding_index_privileges,local index privileges>>.
|
||||
|
||||
[[remote_index_privilege_example_1]]
|
||||
===== Example: Grant access to indices in remote clusters
|
||||
|
||||
. Go to **Stack Management > Roles**, and then click **Create role**.
|
||||
. In **Remote index privileges**, enter:
|
||||
.. The name of your remote cluster in the **Remote clusters** field.
|
||||
.. The name of the index in your remote cluster in the **Remote indices** field.
|
||||
.. The allowed actions in the **Privileges** field. (e.g. `read` and `view_index_metadata`)
|
||||
|
||||
[role="screenshot"]
|
||||
image::security/images/create-role-remote-index-example.png[Create role with remote index privileges]
|
||||
|
||||
|
||||
[[adding_kibana_privileges]]
|
||||
==== {kib} privileges
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 261 KiB |
Binary file not shown.
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 227 KiB |
BIN
docs/user/security/images/create-role-remote-index-example.png
Normal file
BIN
docs/user/security/images/create-role-remote-index-example.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 245 KiB |
Loading…
Add table
Add a link
Reference in a new issue