Skip to content

Commit 3ff6580

Browse files
Merge branch 'main' of github.com:elastic/docs-content into flb-kib-quickstart-refine
2 parents d9fffe3 + 31f960d commit 3ff6580

File tree

202 files changed

+2198
-2710
lines changed

Some content is hidden

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

202 files changed

+2198
-2710
lines changed

.github/workflows/docs-build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
name: docs-build
22

33
on:
4+
push:
5+
branches:
6+
- main
47
pull_request: ~
58

69
jobs:

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Elastic Docs Content
22

3+
![GitHub deployments](https://img.shields.io/github/deployments/elastic/docs-content/docs-preview?logo=elastic&label=docs-preview&link=https%3A%2F%2Fdocs-v3-preview.elastic.dev%2Felastic%2Fdocs-content%2Ftree%2Fmain)
4+
35
This repo contains source files for Elastic documentation.
46

57
## Contribute

cloud-account/add-a-login-method.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-change-login-method.html
4+
applies:
5+
serverless: all
6+
hosted: all
47
---
58

69
# Add a login method [ec-change-login-method]
@@ -19,8 +22,7 @@ To enable password-based login in addition to Google or Microsoft sign-in, go to
1922

2023
After you create a password, log in. You’ll be prompted to [enable multifactor authentication](multifactor-authentication.md).
2124

22-
You will now be able to change the email address in your [user settings](https://cloud.elastic.co/user/settings).
23-
25+
You will now be able to change the email address in your [user settings](https://cloud.elastic.co/user/settings). Refer to [Update your email address](/cloud-account/update-your-email-address.md) for more information.
2426

2527
## Enable Google or Microsoft sign-in [ec_enable_google_or_microsoft_sign_in]
2628

cloud-account/change-your-password.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-change-password.html
4+
applies:
5+
serverless: all
6+
hosted: all
47
---
58

69
# Change your password [ec-change-password]
710

8-
If you created a password when you signed up for a Elasticsearch Service account, or you added the password-based login method to your account, then you can change your password if needed.
11+
If you created a password when you signed up for a {{ecloud}} account, or you added the password-based login method to your account, then you can change your password if needed.
912

1013
If you know your current password:
1114

12-
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
15+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
1316
2. Open the user menu in the header bar.
1417
3. Go to **Profile**.
1518
4. Select **Change password**.
1619
5. Enter the current password and provide the new password that you want to use.
1720

1821
If you don’t know your current password:
1922

20-
1. At the login screen for the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), select the link **Forgot password?**.
23+
1. At the login screen for the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), select the link **Forgot password?**.
2124
2. Enter the primary email address for your account and select **Reset password**.
2225

23-
By default, to sign up for Elasticsearch Service you use your primary email address. If you change it at some point, use your current email address to log in to Elasticsearch Service.
26+
By default, to sign up for {{ecloud}} you use your primary email address. If you change it at some point, use your current email address to log in to {{ecloud}}.
2427

2528
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.
2629

cloud-account/index.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,29 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/cloud/current/ec-account-user-settings.html
44
- https://www.elastic.co/guide/en/serverless/current/general-user-profile.html
5+
applies:
6+
serverless: all
7+
hosted: all
58
---
69

7-
# Cloud account
10+
# Manage your Cloud account
811

9-
% What needs to be done: Refine
12+
Your {{ecloud}} account allows you to manage your personal settings, including your email address, password, and authentication methods. You can perform the following tasks at any time from your user profile:
1013

11-
% GitHub issue: https://github.com/elastic/docs-projects/issues/304
14+
* [Update your email address](/cloud-account/update-your-email-address.md)
15+
* [Add an additional login method](/cloud-account/add-a-login-method.md): Choose from password-based login, Google sign-in, and Microsoft sign-in.
1216

13-
% Scope notes: https://github.com/elastic/docs-projects/issues/304
17+
If you use password-based login, then you can perform the following additional tasks:
1418

15-
% Use migrated content from existing pages that map to this page:
19+
* [Change your password](/cloud-account/change-your-password.md)
20+
* [Configure multifactor authentication](/cloud-account/multifactor-authentication.md)
1621

17-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-account-user-settings.md
18-
% - [ ] ./raw-migrated-files/docs-content/serverless/general-user-profile.md
22+
Additionally, you can manage your organization membership, including joining or leaving an organization. Refer to [Join or leave an organization](/cloud-account/join-or-leave-an-organization.md) for more information.
23+
24+
::::{tip}
25+
This section focuses on the actions you can take as an individual user to manage your own account. It does not cover organization-wide settings, such as managing user permissions or configuring organization-level access controls, which are handled by the organization administrators.
26+
27+
For information on organization and access management, refer to:
28+
- [Manage your Cloud organization](/deploy-manage/cloud-organization.md)
29+
- [Manage user roles and permissions](/deploy-manage/users-roles/cloud-organization/user-roles.md)
30+
::::

cloud-account/join-or-leave-an-organization.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,41 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/cloud/current/ec-invite-users.html
44
- https://www.elastic.co/guide/en/serverless/current/general-manage-organization.html
5+
applies:
6+
serverless: all
7+
hosted: all
58
---
69

710
# Join or leave an organization
811

9-
% What needs to be done: Refine
12+
Organizations in {{ecloud}} group user accounts, projects and deployments under a common billing and access structure. If you have been invited to an organization, you can accept the invitation and become a member. You can also leave an organization at any time, as long as you don’t have active projects or deployments associated with your account.
1013

11-
% Scope notes: https://github.com/elastic/docs-projects/issues/304
14+
This guide explains how to join or leave an organization, including steps for handling projects and deployments when switching organizations.
1215

13-
% Use migrated content from existing pages that map to this page:
16+
## Accept an invitation [ec-accept-invitation]
1417

15-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-invite-users.md
16-
% - [ ] ./raw-migrated-files/docs-content/serverless/general-manage-organization.md
18+
Invitations to join an organization are sent by email. Invited users have 72 hours to accept the invitation. If they do not join within that period, an administrator of the organization will have to send a new invitation. Refer to [manage users](/deploy-manage/users-roles/cloud-organization/manage-users.md) for more information.
19+
20+
## Leave an organization [ec-leave-organization]
21+
22+
On the **Members** tab of the **Organization** page, click the three dots corresponding to your email address and select **Leave organization**.
23+
24+
If you’re the only user in the organization, you can only leave if you deleted all your deployments and projects, and you don’t have pending bills.
25+
26+
## Join an organization from an existing {{ecloud}} account [ec-join-invitation]
27+
28+
If you already belong to an organization, and you want to join a new one you will need to leave your existing organization and follow this steps:
29+
30+
1. Make sure you do not have active projects or deployments before you leave your current organization.
31+
2. Delete your projects or deployments and clear any bills.
32+
3. Leave your current organization.
33+
4. Ask the administrator to invite you to the organization you want to join.
34+
5. Accept the invitation that you will get by email.
35+
36+
Alternatively, for Elastic Cloud Hosted deployments, there's a possibility to migrate your deployments to the new organization through back up and restore operations. In such case:
37+
38+
1. [Back up your deployments to any private repository](/deploy-manage/tools/snapshot-and-restore/ec-custom-repository.md) so that you can restore them to your new organization.
39+
2. Leave your current organization.
40+
3. Ask the administrator to invite you to the organization you want to join.
41+
4. Accept the invitation that you will get by email.
42+
5. Configure the private repository in your new organization and restore the backup you took in step 1.

cloud-account/multifactor-authentication.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-account-security-mfa.html
4+
applies:
5+
serverless: all
6+
hosted: all
47
---
58

69
# Multifactor authentication [ec-account-security-mfa]
710

8-
If you use a password-based login, Elastic requires that you add an extra layer of security to your Elasticsearch Service account by enabling a multifactor authentication (MFA) method.
11+
If you use a password-based login, Elastic requires you to enable multifactor authentication (MFA) for added security on your {{ecloud}} account.
912

1013
You can choose from the following methods:
1114

@@ -15,7 +18,7 @@ You can choose from the following methods:
1518

1619
Elastic recommends that you enable multiple methods so that you can still access your account if you lose access to one method.
1720

18-
If you use only a Google or Microsoft account to log in, then you can’t configure MFA in Elasticsearch Service. You can check and manage your multifactor authentication options in your Google or Microsoft account security settings.
21+
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.
1922

2023
::::{note}
2124
You can no longer configure SMS as a multifactor authentication method. If you already use SMS for multifactor authentication, then you can continue using it. You’ll be prompted to switch to a new MFA method in the future.
@@ -27,7 +30,7 @@ You can no longer configure SMS as a multifactor authentication method. If you a
2730

2831
To enable multifactor authentication using an authenticator app, you must enroll your device.
2932

30-
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
33+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
3134
2. Go to [User settings](https://cloud.elastic.co/user/settings) and choose **Profile**. Navigate to the **Multifactor authentication** section.
3235
3. On the **Authenticator app** card, select **Set up**.
3336
4. Scan the QR code with your authenticator app. If you can’t scan the QR code, then you can enter the code manually.
@@ -38,7 +41,7 @@ To enable multifactor authentication using an authenticator app, you must enroll
3841

3942
To enable multifactor authentication using a security key or biometrics, you must register your security key or biometric data.
4043

41-
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
44+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
4245
2. Go to [User settings](https://cloud.elastic.co/user/settings) and choose **Profile**. Navigate to the **Multifactor authentication** section.
4346
3. On the **Security key or biometrics** card, select **Set up**.
4447
4. Follow the prompts on your screen to register your hardware security key or your biometric authentication method.
@@ -48,7 +51,7 @@ To enable multifactor authentication using a security key or biometrics, you mus
4851

4952
To enable multifactor authentication using an authenticator app, you must verify your email address.
5053

51-
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
54+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
5255
2. Go to [User settings](https://cloud.elastic.co/user/settings) and choose **Profile**. Navigate to the **Multifactor authentication** section.
5356
3. On the **Email** card, select **Set up**.
5457
4. Enter the verification code sent to your email address, and then select **Enable authentication method**.
@@ -105,12 +108,9 @@ You can explore the following workarounds:
105108
* Use the email MFA method, assuming all of your team members have access to the generic account or distribution list’s mailbox.
106109
* Keep using the generic account to log in and set up multifactor authentication [using an authenticator app](#ec-account-security-mfa-authenticator).
107110

108-
```
109-
During the setup, take a photo of the QR code, or note its numeric version, and share it across your team. This code is sensitive and should be stored and shared securely. For example, it should be stored in an encrypted place using a secure algorithm such as AES-256, and transmitted over a secure encrypted channel such as TLS 1.3.
110-
```
111-
```
112-
This QR code is the "base" number used by the Authenticator app to generate codes based on the current time. There is no danger of synchronization issues. However, there is risk of a breach if the QR code picture or number is compromised.
113-
```
111+
During the setup, take a photo of the QR code, or note its numeric version, and share it across your team. This code is sensitive and should be stored and shared securely. For example, it should be stored in an encrypted place using a secure algorithm such as AES-256, and transmitted over a secure encrypted channel such as TLS 1.3.
112+
113+
This QR code is the "base" number used by the Authenticator app to generate codes based on the current time. There is no danger of synchronization issues. However, there is risk of a breach if the QR code picture or number is compromised.
114114

115115

116116
**After I set up an MFA method, will I need to answer an MFA challenge every time I authenticate through Elastic Cloud?**
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-update-email-address.html
4+
applies:
5+
serverless: all
6+
hosted: all
47
---
58

69
# Update your email address [ec-update-email-address]
710

8-
Each Elasticsearch Service account has a primary email associated with it. By default, the primary email address is used to sign up for Elasticsearch Service and to log in. If needed, you can change this primary email address:
11+
Each {{ecloud}} account has a primary email associated with it. By default, the primary email address is used to sign up for {{ecloud}} and to log in. If needed, you can change this primary email address:
912

10-
1. By **Email address**, select **edit**.
11-
2. Enter a new email address and your current password.
13+
1. To edit your account settings, select the user icon on the header bar and select **Settings**.
14+
2. In the **Email address** section, select **edit**.
15+
3. Enter a new email address and your current password.
1216

1317
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.
1418

15-
16-
If you are using Google or Microsoft Sign-In and would like to change your email address, you will need to:
19+
If you are using Google or Microsoft Sign-In and would like to change your email address, you need to:
1720

1821
1. Go to the [Forgot password](https://cloud.elastic.co/forgot) page and enter your email address.
1922
2. Follow the instructions in the "Reset your password" email.
20-
3. In the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), update your [User settings](https://cloud.elastic.co/user/settings) to the new email address.
23+
3. In the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), update your [User settings](https://cloud.elastic.co/user/settings) to the new email address.
2124

2225
If your organization is associated with [Azure Marketplace](../deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md), you can’t change your primary email address using the above methods. Instead, [invite another user](../deploy-manage/users-roles/cloud-organization/manage-users.md) with the desired email address to your organization.
2326

deploy-manage/autoscaling/ec-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ When past behavior on a hot tier indicates that the influx of data can increase
6262

6363
* Through ILM policies. For example, if a deployment has only hot nodes and autoscaling is enabled, it automatically creates warm or cold nodes, if an ILM policy is trying to move data from hot to warm or cold nodes.
6464

65-
On machine learning nodes, scaling is determined by an estimate of the memory and CPU requirements for the currently configured jobs and trained models. When a new machine learning job tries to start, it looks for a node with adequate native memory and CPU capacity. If one cannot be found, it stays in an `opening` state. If this waiting job exceeds the queueing limit set in the machine learning decider, a scale up is requested. Conversely, as machine learning jobs run, their memory and CPU usage might decrease or other running jobs might finish or close. In this case, if the duration of decreased resource usage exceeds the set value for `down_scale_delay`, a scale down is requested. Check [Machine learning decider](autoscaling-deciders.md) for more detail. To learn more about machine learning jobs in general, check [Create anomaly detection jobs](https://www.elastic.co/guide/en/machine-learning/current/create-jobs.html).
65+
On machine learning nodes, scaling is determined by an estimate of the memory and CPU requirements for the currently configured jobs and trained models. When a new machine learning job tries to start, it looks for a node with adequate native memory and CPU capacity. If one cannot be found, it stays in an `opening` state. If this waiting job exceeds the queueing limit set in the machine learning decider, a scale up is requested. Conversely, as machine learning jobs run, their memory and CPU usage might decrease or other running jobs might finish or close. In this case, if the duration of decreased resource usage exceeds the set value for `down_scale_delay`, a scale down is requested. Check [Machine learning decider](autoscaling-deciders.md) for more detail. To learn more about machine learning jobs in general, check [Create anomaly detection jobs](https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html).
6666

6767
On a highly available deployment, autoscaling events are always applied to instances in each availability zone simultaneously, to ensure consistency.
6868

0 commit comments

Comments
 (0)