Skip to content

Commit 765bd74

Browse files
Spaces docs for serverless (#55)
* add spaces file from asciidoc * Add Spaces page to serverless docs * remove duplicate image * forgot link * fix nav and add missing step about avatar * fix img path * missing punctuation * add reference to custom roles for feature access per space * typos in other docs * provide better image for space switcher * Stack Management is now Management * make image smaller * Update serverless/pages/spaces.mdx Co-authored-by: Joe Peeples <[email protected]> * feedback * add copy to other spaces to spaces and saved objects pages * small adjustments * Update serverless/pages/spaces.mdx Co-authored-by: Joe Peeples <[email protected]> * update availability per project type * add more specific URL to Spaces serverless API * fix icon * Update serverless/pages/saved-objects.mdx --------- Co-authored-by: Joe Peeples <[email protected]>
1 parent 2d519f7 commit 765bd74

11 files changed

+96
-10
lines changed
114 KB
Loading

serverless/nav/serverless-project-settings.docnav.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@
5959
"slug": "/serverless/saved-objects",
6060
"classic-sources": ["enKibanaManagingSavedObjects"]
6161
},
62+
{
63+
"slug": "/serverless/spaces"
64+
},
6265
{
6366
"slug": "/serverless/tags",
6467
"classic-sources": ["enKibanaManagingTags"]

serverless/pages/api-keys.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ A _managed API key_ is created and managed by ((kib)) to correctly run backgroun
2929
3030
You must have the `manage_security`, `manage_api_key`, or the `manage_own_api_key`
3131
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
32-
**Stack Management → Roles**, or use the <DocLink id="enKibanaRoleManagementApi">Role Management API</DocLink>. */}
32+
**Management → Custom Roles**, or use the <DocLink id="enKibanaRoleManagementApi">Role Management API</DocLink>. */}
3333

3434
## Create an API key
3535

serverless/pages/explore-your-data-ml-nlp-inference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ you can use it to perform ((nlp)) tasks in ingest pipelines.
2222

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

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

2727
1. Click **Create pipeline** or edit an existing pipeline.
2828
1. Add an [((infer)) processor](((ref))/inference-processor.html) to your pipeline:

serverless/pages/explore-your-data-visualize-your-data-create-visualizations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ To personalize your dashboards, add your own logos and graphics with the **Image
391391

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

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

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

serverless/pages/general-developer-tools.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ tags: [ 'serverless', 'dev tools', 'overview' ]
1818
"width": "50%"
1919
},
2020
{
21-
"title": "Availabile in",
21+
"title": "Available in",
2222
"width": "25%"
2323
}
2424
]}>

serverless/pages/index-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ If you use ((es)) ((security-features)), the following <DocLink id="enElasticsea
3636
3737
* The `manage_index_templates` cluster privilege to manage index templates.
3838
39-
To add these privileges, go to **Stack Management → Security → Roles**.
39+
To add these privileges, go to **Management → Custom Roles**.
4040
4141
*/}
4242

serverless/pages/project-settings.mdx

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
2222
"width": "50%"
2323
},
2424
{
25-
"title": "Availabile in",
25+
"title": "Available in",
2626
"width": "25%"
2727
}
2828
]}>
@@ -59,7 +59,6 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
5959
</DocCell>
6060
<DocCell>
6161
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
62-
<DocBadge template="observability" slug="/serverless/observability/what-is-observability-serverless" />
6362
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
6463
</DocCell>
6564
</DocRow>
@@ -69,7 +68,6 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
6968
<DocCell>Create and manage roles that grant privileges within your project.</DocCell>
7069
<DocCell>
7170
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
72-
<DocBadge template="observability" slug="/serverless/observability/what-is-observability-serverless" />
7371
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
7472
</DocCell>
7573
</DocRow>
@@ -224,6 +222,19 @@ To learn more about roles, refer to <DocLink slug="/serverless/general/assign-us
224222
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
225223
</DocCell>
226224
</DocRow>
225+
<DocRow>
226+
<DocCell>
227+
<DocLink slug="/serverless/spaces"/>
228+
</DocCell>
229+
<DocCell>
230+
Organize your project and objects into multiple spaces.
231+
</DocCell>
232+
<DocCell>
233+
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
234+
<DocBadge template="observability" slug="/serverless/observability/what-is-observability-serverless" />
235+
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
236+
</DocCell>
237+
</DocRow>
227238
<DocRow>
228239
<DocCell>
229240
<DocLink slug="/serverless/tags"/>

serverless/pages/saved-objects.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ TBD: Need serverless-specific RBAC requirements
1919
2020
To access **Saved Objects**, you must have the required `Saved Objects Management` ((kib)) privilege.
2121
22-
To add the privilege, open the main menu, and then click **Stack Management → Roles**.
22+
To add the privilege, open the main menu, and then click **Management → Roles**.
2323
2424
<DocCallOut title="Note">
2525
Granting access to `Saved Objects Management` authorizes users to
@@ -85,3 +85,15 @@ TBD: Are these settings configurable in serverless?
8585
The <DocLink id="enKibanaSettings" section="savedObjects-maxImportExportSize">`savedObjects.maxImportExportSize`</DocLink> configuration setting limits the number of saved objects that you can export.
8686
</DocCallOut> */}
8787

88+
## Copy to other spaces
89+
90+
Copy saved objects and their related objects between spaces.
91+
92+
1. Click the actions icon <DocIcon type="boxesHorizontal" title="Actions" />.
93+
1. Click **Copy to spaces**.
94+
1. Specify whether to automatically overwrite any objects that already exist
95+
in the target spaces, or resolve them on a per-object basis.
96+
1. Select the spaces in which to copy the object.
97+
98+
The copy operation automatically includes child objects that are related to
99+
the saved object.

serverless/pages/spaces.mdx

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
slug: /serverless/spaces
3+
title: Spaces
4+
description: Organize your project and objects into multiple spaces.
5+
---
6+
7+
This content applies to: <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" />
8+
9+
10+
Spaces enable you to organize your dashboards and other saved
11+
objects into meaningful categories. Once inside a space, you see only
12+
the dashboards and saved objects that belong to that space.
13+
14+
When you create and enter a new project, you're using the default space of that project.
15+
16+
You can identify the space you're in or switch to a different space from the header.
17+
18+
<DocImage size="l" url="../images/space-breadcrumb.png" alt="Space breadcrumb" />
19+
20+
You can view and manage the spaces of a project from the **Spaces** page in **Management**.
21+
22+
## Required permissions
23+
24+
You must have an admin role on the project to manage its **Spaces**.
25+
26+
## Create or edit a space
27+
28+
You can have up to 100 spaces in a project.
29+
30+
1. Click **Create space** or select the space you want to edit.
31+
32+
2. Provide:
33+
- A meaningful name and description for the space.
34+
- 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.
35+
36+
3. Customize the avatar of the space to your liking.
37+
38+
4. Save the space.
39+
40+
((kib)) also has an [API](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-spaces)
41+
if you prefer to create spaces programmatically.
42+
43+
<DocIf condition={"((serverlessCustomRoles))" === "true"}>
44+
## Customize access to space
45+
46+
Customizing access to a space is available for the following project types only: <DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" /> <DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
47+
48+
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"/>.
49+
</DocIf>
50+
51+
## Delete a space
52+
53+
Deleting a space permanently removes the space and all of its contents.
54+
Find the space on the *Spaces* page and click the trash icon in the Actions column.
55+
56+
You can't delete the default space, but you can customize it to your liking.
57+
58+
## Move saved objects between spaces
59+
60+
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>.

0 commit comments

Comments
 (0)