Skip to content

Commit 838e5c2

Browse files
authored
Merge branch 'main' into roles-xref-toc
2 parents 3b898b6 + 6229b2f commit 838e5c2

File tree

430 files changed

+4154
-1508
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

430 files changed

+4154
-1508
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/deploy-manage/ @elastic/admin-docs
1212
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
1313
/extend/ @elastic/core-docs
14-
/get-started/ @elastic/core-docs
14+
/get-started/ @elastic/core-docs @elastic/project-docs
1515

1616
/manage-data/ @elastic/admin-docs
1717
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
@@ -35,7 +35,7 @@
3535
/release-notes/ @elastic/docs
3636

3737
/release-notes/apm-agents/ @elastic/ingest-docs
38-
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs
38+
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs @elastic/docs-serverless-release-team
3939
/release-notes/elastic-observability/ @elastic/ski-docs
4040
/release-notes/elastic-security/ @elastic/ski-docs
4141
/release-notes/elasticsearch-clients/ @elastic/developer-docs
@@ -44,9 +44,11 @@
4444

4545
/solutions/ @elastic/experience-docs @elastic/developer-docs
4646
/solutions/observability/ @elastic/experience-docs
47-
/solutions/observability/get-started/ @elastic/ski-docs
47+
/solutions/observability/get-started/ @elastic/ski-docs @elastic/project-docs
4848
/solutions/search/ @elastic/developer-docs
49+
/solutions/search/get-started/ @elastic/developer-docs @elastic/project-docs
4950
/solutions/security/ @elastic/experience-docs
51+
/solutions/security/get-started @elastic/experience-docs @elastic/project-docs
5052

5153
/troubleshoot/ @elastic/docs
5254
/troubleshoot/deployments/ @elastic/admin-docs
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Update Kube-Stack Version
2+
3+
on:
4+
schedule:
5+
# Run every Monday at 9:00 AM UTC
6+
- cron: '0 9 * * 1'
7+
workflow_dispatch: # Allow manual triggering
8+
9+
jobs:
10+
update-kube-stack-version:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
with:
17+
token: ${{ secrets.GITHUB_TOKEN }}
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.9'
23+
24+
- name: Run kube-stack version update script
25+
run: |
26+
cd scripts
27+
python update_kube_stack_version.py
28+
29+
- name: Check for changes
30+
id: verify-changed-files
31+
run: |
32+
if [ -n "$(git status --porcelain)" ]; then
33+
echo "changed=true" >> $GITHUB_OUTPUT
34+
else
35+
echo "changed=false" >> $GITHUB_OUTPUT
36+
fi
37+
38+
- name: Commit and push changes
39+
if: steps.verify-changed-files.outputs.changed == 'true'
40+
run: |
41+
git config --local user.email "[email protected]"
42+
git config --local user.name "GitHub Action"
43+
git add docs/docset.yml
44+
git commit -m "chore: update kube-stack version [skip ci]"
45+
git push
46+
47+
- name: Create Pull Request
48+
if: steps.verify-changed-files.outputs.changed == 'true'
49+
uses: peter-evans/create-pull-request@v5
50+
with:
51+
token: ${{ secrets.GITHUB_TOKEN }}
52+
commit-message: "chore: update kube-stack version"
53+
title: "chore: update kube-stack version"
54+
body: |
55+
This PR automatically updates the kube-stack version in `docs/docset.yml` based on the latest version from the elastic-agent repository.
56+
57+
**Changes:**
58+
- Updated kube-stack version in docset.yml
59+
60+
This PR was created automatically by the weekly kube-stack version update workflow.
61+
branch: update-kube-stack-version
62+
delete-branch: true
63+
labels: |
64+
automated
65+
documentation

cloud-account/multifactor-authentication.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ Multifactor authentication (MFA) is **mandatory** when you log in to {{ecloud}}
2121
You can no longer configure SMS as a multifactor authentication method.
2222
::::
2323

24-
Elastic recommends that you enable multiple methods so that you can still access your account if you lose access to one method.
24+
::::{important}
25+
26+
For enhanced security, we recommend you configure at least two different authentication methods. This redundancy ensures that losing access to one method doesn't impair access to your {{ecloud}} account.
27+
28+
::::
2529

2630
If you use only a Google or Microsoft account to log in, then you can’t configure MFA in {{ecloud}}. You can check and manage your multifactor authentication options in your Google or Microsoft account security settings.
2731

deploy-manage/api-keys.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ applies_to:
66
ece: ga
77
self: ga
88
serverless: ga
9+
navigation_title: API keys
910
---
1011

11-
# API keys
12+
# Elastic API keys
1213

1314
API keys are security mechanisms used to authenticate and authorize access to your deployments and {{es}} resources.
1415

deploy-manage/cloud-organization/billing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Elastic charges a recurring fee for using our offerings on {{ecloud}}. In this s
2020

2121
{{ecloud}} pricing and billing is based on your usage across a number of dimensions. These dimensions are different for {{ech}} deployments and {{serverless-full}} projects. Each {{serverless-full}} project type also has its own billing dimensions.
2222

23-
* [{{ech}} deployments](/deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md)
24-
* [{{serverless-full}}](/deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md)
25-
* [{{es}} projects](/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md)
26-
* [Elastic Observability projects](/deploy-manage/cloud-organization/billing/elastic-observability-billing-dimensions.md)
27-
* [Elastic Security projects](/deploy-manage/cloud-organization/billing/security-billing-dimensions.md)
23+
* [](/deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md)
24+
* [](/deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md)
25+
* [](/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md)
26+
* [](/deploy-manage/cloud-organization/billing/elastic-observability-billing-dimensions.md)
27+
* [](/deploy-manage/cloud-organization/billing/security-billing-dimensions.md)
2828

2929
For more information, you can also refer to our [{{ech}}](https://www.elastic.co/pricing) and [{{serverless-full}}](https://www.elastic.co/pricing/serverless-search) pricing pages.
3030

deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,19 @@ Data Transfer accounts for the volume of data (payload) going into, out of, and
3939

4040
We meter and bill data transfer using three dimensions:
4141

42-
1. Data in (free)
43-
: *Data in* accounts for all of the traffic going into the deployment. It includes index requests with data payload, as well as queries sent to the deployment (although the byte size of the latter is typically much smaller).
42+
1. **Data in (free)**
43+
44+
*Data in* accounts for all of the traffic going into the deployment. It includes index requests with data payload, as well as queries sent to the deployment (although the byte size of the latter is typically much smaller).
4445

45-
2. Data out
46-
: *Data out* accounts for all of the traffic coming out of the deployment. This includes search results, as well as monitoring data sent from the deployment. The same rate applies regardless of the destination of the data, whether to the internet, to another region, or to a cloud provider account in the same region. Data coming out of the deployment through AWS PrivateLink, GCP Private Service Connect, or Azure Private Link, is also considered *Data out*.
46+
2. **Data out**
47+
48+
*Data out* accounts for all of the traffic coming out of the deployment. This includes search results, as well as monitoring data sent from the deployment. The same rate applies regardless of the destination of the data, whether to the internet, to another region, or to a cloud provider account in the same region. Data coming out of the deployment through AWS PrivateLink, GCP Private Service Connect, or Azure Private Link, is also considered *Data out*.
4749

48-
3. Data inter-node
49-
: *Data inter-node* accounts for all of the traffic sent between the components of the deployment. This includes the data sync between nodes of a cluster which is managed automatically by {{es}} cluster sharding. It also includes data related to search queries executed across multiple nodes of a cluster. Note that single-node {{es}} clusters typically have lower charges, but may still incur inter-node charges accounting for data exchanged with {{kib}} nodes or other nodes, such as machine learning or APM.
50-
51-
We provide a free allowance of 100GB per month, which includes the sum of *data out* and *data inter-node*, across all deployments in the account. Once this threshold is passed, a charge is applied for any data transfer used in excess of the 100GB monthly free allowance.
50+
3. **Data inter-node**
51+
52+
*Data inter-node* accounts for all of the traffic sent between the components of the deployment. This includes the data sync between nodes of a cluster which is managed automatically by {{es}} cluster sharding. It also includes data related to search queries executed across multiple nodes of a cluster. Note that single-node {{es}} clusters typically have lower charges, but may still incur inter-node charges accounting for data exchanged with {{kib}} nodes or other nodes, such as machine learning or APM.
53+
54+
We provide a free allowance of 100GB per month, which includes the sum of *data out* and *data inter-node*, across all deployments in the account. Once this threshold is passed, a charge is applied for any data transfer used in excess of the 100GB monthly free allowance.
5255

5356
::::{note}
5457
Data inter-node charges are currently waived for Azure deployments.
@@ -71,22 +74,24 @@ Storage costs are tied to the cost of storing the backup snapshots in the underl
7174

7275
As is common with Cloud providers, we meter and bill snapshot storage using two dimensions:
7376

74-
1. Storage size (GB/month)
75-
: This is calculated by metering the storage space (GBs) occupied by all snapshots of all deployments tied to an account. The same unit price applies to all regions. To calculate the due charges, we meter the amount of storage on an hourly basis and produce an average size (in GB) for a given month. The average amount is then used to bill the account for the GB/month used within a billing cycle (a calendar month).
76-
77-
For example, if the storage used in April 2019 was 100GB for 10 days, and then 130GB for the remaining 20 days of the month, the average storage would be 120 GB/month, calculated as (100*10 + 130*20)/30.
78-
79-
We provide a free allowance of 100 GB/month to all accounts across all the account deployments. Any metered storage usage below that amount will not be billed. Whenever the 100 GB/month threshold is crossed, we bill for the storage used in excess of the 100GB/month free allowance.
80-
81-
82-
2. Storage API requests (1K Requests/month)
83-
: These costs are calculated by counting the total number of calls to backup or restore snapshots made by all deployments associated with an account. Unlike storage size, this dimension is cumulative, summed up across the billing cycle, and is billed at a price of 1,000 requests.
84-
85-
We provide a free allowance of 100,000 API requests to all accounts each month across all the account deployments. Once this threshold is passed, we bill only for the use of API requests in excess of the free allowance.
86-
87-
::::{note}
88-
A single snapshot operation does not equal a single API call. There could be thousands of API calls associated with a single snapshot operation, as different files are written, deleted, and modified. The price we list is per 1000 API calls, so a rate of $0.0018 for 1000 API calls would cost $1.80 for a million calls.
89-
::::
77+
1. **Storage size (GB/month)**
78+
79+
This is calculated by metering the storage space (GBs) occupied by all snapshots of all deployments tied to an account. The same unit price applies to all regions. To calculate the due charges, we meter the amount of storage on an hourly basis and produce an average size (in GB) for a given month. The average amount is then used to bill the account for the GB/month used within a billing cycle (a calendar month).
80+
81+
For example, if the storage used in April 2019 was 100GB for 10 days, and then 130GB for the remaining 20 days of the month, the average storage would be 120 GB/month, calculated as (100*10 + 130*20)/30.
82+
83+
We provide a free allowance of 100 GB/month to all accounts across all the account deployments. Any metered storage usage below that amount will not be billed. Whenever the 100 GB/month threshold is crossed, we bill for the storage used in excess of the 100GB/month free allowance.
84+
85+
86+
2. **Storage API requests (1K Requests/month)**
87+
88+
These costs are calculated by counting the total number of calls to backup or restore snapshots made by all deployments associated with an account. Unlike storage size, this dimension is cumulative, summed up across the billing cycle, and is billed at a price of 1,000 requests.
89+
90+
We provide a free allowance of 100,000 API requests to all accounts each month across all the account deployments. Once this threshold is passed, we bill only for the use of API requests in excess of the free allowance.
91+
92+
::::{note}
93+
A single snapshot operation does not equal a single API call. There could be thousands of API calls associated with a single snapshot operation, as different files are written, deleted, and modified. The price we list is per 1000 API calls, so a rate of $0.0018 for 1000 API calls would cost $1.80 for a million calls.
94+
::::
9095

9196

9297

deploy-manage/cloud-organization/billing/elastic-observability-billing-dimensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Elastic for Observability
2+
navigation_title: Observability projects
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/observability-billing.html
55
applies_to:
@@ -8,7 +8,7 @@ products:
88
- id: cloud-serverless
99
---
1010

11-
# Elastic for Observability billing dimensions [observability-billing]
11+
# {{obs-serverless}} billing dimensions [observability-billing]
1212

1313
{{obs-serverless}} projects provide you with all the capabilities of Elastic Observability to monitor critical applications. Projects are provided using a Software as a Service (SaaS) model, and pricing is entirely consumption-based. {{obs-serverless}} projects are available in the following tiers of carefully selected features to enable common observability operations:
1414

deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Elasticsearch
2+
navigation_title: Elasticsearch projects
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-billing.html
55
applies_to:
@@ -10,7 +10,7 @@ products:
1010
description: Learn about how costs for Elasticsearch Serverless projects are calculated, and strategies you can use to lower your costs.
1111
---
1212

13-
# {{es}} billing dimensions [elasticsearch-billing]
13+
# {{es-serverless}} billing dimensions [elasticsearch-billing]
1414

1515
{{es-serverless}} projects are priced based on consumption of the underlying infrastructure that supports your use case with the performance characteristics you need.
1616
Measurements are in virtual compute units (VCUs).
@@ -48,7 +48,7 @@ You can control costs using the following strategies:
4848
* **Machine learning trained model autoscaling**: [Trained model autoscaling](/deploy-manage/autoscaling/trained-model-autoscaling.md) is always enabled and cannot be disabled, ensuring efficient resource usage, reduced costs, and optimal performance without manual configuration.
4949

5050
Trained model deployments automatically scale down to zero allocations after 24 hours without any inference requests. When they scale up again, they remain active for 5 minutes before they can scale down. During these cooldown periods, you will continue to be billed for the active resources.
51-
* **Indexing strategies** Consider your indexing strategies and how they might impact overall VCU usage and costs.
51+
* **Indexing strategies**: Consider your indexing strategies and how they might impact overall VCU usage and costs.
5252
To ensure optimal performance and cost-effectiveness for your project, it's important to consider how you structure your data.
5353

5454
Consolidate small indices for better efficiency.
@@ -59,3 +59,8 @@ You can control costs using the following strategies:
5959
Higher resource consumption can lead to higher costs and potentially impact the overall performance of your project.
6060

6161
If your use case naturally generates many small, separate streams of data, the recommended approach is to implement a process to consolidate them into fewer, larger indices. This practice leads to more efficient resource utilization. By grouping your data into larger indices, you can ensure a more performant and cost-efficient experience with {{es-serverless}}.
62+
* **Project subtype or profile**: When you use the [API]({{cloud-serverless-apis}}operation/operation-createelasticsearchproject) to create projects, be aware that the `optimized_for` option affects the VCU allocation and costs.
63+
64+
The `general_purpose` option is suitable for most search use cases. For example, it is the right profile for full-text search, sparse vectors, and dense vectors that use compression such as BBQ. It is used by default when you create projects from the UI.
65+
66+
The `vector` option is recommended only for uncompressed dense vectors ([dense_vector](elasticsearch://reference/elasticsearch/mapping-reference/dense-vector.md) fields with `int4` or `int8` quantization strategies) and high dimensionality. Though the per VCU cost is the same for general purpose and vector profiles, the latter allocates more VCUs for searchable data. This leads to higher VCU consumption in order to improve the performance for uncompressed vector data.

deploy-manage/cloud-organization/billing/security-billing-dimensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Elastic for Security
2+
navigation_title: Security projects
33
mapped_pages:
44
- https://www.elastic.co/guide/en/serverless/current/security-billing.html
55
applies_to:
@@ -8,7 +8,7 @@ products:
88
- id: cloud-serverless
99
---
1010

11-
# Elastic for Security billing dimensions [security-billing]
11+
# {{elastic-sec}} billing dimensions [security-billing]
1212

1313
{{elastic-sec}} serverless projects provide you with all the capabilities of {{elastic-sec}} to perform SIEM, security analytics, endpoint security, and cloud security workflows. Projects are provided using a Software as a Service (SaaS) model, and pricing is entirely consumption based. Security Analytics/SIEM is available in two tiers of carefully selected features to enable common security operations:
1414

deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Specific prices can be found in the [Cloud Pricing Table](https://cloud.elastic.
2121

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

24-
* [{{es}} billing dimensions](elasticsearch-billing-dimensions.md)
25-
* [Elastic for Observability billing dimensions](elastic-observability-billing-dimensions.md)
26-
* [Elastic for Security dimensions](security-billing-dimensions.md)
24+
* [](elasticsearch-billing-dimensions.md)
25+
* [](elastic-observability-billing-dimensions.md)
26+
* [](security-billing-dimensions.md)
2727

2828

2929
## Add-ons [add-ons]

0 commit comments

Comments
 (0)