Skip to content
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

Spaces docs for serverless #55

Merged
merged 23 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
c926a47
add spaces file from asciidoc
florent-leborgne Sep 3, 2024
ebe0f6c
Add Spaces page to serverless docs
florent-leborgne Sep 16, 2024
48c28f8
remove duplicate image
florent-leborgne Sep 16, 2024
370c1ed
forgot link
florent-leborgne Sep 16, 2024
f60ebfc
fix nav and add missing step about avatar
florent-leborgne Sep 16, 2024
028c9ba
fix img path
florent-leborgne Sep 16, 2024
f021c57
missing punctuation
florent-leborgne Sep 16, 2024
211c616
add reference to custom roles for feature access per space
florent-leborgne Sep 30, 2024
e0b392e
typos in other docs
florent-leborgne Sep 30, 2024
85efbf1
provide better image for space switcher
florent-leborgne Sep 30, 2024
00bb799
Stack Management is now Management
florent-leborgne Sep 30, 2024
a9d629e
make image smaller
florent-leborgne Sep 30, 2024
fd17ae2
Update serverless/pages/spaces.mdx
florent-leborgne Sep 30, 2024
4cc702f
feedback
florent-leborgne Sep 30, 2024
c96ae1b
Merge branch 'spaces-docs' of github.com:florent-leborgne/docs-conten…
florent-leborgne Sep 30, 2024
6a38f82
add copy to other spaces to spaces and saved objects pages
florent-leborgne Sep 30, 2024
c626e5b
small adjustments
florent-leborgne Sep 30, 2024
cc3214b
Update serverless/pages/spaces.mdx
florent-leborgne Oct 2, 2024
b503b8a
update availability per project type
florent-leborgne Oct 7, 2024
d7b0cb6
Merge branch 'spaces-docs' of github.com:florent-leborgne/docs-conten…
florent-leborgne Oct 7, 2024
8d03db9
add more specific URL to Spaces serverless API
florent-leborgne Oct 8, 2024
26fe0ae
fix icon
florent-leborgne Oct 11, 2024
e71bf19
Update serverless/pages/saved-objects.mdx
florent-leborgne Oct 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added serverless/images/space-breadcrumb.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
2 changes: 1 addition & 1 deletion serverless/pages/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A _managed API key_ is created and managed by ((kib)) to correctly run backgroun

You must have the `manage_security`, `manage_api_key`, or the `manage_own_api_key`
cluster privileges to use API keys in Elastic. API keys can also be seen in a readonly view with access to the page and the `read_security` cluster privilege. To manage roles, open the main menu, then click
**Stack Management → Roles**, or use the <DocLink id="enKibanaRoleManagementApi">Role Management API</DocLink>. */}
**Management → Custom Roles**, or use the <DocLink id="enKibanaRoleManagementApi">Role Management API</DocLink>. */}

## Create an API key

Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/explore-your-data-ml-nlp-inference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ you can use it to perform ((nlp)) tasks in ingest pipelines.

In ((kib)), you can create and edit pipelines under **Content** → **Pipelines**.

<div style={{ textAlign: "center" }}><DocImage url="../images/ml-nlp-pipeline-lang.png" alt="Creating a pipeline in the Stack Management app" /></div>
<div style={{ textAlign: "center" }}><DocImage url="../images/ml-nlp-pipeline-lang.png" alt="Creating a pipeline in the Management app" /></div>

1. Click **Create pipeline** or edit an existing pipeline.
1. Add an [((infer)) processor](((ref))/inference-processor.html) to your pipeline:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ To personalize your dashboards, add your own logos and graphics with the **Image

1. To save the new image panel to your dashboard click **Save**.

To manage your uploaded image files, open the main menu, then click **Stack Management → Kibana → Files**.
To manage your uploaded image files, open the main menu, then click ** Management → Files**.

<DocCallOut title="Warning" color="warning">

Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/general-developer-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ tags: [ 'serverless', 'dev tools', 'overview' ]
"width": "50%"
},
{
"title": "Availabile in",
"title": "Available in",
"width": "25%"
}
]}>
Expand Down
2 changes: 1 addition & 1 deletion serverless/pages/index-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you use ((es)) ((security-features)), the following <DocLink id="enElasticsea

* The `manage_index_templates` cluster privilege to manage index templates.

To add these privileges, go to **Stack Management → Security → Roles**.
To add these privileges, go to **Management → Custom Roles**.

*/}

Expand Down
14 changes: 13 additions & 1 deletion serverless/pages/project-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
"width": "50%"
},
{
"title": "Availabile in",
"title": "Available in",
"width": "25%"
}
]}>
Expand Down Expand Up @@ -224,6 +224,18 @@ 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="security" slug="/serverless/security/what-is-security-serverless" />
</DocCell>
</DocRow>
<DocRow>
<DocCell>
<DocLink slug="/serverless/tags"/>
Expand Down
15 changes: 14 additions & 1 deletion serverless/pages/saved-objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TBD: Need serverless-specific RBAC requirements

To access **Saved Objects**, you must have the required `Saved Objects Management` ((kib)) privilege.

To add the privilege, open the main menu, and then click **Stack Management → Roles**.
To add the privilege, open the main menu, and then click **Management → Roles**.
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

<DocCallOut title="Note">
Granting access to `Saved Objects Management` authorizes users to
Expand Down Expand Up @@ -85,3 +85,16 @@ TBD: Are these settings configurable in serverless?
The <DocLink id="enKibanaSettings" section="savedObjects-maxImportExportSize">`savedObjects.maxImportExportSize`</DocLink> configuration setting limits the number of saved objects that you can export.
</DocCallOut> */}

## Copy to other spaces

Copy saved objects and their related objects between spaces.

1. Click the actions icon image:images/actions_icon.png[Actions icon].
wajihaparvez marked this conversation as resolved.
Show resolved Hide resolved
1. Click **Copy to spaces**.
1. Specify whether to automatically overwrite any objects that already exist
in the target spaces, or resolve them on a per-object basis.
1. Select the spaces in which to copy the object.
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

The copy operation automatically includes child objects that are related to
the saved object. If you don't want this behavior, use
the [copy saved objects to space API](https://www.elastic.co/docs/api/doc/serverless) instead.
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved
57 changes: 57 additions & 0 deletions serverless/pages/spaces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
slug: /serverless/spaces
title: Spaces
description: Organize your project and objects into multiple spaces.
---

This content applies to: <DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" /> <DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

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.

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 or switch to a different space from the header.

<DocImage size="l" url="../images/space-breadcrumb.png" alt="Space breadcrumb" />

You can view and manage the spaces of a project from the **Spaces** page in **Management**.

## Required permissions

You must have the admin role on the project to manage its **Spaces**.
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

## 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)
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved
if you prefer to create spaces programmatically.

<DocIf condition={"((serverlessCustomRoles))" === "true"}>
## Customize access to space

As an administrator, you can define custom roles with specific access to certain spaces and features in a project. Refer to <DocLink slug="/serverless/custom-roles"/>.
</DocIf>
florent-leborgne marked this conversation as resolved.
Show resolved Hide resolved

## 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

To move saved objects between spaces, you can <DocLink slug="/serverless/saved-objects" section="copy-to-other-spaces">copy objects</DocLink> or <DocLink slug="/serverless/saved-objects" section="import-and-export">export and import objects</DocLink>.
2 changes: 1 addition & 1 deletion serverless/pages/tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ TBD: What are the serverless RBAC requirements?
To create tags, you must meet the minimum requirements.

* Access to **Tags** requires the `Tag Management` Kibana privilege. To add the privilege, open the main menu,
and then click **Stack Management → Roles**.
and then click **Management → Custom Roles**.

* The `read` privilege allows you to assign tags to the saved objects for which you have write permission.
* The `write` privilege enables you to create, edit, and delete tags.
Expand Down
Loading