Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This repo contains source files for Elastic documentation.

## Contribute

If you find any bugs in our documentation, or want to request an enhancement, please [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
If you find any bugs in our documentation, or want to request an enhancement, [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).

We write our docs in markdown. See our [syntax guide](https://elastic.github.io/docs-builder/syntax/index.html) for examples and additional functionality.

Expand Down
4 changes: 2 additions & 2 deletions deploy-manage/cloud-organization/billing/billing-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ $$$faq-payment$$$What are the available payment methods on {{ecloud}}?
: 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/index.md) using the *Billing issue* category.
: If you have any further questions about your credit card statement, billing, or receipts, send an email to `[email protected]` or open a [Support case](../../../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 {{ecloud}}. 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 @@ -90,7 +90,7 @@ $$$faq-deleteaccount$$$How can I delete my {{ecloud}} account?
: To have your account removed, you can contact support through the {{ecloud}} [Support form](https://cloud.elastic.co/support?page=docs&placement=docs-body) or use one of these [alternative contact methods](../../../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 {{ecloud}} 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/index.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, use the {{ecloud}} 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/index.md).

$$$faq-included$$$What is included in my paid {{ech}} deployment?
: All subscription tiers for {{ech}} include the following free allowance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ navigation_title: Ansible playbook

If you already use Ansible in your business for provisioning, configuration management, and application deployment, you can use the ECE Ansible playbook to get up and running with {{ece}} faster, on any cloud provider.

Please note that the ECE Ansible playbook is a community project, supported by Elastic, available on GitHub: [elastic/ansible-elastic-cloud-enterprise](https://github.com/elastic/ansible-elastic-cloud-enterprise). Elastic welcomes all community contributions to the repository and will validate any changes on a best-effort basis.
Note that the ECE Ansible playbook is a community project, supported by Elastic, available on GitHub: [elastic/ansible-elastic-cloud-enterprise](https://github.com/elastic/ansible-elastic-cloud-enterprise). Elastic welcomes all community contributions to the repository and will validate any changes on a best-effort basis.

Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
[...]
```

6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Please note that multiple env variables in that configuration file exists — use the one in the [engine] section.
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Note that multiple env variables in that configuration file exists — use the one in the [engine] section.

Example:

Expand Down Expand Up @@ -304,7 +304,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
sudo install -o elastic -g elastic -d -m 700 /mnt/data/docker
```

25. If you want to use FirewallD, please ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
25. If you want to use FirewallD, ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:

```sh
sudo systemctl disable firewalld
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-enterprise/ece-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ If you’re using a [private Docker registry server](ece-install-offline-with-re

Avoid deleting containers unless explicitly instructed by Elastic Support or official documentation. Doing so may lead to unexpected issues or loss of access to your {{ece}} platform. For more details, refer to [](/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md).

If in doubt, please [contact support for help](/troubleshoot/index.md#contact-us).
If in doubt, [contact support for help](/troubleshoot/index.md#contact-us).
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ The size of your ECE deployment has a bearing on the JVM heap sizes that you sho
The ECE management services provided by the coordinators and directors require fast SSD storage to work correctly. For smaller deployments that co-locate the ECE management services with proxies and allocators on the same hosts, you must use fast SSD storage for your entire deployment. If SSD-only storage is not feasible, [some of the ECE management services need to be separated](ece-roles.md).

::::{note}
When using SSDs on an external (shared) storage system, please check with your storage vendor whether TRIM [should be disabled](https://www.elastic.co/blog/is-your-elasticsearch-trimmed) on the ECE hosts to avoid unnecessary stress on the storage system.
When using SSDs on an external (shared) storage system, check with your storage vendor whether TRIM [should be disabled](https://www.elastic.co/blog/is-your-elasticsearch-trimmed) on the ECE hosts to avoid unnecessary stress on the storage system.
::::
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ mapped_pages:
# Wildcard DNS record [ece-wildcard-dns]

::::{warning}
We do not recommend using `ip.es.io` for production systems. Please set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`.
Don't use `ip.es.io` for production systems. Set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`.
::::

By default, {{ece}} uses the external `ip.es.io` service provided by Elastic to resolve virtual {{es}} cluster host names in compliance with RFC1918. The service works by resolving host names of the form `<ip>.ip.es.io` to `<ip>`. In the case of {{ece}}, each cluster is assigned a virtual host name of the form `<cluster id>.<proxy ip address>.ip.es.io:<port>`, such as `6dfc65aae62341e18a8b7692dcc97186.10.8.156.132.ip.es.io:9243`. The `ip.es.io` service simply resolves the virtual host name of the cluster to the proxy address which is specified during installation, `10.8.156.132` in our example, so that client requests are sent to the proxy. The proxy then extracts the cluster ID from the virtual host name of the cluster and uses its internal routing table to route the request to the right allocator.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
[...]
```

6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Please note that multiple env variables in that configuration file exists — use the one in the [engine] section.
6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Note that multiple env variables in that configuration file exists — use the one in the [engine] section.

Example:

Expand Down Expand Up @@ -334,7 +334,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
sudo install -o elastic -g elastic -d -m 700 /mnt/data/docker
```

25. If you want to use FirewallD, please ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:
25. If you want to use FirewallD, ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with:

```sh
sudo systemctl disable firewalld
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Following are the supported upgrade paths for Podman 5 in {{ece}}.
Podman `5.2.2-13` is only supported when conducting a **fresh {{ece}} installation** or performing a **grow-and-shrink update** from Docker or Podman 4.

For **in-place updates**, it is recommended to use Podman `5.2.2-9`, since upgrades to versions `5.2.2-11` and `5.2.2-13` are affected by a known [memory leak issue](https://github.com/containers/podman/issues/25473).
When performing an in-place update, please make sure to configure the Podman version to be locked at version `5.2.2-9.*`, by following the instructions below.
When performing an in-place update, make sure to configure the Podman version to be locked at version `5.2.2-9.*`, by following the instructions below.

```sh
## Install versionlock
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ spec:
...
```

Please note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.
Note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.


## Running as a non-root user [k8s-elastic-agent-running-as-a-non-root-user]
Expand Down
4 changes: 2 additions & 2 deletions deploy-manage/deploy/cloud-on-k8s/pod-prestop-hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ mapped_pages:

When an {{es}} `Pod` is terminated, its `Endpoint` is removed from the `Service` and the {{es}} process is terminated. As these two operations happen in parallel, a race condition exists. If the {{es}} process is already shut down, but the `Endpoint` is still a part of the `Service`, any new connection might fail. For more information, check [Termination of pods](https://kubernetes.io/docs/concepts/workloads/pods/pod/#termination-of-pods).

Moreover, kube-proxy resynchronizes its rules [every 30 seconds by default](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/#options). During that time window of 30 seconds, the terminating Pod IP may still be used when targeting the service. Please note the resync operation itself may take some time, especially if kube-proxy is configured to use iptables with a lot of services and rules to apply.
Moreover, kube-proxy resynchronizes its rules [every 30 seconds by default](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/#options). During that time window of 30 seconds, the terminating Pod IP may still be used when targeting the service. Note the resync operation itself may take some time, especially if kube-proxy is configured to use iptables with a lot of services and rules to apply.

To address this issue and minimize unavailability, ECK relies on a [PreStop lifecycle hook](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/). It waits for an additional `PRE_STOP_ADDITIONAL_WAIT_SECONDS` (defaulting to 50). The additional wait time is used to:

Expand Down Expand Up @@ -39,5 +39,5 @@ The pre-stop lifecycle hook also tries to gracefully shut down the {{es}} node i

This is done on a best effort basis. In particular requests to an {{es}} cluster already in the process of shutting down might fail if the Kubernetes service has already been removed. The script allows for `PRE_STOP_MAX_DNS_ERRORS` which default to 2 before giving up.

When using local persistent volumes a different behaviour might be desirable because the {{es}} node’s associated storage will not be available anymore on the new Kubernetes node. `PRE_STOP_SHUTDOWN_TYPE` allows to override the default shutdown type to one of the [possible values](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node). Please be aware that setting it to anything other than `restart` might mean that the pre-stop hook will run longer than `terminationGracePeriodSeconds` of the Pod while moving data out of the terminating Pod and will not be able to complete unless you also adjust that value in the `podTemplate`.
When using local persistent volumes a different behaviour might be desirable because the {{es}} node’s associated storage will not be available anymore on the new Kubernetes node. `PRE_STOP_SHUTDOWN_TYPE` allows to override the default shutdown type to one of the [possible values](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node). Be aware that setting it to anything other than `restart` might mean that the pre-stop hook will run longer than `terminationGracePeriodSeconds` of the Pod while moving data out of the terminating Pod and will not be able to complete unless you also adjust that value in the `podTemplate`.

Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ When `kubectl` is used to modify a resource, it calculates the diff between the
If you have configured a Beat to run as a `Deployment` and you are using a `hostPath` volume as the Beats data directory, you might encounter an error similar to the following:

```shell
ERROR instance/beat.go:958 Exiting: data path already locked by another beat. Please make sure that multiple beats are not sharing the same data path (path.data).
ERROR instance/beat.go:958 Exiting: data path already locked by another beat. Make sure that multiple beats are not sharing the same data path (path.data).
```

This can happen if the new Pod is scheduled on the same Kubernetes node as the old Pod and is now trying to use the same data directory. Use a [`Recreate`](/deploy-manage/deploy/cloud-on-k8s/configuration-beats.md#k8s-beat-chose-the-deployment-model) deployment strategy to avoid this problem.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ For customers paying in non-USD currencies, any future prepaid fees, or on-deman

## Our commitment to you [ec_our_commitment_to_you]

We understand that pricing adjustments can raise questions or concerns, and we are here to support you throughout this process. Should you have any inquiries or need assistance, please reach out to your Elastic account representative or Elastic Support at `[email protected]`.
We understand that pricing adjustments can raise questions or concerns, and we are here to support you throughout this process. Should you have any inquiries or need assistance, reach out to your Elastic account representative or Elastic Support at `[email protected]`.
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ $$$azure-integration-migrate$$$How do I migrate my data from the classic Azure m


$$$azure-integration-no-inbox$$$Can I invite users to my organization, even if they cannot receive emails?
: You can add Azure users as members of your organization even if they don’t have an inbox. Please reach out to Elastic support.
: You can add Azure users as members of your organization even if they don’t have an inbox. Reach out to Elastic support.


## Billing [ec-azure-integration-billing-faq]
Expand Down Expand Up @@ -510,7 +510,7 @@ Mimicking this metadata by manually adding tags to an {{ecloud}} deployment will

$$$azure-integration-logs-not-ingested$$$My {{ecloud}} Azure Native ISV Service logs are not being ingested.
: * When you set up monitoring for your Azure services, if your Azure and Elastic resources are in different subscriptions, you need to make sure that the `Microsoft.Elastic` resource provider is registered in the subscription in which the Azure resources exist. Check [How do I monitor my existing Azure services?](#azure-integration-monitor) for details.
* If you are using [IP or Private Link traffic filters](../../security/traffic-filtering.md), please reach out to [the Elastic Support Team](#azure-integration-support).
* If you are using [IP or Private Link traffic filters](../../security/traffic-filtering.md), reach out to [the Elastic Support Team](#azure-integration-support).



Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/elastic-cloud/cloud-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ $$$faq-where$$$**Where are deployments hosted?**
$$$faq-vs-aws$$$**What is the difference between {{ech}} and the Amazon {{es}} Service?**
: {{ech}} is the only hosted and managed {{es}} service built, managed, and supported by the company behind {{es}}, {{kib}}, {{beats}}, and {{ls}}. With {{ech}}, you always get the latest versions of the software. Our service is built on best practices and years of experience hosting and managing thousands of {{es}} clusters in the Cloud and on premise. For more information, check the following Amazon and Elastic {{es}} Service [comparison page](https://www.elastic.co/aws-elasticsearch-service).

Please note that there is no formal partnership between Elastic and Amazon Web Services (AWS), and Elastic does not provide any support on the AWS {{es}} Service.
Note that there is no formal partnership between Elastic and Amazon Web Services (AWS), and Elastic does not provide any support on the AWS {{es}} Service.


$$$faq-aws$$$**Can I use {{ech}} on platforms other than AWS?**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ mapped_pages:

# Create a monthly pay-as-you-go subscription on AWS Marketplace [ec-aws-marketplace-conversion]

When subscribing to an annual prepaid subscription to {{ecloud}} on AWS Marketplace, please follow these instructions to obtain a separate pay-as-you-go subscription. This subscription will allow us to continue your {{ecloud}} service through the Marketplace once the contract is expired. You will not get charged twice for the usage under the annual contract.
When subscribing to an annual prepaid subscription to {{ecloud}} on AWS Marketplace, follow these instructions to obtain a separate pay-as-you-go subscription. This subscription will allow us to continue your {{ecloud}} service through the Marketplace once the contract is expired. You will not get charged twice for the usage under the annual contract.

1. Log in to AWS under the same Account ID that you will use to accept the Annual Private Offer.
2. Go to the [AWS Marketplace subscription page for {{ecloud}} pay-as-you-go](https://aws.amazon.com/marketplace/saas/ordering?productId=bb253a6c-e775-4634-bdf0-17bd56a69c36&offerId=b2uzdkwqj7177fqhm39o4snxy).
Expand Down
Loading
Loading