Skip to content

Commit

Permalink
Merge remote-tracking branch 'staging-serverless-general-docs/main' i…
Browse files Browse the repository at this point in the history
…nto add-missing-files
  • Loading branch information
shainaraskas committed May 23, 2024
2 parents a7bed94 + f17d77c commit 9e78910
Show file tree
Hide file tree
Showing 9 changed files with 415 additions and 51 deletions.
45 changes: 45 additions & 0 deletions docs/manage-billing-pricing-model.mdx
Original file line number Diff line number Diff line change
@@ -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' ]
---

<DocBadge template="technical preview" />

Elastic Cloud serverless billing is based on your actual usage across these dimensions:

* <DocLink id="serverlessBilling" section="offerings">Offerings</DocLink>
* <DocLink id="serverlessBilling" section="add-ons">Add-ons</DocLink>


<div id="offerings"></div>

## Offerings

To learn about billing dimensions for specific offerings, refer to:

* <DocLink id="serverlessElasticsearchBilling"/>
* <DocLink id="serverlessObservabilityBilling"/>
* <DocLink id="serverlessSecurityBilling"/>

<div id="add-ons"></div>

## 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.
4 changes: 3 additions & 1 deletion docs/manage-billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ tags: [ 'serverless', 'general', 'billing', 'overview' ]

<DocBadge template="technical preview" />

<DocCallOut title="You will not be charged for usage for serverless projects during this preview. Detailed pricing information will be made available in the near future." />
<DocCallOut color="warning" title="Serverless billing starts June 1, 2024">
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.
</DocCallOut>

You can manage the billing details of your organization directly from the Elastic Cloud console.

Expand Down
170 changes: 170 additions & 0 deletions docs/manage-your-project-rest-api.mdx
Original file line number Diff line number Diff line change
@@ -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']
---

<DocBadge template="technical preview" />

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.

<DocCallOut color="success" title="Tip">
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).

</DocCallOut>

## 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 <DocLink id="serverlessGeneralManageProjectRestAPI" text="obtain a list of available regions" section="list-available-regions" />.

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"
```
76 changes: 57 additions & 19 deletions docs/manage-your-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<DocTable columns={[
{
"title": "Feature",
"title": "Setting",
"width": "25%"
},
{
Expand All @@ -48,32 +56,39 @@ You can also edit the features and usage for your project. Available features va
**Search Power**
</DocCell>
<DocCell>
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.
</DocCell>
<DocCell>
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
</DocCell>
</DocRow>
<DocRow>
<DocCell>
**Project features**
**Search Boost Window**
</DocCell>
<DocCell>
Controls <DocLink id="serverlessGeneralManageProject" section="project-features-add-ons">feature tiers and add-on options</DocLink> 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.
</DocCell>
<DocCell>
<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" />
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
</DocCell>
</DocRow> <DocRow>
</DocRow>
<DocRow>
<DocCell>
**Search Data Lake**
**Data Retention**
</DocCell>
<DocCell>
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.
</DocCell>
<DocCell>
<DocBadge template="elasticsearch" slug="/serverless/elasticsearch/what-is-elasticsearch-serverless" />
Expand All @@ -83,22 +98,20 @@ You can also edit the features and usage for your project. Available features va
</DocRow>
<DocRow>
<DocCell>
**Search Boost Window**
**Project features**
</DocCell>
<DocCell>
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 <DocLink id="serverlessGeneralManageProject" section="project-features-add-ons">feature tiers and add-on options</DocLink> for your ((elastic-sec)) project.
</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>
</DocTable>

<div id="project-features-add-ons"></div>

### Project features and add-ons
## Project features and add-ons

<DocBadge template="security" slug="/serverless/security/what-is-security-serverless" /> For ((elastic-sec)) projects, edit the **Project features** to select a feature tier and enable add-on options for specific use cases.

Expand Down Expand Up @@ -129,3 +142,28 @@ You can also edit the features and usage for your project. Available features va
</DocCell>
</DocRow>
</DocTable>

### 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
26 changes: 26 additions & 0 deletions docs/service-status.mdx
Original file line number Diff line number Diff line change
@@ -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.
Loading

0 comments on commit 9e78910

Please sign in to comment.