Skip to content

Commit 63cd474

Browse files
authored
Merge branch 'main' into rseldner-patch-1
2 parents 2578aa2 + 21777be commit 63cd474

File tree

159 files changed

+1315
-570
lines changed

Some content is hidden

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

159 files changed

+1315
-570
lines changed

.github/ISSUE_TEMPLATE/internal-request.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ body:
6363
- 'N/A'
6464
- '8.17'
6565
- '8.18'
66+
- '8.19'
6667
- '9.0'
68+
- '9.1'
6769
default: 0
6870
validations:
6971
required: true
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: "UI copy request"
2+
description: Submit a UI copy-related request to the documentation team.
3+
title: "[UI copy]: "
4+
labels: "ui-copy"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Hello! Use this form to submit a UI copy related request to Elastic's documentation team. You should also directly contact the specific writer or docs team that's responsibile for the applicable part of the product, especially for time-sensitive requests.
10+
> [!WARNING]
11+
> THIS IS A PUBLIC REPO. DO NOT INCLUDE SENSITIVE INFORMATION HERE.
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: Summarize your request here. What is the work and how can we help? Do we need to write new copy, or edit existing copy? Feel free to include screenshots.
17+
placeholder: |
18+
What: We're introducing new feature A. We need a writer to review the UI copy.
19+
When: This feature will launch at the completion of project B.
20+
Why: This feature will make X, Y, and Z easier for the user.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: related
25+
attributes:
26+
label: Related links / assets
27+
description: Where can the documentation team learn more about this feature?
28+
value: |
29+
Please include each of the following, if applicable:
30+
Figma link(s):
31+
Github epic link(s):
32+
Github issue link(s):
33+
How to find the text in a production environment:
34+
Testing environment information:
35+
NOTE: To keep sensitive information such as credentials secure, do not include it in this form.
36+
validations:
37+
required: true
38+
- type: dropdown
39+
id: product-area
40+
attributes:
41+
label: Which product area does this mainly concern?
42+
options:
43+
- Cloud UI
44+
- Search solution
45+
- Observability solution
46+
- Security solution
47+
- Kibana Analytics (Discover, Dashboards...)
48+
- Kibana Management
49+
- Something else
50+
default: 0
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: collaborators
55+
attributes:
56+
label: Collaborators
57+
description: Please include contact information for the responsible product manager, designer, and developer.
58+
value: |
59+
PM:
60+
Designer:
61+
Developer:
62+
Others (if applicable):
63+
validations:
64+
required: true
65+
- type: textarea
66+
id: timeline
67+
attributes:
68+
label: Timeline / deliverables
69+
description: When would it be ideal for for us to complete the request? What deliverables do you need, and when? If applicable, how do the release timelines for this feature differ between serverless / stateful?
70+
placeholder: |
71+
For example:
72+
73+
We need a final draft of the new UI copy no later than December 5, ideally by December 1. No differences between serverless/ESS.
74+
75+
This is an urgent request, it would be great to have updated copy for A and B ASAP, since the original copy is already in production. No differences between serverless/ESS.
76+
validations:
77+
required: true
78+
- type: markdown
79+
attributes:
80+
value: |
81+
Thanks for submitting this issue! We'll be in contact shortly.

cloud-account/multifactor-authentication.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,19 @@ applies:
88

99
# Multifactor authentication [ec-account-security-mfa]
1010

11-
If you use a password-based login, Elastic requires you to enable multifactor authentication (MFA) for added security on your {{ecloud}} account.
12-
13-
You can choose from the following methods:
11+
Multifactor authentication (MFA) is **mandatory** when you log in to {{ecloud}} using a standard email/password combination, and can't be turned off. It helps protecting your account by adding an extra identity verification step when you log in. You can choose and define the MFA method to use based on your preference:
1412

1513
* Set up an **authenticator app** such as Google Authenticator, Microsoft Authenticator, or Okta Verify. These apps generate a time-based one-time password (TOTP) that you enter along with your password when you log in.
1614
* Authenticate using a **hardware security key or biometric data**, such as a YubiKey or a fingerprint reader.
1715
* Receive a verification code through **email**. You enter this code along with your password when you log in.
1816

19-
Elastic recommends that you enable multiple methods so that you can still access your account if you lose access to one method.
20-
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.
22-
2317
::::{note}
24-
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.
25-
18+
You can no longer configure SMS as a multifactor authentication method.
2619
::::
2720

21+
Elastic recommends that you enable multiple methods so that you can still access your account if you lose access to one method.
22+
23+
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.
2824

2925
## Configure an authenticator app [ec-account-security-mfa-authenticator]
3026

deploy-manage/autoscaling/autoscaling-in-eck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ kubectl get elasticsearchautoscaler autoscaling-sample \
222222
-o jsonpath='{ .status.conditions }' | jq
223223
```
224224

225-
```json
225+
```json subs=true
226226
[
227227
{
228228
"lastTransitionTime": "2022-09-09T08:07:10Z",

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ Based on these four key concepts, the prepaid consumption lifecycle is as follow
7171
1. You purchase credits expressed in ECU, typically at a discount.
7272
2. You begin using {{ecloud}} resources.
7373
3. At every billing cycle (which takes place on the first of each month), the previous month's usage, expressed in ECU, is deducted from your ECU balance.
74-
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.¹
74+
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.[^1^](#footnote-1)
7575
5. At the end of the contract period, any credits remaining in your balance are forfeited.
76-
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.²
76+
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.[^2^](#footnote-2)
7777

78-
¹ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
78+
^1^ $$$footnote-1$$$ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
7979

80-
² Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
80+
^2^ $$$footnote-2$$$ Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
8181

8282
::::{note}
8383
Existing annual+overages customers will be able to switch to prepaid consumption when they renew or sign a new contract. Existing manual burndown customers will be migrated gradually to prepaid consumption in the near future. Exceptions apply.

deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ There are a number of fields that need to be added to each {{es}} node in order
3030

3131
The following example is based on the `default` system owned deployment template that already supports `node_roles`. This template will be used as a reference for the next sections:
3232

33-
::::{dropdown} Reference example with support for `node_roles`
33+
::::{dropdown} Reference example with support for node_roles
3434
:name: ece-node-roles-support-example
3535

3636
```json
@@ -363,7 +363,7 @@ It is recommended to add the `id` field to each {{es}} topology element in the d
363363

364364
The existing template contains three {{es}} topology elements and two resources (`elasticsearch` and `kibana`).
365365

366-
::::{dropdown} Custom example without support for `node_roles`
366+
::::{dropdown} Custom example without support for node_roles
367367
```json
368368
{
369369
...
@@ -471,7 +471,7 @@ Then, it is only necessary to add the four {{es}} topology elements (`warm`, `co
471471

472472
After adding support for `node_roles`, the resulting deployment template should look similar to the following:
473473

474-
::::{dropdown} Custom example with support for `node_roles`
474+
::::{dropdown} Custom example with support for node_roles
475475
:name: example-with-support-for-node-roles
476476

477477
```json
@@ -772,7 +772,7 @@ These fields represent the default settings for the deployment. However, autosca
772772

773773
Similar to the `node_roles` example, the following one is also based on the `default` deployment template that already supports `node_roles` and autoscaling. This template will be used as a reference for the next sections:
774774

775-
::::{dropdown} Reference example with support for `node_roles` and autoscaling
775+
::::{dropdown} Reference example with support for node_roles and autoscaling
776776
```json
777777
{
778778
...
@@ -1102,7 +1102,7 @@ To update a custom deployment template:
11021102

11031103
After adding support for autoscaling to the [example](#ece-node-roles-support-example) presented in the previous section, the resulting deployment template should look similar to the following:
11041104

1105-
::::{dropdown} Custom example with support for `node_roles` and autoscaling
1105+
::::{dropdown} Custom example with support for node_roles and autoscaling
11061106
```json
11071107
{
11081108
...
@@ -1780,7 +1780,7 @@ After the migration plan has finished, we recommend following the [Migrate index
17801780

17811781
The following is an example of a deployment plan that does not contain `node_roles`:
17821782

1783-
::::{dropdown} Example deployment plan with `node_type`
1783+
::::{dropdown} Example deployment plan with node_type
17841784
```json
17851785
{
17861786
"name": "Example deployment",
@@ -1924,7 +1924,7 @@ The following is an example of a deployment plan that does not contain `node_rol
19241924

19251925
After adding support for `node_roles` to the example deployment plan, the resulting plan should look similar to the following:
19261926

1927-
::::{dropdown} Example deployment plan with `node_roles`
1927+
::::{dropdown} Example deployment plan with node_roles
19281928
```json
19291929
{
19301930
"name": "Example deployment",

deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To perform an offline installation without a private Docker registry, you have t
2727
For example, for {{ece}} 4.0.0 and the {{stack}} versions it shipped with, you need:
2828

2929
* {{ece}} 4.0.0
30-
* {es} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
30+
* {{es}} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
3131

3232
2. Create .tar files of the images:
3333

deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ mapped_pages:
1010

1111
::::{warning}
1212
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`.
13+
14+
`ip.es.io` is intended for use only by {{ece}} customers. We may, acting in our sole discretion, immediately terminate, suspend, or block any unauthorized users or uses without notice.
1315
::::
1416

1517
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.
@@ -18,3 +20,5 @@ The `ip.es.io` service is provided to help you evaluate {{ece}} without having t
1820

1921
A wildcard certificate is enabled based on the deployment domain name. For more information on modifying the deployment domain name, check [Configure endpoints](change-endpoint-urls.md). The deployment domain name also determines the endpoint URLs that are displayed in the Cloud UI.
2022

23+
Report security issues to [email protected].
24+

deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md

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

1111
Custom endpoint aliases allow users to replace the UUID for each application with a human readable string. Platform administrators must enable this feature to allow deployment managers to create and modify aliases for their deployments.
1212

13-
::::{note}
13+
::::{note}
1414
You need to update your proxy certificates to support this feature.
1515
::::
1616

@@ -20,16 +20,16 @@ After installing or upgrading to version 2.10 or later:
2020
1. [Login to the Cloud UI](log-into-cloud-ui.md)
2121
2. [Update your proxy certificate(s)](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). In addition to currently configured domains, additional SAN entries must be configured for each application-specific subdomain:
2222

23-
::::{note}
23+
::::{note}
2424
If you are not using wildcard certificates, you need to repeat this process for each deployment to account for specific aliases.
2525
::::
2626

2727

28-
* For {{es}}, the certificate needs to allow for ***.es.<your-domain>**
29-
* For {{kib}}, the certificate needs to allow for ***.kb.<your-domain>**
30-
* For APM, the certificate needs to allow for ***.apm.<your-domain>**
31-
* For Fleet, the certificate needs to allow for ***.fleet.<your-domain>**
32-
* For Universal Profiling, the certificate needs to allow for ***.profiling.<your-domain>** and ***.symbols.<your-domain>**
28+
* For {{es}}, the certificate needs to allow for **\*.es.<your-domain>**
29+
* For {{kib}}, the certificate needs to allow for **\*.kb.<your-domain>**
30+
* For APM, the certificate needs to allow for **\*.apm.<your-domain>**
31+
* For Fleet, the certificate needs to allow for **\*.fleet.<your-domain>**
32+
* For Universal Profiling, the certificate needs to allow for **\*.profiling.<your-domain>** and **\*.symbols.<your-domain>**
3333

3434
3. In the **Platform** menu, select **Settings**.
3535
4. Under the **Enable custom endpoint alias naming**, toggle the setting to allow platform administrators and deployment managers to choose a simplified, unique URL for the endpoint.

deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $$$ece-elastic-stack-stackpacks-recent$$$
4545

4646
Following is the full list of available packs containing {{stack}} versions. Note that Enterprise Search was introduced with ECE 2.6.0 and requires that version or higher.
4747

48-
::::{dropdown} **Expand to view the full list**
48+
::::{dropdown} Expand to view the full list
4949
| Required downloads | Minimum required ECE version |
5050
| --- | --- |
5151
| [{{es}}, {{kib}}, and APM stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |

0 commit comments

Comments
 (0)