Skip to content

Commit

Permalink
Add Spaces page to serverless docs
Browse files Browse the repository at this point in the history
  • Loading branch information
florent-leborgne committed Sep 16, 2024
1 parent c926a47 commit ebe0f6c
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 89 deletions.
Binary file added serverless/images/space-breadcrumb copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions serverless/nav/serverless-project-settings.docnav.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@
"slug": "/serverless/saved-objects",
"classic-sources": ["enKibanaManagingSavedObjects"]
},
{
"slug": "/serverless/spaces",
},
{
"slug": "/serverless/tags",
"classic-sources": ["enKibanaManagingTags"]
Expand Down
13 changes: 13 additions & 0 deletions serverless/pages/project-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,19 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
</DocCell>
</DocRow>
<DocRow>
<DocCell>
<DocLink slug="/serverless/spaces"/>
</DocCell>
<DocCell>
Organize your project and objects into multiple spaces
</DocCell>
<DocCell>
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
<DocBadge template="observability" slug="/serverless/observability/what-is-observability-serverless" />
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
</DocCell>
</DocRow>
<DocRow>
<DocCell>
<DocLink slug="/serverless/tags"/>
Expand Down
106 changes: 17 additions & 89 deletions serverless/pages/spaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,110 +10,38 @@ the dashboards and saved objects that belong to that space.

When you create and enter a new project, you're using the default space of that project.

You can identify the space you're in from the header.
You can identify the space you're in or switch to a different space from the header.

![Space breadcrumb](images/space-breadcrumb.png)

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.
You can view and manage the spaces of a project from the **Spaces** page in **Stack Management**.

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

[float]
==== Required privileges
You must have the admin role on the project to manage its **Spaces**.

The `kibana_admin` role or equivalent is required to manage **Spaces**.
## Create or edit a space

[float]
[[spaces-managing]]
=== View, create, and delete spaces
You can create as many spaces as you need.

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.
1. Click *Create space* or select the space you want to edit.

[role="screenshot"]
image::images/space-management.png["Space management"]
2. Provide:
- A meaningful name and description for the space.
- A URL identifier. The URL identifier is a short text string that becomes part of the ((kib)) URL. ((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 later.

[float]
==== Create or edit a space
3. Save the 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>>
((kib)) also has an [API](https://www.elastic.co/docs/api/doc/serverless)
if you prefer to create spaces programmatically.

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

[float]
==== Delete a space
## 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, {kib} Security>>.

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

[float]
[[spaces-control-user-access]]
=== Control feature access based on user privileges

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.

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

[float]
[[spaces-moving-objects]]
=== Move saved objects between spaces

To move saved objects between spaces, you can <<managing-saved-objects-copy-to-space, copy objects>>, or <<managing-saved-objects-export-objects, export and import objects>>.

[float]
[[spaces-default-route]]
=== Configure a space-level landing page

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 default route setting in
<<kibana-general-settings, Stack Management > {kib} > Advanced settings>>.
For example, you might set the default route to `/app/dashboards`.

[role="screenshot"]
image::images/spaces-configure-landing-page.png["Configure space-level landing page"]
Find the space on the *Spaces* 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-delete-started]]
=== Disabling spaces
## Move saved objects between spaces

Starting in {kib} 8.0, the Spaces feature cannot be disabled.
To move saved objects between spaces, you can <<managing-saved-objects-export-objects, export and import objects>>.

0 comments on commit ebe0f6c

Please sign in to comment.