Skip to content

Commit

Permalink
Merge branch 'main' into 366/transform-enrich
Browse files Browse the repository at this point in the history
  • Loading branch information
kilfoyle authored Feb 5, 2025
2 parents a4bbcef + 1edfde1 commit 654a46e
Show file tree
Hide file tree
Showing 264 changed files with 1,670 additions and 1,690 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/comment-on-asciidoc-changes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Comment on PR for .asciidoc changes

on:
# We need to use pull_request_target to be able to comment on PRs from forks
pull_request_target:
types:
- synchronize
- opened
- reopened
branches:
- main
- master
- "9.0"

jobs:
comment-on-asciidoc-change:
permissions:
contents: read
pull-requests: write
uses: elastic/docs-builder/.github/workflows/comment-on-asciidoc-changes.yml@main
1 change: 1 addition & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ jobs:
strict: false
permissions:
contents: read
pull-requests: read
2 changes: 1 addition & 1 deletion cloud-account/multifactor-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To enable multifactor authentication using an authenticator app, you must verify

You can remove a multifactor authentication method after it’s added by clicking **Remove**.

Before you remove an authentication method, you must set up an alternate method. If you can’t use any of your configured authentication methods — for example, if your device is lost or stolen — then [contact support](../troubleshoot/troubleshoot/cloud.md).
Before you remove an authentication method, you must set up an alternate method. If you can’t use any of your configured authentication methods — for example, if your device is lost or stolen — then [contact support](../troubleshoot/troubleshoot/index.md).


## Frequently asked questions [ec-account-security-mfa-faq]
Expand Down
6 changes: 3 additions & 3 deletions deploy-manage/cloud-organization/billing/billing-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ $$$faq-payment$$$What are the available payment methods on Elasticsearch Service
: For month-to-month payments only credit cards are accepted. We also allow payments by bank transfer for annual subscriptions.

$$$faq-contact$$$Who can I contact for more information?
: If you have any further questions about your credit card statement, billing, or receipts, please send an email to `[email protected]` or open a [Support case](../../../troubleshoot/troubleshoot/cloud.md) using the *Billing issue* category.
: If you have any further questions about your credit card statement, billing, or receipts, please send an email to `[email protected]` or open a [Support case](../../../troubleshoot/troubleshoot/index.md) using the *Billing issue* category.

$$$faq-charge$$$Why is my credit card charged?
: If you are on a monthly plan, the charge is a recurring fee for using our hosted Elasticsearch Service. The fee is normally charged at the start of each month, but it can also be charged at other times during the month. If a charge is unsuccessful, we will try to charge your card again at a later date.
Expand All @@ -86,10 +86,10 @@ $$$faq-chargednotusing$$$Why am I being charged if I don’t use any of my deplo
: Even if you have no activity on your account and you haven’t logged into the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), your active deployments still incur costs that we need to charge you for. To avoid being charged for active but unused deployments, you can simply delete them. Your account will stay active with no charges, and you can always spin up more capacity when you need it.

$$$faq-deleteaccount$$$How can I delete my Elastic Cloud account?
: To have your account removed, you can contact support through the Elasticsearch Service [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) or use one of these [alternative contact methods](../../../troubleshoot/troubleshoot/cloud.md). For details about our data erasure policy, check [Privacy Rights and Choices](https://www.elastic.co/legal/privacy-statement#privacy-rights-and-choices?page=docs&placement=docs-body) in our General Privacy Statement.
: To have your account removed, you can contact support through the Elasticsearch Service [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) or use one of these [alternative contact methods](../../../troubleshoot/troubleshoot/index.md). For details about our data erasure policy, check [Privacy Rights and Choices](https://www.elastic.co/legal/privacy-statement#privacy-rights-and-choices?page=docs&placement=docs-body) in our General Privacy Statement.

$$$faq-refund$$$Can I get a refund?
: Charges are non-refundable, but once you delete a deployment we’ll stop charging you for that deployment immediately. You only pay for what you use and you can stop using the service at any time. For any special considerations warranting a potential refund, please use the Elasticsearch Service Console [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) to open a support case and select *Billing issue* as the category. To ensure quick processing, be sure to provide detail about the reasons for the refund request as well as other matters pertaining to the issue. For other ways to open a Support case, check [Getting help](../../../troubleshoot/troubleshoot/cloud.md).
: Charges are non-refundable, but once you delete a deployment we’ll stop charging you for that deployment immediately. You only pay for what you use and you can stop using the service at any time. For any special considerations warranting a potential refund, please use the Elasticsearch Service Console [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) to open a support case and select *Billing issue* as the category. To ensure quick processing, be sure to provide detail about the reasons for the refund request as well as other matters pertaining to the issue. For other ways to open a Support case, check [Contact us](../../../troubleshoot/troubleshoot/index.md).

$$$faq-included$$$What is included in my paid Elasticsearch Service deployment?
: All subscription tiers for the Elasticsearch Service include the following free allowance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Data transfer out of deployments and between nodes of the cluster is hard to con

The largest contributor to inter-node data transfer is usually shard movement between nodes in a cluster. The only way to prevent shard movement is by having a single node in a single availability zone. This solution is only possible for clusters up to 64GB RAM and is not recommended as it creates a risk of data loss. [Oversharding](https://www.elastic.co/guide/en/elasticsearch/reference/current/avoid-oversharding.html) can cause excessive shard movement. Avoiding oversharding can also help control costs and improve performance. Note that creating snapshots generates inter-node data transfer. The *storage* cost of snapshots is detailed later in this document.

The exact root cause of unusual data transfer is not always something we can identify as it can have many causes, some of which are out of our control and not associated with Cloud configuration changes. It may help to [enable monitoring](../../monitor/stack-monitoring/stack-monitoring-on-elastic-cloud-deployments.md) and examine index and shard activity on your cluster.
The exact root cause of unusual data transfer is not always something we can identify as it can have many causes, some of which are out of our control and not associated with Cloud configuration changes. It may help to [enable monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) and examine index and shard activity on your cluster.


## Storage [storage]
Expand Down
25 changes: 12 additions & 13 deletions deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ If you want to install Elastic Cloud Enterprise on your own hosts, the steps for
Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with Elastic Cloud Enterprise.


## Install Docker [ece-install-docker-sles12-cloud]
## Install Docker [ece-install-docker-sles12-cloud]

::::{important}
::::{important}
Make sure to use a combination of Linux distribution and Docker version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more.
::::

Expand Down Expand Up @@ -63,7 +63,7 @@ Make sure to use a combination of Linux distribution and Docker version that is



## Set up OS groups and user [ece_set_up_os_groups_and_user]
## Set up OS groups and user [ece_set_up_os_groups_and_user]

1. If they don’t already exist, create the following OS groups:

Expand All @@ -80,18 +80,18 @@ Make sure to use a combination of Linux distribution and Docker version that is



## Set up XFS on SLES [ece-xfs-setup-sles12-cloud]
## Set up XFS on SLES [ece-xfs-setup-sles12-cloud]

XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On SLES 12 and 15, you need to set up an XFS file system and have quotas enabled.

Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space.

::::{note}
::::{note}
Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, nor is it provided as part of supporting Elastic Cloud Enterprise.
::::


::::{important}
::::{important}
You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly.
::::

Expand Down Expand Up @@ -124,7 +124,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage



## Update the configurations settings [ece-update-config-sles-cloud]
## Update the configurations settings [ece-update-config-sles-cloud]

1. Stop the Docker service:

Expand Down Expand Up @@ -162,7 +162,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
EOF
```
::::{important}
::::{important}
The `net.ipv4.tcp_retries2` setting applies to all TCP connections and affects the reliability of communication with systems other than Elasticsearch clusters too. If your clusters communicate with external systems over a low quality network then you may need to select a higher value for `net.ipv4.tcp_retries2`.
::::
Expand All @@ -178,7 +178,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
Add the following configuration values to the `/etc/security/limits.conf` file. These values are derived from our experience with the Elastic Cloud hosted offering and should be used for Elastic Cloud Enterprise as well.
::::{tip}
::::{tip}
If you are using a user name other than `elastic`, adjust the configuration values accordingly.
::::
Expand Down Expand Up @@ -243,7 +243,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
## Configure the Docker daemon [ece-configure-docker-daemon-sles12-cloud]
## Configure the Docker daemon [ece-configure-docker-daemon-sles12-cloud]
1. Edit `/etc/docker/daemon.json`, and make sure that the following configuration values are present:<br>
Expand Down Expand Up @@ -321,7 +321,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
5. Reboot your system to ensure that all configuration changes take effect:
```literal
```sh
sudo reboot
```
Expand All @@ -333,7 +333,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
7. After rebooting, verify that your Docker settings persist as expected:
```literal
```sh
sudo docker info | grep Root
```
Expand All @@ -342,4 +342,3 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
If the command returns `Docker Root Dir: /var/lib/docker`, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, check [Custom Docker daemon options](https://docs.docker.com/engine/admin/systemd/#/custom-docker-daemon-options) in the Docker documentation.
8. Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise.
25 changes: 12 additions & 13 deletions deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ If you want to install Elastic Cloud Enterprise on your own hosts, the steps for
Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with Elastic Cloud Enterprise.


## Install Docker [ece-install-docker-sles12-onprem]
## Install Docker [ece-install-docker-sles12-onprem]

::::{important}
::::{important}
Make sure to use a combination of Linux distribution and Docker version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more.
::::

Expand Down Expand Up @@ -63,7 +63,7 @@ Make sure to use a combination of Linux distribution and Docker version that is



## Set up OS groups and user [ece_set_up_os_groups_and_user_2]
## Set up OS groups and user [ece_set_up_os_groups_and_user_2]

1. If they don’t already exist, create the following OS groups:

Expand All @@ -80,18 +80,18 @@ Make sure to use a combination of Linux distribution and Docker version that is



## Set up XFS on SLES [ece-xfs-setup-sles12-onprem]
## Set up XFS on SLES [ece-xfs-setup-sles12-onprem]

XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On SLES 12 and 15, you need to set up an XFS file system and have quotas enabled.

Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space.

::::{note}
::::{note}
Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, nor is it provided as part of supporting Elastic Cloud Enterprise.
::::


::::{important}
::::{important}
You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly.
::::

Expand Down Expand Up @@ -124,7 +124,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage



## Update the configurations settings [ece-update-config-sles-onprem]
## Update the configurations settings [ece-update-config-sles-onprem]

1. Stop the Docker service:

Expand Down Expand Up @@ -162,7 +162,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
EOF
```
::::{important}
::::{important}
The `net.ipv4.tcp_retries2` setting applies to all TCP connections and affects the reliability of communication with systems other than Elasticsearch clusters too. If your clusters communicate with external systems over a low quality network then you may need to select a higher value for `net.ipv4.tcp_retries2`.
::::
Expand All @@ -178,7 +178,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
Add the following configuration values to the `/etc/security/limits.conf` file. These values are derived from our experience with the Elastic Cloud hosted offering and should be used for Elastic Cloud Enterprise as well.
::::{tip}
::::{tip}
If you are using a user name other than `elastic`, adjust the configuration values accordingly.
::::
Expand Down Expand Up @@ -243,7 +243,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
## Configure the Docker daemon [ece-configure-docker-daemon-sles12-onprem]
## Configure the Docker daemon [ece-configure-docker-daemon-sles12-onprem]
1. Edit `/etc/docker/daemon.json`, and make sure that the following configuration values are present:<br>
Expand Down Expand Up @@ -321,7 +321,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
5. Reboot your system to ensure that all configuration changes take effect:
```literal
```sh
sudo reboot
```
Expand All @@ -333,7 +333,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
7. After rebooting, verify that your Docker settings persist as expected:
```literal
```sh
sudo docker info | grep Root
```
Expand All @@ -342,4 +342,3 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage
If the command returns `Docker Root Dir: /var/lib/docker`, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, check [Custom Docker daemon options](https://docs.docker.com/engine/admin/systemd/#/custom-docker-daemon-options) in the Docker documentation.
8. Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise.
Loading

0 comments on commit 654a46e

Please sign in to comment.