From b9df63af7f26211c1ad96afafda61a059b610933 Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Wed, 20 Nov 2024 12:50:04 +0100 Subject: [PATCH] check and organize project settings --- serverless/index-serverless-devtools.asciidoc | 2 +- ...index-serverless-project-settings.asciidoc | 47 ++++++++------- serverless/index.asciidoc | 1 - serverless/pages/manage-billing.asciidoc | 2 +- serverless/pages/manage-org.asciidoc | 6 +- serverless/pages/manage-your-project.asciidoc | 20 ++++--- .../project-and-management-settings.asciidoc | 1 + .../pages/project-settings-access.asciidoc | 34 +++++++++++ .../pages/project-settings-alerts.asciidoc | 38 ++++++++++++ .../pages/project-settings-content.asciidoc | 55 +++++++++++++++++ ...sciidoc => project-settings-data.asciidoc} | 59 +++---------------- serverless/pages/rules.asciidoc | 2 +- serverless/pages/user-profile.asciidoc | 50 +--------------- serverless/pages/visualize-library.asciidoc | 8 +-- 14 files changed, 185 insertions(+), 140 deletions(-) create mode 100644 serverless/pages/project-settings-access.asciidoc create mode 100644 serverless/pages/project-settings-alerts.asciidoc create mode 100644 serverless/pages/project-settings-content.asciidoc rename serverless/pages/{project-settings.asciidoc => project-settings-data.asciidoc} (52%) diff --git a/serverless/index-serverless-devtools.asciidoc b/serverless/index-serverless-devtools.asciidoc index 3c679fe7..61e34db2 100644 --- a/serverless/index-serverless-devtools.asciidoc +++ b/serverless/index-serverless-devtools.asciidoc @@ -1,4 +1,4 @@ -[[devtools-developer-tools]] +[role="exclude",id="devtools-developer-tools"] = Dev tools include::./pages/general-developer-tools.asciidoc[leveloffset=+1] diff --git a/serverless/index-serverless-project-settings.asciidoc b/serverless/index-serverless-project-settings.asciidoc index 9c53a8c7..0b51743a 100644 --- a/serverless/index-serverless-project-settings.asciidoc +++ b/serverless/index-serverless-project-settings.asciidoc @@ -1,38 +1,43 @@ [[project-and-management-settings]] -== Project and management settings +== Manage your project +include::./pages/project-and-management-settings.asciidoc[leveloffset=+2] +include::./pages/manage-your-project.asciidoc[leveloffset=+2] +include::./pages/manage-your-project-rest-api.asciidoc[leveloffset=+3] -include::./pages/project-and-management-settings.asciidoc[leveloffset=+2] include::./index-serverless-devtools.asciidoc[leveloffset=+2] -include::./pages/project-settings.asciidoc[leveloffset=+2] -include::./pages/api-keys.asciidoc[leveloffset=+3] -include::./pages/action-connectors.asciidoc[leveloffset=+3] + +include::./pages/project-settings-access.asciidoc[leveloffset=+2] +include::./pages/manage-org.asciidoc[leveloffset=+3] include::./pages/custom-roles.asciidoc[leveloffset=+3] -include::./pages/data-views.asciidoc[leveloffset=+3] -include::./pages/files.asciidoc[leveloffset=+3] +include::./pages/api-keys.asciidoc[leveloffset=+3] + +include::./pages/project-settings-data.asciidoc[leveloffset=+2] +include::./pages/integrations.asciidoc[leveloffset=+3] +include::./pages/fleet-and-elastic-agent.asciidoc[leveloffset=+3] include::./pages/index-management.asciidoc[leveloffset=+3] +include::./pages/data-views.asciidoc[leveloffset=+3] +include::./pages/machine-learning.asciidoc[leveloffset=+3] include::./pages/ingest-pipelines.asciidoc[leveloffset=+3] include::./pages/logstash-pipelines.asciidoc[leveloffset=+3] -include::./pages/machine-learning.asciidoc[leveloffset=+3] -include::./pages/maintenance-windows.asciidoc[leveloffset=+3] -include::./pages/maps.asciidoc[leveloffset=+3] +include::./pages/transforms.asciidoc[leveloffset=+3] + +include::./pages/project-settings-content.asciidoc[leveloffset=+2] +include::./pages/spaces.asciidoc[leveloffset=+3] include::./pages/reports.asciidoc[leveloffset=+3] -include::./pages/rules.asciidoc[leveloffset=+3] include::./pages/saved-objects.asciidoc[leveloffset=+3] -include::./pages/spaces.asciidoc[leveloffset=+3] +include::./pages/files.asciidoc[leveloffset=+3] +include::./pages/maps.asciidoc[leveloffset=+3] include::./pages/tags.asciidoc[leveloffset=+3] -include::./pages/transforms.asciidoc[leveloffset=+3] +include::./pages/visualize-library.asciidoc[leveloffset=+3] -include::./pages/integrations.asciidoc[leveloffset=+2] - -include::./pages/fleet-and-elastic-agent.asciidoc[leveloffset=+2] - -include::./pages/manage-org.asciidoc[leveloffset=+2] - -include::./pages/manage-your-project.asciidoc[leveloffset=+2] +include::./pages/project-settings-alerts.asciidoc[leveloffset=+2] +include::./pages/rules.asciidoc[leveloffset=+3] +include::./pages/action-connectors.asciidoc[leveloffset=+3] +include::./pages/maintenance-windows.asciidoc[leveloffset=+3] -include::./pages/manage-your-project-rest-api.asciidoc[leveloffset=+3] +//include::./pages/project-settings.asciidoc[leveloffset=+2] include::./pages/manage-billing.asciidoc[leveloffset=+2] include::./pages/manage-billing-check-subscription.asciidoc[leveloffset=+3] diff --git a/serverless/index.asciidoc b/serverless/index.asciidoc index 6d9ff332..54cdacb1 100644 --- a/serverless/index.asciidoc +++ b/serverless/index.asciidoc @@ -26,4 +26,3 @@ include::./index-serverless-project-settings.asciidoc[] // Hidden pages include::./pages/explore-your-data-visualize-your-data-create-dashboards.asciidoc[leveloffset=+1] include::./pages/explore-your-data-visualize-your-data-create-visualizations.asciidoc[leveloffset=+1] -include::./pages/visualize-library.asciidoc[leveloffset=+1] diff --git a/serverless/pages/manage-billing.asciidoc b/serverless/pages/manage-billing.asciidoc index 058747e0..d2b3e48e 100644 --- a/serverless/pages/manage-billing.asciidoc +++ b/serverless/pages/manage-billing.asciidoc @@ -5,7 +5,7 @@ // :keywords: serverless, general, billing, overview ++++ -Manage billing +Billing ++++ preview:[] diff --git a/serverless/pages/manage-org.asciidoc b/serverless/pages/manage-org.asciidoc index 39527738..34e0900c 100644 --- a/serverless/pages/manage-org.asciidoc +++ b/serverless/pages/manage-org.asciidoc @@ -6,11 +6,9 @@ preview:[] -An **organization** is the umbrella for all of your {ecloud} resources, including hosted deployments and serverless projects, users, and account settings. When you sign up to {ecloud}, you create an organization. +//An **organization** is the umbrella for all of your {ecloud} resources, including hosted deployments and serverless projects, users, and account settings. When you sign up to {ecloud}, you create an organization. -In this article we walk you through the essential processes to effectively oversee your organization. - -Learn how to: +In this article, learn how to: * <>: Invite users in your organization to access serverless projects and specify their roles. * <>: Assign predefined roles to users in your organization. diff --git a/serverless/pages/manage-your-project.asciidoc b/serverless/pages/manage-your-project.asciidoc index 3bc13119..dc404899 100644 --- a/serverless/pages/manage-your-project.asciidoc +++ b/serverless/pages/manage-your-project.asciidoc @@ -1,25 +1,29 @@ [[elasticsearch-manage-project]] -= Manage performance and data retention += Manage performance and general settings // :description: Configure project-wide features and usage. // :keywords: serverless, elasticsearch, project, manage +++++ +Performance and general settings +++++ + preview:[] -{serverless-full} projects are fully managed and automatically scaled by Elastic. You have the option of {es}, {observability}, or {security} for your project. +{serverless-full} projects are fully managed and automatically scaled by Elastic. You have the option of {es}, {observability}, or {elastic-sec} for your project. -To manage a project: +Your project's performance and general data retention are controlled by the **Search AI Lake settings**. To manage these settings: . Navigate to https://cloud.elastic.co/[cloud.elastic.co]. . Log in to your Elastic Cloud account. . Select your project from the **Serverless projects** panel and click **Manage**. -From the project page, you can: +//From the project page, you can: -* **Rename your project**. In the **Overview** section, click **Edit** next to the project's name. -* **Manage data and integrations**. Update your project data, including storage settings, indices, and data views, directly in your project. -* **Manage API keys**. Access your project and interact with its data programmatically using {es} APIs. -* **Manage members**. Add members and manage their access to this project or other resources of your organization. +//* **Rename your project**. In the **Overview** section, click **Edit** next to the project's name. +//* **Manage data and integrations**. Update your project data, including storage settings, indices, and data views, directly in your project. +//* **Manage API keys**. Access your project and interact with its data programmatically using {es} APIs. +//* **Manage members**. Add members and manage their access to this project or other resources of your organization. [discrete] [[elasticsearch-manage-project-search-ai-lake-settings]] diff --git a/serverless/pages/project-and-management-settings.asciidoc b/serverless/pages/project-and-management-settings.asciidoc index a23249cd..906f3aa6 100644 --- a/serverless/pages/project-and-management-settings.asciidoc +++ b/serverless/pages/project-and-management-settings.asciidoc @@ -3,6 +3,7 @@ preview:[] +[[project-settings]] The documentation in this section describes shared capabilities that are available in multiple solutions. Look for the doc badge on each page to see if the page is valid for your solution: diff --git a/serverless/pages/project-settings-access.asciidoc b/serverless/pages/project-settings-access.asciidoc new file mode 100644 index 00000000..4fddc092 --- /dev/null +++ b/serverless/pages/project-settings-access.asciidoc @@ -0,0 +1,34 @@ +[[project-settings-access]] += Manage access + +// :description: Manage your indices, data views, saved objects, settings, and more from a central location in Elastic. +// :keywords: serverless, management, overview + +++++ +Access +++++ + +preview:[] + +Go to **Project settings**, then ** Management** to manage your indices, data views, saved objects, settings, and more. +You can also open Management by using the {kibana-ref}/kibana-concepts-analysts.html#_finding_your_apps_and_objects[global search field]. + +Access to individual features is governed by Elastic user roles. +Consult your administrator if you do not have the appropriate access. +To learn more about roles, refer to <>. + +|=== +| Feature | Description | Available in + +| <> +| Invite and manage your team's access to your organization. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Create and manage keys that can interact with your project's data. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Create and manage custom roles for your users. +| {es-badge}{sec-badge} +|=== diff --git a/serverless/pages/project-settings-alerts.asciidoc b/serverless/pages/project-settings-alerts.asciidoc new file mode 100644 index 00000000..2dc9be65 --- /dev/null +++ b/serverless/pages/project-settings-alerts.asciidoc @@ -0,0 +1,38 @@ +[[project-settings-alerts]] += Manage alerts and insights + +// :description: Manage your indices, data views, saved objects, settings, and more from a central location in Elastic. +// :keywords: serverless, management, overview + +++++ +Alerts and insights +++++ + +preview:[] + +Go to **Project settings**, then ** Management** to manage your indices, data views, saved objects, settings, and more. +You can also open Management by using the {kibana-ref}/kibana-concepts-analysts.html#_finding_your_apps_and_objects[global search field]. + +Access to individual features is governed by Elastic user roles. +Consult your administrator if you do not have the appropriate access. +To learn more about roles, refer to <>. + +|=== +| Feature | Description | Available in + +| <> +| Create and manage reusable connectors for triggering actions. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Suppress rule notifications for scheduled periods of time. +| {obs-badge}{sec-badge} + +| <> +| Create and manage rules that generate alerts. +| {es-badge} + +| <> +| Manage entity risk scoring, and preview risky entities. +| {sec-badge} +|=== diff --git a/serverless/pages/project-settings-content.asciidoc b/serverless/pages/project-settings-content.asciidoc new file mode 100644 index 00000000..01187dfe --- /dev/null +++ b/serverless/pages/project-settings-content.asciidoc @@ -0,0 +1,55 @@ +[[project-settings-content]] += Manage project content + +// :description: Manage your indices, data views, saved objects, settings, and more from a central location in Elastic. +// :keywords: serverless, management, overview + +++++ +Content +++++ + +preview:[] + +Go to **Project settings**, then ** Management** to manage your indices, data views, saved objects, settings, and more. +You can also open Management by using the {kibana-ref}/kibana-concepts-analysts.html#_finding_your_apps_and_objects[global search field]. + +Access to individual features is governed by Elastic user roles. +Consult your administrator if you do not have the appropriate access. +To learn more about roles, refer to <>. + +|=== +| Feature | Description | Available in + +| <> +| Bulk assign asset criticality to multiple entities by importing a text file. +| {sec-badge} + +| <> +| Manage files that are stored in {kib}. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Create maps from your geographical data. +| {sec-badge} + +| <> +| Manage and download reports such as CSV files generated from saved searches. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Copy, edit, delete, import, and export your saved objects. +These include dashboards, visualizations, maps, {data-sources}, and more. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Organize your project and objects into multiple spaces. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Create, manage, and assign tags to your saved objects. +| {es-badge}{obs-badge}{sec-badge} + +| <> +| Create and manage visualization panels that you can use across multiple dashboards. +| {es-badge}{obs-badge}{sec-badge} +|=== diff --git a/serverless/pages/project-settings.asciidoc b/serverless/pages/project-settings-data.asciidoc similarity index 52% rename from serverless/pages/project-settings.asciidoc rename to serverless/pages/project-settings-data.asciidoc index c10545d2..94534e5a 100644 --- a/serverless/pages/project-settings.asciidoc +++ b/serverless/pages/project-settings-data.asciidoc @@ -1,11 +1,11 @@ -[[project-settings]] -= Management settings +[[project-setting-data]] += Manage project data // :description: Manage your indices, data views, saved objects, settings, and more from a central location in Elastic. // :keywords: serverless, management, overview ++++ -Management +Data ++++ preview:[] @@ -20,30 +20,18 @@ To learn more about roles, refer to <>. |=== | Feature | Description | Available in -| <> -| Create and manage keys that can send requests on behalf of users. -| {es-badge}{obs-badge}{sec-badge} - -| <> -| Bulk assign asset criticality to multiple entities by importing a text file. -| {sec-badge} +| <> +| Connect your data to your project. +| {obs-badge}{sec-badge} -| <> -| Create and manage reusable connectors for triggering actions. -| {es-badge}{sec-badge} +| <> +| Add monitoring for logs, metrics, and other types of data to a host.. +| {obs-badge}{sec-badge} | <> | Manage the fields in the data views that retrieve your data from {es-serverless}. | {es-badge}{obs-badge}{sec-badge} -| <> -| Manage entity risk scoring, and preview risky entities. -| {sec-badge} - -| <> -| Manage files that are stored in {kib}. -| {es-badge}{obs-badge}{sec-badge} - | <> | View index settings, mappings, and statistics and perform operations on indices. | {es-badge}{obs-badge}{sec-badge} @@ -60,35 +48,6 @@ To learn more about roles, refer to <>. | View, export, and import your {anomaly-detect} and {dfanalytics} jobs and trained models. | {es-badge}{obs-badge}{sec-badge} -| <> -| Suppress rule notifications for scheduled periods of time. -| {obs-badge}{sec-badge} - -| <> -| Create maps from your geographical data. -| {sec-badge} - -| <> -| Manage and download reports such as CSV files generated from saved searches. -| {es-badge}{obs-badge}{sec-badge} - -| <> -| Create and manage rules that generate alerts. -| {es-badge} - -| <> -| Copy, edit, delete, import, and export your saved objects. -These include dashboards, visualizations, maps, {data-sources}, and more. -| {es-badge}{obs-badge}{sec-badge} - -| <> -| Organize your project and objects into multiple spaces. -| {es-badge}{obs-badge}{sec-badge} - -| <> -| Create, manage, and assign tags to your saved objects. -| {es-badge}{obs-badge}{sec-badge} - | <> | Use transforms to pivot existing {es} indices into summarized or entity-centric indices. | {es-badge}{obs-badge}{sec-badge} diff --git a/serverless/pages/rules.asciidoc b/serverless/pages/rules.asciidoc index b8cf47bd..c9be697a 100644 --- a/serverless/pages/rules.asciidoc +++ b/serverless/pages/rules.asciidoc @@ -6,7 +6,7 @@ preview:[] -This content applies to: {es-badge} +This content applies to: {es-badge} {sec-badge} In general, a rule consists of three parts: diff --git a/serverless/pages/user-profile.asciidoc b/serverless/pages/user-profile.asciidoc index 5d7a04f9..bc17ecd4 100644 --- a/serverless/pages/user-profile.asciidoc +++ b/serverless/pages/user-profile.asciidoc @@ -6,51 +6,5 @@ preview:[] -To edit your user profile, go to the user icon on the header bar and select **Profile**. - -[discrete] -[[general-user-profile-update-your-email-address]] -== Update your email address - -Your email address is used to sign in. If needed, you can change this email address. - -. In the **Profile** section, by **Email address**, select **Edit**. -. Enter a new email address and your current password. -+ -An email is sent to the new address with a link to confirm the change. If you don't get the email after a few minutes, check your spam folder. - -[discrete] -[[general-user-profile-change-your-password]] -== Change your password - -When you signed up with your email address, you selected a password that you use to log in to the Elastic Cloud console. If needed, you can change this password. - -If you know your current password: - -. Navigate to the **Password** section and select **Change password**. -. Enter the current password and provide the new password that you want to use. - -If you don't know your current password: - -. At the login screen for the Elastic Cloud console, select the link **Forgot password?** -. Enter the email address for your account and select **Reset password**. -+ -An email is sent to the address you specified with a link to reset the password. If you don't get the email after a few minutes, check your spam folder. - -[discrete] -[[general-user-profile-enable-multi-factor-authentication]] -== Enable multi-factor authentication - -To add an extra layer of security, you can either set up Google authenticator or text messaging on a mobile device. - -[TIP] -==== -Before you start using multi-factor authentication, verify that your device has SMS capabilities or download the Google Authenticator application onto your device. -==== - -To enable multi-factor authentication, you must enroll your device. - -. Navigate to the **Multi-factor authentication** section. -. Select **Configure** to enable the Authenticator app or **Add a phone number** to enable the Text message. - -If the device you want to remove is your only enrolled device, you must disable multi-factor authentication first. If your device is lost or stolen, contact https://support.elastic.co/[support]. +At any time, you can update your email address, change your password, or manage your multifactor authentication methods from your user profile. +Check {cloud}/ec-account-user-settings.html[Edit user account settings] for more details. \ No newline at end of file diff --git a/serverless/pages/visualize-library.asciidoc b/serverless/pages/visualize-library.asciidoc index a4be7d86..101196bb 100644 --- a/serverless/pages/visualize-library.asciidoc +++ b/serverless/pages/visualize-library.asciidoc @@ -1,12 +1,8 @@ -[role="exclude",id="visualize-library"] +[[visualize-library]] = Visualize Library // :keywords: serverless, Elasticsearch, Observability, Security -//// -/* TODO: Figure out best way to deal with inconsistent location of these capabilities in different solutions. -This content has been removed from the navigation for now because it's not useful in its current state.*/ -//// This content applies to: {es-badge} {obs-badge} {sec-badge} @@ -15,6 +11,8 @@ The **Visualize Library** is a space where you can save visualization panels tha * **Visualizations** * **Annotation groups** +You can find the **Visualize Library** by using the global search field of your project. + [discrete] [[visualize-library-visualizations]] == Visualizations