Skip to content

Commit 6c0ab30

Browse files
[D&M] Clean up Spaces page (#504)
Largely inspired by the versioning tests we did with it with @shainaraskas and the guidelines we came up with. Closes: elastic/docs-projects#348
1 parent 9bcc3a3 commit 6c0ab30

File tree

1 file changed

+131
-2
lines changed

1 file changed

+131
-2
lines changed

deploy-manage/manage-spaces.md

Lines changed: 131 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless: ga
25
mapped_urls:
36
- https://www.elastic.co/guide/en/kibana/current/xpack-spaces.html
47
- https://www.elastic.co/guide/en/serverless/current/spaces.html
58
---
69

7-
# Manage spaces
10+
# Manage spaces [xpack-spaces]
811

912
% What needs to be done: Refine
1013

@@ -23,4 +26,130 @@ $$$spaces-control-feature-visibility$$$
2326

2427
$$$spaces-control-user-access$$$
2528

26-
$$$spaces-managing$$$
29+
$$$spaces-managing$$$
30+
31+
**Spaces** let you organize your content and users according to your needs.
32+
33+
- Each space has its own saved objects.
34+
- 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.
35+
- In {{stack}} deployments on version 8.16 and later, each space has its own navigation, called solution view.
36+
37+
{{kib}} creates a default space for you. When you create more spaces, users are asked to choose a space when they log in, and can change their current space at any time from the top menu.
38+
39+
:::{image} ../images/kibana-change-space.png
40+
:alt: Change current space menu
41+
:class: screenshot
42+
:::
43+
44+
To go to **Spaces**, find **Stack Management** in the navigation menu or use the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
45+
46+
47+
## Required permissions [_required_privileges_3]
48+
49+
* **Serverless projects:** `Admin` role or equivalent
50+
* **{{stack}} deployments:** `kibana_admin` or equivalent
51+
52+
53+
## Create a space [spaces-managing]
54+
55+
The maximum number of spaces that you can have differs by deployment type:
56+
57+
* **Serverless projects:** Maximum of 100 spaces.
58+
* **{{stack}} deployments:** Controlled by the `xpack.spaces.maxSpaces` setting. Default is 1000. View the full list of Space settings in [this document](https://www.elastic.co/guide/en/kibana/current/spaces-settings-kb.html).
59+
60+
To create a space:
61+
62+
::::{tab-set}
63+
:group: stack-serverless
64+
65+
:::{tab-item} {{serverless-short}}
66+
:sync: serverless
67+
68+
1. Click **Create space** or select the space you want to edit.
69+
2. Provide:
70+
71+
* A meaningful name and description for the space.
72+
* 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.
73+
74+
3. Customize the avatar of the space to your liking.
75+
4. Save the space.
76+
:::
77+
78+
:::{tab-item} {{stack}}
79+
:sync: stack
80+
81+
1. Select **Create space** and provide a name, description, and URL identifier.
82+
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.
83+
84+
2. Select a **Solution view**. This setting controls the navigation that all users of the space will get:
85+
* **Search**: A light navigation menu focused on analytics and Search use cases. Features specific to Observability and Security are hidden.
86+
* **Observability**: A light navigation menu focused on analytics and Observability use cases. Features specific to Search and Security are hidden.
87+
* **Security**: A light navigation menu focused on analytics and Security use cases. Features specific to Observability and Search are hidden.
88+
* **Classic**: All features from all solutions are visible by default using the classic, multilayered navigation menus. You can customize which features are visible individually.
89+
90+
3. If you selected the **Classic** solution view, you can customize the **Feature visibility** as you need it to be for that space.
91+
92+
% This is hacking since proper admonition blocks are currently breaking my tabs
93+
> **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 [{{kib}} Security](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md).
94+
95+
4. Customize the avatar of the space to your liking.
96+
5. Save your new space by selecting **Create space**.
97+
:::
98+
99+
::::
100+
101+
You can edit all of the space settings you just defined at any time, except for the URL identifier.
102+
103+
Elastic also allows you to manage spaces using APIs:
104+
105+
* **Serverless projects:** [Spaces API](https://www.elastic.co/docs/api/doc/serverless/operation/operation-get-spaces-space)
106+
* **{{stack}} deployments:** [Spaces API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-spaces-copy-saved-objects)
107+
108+
109+
## Define access to a space [spaces-control-user-access]
110+
```{applies_to}
111+
stack: ga
112+
serverless:
113+
elasticsearch: ga
114+
security: ga
115+
observability: unavailable
116+
```
117+
118+
Users can access spaces based on the roles that they have.
119+
120+
* 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.
121+
* When creating or editing a role, you can define which existing spaces that role can access, and with which permissions. Role management differs between {{stack}} deployments and serverless projects.
122+
- For Serverless projects, check [Custom roles](/deploy-manage/users-roles/cloud-organization/user-roles.md).
123+
- For {{stack}} deployments, check [Creating or editing a role](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md).
124+
125+
126+
If you're managing an {{stack}} deployment, then you can also assign roles and define permissions for a space from the **Permissions** tab of the space settings.
127+
128+
When a role is assigned to *All Spaces*, you can’t remove its access from the space settings. You must instead edit the role to give it more granular access to individual spaces.
129+
130+
131+
132+
## Delete a space [_delete_a_space]
133+
134+
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.
135+
136+
137+
## Move saved objects between spaces [spaces-moving-objects]
138+
139+
To move saved objects between spaces, you can [copy objects](/explore-analyze/find-and-organize/saved-objects.md#managing-saved-objects-copy-to-space), or [export and import objects](/explore-analyze/find-and-organize/saved-objects.md#managing-saved-objects-export-objects).
140+
141+
142+
## Configure a space-level landing page [spaces-default-route]
143+
```{applies_to}
144+
stack: ga
145+
serverless: unavailable
146+
```
147+
148+
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.
149+
150+
To configure the landing page, use the default route setting in [Stack Management > {{kib}} > Advanced settings](https://www.elastic.co/guide/en/kibana/current/advanced-options.html#kibana-general-settings). For example, you might set the default route to `/app/dashboards`.
151+
152+
:::{image} ../images/kibana-spaces-configure-landing-page.png
153+
:alt: Configure space-level landing page
154+
:class: screenshot
155+
:::

0 commit comments

Comments
 (0)