Skip to content

Commit cab411b

Browse files
authored
Merge branch 'main' into frconil-patch-2
2 parents 65bfe79 + f3bdcdf commit cab411b

File tree

208 files changed

+923
-846
lines changed

Some content is hidden

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

208 files changed

+923
-846
lines changed

.github/CODEOWNERS

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,66 @@
1-
/.github/ @elastic/doc-leads
2-
/.github/workflows/ @elastic/docs-engineering
1+
# Unless a later match takes precedence, someone on the docs team must review all PRs to this repo
2+
* @elastic/docs
33

4-
/serverless/ @elastic/platform-docs
5-
/serverless/serverless-changelog.asciidoc @elastic/docs
4+
# Templates, workflows, and config
5+
/.github/ @elastic/doc-leads
6+
/.github/workflows/ @elastic/docs-engineering
7+
/acrolinx/ @elastic/doc-leads
8+
9+
# The docs
10+
/cloud-account/ @elastic/admin-docs
11+
/deploy-manage/ @elastic/admin-docs
12+
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
13+
/extend/ @elastic/core-docs
14+
/get-started/ @elastic/core-docs
15+
16+
/manage-data/ @elastic/admin-docs
17+
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
18+
/manage-data/ingest/ @elastic/ingest-docs
19+
20+
/reference/ @elastic/docs
21+
/reference/apm-agents/ @elastic/ingest-docs
22+
/reference/data-analysis/ @elastic/docs
23+
/reference/data-analysis/observability/ @elastic/experience-docs
24+
/reference/data-analysis/kibana/ @elastic/experience-docs
25+
/reference/data-analysis/machine-learning/ @elastic/developer-docs
26+
/reference/data-analysis/observability/ @elastic/experience-docs
27+
/reference/elasticsearch/clients/ @elastic/developer-docs
28+
/reference/fleet/ @elastic/ingest-docs
29+
/reference/glossary/ @elastic/docs
30+
/reference/ingestion-tools/ @elastic/ingest-docs
31+
/reference/observability/ @elastic/experience-docs
32+
/reference/search/ @elastic/developer-docs
33+
/reference/security/ @elastic/experience-docs
34+
35+
/release-notes/ @elastic/docs
36+
37+
/release-notes/apm-agents/ @elastic/ingest-docs
38+
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs
39+
/release-notes/elastic-observability/ @elastic/ski-docs
40+
/release-notes/elastic-security/ @elastic/ski-docs
41+
/release-notes/elasticsearch-clients/ @elastic/developer-docs
42+
/release-notes/fleet-elastic-agent/ @elastic/ingest-docs
43+
/release-notes/intro/ @elastic/docs
44+
45+
/solutions/ @elastic/experience-docs @elastic/developer-docs
46+
/solutions/observability/ @elastic/experience-docs
47+
/solutions/observability/get-started/ @elastic/ski-docs
48+
/solutions/search/ @elastic/developer-docs
49+
/solutions/security/ @elastic/experience-docs
50+
/solutions/security/cloud/ @elastic/ingest-docs
51+
52+
/troubleshoot/ @elastic/docs
53+
/troubleshoot/deployments/ @elastic/admin-docs
54+
/troubleshoot/elasticsearch/ @elastic/admin-docs
55+
/troubleshoot/ingest/ @elastic/ingest-docs
56+
/troubleshoot/kibana/ @elastic/admin-docs @elastic/experience-docs
57+
/troubleshoot/monitoring/ @elastic/admin-docs @elastic/experience-docs
58+
/troubleshoot/observability/ @elastic/ski-docs
59+
/troubleshoot/security/ @elastic/ski-docs
60+
61+
# Raw migrated files
62+
/raw-migrated-files/ @elastic/docs
63+
64+
# Legacy serverless docs
65+
/serverless/ @elastic/admin-docs
66+
/serverless/serverless-changelog.asciidoc @elastic/docs

.github/ISSUE_TEMPLATE/community-request.yaml renamed to .github/ISSUE_TEMPLATE/a-community-request.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: "Community documentation request"
2-
description: Request a documentation change or enhancement.
3-
title: "[Request]: "
4-
labels: ["Request", "community"]
2+
description: An issue template for non-Elastic employees to request changes to the documentation.
3+
title: "[Community]: "
4+
labels: ["community"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this request!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
This issue template is for non-Elastic employees to request changes to the documentation. **If you are an Elastic employee, please use the internal issue template instead.**
10+
11+
This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead. Thanks for taking the time to fill out this request!
1212
- type: textarea
1313
id: link
1414
attributes:

.github/ISSUE_TEMPLATE/internal-request.yaml renamed to .github/ISSUE_TEMPLATE/b-internal-request.yaml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: "Internal documentation request (Elastic employees)"
2-
description: Request a documentation change or enhancement for any supported release.
3-
title: "[REQUEST]: "
4-
labels: ["request", "Team:Docs"]
2+
description: An issue template for Elastic employees to request improvements, additions, or changes to the documentation.
3+
title: "[Internal]: "
54
body:
65
- type: markdown
76
attributes:
@@ -69,6 +68,14 @@ body:
6968
default: 0
7069
validations:
7170
required: true
71+
- type: input
72+
id: release-serverless
73+
attributes:
74+
label: Serverless release
75+
description: When do you expect the feature to be promoted and available in the _**serverless production environment**_?
76+
placeholder: The week of April 1, 2024
77+
validations:
78+
required: true
7279
- type: dropdown
7380
id: collaboration
7481
attributes:

.github/ISSUE_TEMPLATE/api-feedback.yaml renamed to .github/ISSUE_TEMPLATE/c-api-feedback.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "API docs feedback"
22
description: Tell us about your experience with Elastic API documentation.
3-
title: "[Feedback]: "
4-
labels: ["feedback", "community"]
3+
title: "[API]: "
4+
labels: ["api-feedback"]
55
body:
66
- type: markdown
77
attributes:

.github/ISSUE_TEMPLATE/issue-report.yaml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
name: "Docs issue"
2-
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
3-
title: "[Issue]: "
4-
labels: ["triage"]
1+
name: "Website issue"
2+
description: This issue template should only be used when navigating directly from elastic.co.
3+
title: "[Website]: "
4+
labels: ["source:web"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this issue report!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
Hi 👋. Thanks for taking the time to fill out this issue report! This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead.
1210
- type: dropdown
1311
attributes:
1412
label: Type of issue

.github/workflows/add-to-board.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ jobs:
1212
route:
1313
runs-on: ubuntu-latest
1414
if: |
15+
github.event.label.name == 'team:Ingest' ||
16+
github.event.label.name == 'team:Experience' ||
17+
github.event.label.name == 'team:Admin' ||
18+
github.event.label.name == 'team:Developer' ||
1519
github.event.label.name == 'team:DocsEng' ||
1620
github.event.label.name == 'team:Obs' ||
1721
github.event.label.name == 'team:Platform' ||
@@ -21,12 +25,16 @@ jobs:
2125
env:
2226
PROJECT_ID_MAP: |
2327
{
24-
"team:DocsEng": "1625",
25-
"team:Obs": "649",
26-
"team:Platform": "1232",
27-
"team:Projects": "1415",
28-
"team:Search": "726",
29-
"team:Security": "1034"
28+
"team:Ingest": "649",
29+
"team:Experience": "1034",
30+
"team:Admin": "1927",
31+
"team:Developer": "726",
32+
"team:DocsEng": "1625",
33+
"team:Obs": "649",
34+
"team:Platform": "1232",
35+
"team:Projects": "1415",
36+
"team:Search": "726",
37+
"team:Security": "1034"
3038
}
3139
steps:
3240
- name: Remove needs-team label

cloud-account/multifactor-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To enable multifactor authentication using an authenticator app, you must verify
6060

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

63-
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/index.md).
63+
Before you remove an authentication method, you must set up an alternate method. If you can’t use any of your configured authentication methodsfor example, if your device is lost or stolenthen [contact support](../troubleshoot/index.md).
6464

6565

6666
## Frequently asked questions [ec-account-security-mfa-faq]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ For a data tier, an autoscaling event can be triggered in the following cases:
7171

7272
* 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.
7373

74-
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](../../explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs.md#ml-ad-create-job)
74+
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](../../explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs.md#ml-ad-create-job).
7575

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

@@ -650,4 +650,4 @@ curl -XPOST \
650650

651651
:::
652652

653-
::::
653+
::::

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ 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)
42+
1. Data in (free)
4343
: *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).
4444

45-
2. Data out
45+
2. Data out
4646
: *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*.
4747

48-
3. Data inter-node
48+
3. Data inter-node
4949
: *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.
5050

5151
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.
@@ -71,15 +71,15 @@ Storage costs are tied to the cost of storing the backup snapshots in the underl
7171

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

74-
1. Storage size (GB/month)
74+
1. Storage size (GB/month)
7575
: 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).
7676

7777
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.
7878

7979
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.
8080

8181

82-
2. Storage API requests (1K Requests/month)
82+
2. Storage API requests (1K Requests/month)
8383
: 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.
8484

8585
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.

deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
141141
[...]
142142
```
143143

144-
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.
144+
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 existsuse the one in the [engine] section.
145145

146146
Example:
147147

deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
171171
[...]
172172
```
173173

174-
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.
174+
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 existsuse the one in the [engine] section.
175175

176176
Example:
177177

deploy-manage/deploy/cloud-on-k8s/configuration-logstash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ If the volume driver supports `ExpandInUsePersistentVolumes`, the filesystem is
341341

342342
If the volume driver does not support `ExpandInUsePersistentVolumes`, you must manually delete Pods after the resize so that they can be recreated automatically with the expanded filesystem.
343343

344-
Any other changes in the volumeClaimTemplates—such as changing the storage class or decreasing the volume size—are not allowed. To make changes such as these, you must fully delete the {{ls}} resource, delete and recreate or resize the volume, and create a new {{ls}} resource.
344+
Any other changes in the volumeClaimTemplates—such as changing the storage class or decreasing the volume size—are not allowed. To make changes such as these, you must fully delete the {{ls}} resource, delete and recreate or resize the volume, and create a new {{ls}} resource.
345345

346346
Before you delete a persistent queue (PQ) volume, ensure that the queue is empty. We recommend setting `queue.drain: true` on the {{ls}} Pods to ensure that the queue is drained when Pods are shutdown. Note that you should also increase the `terminationGracePeriodSeconds` to a large enough value to allow the queue to drain.
347347

deploy-manage/deploy/cloud-on-k8s/configure-eck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ data:
9393
ubi-only: false
9494
```
9595
96-
Alternatively, you can edit the `elastic-operator` StatefulSet and add flags to the `args` section of the operator container — which will trigger an automatic restart of the operator pod by the StatefulSet controller.
96+
Alternatively, you can edit the `elastic-operator` StatefulSet and add flags to the `args` section of the operator containerwhich will trigger an automatic restart of the operator pod by the StatefulSet controller.
9797

9898
## Configure ECK under Operator Lifecycle Manager [k8s-operator-config-olm]
9999

deploy-manage/deploy/cloud-on-k8s/configure-validating-webhook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ products:
1010

1111
# Configure the validating webhook [k8s-webhook]
1212

13-
ECK can be configured to provide a [validating webhook](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) that validates Elastic custom resources ({{eck_resources_list}}) before they are created or updated. Validating webhooks provide immediate feedback if a submitted manifest contains invalid or illegal configuration — which can help you catch errors early and save time that would otherwise be spent on troubleshooting.
13+
ECK can be configured to provide a [validating webhook](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) that validates Elastic custom resources ({{eck_resources_list}}) before they are created or updated. Validating webhooks provide immediate feedback if a submitted manifest contains invalid or illegal configurationwhich can help you catch errors early and save time that would otherwise be spent on troubleshooting.
1414

1515
Validating webhooks are defined using a `ValidatingWebhookConfiguration` object that defines the following:
1616

@@ -30,7 +30,7 @@ Validating webhooks are defined using a `ValidatingWebhookConfiguration` object
3030
When using the default `operator.yaml` manifest, ECK is installed with a `ValidatingWebhookConfiguration` configured as follows:
3131

3232
* Validate all known Elastic custom resources ({{eck_resources_list}}) on create and update.
33-
* The operator itself is the webhook server — which is exposed through a service named `elastic-webhook-server` in the `elastic-system` namespace.
33+
* The operator itself is the webhook serverwhich is exposed through a service named `elastic-webhook-server` in the `elastic-system` namespace.
3434
* The operator generates a certificate for the webhook and stores it in a secret named `elastic-webhook-server-cert` in the `elastic-system` namespace. This certificate is automatically rotated by the operator when it is due to expire.
3535

3636

0 commit comments

Comments
 (0)