diff --git a/serverless/nav/serverless-general.docnav.json b/serverless/nav/serverless-general.docnav.json index 75f5f747..0d41cfeb 100644 --- a/serverless/nav/serverless-general.docnav.json +++ b/serverless/nav/serverless-general.docnav.json @@ -8,6 +8,9 @@ { "pageId": "whatIsServerlessElastic" }, + { + "pageId": "serverlessSignUpTrial" + }, { "pageId": "serverlessGeneralManageOrganization", "items": [ @@ -23,7 +26,13 @@ ] }, { - "pageId": "serverlessGeneralManageProject" + "label": "Manage your projects", + "pageId": "serverlessGeneralManageProject", + "items": [ + { + "id": "serverlessGeneralManageProjectRestAPI" + } + ] }, { "label": "Manage billing", @@ -37,9 +46,15 @@ }, { "id": "serverlessGeneralBillingHistory" + }, + { + "id": "serverlessBilling" } ] }, + { + "pageId": "ServerlessServiceStatus" + }, { "pageId": "serverlessGeneralUserProfile" } diff --git a/serverless/pages/manage-billing-pricing-model.mdx b/serverless/pages/manage-billing-pricing-model.mdx new file mode 100644 index 00000000..cf2c033a --- /dev/null +++ b/serverless/pages/manage-billing-pricing-model.mdx @@ -0,0 +1,45 @@ +--- +id: serverlessBilling +slug: /serverless/general/serverless-billing +title: Serverless billing dimensions +description: Understand how usage affects serverless pricing. +tags: [ 'serverless', 'general', 'billing', 'pricing model' ] +--- + + + +Elastic Cloud serverless billing is based on your actual usage across these dimensions: + +* Offerings +* Add-ons + + +
+ +## Offerings + +To learn about billing dimensions for specific offerings, refer to: + +* +* +* + +
+ +## Add-ons + +### Data out + +_Data out_ accounts for all of the traffic coming out of a serverless project. +This includes search results, as well as monitoring data sent from the project. +The same rate applies regardless of the destination of the data, whether to the internet, +another region, or a cloud provider account in the same region. +Data coming out of the project through AWS PrivateLink, GCP Private Service Connect, +or Azure Private Link is also considered data out. + + +### Support + +If your subscription level is Standard, there is no separate charge for Support reflected on your bill. +If your subscription level is Gold, Platinum, or Enterprise, a charge is made for Support as a percentage (%) of the ECUs. +To find out more about our support levels, go to https://www.elastic.co/support. \ No newline at end of file diff --git a/serverless/pages/manage-billing.mdx b/serverless/pages/manage-billing.mdx index 9fac8706..80cec26e 100644 --- a/serverless/pages/manage-billing.mdx +++ b/serverless/pages/manage-billing.mdx @@ -8,7 +8,9 @@ tags: [ 'serverless', 'general', 'billing', 'overview' ] - + + Until May 31, 2024, your serverless consumption will not incur any charges, but will be visible along with your total Elastic Cloud consumption on the [Billing Usage page](https://cloud.elastic.co/billing/usage?). Unless you are in a trial period, usage on or after June 1, 2024 will be deducted from your existing Elastic Cloud credits or be billed to your active payment method. + You can manage the billing details of your organization directly from the Elastic Cloud console. diff --git a/serverless/pages/manage-your-project-rest-api.mdx b/serverless/pages/manage-your-project-rest-api.mdx new file mode 100644 index 00000000..b064f2c0 --- /dev/null +++ b/serverless/pages/manage-your-project-rest-api.mdx @@ -0,0 +1,170 @@ +--- +id: serverlessGeneralManageProjectRestAPI +slug: /serverless/general/manage-project-with-api +title: Using the Project Management REST API +description: Manage your organization's serverless projects using the REST API. +tags: [ 'serverless', 'project', 'manage', 'rest', 'api'] +--- + + + +You can manage serverless projects using Elastic Cloud's [Project Management](https://docs.elastic.co/api-reference/project-management) REST API. This API allows you to create, update, and delete projects, as well as manage project features and usage. + + + More APIs let you interact with data, capabilities, and settings inside of specific projects. Refer to the [Serverless API reference page](https://docs.elastic.co/api-reference). + + + +## API Principles + +- The Elastic Cloud REST API is built following REST principles: + - Resources (such as projects) are represented as URIs. + - Standard HTTP response codes and verbs are used (GET, POST, PUT, PATCH and DELETE). + - API calls are stateless. Every request that you make happens in isolation from other calls and must include all the information necessary to fulfill the request. +- JSON is the data interchange format. + +## Authentication + +API keys are used to authenticate requests to the Elastic Cloud REST API. +Learn how to [create API keys](https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html). + +You must provide the API key for all API requests in the `Authorization` header as follows: + +```bash +"Authorization: ApiKey $API_KEY" +``` + +For example, if you interact with the API using the `curl` command: + +```bash +curl -H "Authorization: ApiKey essu_..." https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch +``` + +## Open API Specification + +The Project Management API is documented using the [OpenAPI Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification). The current supported version of the specification is `3.0`. + +For details, check the [API reference](https://docs.elastic.co/api-reference) or download the [OpenAPI Specification](https://docs.elastic.co/api-reference/openapi/serverless-project-api.yml). + +This specification can be used to generate client SDKs, or on tools that support it, such as the [Swagger Editor](https://editor.swagger.io). + + +## Examples + +To try the examples in this section: + +1. [Create an API key](https://www.elastic.co/guide/en/cloud/current/ec-api-authentication.html). + +2. Store the generated API key as an environment variable so that you don't need to specify it again for each request: + + ```bash + export API_KEY="YOUR_GENERATED_API_KEY" + ``` + +### Create a serverless Elasticsearch project + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + -H "Content-Type: application/json" \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch" \ + -XPOST --data '{ + "name": "My project", [^1] + "region_id": "aws-us-east-1" [^2] + }' +``` +[^1]: Replace **`My project`** with a more descriptive name in this call. +[^2]: You can . + +The response from the create project request will include the created project details, such as the project ID, +the credentials to access the project, and the endpoints to access different apps such as Elasticsearch and Kibana. + +Example of `Create project` response: + +```json +{ + "id": "cace8e65457043698ed3d99da2f053f6", + "endpoints": { + "elasticsearch": "https://sample-project-c990cb.es.us-east-1.aws.elastic.cloud", + "kibana": "https://sample-project-c990cb-c990cb.kb.us-east-1.aws.elastic.cloud" + }, + "credentials": { + "username": "admin", + "password": "abcd12345" + } + (...) +} +``` + +You can store the project ID as an environment variable for the next requests: + +```bash +export PROJECT_ID=cace8e65457043698ed3d99da2f053f6 +``` + +### Get project + +You can retrieve your project details through an API call: + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}" +``` + +### Get project status + +The 'status' endpoint indicates whether the project is initialized and ready to be used. In the response, the project's `phase` will change from "initializing" to "initialized" when it is ready: + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}/status" +``` + +Example response: + +```json +{ + "phase":"initializing" +} +``` + +### Reset Credentials + +If you lose the credentials provided at the time of the project creation, you can reset the credentials by using the following endpoint: + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + -XPOST \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}/_reset-credentials" +``` + +### Delete Project + +You can delete your project via the API: + +```bash +curl -XDELETE -H "Authorization: ApiKey $API_KEY" \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}" +``` + +### Update Project + +You can update your project using a PATCH request. Only the fields included in the body of the request will be updated. + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + -H "Content-Type: application/json" \ + "https://api.elastic-cloud.com/api/v1/serverless/projects/elasticsearch/${PROJECT_ID}" \ + -XPATCH --data '{ + "name": "new name", + "alias": "new-project-alias" + }' +``` + +### List available regions + +You can obtain the list of regions where projects can be created using the API: + +```bash +curl -H "Authorization: ApiKey $API_KEY" \ + "https://api.elastic-cloud.com/api/v1/serverless/regions" +``` \ No newline at end of file diff --git a/serverless/pages/manage-your-project.mdx b/serverless/pages/manage-your-project.mdx index acdaf8e5..6b572107 100644 --- a/serverless/pages/manage-your-project.mdx +++ b/serverless/pages/manage-your-project.mdx @@ -25,13 +25,21 @@ From the project page, you can: - **Manage members**. Add members and manage their access to this project or other resources of your organization. -## Features and usage +## Search AI Lake settings -You can also edit the features and usage for your project. Available features vary by project type. +Once ingested, your data is stored in cost-efficient, general storage. A cache layer is available on top of the general storage for recent and frequently queried data that provides faster search speed. Data in this cache layer is considered **search-ready**. + +Together, these data storage layers form your project's **Search AI Lake**. + +The total volume of search-ready data is the sum of the following: +1. The volume of non-time series project data +2. The volume of time series project data included in the Search Boost Window + +Each project type offers different settings that let you adjust the performance and volume of search-ready data, as well as the features available in your projects. - Controls the number of VCUs (Virtual Compute Units) allocated per GB of data to your project. + Search Power affects search speed by controlling the number of VCUs (Virtual Compute Units) allocated to search-ready data in the project. Additional VCUs provide more compute resources and result in performance gains. - Each VCU adds a combination of CPU, RAM, and data storage to your project, resulting in performance gains. + The **Cost-efficient** Search Power setting limits the available cache size, and generates cost savings by reducing search performance. + + The **Balanced** Search Power setting ensures that there is sufficient cache for all search-ready data, in order to respond quickly to queries. + + The **Performance** Search Power setting provides more computing resources in addition to the searchable data cache, in order to respond quickly to higher query volumes and more complex queries. @@ -58,22 +70,25 @@ You can also edit the features and usage for your project. Available features va - **Project features** + **Search Boost Window** - Controls feature tiers and add-on options for your ((elastic-sec)) project. + Non-time series data is always considered search-ready. The **Search Boost Window** determines the volume of time series project data that will be considered search-ready. + + Increasing the window results in a bigger portion of time series project data included in the total search-ready data volume. - + - + + - **Search Data Lake** + **Data Retention** - Provides cost-optimized storage for your data. By default, all data is stored indefinitely in the Search Data Lake and remains searchable. + Data retention policies determine how long your project data is retained. - You can specify different retention periods for each data source configured in your project. + You can specify different retention periods for specific data streams in your project. @@ -83,22 +98,20 @@ You can also edit the features and usage for your project. Available features va - **Search Boost Window** + **Project features** - Provides accelerated query speed for data residing on data streams. Increasing the boost window results in improved search and analytics performance for more data. - - The default Search Boost window size is 7 days. + Controls feature tiers and add-on options for your ((elastic-sec)) project. - + - +
-### Project features and add-ons +## Project features and add-ons For ((elastic-sec)) projects, edit the **Project features** to select a feature tier and enable add-on options for specific use cases. @@ -129,3 +142,28 @@ You can also edit the features and usage for your project. Available features va + +### Downgrading the feature tier + +When you downgrade your Security project features selection from **Security Analytics Complete** to **Security Analytics Essentials**, the following features become unavailable: + +* All Entity Analytics features +* The ability to use certain entity analytics-related integration packages, such as: + * Data Exfiltration detection + * Lateral Movement detection + * Living off the Land Attack detection +* Intelligence Indicators page +* External rule action connectors +* Case connectors +* Endpoint response actions history +* Endpoint host isolation exceptions +* AI Assistant +* Attack discovery + +And, the following data may be permanently deleted: +* AI Assistant conversation history +* AI Assistant settings +* Entity Analytics user and host risk scores +* Entity Analytics asset criticality information +* Detection rule external connector settings +* Detection rule response action settings \ No newline at end of file diff --git a/serverless/pages/project-settings.mdx b/serverless/pages/project-settings.mdx index f56a8c3d..be24275f 100644 --- a/serverless/pages/project-settings.mdx +++ b/serverless/pages/project-settings.mdx @@ -40,6 +40,17 @@ To learn more about roles, refer to + + + Asset criticality + + + Bulk assign asset criticality to multiple entities by importing a text file. + + + + + diff --git a/serverless/pages/service-status.mdx b/serverless/pages/service-status.mdx new file mode 100644 index 00000000..a78755c8 --- /dev/null +++ b/serverless/pages/service-status.mdx @@ -0,0 +1,26 @@ +--- +id: ServerlessServiceStatus +slug: /serverless/general/serverless-status +title: Monitor serverless status +tags: ['serverless'] +--- + +Serverless projects run on cloud platforms, which may undergo changes in availability. +When availability changes, Elastic makes sure to provide you with a current service status. + +To check current and past service availability, go to the Elastic serverless [service status](https://serverless-preview-status.statuspage.io/) page. + +## Subscribe to updates + +You can be notified about changes to the service status automatically. + +To receive service status updates: + +1. Go to the Elastic serverless [service status](https://serverless-preview-status.statuspage.io/) page. +2. Select **SUBSCRIBE TO UPDATES**. +3. You can be notified in the following ways: + - Email + - Slack + - Atom or RSS feeds + +After you subscribe, you'll be notified whenever a service status update is posted. diff --git a/serverless/pages/sign-up.mdx b/serverless/pages/sign-up.mdx index 9abc3710..1789cbc4 100644 --- a/serverless/pages/sign-up.mdx +++ b/serverless/pages/sign-up.mdx @@ -1,23 +1,86 @@ --- -id: serverlessGeneralSignUp -# slug: /serverless/general/sign-up -title: Sign up -# description: Description to be written +id: serverlessSignUpTrial +slug: /serverless/general/sign-up-trial +title: Get started with serverless +description: Information about signing up for a serverless Elastic Cloud trial tags: [ 'serverless', 'general', 'signup' ] --- -## Join Elastic Cloud +There are two options to create serverless projects: - ### Add your billing details +- If you are an existing customer, [log in to Elastic Cloud](https://cloud.elastic.co/login). On the home page, you will see a new option to create serverless projects. Note that if you are already subscribed to Elastic Cloud, there is no specific trial for serverless projects. - ### Choose a tier +- If you are a new user, you can [sign up for a free 14-day trial](https://cloud.elastic.co/registration), and you will be able to launch a serverless project. -## Subscribe from a marketplace - - ### AWS Marketplace +## What is included in my trial? - ### Azure Marketplace +Your free 14-day trial includes: - ### Azure Native ISV Service - - ### GCP Marketplace +**One hosted deployment** + + A deployment lets you explore Elastic solutions for Search, Observability, and Security. Trial deployments run on the latest version of the Elastic Stack. They includes 8 GB of RAM spread out over two availability zones, and enough storage space to get you started. If you’re looking to evaluate a smaller workload, you can scale down your trial deployment. +Each deployment includes Elastic features such as Maps, SIEM, machine learning, advanced security, and much more. You have some sample data sets to play with and tutorials that describe how to add your own data. + +**One serverless project** + + Serverless projects package Elastic Stack features by type of solution: + +- [Elasticsearch](https://docs.elastic.co/serverless/elasticsearch/what-is-elasticsearch-serverless) +- [Observability](https://docs.elastic.co/serverless/observability/what-is-observability-serverless) +- [Security](https://docs.elastic.co/serverless/security/what-is-security-serverless) + +When you create a project, you select the project type applicable to your use case, so only the relevant and impactful applications and features are easily accessible to you. + + + During the trial period, you are limited to one active hosted deployment and one active serverless project at a time. When you subscribe, you can create additional deployments and projects. + + +## What limits are in place during a trial? + +During the free 14 day trial, Elastic provides access to one hosted deployment and one serverless project. If all you want to do is try out Elastic, the trial includes more than enough to get you started. During the trial period, some limitations apply. + +**Hosted deployments** + +- You can have one active deployment at a time +- The deployment size is limited to 8GB RAM and approximately 360GB of storage, depending on the specified hardware profile +- Machine learning nodes are available up to 4GB RAM +- Custom Elasticsearch plugins are not enabled + +**Serverless projects** + +- You can have one active serverless project at a time. +- Search Power is limited to 100. This setting only exists in Elasticsearch projects +- Search Boost Window is limited to 7 days. This setting only exists in Elasticsearch projects + +**How to remove restrictions?** + +To remove limitations, subscribe to [Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-billing-details.html). Elastic Cloud subscriptions include the following benefits: + +- Increased memory or storage for deployment components, such as Elasticsearch clusters, machine learning nodes, and APM server. +- As many deployments and projects as you need. +- Third availability zone for your deployments. +- Access to additional features, such as cross-cluster search and cross-cluster replication. + +You can subscribe to Elastic Cloud at any time during your trial. Billing starts when you subscribe. To maximize the benefits of your trial, subscribe at the end of the free period. To monitor charges, anticipate future costs, and adjust your usage, check your [account usage](https://www.elastic.co/guide/en/cloud/current/ec-account-usage.html) and [billing history](https://www.elastic.co/guide/en/cloud/current/ec-billing-history.html). + +## How do I get started with my trial? + +Start by checking out some common approaches for [moving data into Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-cloud-ingest-data.html#ec-ingest-methods). + +## What happens at the end of the trial? + +When your trial expires, the deployment and project that you created during the trial period are suspended until you subscribe to [Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-billing-details.html). When you subscribe, you are able to resume your deployment and serverless project, and regain access to the ingested data. After your trial expires, you have 30 days to subscribe. After 30 days, your deployment, serverless project, and ingested data are permanently deleted. + +If you’re interested in learning more ways to subscribe to Elastic Cloud, don’t hesitate to [contact us](https://www.elastic.co/contact). + +## How do I sign up through a marketplace? + +If you’re interested in consolidated billing, subscribe from the AWS Marketplace, which allows you to skip the trial period and connect your AWS Marketplace email to your unique Elastic account. + + + Serverless projects are only available for AWS Marketplace. Support for GCP Marketplace and Azure Marketplace will be added in the near future. + + +## How do I get help? + +We’re here to help. If you have any questions, reach out to [Support](https://cloud.elastic.co/support). \ No newline at end of file diff --git a/serverless/pages/what-is-serverless.mdx b/serverless/pages/what-is-serverless.mdx index effdf351..45ba7ead 100644 --- a/serverless/pages/what-is-serverless.mdx +++ b/serverless/pages/what-is-serverless.mdx @@ -16,15 +16,16 @@ and business continuity. data you ingest, more resources are allocated for that period of time. When the spike is over, the system uses less resources, without any action on your end. -**Optimized data storage.** Your data is stored in the Search Data Lake of your project, which serves as a cost-efficient and performant storage. -A high performance cache layer is available on top of the Search Data Lake for your most queried data. The size of the cache depends on performance settings -that you configure for each project. +**Optimized data storage.** Your data is stored in cost-efficient, general storage. A cache layer is available on top of the general storage for recent and frequently queried data that provides faster search speed. +The size of the cache layer and the volume of data it holds depend on that you can configure for each project. -**Dedicated experiences.** Each serverless solution includes navigation and functionality that helps you focus on your data, goals, and use cases. +**Dedicated experiences.** All serverless solutions are built on the Elastic Search Platform and include the core capabilities of the Elastic Stack. They also each offer a distinct experience and specific capabilities that help you focus on your data, goals, and use cases. **Pay per usage.** Each serverless project type includes product-specific and usage-based pricing. - + + Until May 31, 2024, your serverless consumption will not incur any charges, but will be visible along with your total Elastic Cloud consumption on the [Billing Usage page](https://cloud.elastic.co/billing/usage?). Unless you are in a trial period, usage on or after June 1, 2024 will be deducted from your existing Elastic Cloud credits or be billed to your active payment method. + # Control your data and performance @@ -33,17 +34,10 @@ Control your project data and query performance against your project data. **Data.** Choose the data you want to ingest, and the method to ingest it. By default, data is stored indefinitely in your project, and you define the retention settings for your data streams. -**Performance.** For granular control over query performance against your project data, serverless projects include the following settings: +**Performance.** For granular control over costs and query performance against your project data, serverless projects come with a set of predefined that you can edit. - - **Search Power** — Control the search speed for your project data. - When ingested, a certain amount of data is loaded into a cache to increase query performance. - With Search Power, you can add replicas or reduce the amount of cached data by a static factor to increase search performance. - - - **Search Boost Window** — Determine the amount of data that benefits from faster search. - The system dynamically adjusts the cache allocated to your project based on how much data you ingest during a specified period of time. - # Differences between serverless projects and hosted deployments on ((ecloud)) You can run [hosted deployments](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html) of the ((stack)) on ((ecloud)). These hosted deployments provide more provisioning and advanced configuration options. @@ -59,7 +53,7 @@ You can run [hosted deployments](https://www.elastic.co/guide/en/cloud/current/e | **User management** | Elastic Cloud-managed users. | Elastic Cloud-managed users and native Kibana users. | | **API support** | Subset of [APIs](https://docs.elastic.co/api-reference). | All Elastic APIs. | | **Backups** | Projects automatically backed up by Elastic. | Your responsibility with Snapshot & Restore. | -| **Data retention** | | Index Lifecycle Management. | +| **Data retention** | Editable on data streams. | Index Lifecycle Management. | # Answers to common serverless questions @@ -67,9 +61,9 @@ You can run [hosted deployments](https://www.elastic.co/guide/en/cloud/current/e There is no official SLA for Support in Serverless until General Availability (GA). We’ll do our best to service customers and inquiries as we would any pre-GA product - at a Platinum/Enterprise Severity 3 (1 business day) SLA target. -**Is there migration support between ESS and serverless, and serverless and ESS?** +**Is there migration support between hosted deployments and serverless projects?** -Migration paths between ESS and serverless, and serverless and ESS are currently unsupported. +Migration paths between hosted deployments and serverless projects are currently unsupported. **How does serverless ensure compatibility between software versions?**