Skip to content

Commit fd9c409

Browse files
committed
versioning exploration
1 parent c89b0c6 commit fd9c409

File tree

7 files changed

+621
-2
lines changed

7 files changed

+621
-2
lines changed

deploy-manage/manage-spaces.md

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
2+
applies:
3+
stack: ga 9.0
4+
serverless:
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,106 @@ $$$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+
- **\[Not available in serverless]** Each space has its own navigation.
34+
- Each space has its own saved objects.
35+
- 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.
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](/get-started/the-stack.md#kibana-navigation-search).
45+
46+
47+
## Required permissions [_required_privileges_3]
48+
49+
The `kibana_admin` role or equivalent is required to manage **Spaces**.
50+
51+
::::{note}
52+
In a serverless project, you must have an admin role on that project to manage its **Spaces**.
53+
::::
54+
55+
56+
## Create a space [spaces-managing]
57+
58+
$$$spaces-control-feature-visibility$$$
59+
You can have up to 1,000 spaces by default. The maximum number of spaces can be configured by the `xpack.spaces.maxSpaces` setting (refer to [Spaces settings in {{kib}}](https://www.elastic.co/guide/en/kibana/current/spaces-settings-kb.html)).
60+
61+
::::{note}
62+
In a serverless project, the number of spaces is limited to 100.
63+
::::
64+
65+
1. Select **Create space** and provide a name, description, and URL identifier.
66+
67+
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.
68+
69+
2. **\[Not available in serverless]** Select a **Solution view**. This setting controls the navigation that all users of the space will get:
70+
71+
* **Search**: A light navigation menu focused on analytics and Search use cases. Features specific to Observability and Security are hidden.
72+
* **Observability**: A light navigation menu focused on analytics and Observability use cases. Features specific to Search and Security are hidden.
73+
* **Security**: A light navigation menu focused on analytics and Security use cases. Features specific to Observability and Search are hidden.
74+
* **Classic**: All features from all solutions are visible by default using the classic, multilayered navigation menus. You can customize which features are visible individually.
75+
76+
3. **\[Not available in serverless]** If you selected the **Classic*** solution view, you can customize the ***Feature visibility** as you need it to be for that space.
77+
::::{note}
78+
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).
79+
::::
80+
81+
4. Customize the avatar of the space to your liking.
82+
5. Save your new space by selecting **Create space**.
83+
84+
You can edit all of the space settings you just defined at any time, except for the URL identifier.
85+
86+
{{kib}} also has an [API](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) if you prefer to create spaces programmatically.
87+
88+
89+
## Define access to a space [spaces-control-user-access]
90+
91+
::::{note}
92+
In serverless projects, customizing access to a space is available for the following project types only: [![Elasticsearch](../images/serverless-es-badge.svg "")](/solutions/search.md) [![Security](../images/serverless-sec-badge.svg "")](/solutions/security/elastic-security-serverless.md)
93+
::::
94+
95+
Users can access spaces based on the roles that they have.
96+
97+
* 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.
98+
* When creating or editing a role, you can define which existing spaces that role can access, and with which permissions. Role management differs between Kibana version 9.0 and serverless projects.
99+
- For Kibana version 9.0 and later, check [Creating or editing a role](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md).
100+
- For serverless projects, check [Custom roles](/deploy-manage/users-roles/cloud-organization/user-roles.md).
101+
* **\[Not available in serverless]** 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.
102+
103+
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.
104+
105+
106+
107+
## Delete a space [_delete_a_space]
108+
109+
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.
110+
111+
112+
## Move saved objects between spaces [spaces-moving-objects]
113+
114+
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).
115+
116+
117+
## Configure a space-level landing page [spaces-default-route]
118+
119+
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.
120+
121+
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`.
122+
123+
:::{image} ../images/kibana-spaces-configure-landing-page.png
124+
:alt: Configure space-level landing page
125+
:class: screenshot
126+
:::
127+
128+
129+
## Disable spaces [spaces-delete-started]
130+
131+
Since {{kib}} 8.0, the Spaces feature cannot be disabled.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
applies:
3+
serverless:
4+
---
5+
6+
# Manage spaces in serverless projects [spaces]
7+
8+
9+
This content applies to: [![Elasticsearch](../../images/serverless-es-badge.svg "")](/solutions/search.md) [![Observability](../../images/serverless-obs-badge.svg "")](/solutions/observability.md) [![Security](../../images/serverless-sec-badge.svg "")](/solutions/security/elastic-security-serverless.md)
10+
11+
12+
13+
## Required permissions [spaces-required-permissions]
14+
15+
You must have an admin role on a project to manage its **Spaces**.
16+
17+
18+
## Create or edit a space [spaces-create-or-edit-a-space]
19+
20+
You can have up to 100 spaces in a project.
21+
22+
1. Click **Create space** or select the space you want to edit.
23+
2. Provide:
24+
25+
* A meaningful name and description for the space.
26+
* 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.
27+
28+
3. Customize the avatar of the space to your liking.
29+
4. Save the space.
30+
31+
{{kib}} also has an [API](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-spaces) if you prefer to create spaces programmatically.
32+
33+
34+
## Customize access to space [spaces-customize-access-to-space]
35+
36+
Customizing access to a space is available for the following project types only: [![Elasticsearch](../../images/serverless-es-badge.svg "")](/solutions/search.md) [![Security](../../images/serverless-sec-badge.svg "")](/solutions/security/elastic-security-serverless.md)
37+
38+
As an administrator, you can define custom roles with specific access to certain spaces and features in a project. Refer to [Custom roles](/deploy-manage/users-roles/cloud-organization/user-roles.md).
39+
40+
41+
## Delete a space [spaces-delete-a-space]
42+
43+
Deleting a space permanently removes the space and all of its contents. Find the space on the *Spaces* page and click the trash icon in the Actions column.
44+
45+
You can’t delete the default space, but you can customize it to your liking.
46+
47+
48+
## Move saved objects between spaces [spaces-move-saved-objects-between-spaces]
49+
50+
To move saved objects between spaces, you can [copy objects](/explore-analyze/find-and-organize.md#saved-objects-copy-to-other-spaces) or [export and import objects](/explore-analyze/find-and-organize.md#saved-objects-import-and-export).
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
applies:
3+
stack: ga 9.0
4+
---
5+
6+
# Manage spaces in Elastic Stack 9.0 [xpack-spaces]
7+
8+
9+
## Required privileges [_required_privileges_3]
10+
11+
The `kibana_admin` role or equivalent is required to manage **Spaces**.
12+
13+
14+
## Create a space [spaces-managing]
15+
16+
$$$spaces-control-feature-visibility$$$
17+
You can have up to 1,000 spaces by default. The maximum number of spaces can be configured by the `xpack.spaces.maxSpaces` setting (refer to [Spaces settings in {{kib}}](https://www.elastic.co/guide/en/kibana/current/spaces-settings-kb.html)).
18+
19+
1. Select **Create space** and provide a name, description, and URL identifier.
20+
21+
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.
22+
23+
2. Select a **Solution view**. This setting controls the navigation that all users of the space will get:
24+
25+
* **Search**: A light navigation menu focused on analytics and Search use cases. Features specific to Observability and Security are hidden.
26+
* **Observability**: A light navigation menu focused on analytics and Observability use cases. Features specific to Search and Security are hidden.
27+
* **Security**: A light navigation menu focused on analytics and Security use cases. Features specific to Observability and Search are hidden.
28+
* **Classic**: All features from all solutions are visible by default using the classic, multilayered navigation menus. You can customize which features are visible individually.
29+
30+
3. If you selected the **Classic*** solution view, you can customize the ***Feature visibility** as you need it to be for that space.
31+
32+
::::{note}
33+
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).
34+
::::
35+
36+
4. Customize the avatar of the space to your liking.
37+
5. Save your new space by selecting **Create space**.
38+
39+
You can edit all of the space settings you just defined at any time, except for the URL identifier.
40+
41+
{{kib}} also has an [API](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) if you prefer to create spaces programmatically.
42+
43+
44+
## Define access to a space [spaces-control-user-access]
45+
46+
47+
Users can access spaces based on the roles that they have.
48+
49+
* 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.
50+
* When [creating or editing a role](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md), you can define which existing spaces that role can access, and with which permissions.
51+
* 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.
52+
53+
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.
54+
55+
56+
57+
## Delete a space [_delete_a_space]
58+
59+
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.
60+
61+
62+
## Move saved objects between spaces [spaces-moving-objects]
63+
64+
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).
65+
66+
67+
## Configure a space-level landing page [spaces-default-route]
68+
69+
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.
70+
71+
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`.
72+
73+
:::{image} ../../images/kibana-spaces-configure-landing-page.png
74+
:alt: Configure space-level landing page
75+
:class: screenshot
76+
:::
77+
78+
79+
## Disable spaces [spaces-delete-started]
80+
81+
Since {{kib}} 8.0, the Spaces feature cannot be disabled.

0 commit comments

Comments
 (0)