Skip to content

Commit

Permalink
[DOCS] Puts Spaces content on single page (#41536) (#41812)
Browse files Browse the repository at this point in the history
* [DOCS] Puts Spaces content on single page

* [DOCS] Incorporates review comments

* [DOCS] Incorporated review comments
  • Loading branch information
gchaps committed Jul 23, 2019
1 parent 0c0999a commit 86b761e
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 62 deletions.
1 change: 1 addition & 0 deletions docs/security/authorization/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ NOTE: When running multiple tenants of Kibana by changing the `kibana.index` in

To create a role that grants {kib} privileges, go to **Management -> Security -> Roles** and click **Create role**.

[[adding_kibana_privileges]]
==== Adding {kib} privileges

To assign {kib} privileges to the role, click **Add space privilege** in the Kibana section.
Expand Down
Binary file removed docs/spaces/images/delete-space.png
Binary file not shown.
Binary file added docs/spaces/images/spaces-roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
119 changes: 105 additions & 14 deletions docs/spaces/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,119 @@
[[xpack-spaces]]
== Spaces

With spaces, you can organize your dashboards and other saved objects into meaningful categories.
After creating your own spaces, you will be asked to choose a space when you enter Kibana.
Once inside a space, you will only see the dashboards and other 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.

You can change your current space at any time, by clicking on the space avatar in the top left.
{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"]
image::spaces/images/change-space.png["Change current space"]

With security enabled, you can <<xpack-security-authorization, control which users have access to individual spaces>>.
Kibana supports spaces in several ways. You can:

[[spaces-getting-started]]

* <<spaces-managing, View&comma; create&comma; and delete spaces>>
* <<spaces-control-feature-visibility, Control feature access based on user needs>>
* <<spaces-control-user-access, Control feature access based on user privileges>>
* <<spaces-moving-objects, Move objects between spaces>>
* <<spaces-delete-started, Disable the Spaces feature>>

[float]
[[spaces-getting-started]]
=== Getting Started
[[spaces-managing]]
=== View, create, and delete spaces

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

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
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>>
if you prefer to create spaces programatically.

[role="screenshot"]
image::spaces/images/edit-space.png["Space management"]

[float]
==== Delete a space

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.

[float]
[[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
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
<<xpack-security-authorization, Kibana Security>>.

[role="screenshot"]
image::spaces/images/edit-space-feature-visibility.png["Controlling features visiblity"]

[float]
[[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,
while analysts or executives might have Dashboard and Canvas with read-only privileges.
See <<adding_kibana_privileges>> for details.

[role="screenshot"]
image::spaces/images/spaces-roles.png["Controlling features visiblity"]

[float]
[[spaces-moving-objects]]
=== Move saved objects between spaces
Use {kib}'s <<managing-saved-objects-export-objects, import/export>>
interface to copy objects from one space to another.

. Navigate to the space that contains your saved objects.
. Export your saved objects via the import/export interface.
. Navigate to the space where you want to import the objects.
. Import your saved objects via the import/export interface.
. (Optional) Delete objects in the export space that you no longer need.

{kib} also has experimental <<dashboard-import-api-import, import>> and
<<dashboard-import-api-export, export>> dashboard APIs if you want
a dashboard-centric way to automate this process.


[float]
[[spaces-delete-started]]
=== Disable and version updates

Spaces are automatically enabled in {kib}. If you don't wish to use this feature, you can disable it
by setting `xpack.spaces.enabled` to `false` in your `kibana.yml` configuration file.
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
`kibana.yml` configuration file.

{kib} automatically creates a default space for you. If you are upgrading from another
version of {kib}, then the default space will contain all of your existing saved objects.
Although you can't delete the default space, you can customize it to your liking.
If you are upgrading your
version of {kib}, the default space will contain all of your existing saved objects.

include::managing-spaces.asciidoc[]
include::moving-saved-objects.asciidoc[]
34 changes: 0 additions & 34 deletions docs/spaces/managing-spaces.asciidoc

This file was deleted.

14 changes: 0 additions & 14 deletions docs/spaces/moving-saved-objects.asciidoc

This file was deleted.

0 comments on commit 86b761e

Please sign in to comment.