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

[DOCS] Puts Spaces content on single page (#41536) (#41809)

Browse source 
* [DOCS] Puts Spaces content on single page

* [DOCS] Incorporates review comments

* [DOCS] Incorporated review comments
This commit is contained in:
gchaps 2019-07-23 12:29:05 -07:00 committed by GitHub
parent 4bc77d633d
commit 84427a1af4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 106 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/security/authorization/index.asciidoc
View file

@ -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.

BIN
docs/spaces/images/delete-space.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 400 KiB

BIN
docs/spaces/images/spaces-roles.png Executable file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 390 KiB

119
docs/spaces/index.asciidoc
View file

@ -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-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-getting-started]]
=== Getting Started
[[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
docs/spaces/managing-spaces.asciidoc
View file

@ -1,34 +0,0 @@
[role="xpack"]
[[spaces-managing]]
=== Managing spaces
You can manage spaces from the **Management > Spaces** page. Here you can create, edit, and delete your spaces.
[NOTE]
{kib} has an <<spaces-api, experimental API>> if you want to create your spaces programatically.
[role="screenshot"]
image::spaces/images/space-management.png["Space Management"]
==== Creating and updating spaces
You can create as many spaces as you like, but each space must have a unique space identifier. The space identifier is a short string of text that is part of the {kib} URL when you are inside that space. {kib} automatically suggests a space identifier based on the name of your space, but you are free to customize this to your liking.
[NOTE]
You cannot change the space identifier once the space is created.
[role="screenshot"]
image::spaces/images/edit-space.png["Updating a space"]
==== Controlling feature visibility
You can control which {kib} features are visible in each space. For example, you can hide “Dev Tools” in your “Executive” space, if users of that space don’t need this feature.
[role="screenshot"]
image::spaces/images/edit-space-feature-visibility.png["Controlling features visiblity"]
NOTE: This is not considered a security feature. If you wish to secure access to specific features on a per-user basis, then you need to configure <<xpack-security-authorization, Kibana Security>>.
==== Deleting spaces
Deleting a space is a destructive operation, which cannot be undone. When you delete a space, all of the saved objects that belong to that space are also deleted.
[role="screenshot"]
image::spaces/images/delete-space.png["Deleting a space"]

14
docs/spaces/moving-saved-objects.asciidoc
View file

@ -1,14 +0,0 @@
[role="xpack"]
[[spaces-moving-objects]]
=== Moving saved objects between spaces
You can use {kib}'s <<managing-saved-objects-export-objects, import/export>> interface to copy objects from one space to another:
1. Navigate to the space that contains your saved objects.
2. Export your saved objects via the <<managing-saved-objects-export-objects, import/export>> interface.
3. Navigate to the space you are importing to.
4. Import your saved objects via the <<managing-saved-objects-export-objects, import/export>> interface.
5. (optional) Delete the saved objects from the space you exported from, if you don't want to keep a copy there.
[NOTE]
{kib} also has experimental <<dashboard-import-api-import, import>> and <<dashboard-import-api-export, export>> dashboard APIs if you are looking for a dashboard-centric way to automate this process.