Skip to content

Commit

Permalink
Update spaces docs
Browse files Browse the repository at this point in the history
  • Loading branch information
florent-leborgne committed Oct 9, 2024
1 parent 9493450 commit e925b8f
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 53 deletions.
Binary file removed docs/spaces/images/edit-space.png
Binary file not shown.
Binary file removed docs/spaces/images/space-management.png
Binary file not shown.
Binary file removed docs/spaces/images/spaces-roles.png
Binary file not shown.
93 changes: 40 additions & 53 deletions docs/spaces/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,87 +2,74 @@
[[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.
You can define multiple spaces in a single {kib} instance from the **Spaces** menu. Each space has its own navigation and objects, and users can only access the spaces that they have been granted access to. This access is based on user roles, and a given role can have different permissions per 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 {kib}. You can change your
current space at any time by using the menu.
When you create more spaces, users are asked to choose a space when they log in to {kib}, and can change their
current space at any time from the top menu.

[role="screenshot"]
image::images/change-space.png["Change current space menu"]

To go to **Spaces**, find **Stack Management** in the navigation menu or use the <<kibana-navigation-search,global search bar>>.

[float]
==== Required privileges
=== Required privileges

The `kibana_admin` role or equivalent is required to manage **Spaces**.

[float]
[[spaces-managing]]
=== View, create, and delete spaces

Open the main menu, then click *Stack Management > Spaces* for an overview of your spaces. This view provides actions
for you to create, edit, and delete spaces.
=== Create a space

[role="screenshot"]
image::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.
You can create as many spaces as you like.

. Select *Create space* and provide a name, description, and URL identifier.
+
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 programmatically.

[role="screenshot"]
image::images/edit-space.png["Space management"]
. Select a **Solution view**. This setting controls the navigation that all users of the space will get:

[float]
==== Delete a space
** **Search**: A light navigation menu focused on analytics and Search use cases. Features specific to Observability and Security are hidden.
** **Observability**: A light navigation menu focused on analytics and Observability use cases. Features specific to Search and Security are hidden.
** **Security**: A light navigation menu focused on analytics and Security use cases. Features specific to Observability and Search are hidden.
** **Classic**: All features from all solutions are visible by default using the classic, multilayered navigation menus. You can customize which features are visible individually.

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.
. If you selected the **Classic** solution view, you can customize the **Feature visibility** as you need it to be for that space.
+
NOTE: Even when disabled in this menu, some Management features can remain visible to some users depending on their privileges. Additionally, 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, {kib} Security>>.

[float]
[[spaces-control-feature-visibility]]
=== Control feature access based on user needs
. Customize the avatar of the space to your liking.

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.
. Save your new space by selecting **Create 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, {kib} Security>>.
You can edit all of the space settings you just defined at any time, except for the URL identifier.

[role="screenshot"]
image::images/edit-space-feature-visibility.png["Controlling features visibility"]
{kib} also has an <<spaces-api, API>>
if you prefer to create spaces programmatically.

[float]
[[spaces-control-user-access]]
=== Control feature access based on user privileges
=== Define access to a space

When using {kib} 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 read-only privileges for *Dashboard* and *Canvas*.
Refer to <<adding_kibana_privileges>> for details.
Users can access spaces based on the roles that they have.

[role="screenshot"]
image::images/spaces-roles.png["Controlling features visibility"]
* Certain reserved roles can view and access all spaces by default. You can't prevent those roles from accessing a space. Instead, you can grant different roles to your users.
* When <<kibana-role-management,creating or editing a role>>, you can define which existing spaces that role can access, and with which permissions.
* When editing a space, you can assign roles to the space and define the permissions within the space for these roles. To do that, go to the **Permissions** tab of the space you're editing.

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

//[[spaces-control-feature-visibility]]

[float]
[[spaces-moving-objects]]
Expand All @@ -107,6 +94,6 @@ image::images/spaces-configure-landing-page.png["Configure space-level landing p

[float]
[[spaces-delete-started]]
=== Disabling spaces
=== Disable spaces

Starting in {kib} 8.0, the Spaces feature cannot be disabled.
Since {kib} 8.0, the Spaces feature cannot be disabled.

0 comments on commit e925b8f

Please sign in to comment.