Skip to content

Commit 1b0fbe4

Browse files
Merge branch 'main' into best-practices-ingest-pipelines
2 parents 4c334c5 + cd415d9 commit 1b0fbe4

File tree

402 files changed

+11250
-3165
lines changed

Some content is hidden

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

402 files changed

+11250
-3165
lines changed

.github/workflows/docs-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616
deployments: write
1717
id-token: write
1818
contents: read
19-
pull-requests: read
19+
pull-requests: write
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Label Community Issues
2+
3+
on:
4+
issues:
5+
types: [opened]
6+
7+
jobs:
8+
label-community-issues:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
contents: read
13+
14+
steps:
15+
# Adding this step for debug purposes
16+
# If this works as expected, we can simplify this workflow
17+
# and replace it with the `check-membership` step
18+
- name: Check organization membership (test)
19+
run: echo "${{ github.event.issue.author_association == 'MEMBER' }}"
20+
- name: Check organization membership
21+
id: check-membership
22+
uses: actions/github-script@v7
23+
with:
24+
github-token: ${{ secrets.ORG_MEMBER_READ_TOKEN }}
25+
result-encoding: string
26+
script: |
27+
const issueAuthor = '${{ github.event.issue.user.login }}';
28+
const orgName = 'elastic';
29+
30+
try {
31+
await github.rest.orgs.getMembershipForUser({
32+
org: orgName,
33+
username: issueAuthor
34+
});
35+
36+
console.log(`${issueAuthor} is a member of ${orgName} organization`);
37+
return 'member';
38+
39+
} catch (error) {
40+
if (error.status === 404) {
41+
console.log(`${issueAuthor} is not a member of ${orgName} organization`);
42+
return 'non-member';
43+
} else {
44+
console.log('Error checking organization membership:', error);
45+
return 'error';
46+
}
47+
}
48+
49+
- name: Add community label
50+
if: steps.check-membership.outputs.result == 'non-member'
51+
uses: actions/github-script@v7
52+
with:
53+
github-token: ${{ secrets.GITHUB_TOKEN }}
54+
script: |
55+
const issueAuthor = '${{ github.event.issue.user.login }}';
56+
57+
await github.rest.issues.addLabels({
58+
owner: context.repo.owner,
59+
repo: context.repo.repo,
60+
issue_number: context.issue.number,
61+
labels: ['community']
62+
});
63+
64+
console.log(`Added "community" label to issue by ${issueAuthor}`);

cloud-account/multifactor-authentication.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,12 @@ The only secure and recommended approach is to use one Elastic account for each
106106

107107
For now, you will need to answer an MFA challenge on every login, but we are working on adding a **Trust this device** option, which will "silence" the MFA challenge for one month per user session.
108108

109+
**Can I use multiple email addresses for MFA?**
110+
111+
No, only one email address can be used for MFA verification. In alignment with security best practices, Elastic Cloud is designed to use only one designated email address for MFA purposes. This email is used to send your one-time verification codes during login. If you need to update your MFA email address, review [Update your email address](update-your-email-address.md) for more information.
112+
113+
114+
115+
116+
109117

deploy-manage/api-keys/elastic-cloud-api-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ These keys provides access to the API that enables you to manage your deployment
2727

2828
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2929
2. Go to your avatar in the upper right corner and choose **Organization**.
30-
3. On the API keys tab of the **Organization** page, click **Create API Key**.
31-
4. From the **Create API Key** page, you can configure your new key by adding a name, set expiration, or assign [roles](../users-roles/cloud-organization/user-roles.md).
30+
3. On the **API keys** tab of the **Organization** page, click **Create API key**.
31+
4. On the **Create API key** flyout, you can configure your new key by adding a name, set expiration, or assign [roles](../users-roles/cloud-organization/user-roles.md).
3232

3333
By default, API keys expire after three months. You can set the expiration to a different preset value or to a specific date, up to one year. If you need the key to work indefinitely, you can also set its expiration to Never. In this case, the key won’t expire.
3434

deploy-manage/api-keys/elasticsearch-api-keys.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Several types of {{es}} API keys exist:
1515
* **Cross-cluster** API key: allows other clusters to connect to this cluster.
1616
* **Managed** API key: created and managed by {{kib}} to run background tasks.
1717

18-
To manage API keys in {{kib}}, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
18+
To manage API keys in {{kib}}, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
1919

2020
![API Keys UI](/deploy-manage/images/kibana-api-keys.png "")
2121

@@ -33,23 +33,41 @@ To manage roles, go to the **Roles** management page using the navigation menu o
3333

3434
## Create an API key [create-api-key]
3535

36-
To create an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
36+
Two methods are available to create an API key:
3737

38-
![Create API Key UI](/deploy-manage/images/kibana-create-ccr-api-key.png "")
38+
* As a quick option to create a personal API key from anywhere in {{kib}}:
39+
1. From the **Help menu** (![help icon](/deploy-manage/images/help-icon.svg)), select **Connection details > API key**.
40+
1. Give the key a name.
41+
1. Select **Create API key**.
42+
43+
Your personal API key is created with a default expiration of 90 days from the time of creation. You can manage the key from the **API Keys** page.
3944

40-
Refer to the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) documentation to learn more about creating user API keys.
45+
* To create a personal or cross-cluster API key with configurable options, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
4146

42-
Refer to the [Create cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) documentation to learn more about creating cross-cluster API keys.
47+
![Create API Key UI](/deploy-manage/images/kibana-create-user-api-key.png "")
4348

49+
1. Choose to create either a user or a cross-cluster API key.
50+
2. Optionally, set an expiry date. By default the API key will not expire, but it's a good security practice to give the key a limited lifespan.
51+
3. Configure access:
52+
* For a user API key, you can opt to configure access to specific {{es}} APIs and resources by assigning the key with predefined roles or custom privileges. Refer to [Defining roles](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md) and the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) API documentation to learn more.
53+
* For a cross-cluster API key, you can control the indices that other clusters have access to. Refer to the [Create cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) API documentation to learn more.
54+
4. Add any additional metadata about the API as one or more key-value pairs. Refer to the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) API documentation for examples.
4455

4556
## Update an API key [update-api-key]
4657

47-
To update an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of API key.
58+
To update an API key, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of an API key.
4859

49-
Refer to the [Update API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key) documentation to learn more about updating user API keys.
50-
51-
Refer to the [Update cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key) documentation to learn more about updating cross-cluster API keys.
60+
* For a user API key, you can update:
61+
* The API key's access to {{es}} APIs and resources.
62+
* The metadata associated with the key.
63+
64+
Refer to the [Update API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key) API documentation to learn more.
5265

66+
* For a cross-cluster API key, you can update:
67+
* The indices that other clusters have access to.
68+
* The metadata associated with the key.
69+
70+
Refer to the [Update cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key) API documentation to learn more.
5371

5472
## View and delete API keys [view-api-keys]
5573

deploy-manage/api-keys/serverless-project-api-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ API keys are intended for programmatic access. Don’t use API keys to authentic
4646

4747

4848

49-
### Restrict privileges [api-keys-restrict-privileges]
49+
### Control security privileges [api-keys-restrict-privileges]
5050

51-
When you create or update an API key, use **Restrict privileges** to limit the permissions. Define the permissions using a JSON `role_descriptors` object, where you specify one or more roles and the associated privileges.
51+
When you create or update an API key, use **Control security privileges** to configure access to specific {{es}} APIs and resources. Define the permissions using a JSON `role_descriptors` object, where you specify one or more roles and the associated privileges.
5252

5353
For example, the following `role_descriptors` object defines a `books-read-only` role that limits the API key to `read` privileges on the `books` index.
5454

deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Currently, autoscaling behavior is as follows:
4343
* **Data tiers**
4444

4545
* Each {{es}} [data tier](../../manage-data/lifecycle/data-tiers.md) scales upward based on the amount of available storage. When we detect more storage is needed, autoscaling will scale up each data tier independently to ensure you can continue and ingest more data to your hot and content tier, or move data to the warm, cold, or frozen data tiers.
46-
* In addition to scaling up existing data tiers, a new data tier will be automatically added when necessary, based on your [index lifecycle management policies](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-index-management.html).
46+
* In addition to scaling up existing data tiers, a new data tier will be automatically added when necessary, based on your [index lifecycle management policies](/manage-data/lifecycle/index-lifecycle-management.md).
4747
* To control the maximum size of each data tier and ensure it will not scale above a certain size, you can use the maximum size per zone field.
4848
* Autoscaling based on memory or CPU, as well as autoscaling downward, is not currently supported. In case you want to adjust the size of your data tier to add more memory or CPU, or in case you deleted data and want to scale it down, you can set the current size per zone of each data tier manually.
4949

deploy-manage/cloud-organization/billing/add-billing-details.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Trials get converted to paid subscriptions and billing starts when you add a cre
2424
To add your billing details:
2525

2626
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
27-
2. Select the user icon on the header bar and select **Billing** from the menu.
28-
3. On the **Overview** page, select **Add billing information**.
29-
4. If prompted, complete the multifactor authentication (MFA) required by your bank.
27+
2. From a deployment or project on the home page, select **Manage**.
28+
3. From the lower navigation menu, select **Billing and Subscription**.
29+
4. On the **Overview** page, select **Add billing information**.
30+
5. If prompted, complete the multifactor authentication (MFA) required by your bank.
3031

3132
If you want, you can stop new charges by [deleting your project or deployment](/deploy-manage/uninstall/delete-a-cloud-deployment.md).

deploy-manage/cloud-organization/billing/billing-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ $$$faq-included$$$What is included in my paid {{ech}} deployment?
9999

100100
* Free 1GB RAM {{kib}} instance
101101
* Free 1GB RAM Machine Learning node
102-
* Free 1GB RAM APM server
102+
* Free 1GB RAM APM / Integrations Server instance
103103
* A free allowance for [data transfer and snapshot storage costs](#faq-dts)
104104

105105
Note that if you go above the free tier of Kibana/ML/APM (for example, a 2GB {{kib}} instance), you will be charged in full for the size of that instance.

deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ If, at any time during your monthly subscription with {{ecloud}}, you decide you
3333
To change your subscription level:
3434

3535
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
36-
2. Select the user icon on the header bar and select **Billing** from the menu.
37-
3. On the **Overview** page, select **Update subscription**.
38-
4. Choose a new subscription level.
39-
5. Save your changes.
36+
2. From a deployment or project on the home page, select **Manage**.
37+
3. From the lower navigation menu, select **Billing and Subscription**.
38+
4. On the **Overview** page, select **Update subscription**.
39+
5. Choose a new subscription level.
40+
6. Save your changes.
4041

4142
::::{important}
4243
* Changing to a higher subscription level takes place immediately. Moving to a lower subscription level takes effect 30 days after you most recently changed to a higher subscription level. In the interim, you pay the current rate. If you haven’t performed a self-service change in the past 30 days, then the change to the lower subscription level is immediate.

0 commit comments

Comments
 (0)