-
Notifications
You must be signed in to change notification settings - Fork 156
[Do not merge] [E&A] Add applies frontmatter to most explore and analyze files #336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
8d6bee1
0facb4a
d1f9fc7
f35aa11
f303c3a
e8d181c
fc52ce8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,13 @@ | ||
--- | ||
applies: | ||
stack: ga 9.0 | ||
serverless: | ||
mapped_urls: | ||
- https://www.elastic.co/guide/en/kibana/current/xpack-spaces.html | ||
- https://www.elastic.co/guide/en/serverless/current/spaces.html | ||
--- | ||
|
||
# Manage spaces | ||
# Manage spaces [xpack-spaces] | ||
|
||
% What needs to be done: Refine | ||
|
||
|
@@ -23,4 +26,106 @@ $$$spaces-control-feature-visibility$$$ | |
|
||
$$$spaces-control-user-access$$$ | ||
|
||
$$$spaces-managing$$$ | ||
$$$spaces-managing$$$ | ||
|
||
**Spaces** let you organize your content and users according to your needs. | ||
|
||
- **\[Not available in serverless]** Each space has its own navigation. | ||
- Each space has its own saved objects. | ||
- 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. 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. | ||
|
||
:::{image} ../images/kibana-change-space.png | ||
:alt: Change current space menu | ||
:class: screenshot | ||
::: | ||
|
||
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). | ||
|
||
|
||
## Required permissions [_required_privileges_3] | ||
|
||
The `kibana_admin` role or equivalent is required to manage **Spaces**. | ||
|
||
::::{note} | ||
In a serverless project, you must have an admin role on that project to manage its **Spaces**. | ||
:::: | ||
|
||
|
||
## Create a space [spaces-managing] | ||
|
||
$$$spaces-control-feature-visibility$$$ | ||
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)). | ||
|
||
::::{note} | ||
In a serverless project, the number of spaces is limited to 100. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This is another one that I don't think merits an admonition. But if we do go down this path as far as a best practice we'll want to give advice on what warrants admonitions in general. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. +1
|
||
:::: | ||
|
||
1. 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. | ||
|
||
2. **\[Not available in serverless]** Select a **Solution view**. This setting controls the navigation that all users of the space will get: | ||
|
||
* **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. | ||
|
||
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. | ||
::::{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). | ||
:::: | ||
|
||
4. Customize the avatar of the space to your liking. | ||
5. Save your new space by selecting **Create space**. | ||
|
||
You can edit all of the space settings you just defined at any time, except for the URL identifier. | ||
|
||
{{kib}} also has an [API](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) if you prefer to create spaces programmatically. | ||
|
||
|
||
## Define access to a space [spaces-control-user-access] | ||
|
||
::::{note} | ||
In serverless projects, customizing access to a space is available for the following project types only: [](/solutions/search.md) [](/solutions/security/elastic-security-serverless.md) | ||
:::: | ||
Comment on lines
+91
to
+93
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd consider pulling this out of a note as well
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yep I think we all agree that using notes for version/deployment type differences isn't a great way to show it |
||
|
||
Users can access spaces based on the roles that they have. | ||
|
||
* 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 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. | ||
- For Kibana version 9.0 and later, check [Creating or editing a role](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md). | ||
- For serverless projects, check [Custom roles](/deploy-manage/users-roles/cloud-organization/user-roles.md). | ||
* **\[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. | ||
|
||
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. | ||
|
||
|
||
|
||
## 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. | ||
|
||
|
||
## Move saved objects between spaces [spaces-moving-objects] | ||
|
||
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). | ||
|
||
|
||
## Configure a space-level landing page [spaces-default-route] | ||
|
||
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 [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`. | ||
|
||
:::{image} ../images/kibana-spaces-configure-landing-page.png | ||
:alt: Configure space-level landing page | ||
:class: screenshot | ||
::: | ||
|
||
|
||
## Disable spaces [spaces-delete-started] | ||
|
||
Since {{kib}} 8.0, the Spaces feature cannot be disabled. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
applies: | ||
serverless: | ||
--- | ||
|
||
# Manage spaces in serverless projects [spaces] | ||
|
||
|
||
This content applies to: [](/solutions/search.md) [](/solutions/observability.md) [](/solutions/security/elastic-security-serverless.md) | ||
|
||
|
||
|
||
## Required permissions [spaces-required-permissions] | ||
|
||
You must have an admin role on a project to manage its **Spaces**. | ||
|
||
|
||
## Create or edit a space [spaces-create-or-edit-a-space] | ||
|
||
You can have up to 100 spaces in a project. | ||
|
||
1. Click **Create space** or select the space you want to edit. | ||
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. | ||
|
||
3. Customize the avatar of the space to your liking. | ||
4. Save the space. | ||
|
||
{{kib}} also has an [API](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-spaces) if you prefer to create spaces programmatically. | ||
|
||
|
||
## Customize access to space [spaces-customize-access-to-space] | ||
|
||
Customizing access to a space is available for the following project types only: [](/solutions/search.md) [](/solutions/security/elastic-security-serverless.md) | ||
|
||
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). | ||
|
||
|
||
## Delete a space [spaces-delete-a-space] | ||
|
||
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. | ||
|
||
You can’t delete the default space, but you can customize it to your liking. | ||
|
||
|
||
## Move saved objects between spaces [spaces-move-saved-objects-between-spaces] | ||
|
||
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). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
applies: | ||
stack: ga 9.0 | ||
--- | ||
|
||
# Manage spaces in Elastic Stack 9.0 [xpack-spaces] | ||
|
||
|
||
## Required privileges [_required_privileges_3] | ||
|
||
The `kibana_admin` role or equivalent is required to manage **Spaces**. | ||
|
||
|
||
## Create a space [spaces-managing] | ||
|
||
$$$spaces-control-feature-visibility$$$ | ||
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)). | ||
|
||
1. 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. | ||
|
||
2. Select a **Solution view**. This setting controls the navigation that all users of the space will get: | ||
|
||
* **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. | ||
|
||
3. 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 [{{kib}} Security](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). | ||
:::: | ||
|
||
4. Customize the avatar of the space to your liking. | ||
5. Save your new space by selecting **Create space**. | ||
|
||
You can edit all of the space settings you just defined at any time, except for the URL identifier. | ||
|
||
{{kib}} also has an [API](https://www.elastic.co/guide/en/kibana/current/spaces-api.html) if you prefer to create spaces programmatically. | ||
|
||
|
||
## Define access to a space [spaces-control-user-access] | ||
|
||
|
||
Users can access spaces based on the roles that they have. | ||
|
||
* 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 [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. | ||
* 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. | ||
|
||
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. | ||
|
||
|
||
|
||
## 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. | ||
|
||
|
||
## Move saved objects between spaces [spaces-moving-objects] | ||
|
||
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). | ||
|
||
|
||
## Configure a space-level landing page [spaces-default-route] | ||
|
||
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 [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`. | ||
|
||
:::{image} ../../images/kibana-spaces-configure-landing-page.png | ||
:alt: Configure space-level landing page | ||
:class: screenshot | ||
::: | ||
|
||
|
||
## Disable spaces [spaces-delete-started] | ||
|
||
Since {{kib}} 8.0, the Spaces feature cannot be disabled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to have this in an admonition? This seems unnecessarily eye-catching to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Lisa. wonder if we could do something like this: