maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS][Spaces] Adds example of of using default route setting (#54201) (#54281)

Browse source 
* Added defaultRoute examples

Added `Examples: /app/monitoring, /app/ml, /app/kibana#/dashboards`

* [DOCS] Adds default route example to Spaces docs

Co-authored-by: ErnestoBezanilla <ErnestoBezanilla@users.noreply.github.com>

Co-authored-by: ErnestoBezanilla <ErnestoBezanilla@users.noreply.github.com>
This commit is contained in:
gchaps 2020-01-08 09:31:07 -08:00 committed by GitHub
parent a0ea5d3a17
commit fa01144711
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/spaces/images/spaces-configure-landing-page.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 76 KiB

65
docs/spaces/index.asciidoc
View file

@ -2,13 +2,13 @@
[[xpack-spaces]]
== Spaces
Spaces enable you to organize your dashboards and other saved
objects into meaningful categories. Once inside a space, you see only
the dashboards and saved objects that belong to that space.
Spaces enable you to organize your dashboards and other saved
objects into meaningful categories. Once inside a space, you see only
the dashboards and saved objects that belong to that space.
{kib} creates a default space for you.
After you create your own
spaces, you're asked to choose a space when you log in to Kibana. You can change your
{kib} creates a default space for you.
After you create your own
spaces, you're asked to choose a space when you log in to Kibana. You can change your
current space at any time by using the menu in the upper left.
[role="screenshot"]
@ -29,24 +29,24 @@ Kibana supports spaces in several ways. You can:
[[spaces-managing]]
=== View, create, and delete spaces
Go to **Management > Spaces** for an overview of your spaces. This view provides actions
Go to **Management > Spaces** for an overview of your spaces. This view provides actions
for you to create, edit, and delete spaces.
[role="screenshot"]
image::spaces/images/space-management.png["Space management"]
[float]
==== Create or edit a space
==== Create or edit a space
You can create as many spaces as you like. Click *Create a space* and provide a name,
URL identifier, optional description.
You can create as many spaces as you like. Click *Create a space* and provide a name,
URL identifier, optional description.
The URL identifier is a short text string that becomes part of the
{kib} URL when you are inside that space. {kib} suggests a URL identifier based
The URL identifier is a short text string that becomes part of the
{kib} URL when you are inside that space. {kib} suggests a URL identifier based
on the name of your space, but you can customize the identifier to your liking.
You cannot change the space identifier once you create the space.
{kib} also has an <<spaces-api, API>>
{kib} also has an <<spaces-api, API>>
if you prefer to create spaces programatically.
[role="screenshot"]
@ -55,7 +55,7 @@ image::spaces/images/edit-space.png["Space management"]
[float]
==== Delete a space
Deleting a space permanently removes the space and all of its contents.
Deleting a space permanently removes the space and all of its contents.
Find the space on the *Spaces* overview page and click the trash icon in the Actions column.
You can't delete the default space, but you can customize it to your liking.
@ -63,14 +63,14 @@ You can't delete the default space, but you can customize it to your liking.
[[spaces-control-feature-visibility]]
=== Control feature access based on user needs
You have control over which features are visible in each space.
For example, you might hide Dev Tools
You have control over which features are visible in each space.
For example, you might hide Dev Tools
in your "Executive" space or show Stack Monitoring only in your "Admin" space.
You can define which features to show or hide when you add or edit a space.
Controlling feature
visibility is not a security feature. To secure access
to specific features on a per-user basis, you must configure
Controlling feature
visibility is not a security feature. To secure access
to specific features on a per-user basis, you must configure
<<xpack-security-authorization, Kibana Security>>.
[role="screenshot"]
@ -80,10 +80,10 @@ image::spaces/images/edit-space-feature-visibility.png["Controlling features vis
[[spaces-control-user-access]]
=== Control feature access based on user privileges
When using Kibana with security, you can configure applications and features
based on your users’ privileges. This means different roles can have access
to different features in the same space.
Power users might have privileges to create and edit visualizations and dashboards,
When using Kibana with security, you can configure applications and features
based on your users’ privileges. This means different roles can have access
to different features in the same space.
Power users might have privileges to create and edit visualizations and dashboards,
while analysts or executives might have Dashboard and Canvas with read-only privileges.
See <<adding_kibana_privileges>> for details.
@ -106,7 +106,7 @@ interface.
. Import your saved objects.
. (Optional) Delete objects in the export space that you no longer need.
{kib} also has beta <<saved-objects-api-import, import>> and
{kib} also has beta <<saved-objects-api-import, import>> and
<<saved-objects-api-export, export>> APIs if you want to automate this process.
[float]
@ -115,17 +115,22 @@ interface.
You can create a custom experience for users by configuring the {kib} landing page on a per-space basis.
The landing page can route users to a specific dashboard, application, or saved object as they enter each space.
To configure the landing page, use the `defaultRoute` setting in <<kibana-general-settings, Management > Advanced settings>>.
To configure the landing page, use the default route setting in <<kibana-general-settings, Management > Advanced settings>>.
For example, you might set the default route to `/app/kibana#/dashboards`.
[role="screenshot"]
image::spaces/images/spaces-configure-landing-page.png["Configure space-level landing page"]
[float]
[[spaces-delete-started]]
=== Disable and version updates
Spaces are automatically enabled in {kib}. If you don't want use this feature,
Spaces are automatically enabled in {kib}. If you don't want use this feature,
you can disable it
by setting `xpack.spaces.enabled` to `false` in your
by setting `xpack.spaces.enabled` to `false` in your
`kibana.yml` configuration file.
If you are upgrading your
version of {kib}, the default space will contain all of your existing saved objects.
If you are upgrading your
version of {kib}, the default space will contain all of your existing saved objects.