Skip to content

Commit

Permalink
Add role info to uptime docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewvc committed Mar 5, 2019
1 parent fc493fd commit 90d8883
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/uptime/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ from Heartbeat 7.0.

include::overview.asciidoc[]
include::monitor.asciidoc[]
include::security.asciidoc[]
69 changes: 69 additions & 0 deletions docs/uptime/security.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
[role="xpack"]
[[uptime-security]]

== Use with Elasticsearch Security

If you have Elasticsearch security enabled you'll need to enable certain privileges for users
that would like to access the Uptime app. In this document we'll show an example of creating
a user and support role to implement those privileges.

=== Creating the Role

You'll need a role that lets you access the Heartbeat indices, which by default are `heartbeat-*`.
You can create this with the following request:

["source","sh",subs="attributes,callouts"]
---------------------------------------------------------------
PUT /_security/role/uptime
{ "indices" : [
{
"names" : [
"heartbeat-*"
],
"privileges" : [
"read",
"view_index_metadata"
],
"field_security" : {
"grant" : [
"*"
]
},
"allow_restricted_indices" : false
}
],
"applications" : [
{
"application" : "kibana-.kibana",
"privileges" : [
"all"
],
"resources" : [
"*"
]
}
],
"transient_metadata" : {
"enabled" : true
}
}
---------------------------------------------------------------

=== Creating the User

You will then need to create a user with both the `kibana_user`, and `uptime` roles.
You can do this with the following request.

["source","sh",subs="attributes,callouts"]
---------------------------------------------------------------
PUT /_security/user/jacknich
{
"password" : "j@rV1s",
"roles" : [ "uptime", "kibana_user" ],
"full_name" : "Jack Nicholson",
"email" : "[email protected]",
"metadata" : {
"intelligence" : 7
}
}
---------------------------------------------------------------

0 comments on commit 90d8883

Please sign in to comment.