Skip to content

Commit eaec7c9

Browse files
authored
Merge branch 'main' into receipts-vs-invoices
2 parents 043793e + a1ed66d commit eaec7c9

File tree

8 files changed

+109
-34
lines changed

8 files changed

+109
-34
lines changed

deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,11 @@ When a deployment encrypted with a customer-managed key is deleted or terminated
3939
## Prerequisites [ec_prerequisites_3]
4040

4141
:::::::{tab-set}
42+
:group: csps
4243

4344
::::::{tab-item} AWS
45+
:sync: aws
46+
4447
* Have permissions on AWS KMS to [create a symmetric AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) and to configure AWS IAM roles.
4548

4649
:::{tip}
@@ -51,6 +54,8 @@ When a deployment encrypted with a customer-managed key is deleted or terminated
5154
::::::
5255

5356
::::::{tab-item} Azure
57+
:sync: azure
58+
5459
* Have the following permissions on Azure:
5560

5661
* Permissions to [create an RSA key](https://learn.microsoft.com/en-us/azure/key-vault/keys/about-keys#key-types-and-protection-methods) in the Azure Key Vault where you want to store your key.
@@ -67,6 +72,8 @@ When a deployment encrypted with a customer-managed key is deleted or terminated
6772
::::::
6873

6974
::::::{tab-item} Google Cloud
75+
:sync: gcp
76+
7077
* Consider the cloud regions where you need your deployment to live. Refer to the [list of available regions, deployment templates, and instance configurations](cloud://reference/cloud-hosted/ec-regions-templates-instances.md) supported by {{ecloud}}.
7178
* Have the following permissions in Google Cloud KMS:
7279

@@ -93,8 +100,11 @@ At this time, the following features are not supported:
93100
## Create an encryption key for your deployment [create-encryption-key]
94101

95102
:::::::{tab-set}
103+
:group: csps
96104

97105
::::::{tab-item} AWS
106+
:sync: aws
107+
98108
1. Create a symmetric [single-region key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) or [multi-region replica key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-replicate.html). The key must be available in each region in which you have deployments to encrypt. You can use the same key to encrypt multiple deployments. Later, you will need to provide the Amazon Resource Name (ARN) of that key or key alias to {{ecloud}}.
99109

100110
::::{note}
@@ -135,6 +145,8 @@ At this time, the following features are not supported:
135145
::::::
136146

137147
::::::{tab-item} Azure
148+
:sync: azure
149+
138150
1. Create an RSA key in your Key Vault. The key must be available in each region in which you have deployments to encrypt. You can use the same key to encrypt multiple deployments.
139151
2. After the key is created, view the key and note the key identifier. It should look similar to the following:
140152

@@ -150,6 +162,8 @@ Provide your key identifier without the key version identifier so {{ecloud}} can
150162
::::::
151163

152164
::::::{tab-item} Google Cloud
165+
:sync: gcp
166+
153167
1. [Create a new symmetric key](https://cloud.google.com/kms/docs/create-key) in Google Cloud KMS.
154168

155169
The key must be in a key ring that’s in the same region as your deployment. Do not use key ring in a multi-region location.
@@ -166,8 +180,11 @@ Provide your key identifier without the key version identifier so {{ecloud}} can
166180
## Create a deployment encrypted with your key [ec_create_a_deployment_encrypted_with_your_key]
167181

168182
:::::::{tab-set}
183+
:group: csps
169184

170185
::::::{tab-item} AWS
186+
:sync: aws
187+
171188
1. Create a new deployment. You can do it from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), or from the API:
172189

173190
* from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body):
@@ -211,6 +228,8 @@ The deployment is now created and encrypted using the specified key. Future snap
211228
::::::
212229

213230
::::::{tab-item} Azure
231+
:sync: azure
232+
214233
To create a new deployment with a customer-managed key in Azure, you need to perform actions in {{ecloud}} and in your Azure tenant.
215234

216235
**Step 1: Create a service principal for {{ecloud}}**
@@ -285,6 +304,8 @@ The deployment is now created and encrypted using the specified key. Future snap
285304
::::::
286305

287306
::::::{tab-item} Google Cloud
307+
:sync: gcp
308+
288309
**Step 1: Grant service principals access to your key**
289310

290311
{{ecloud}} uses two service principals to encrypt and decrypt data using your key. You must grant these services access to your key before you create your deployment.
@@ -313,9 +334,19 @@ The deployment is now created and encrypted using the specified key. Future snap
313334
* `cloudkms.cryptoKeyVersions.useToEncrypt`
314335

315336

316-
::::{tip}
317-
The user performing this action needs to belong to the **Owner** or **Cloud KMS Admin** role.
318-
::::
337+
The user performing this action needs to belong to the **Owner** or **Cloud KMS Admin** role.
338+
339+
340+
::::{note}
341+
If [domain restricted sharing](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains) is enabled, then you might not be able to grant the service principals access to the key resource directly. Alternatively, you can grant access to a Google group that contains the relevant service accounts.
342+
343+
1. Create a new Google group within the allowed domain.
344+
2. In the Google Workspace administrator panel, [turn off domain restriction for your newly created Google group](https://support.google.com/a/answer/167097).
345+
3. Add the service principals to the Google group.
346+
4. Grant the Google group the roles as listed.
347+
348+
If you can't use Google Groups for your org, then [contact Elastic Support](https://www.elastic.co/support) for alternatives.
349+
::::
319350

320351

321352
**Step 2: Create your deployment**
@@ -370,14 +401,19 @@ You can check that your hosted deployment is correctly encrypted with the key yo
370401
## Rotate a customer-managed key [rotate-a-customer-managed-key]
371402

372403
:::::::{tab-set}
404+
:group: csps
373405

374406
::::::{tab-item} AWS
407+
:sync: aws
408+
375409
{{ecloud}} will automatically rotate the keys every 31 days as a security best practice.
376410

377411
You can also trigger a manual rotation [in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html), which will take effect in {{ecloud}} within 30 minutes. **For manual rotations to work, you must use an alias when creating the deployment. We do not currently support [on-demand rotations](https://docs.aws.amazon.com/kms/latest/APIReference/API_RotateKeyOnDemand.html) but plan on supporting this in the future.**
378412
::::::
379413

380414
::::::{tab-item} Azure
415+
:sync: azure
416+
381417
To rotate your key, you can [update your key version](https://learn.microsoft.com/en-us/azure/container-registry/tutorial-rotate-revoke-customer-managed-keys) or [configure a key rotation policy](https://learn.microsoft.com/en-us/azure/key-vault/keys/how-to-configure-key-rotation) in Azure Key Vault. In both cases, the rotation will take effect in {{ecloud}} within a day.
382418

383419
For rotations to work, you must provide your key identifier without the key version identifier when you create your deployment.
@@ -386,6 +422,8 @@ For rotations to work, you must provide your key identifier without the key vers
386422
::::::
387423

388424
::::::{tab-item} Google Cloud
425+
:sync: gcp
426+
389427
Key rotations are triggered in Google Cloud. You can rotate your key [manually](https://cloud.google.com/kms/docs/rotate-key#manual) or [automatically](https://cloud.google.com/kms/docs/rotate-key#automatic). In both cases, the rotation will take effect in {{ecloud}} within a day.
390428
::::::
391429

explore-analyze/alerts-cases/alerts/view-alerts.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,38 @@ To get more information about a specific alert, open its action menu (…) and s
4747

4848
If an alert is affected by a maintenance window, the alert details include its identifier. For more information about their impact on alert notifications, refer to [*Maintenance windows*](maintenance-windows.md).
4949

50-
### Alert statuses [alert-status]
50+
## Alert statuses [alert-status]
5151

52-
There are three common alert statuses:
52+
There are four common alert statuses:
5353

5454
`active`
55-
: The conditions for the rule are met and actions should be generated according to the notification settings.
55+
: The conditions for the rule are met. If the rule has [actions](create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings.
5656

57-
`recovered`
58-
: The conditions for the rule are no longer met and recovery actions should be generated.
57+
`flapping`
5958

60-
`untracked`
61-
: Actions are no longer generated. For example, you can choose to move active alerts to this state when you disable or delete rules.
59+
: The alert is switching repeatedly between active and recovered states. If the rule has actions that run when the alert status changes states, those actions are suppressed while the alert is flapping.
6260

63-
::::{note}
64-
An alert can also be in a "flapping" state when it is switching repeatedly between active and recovered states. This state is possible only if you have enabled alert flapping detection in **{{stack-manage-app}} > {{rules-ui}} > Settings**. For each space, you can choose a look back window and threshold that are used to determine whether alerts are flapping. For example, you can specify that the alert must change status at least 6 times in the last 10 runs. If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping.
61+
::::{note}
62+
63+
Alert flapping is turned on by default. You can modify the criteria for changing an alert's status to the flapping state by configuring the **Alert flapping detection** settings. To do this, navigate to the **Alerts** page in the main menu, or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Next, click **Manage Rules**, then **Settings** to open the global rule settings for the space. In the **Alert flapping detection** section, modify the rules' look back window and threshold for alert status changes. For example, you can specify that the alert must change its status at least 6 times in the last 10 runs for it to become a flapping alert.
6564

6665
::::
6766

67+
`recovered`
68+
: The conditions for the rule are no longer met. If the rule has [recovery actions](create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings. Recovery actions only run if the rule's conditions aren't met during the current rule execution, but were in the previous one.
69+
70+
71+
An active alert changes to recovered if the conditions for the rule that generated it are no longer met.
72+
73+
A flapping alert changes to recovered when the rule's conditions are unmet for a specific number of consecutive runs. This number is determined by the **Alert status change threshold** setting, which you can configure under the **Alert flapping detection** settings.
74+
75+
For example, if the threshold requires an alert to change status at least 6 times in the last 10 runs to be considered flapping, then to recover, the rule's conditions must remain unmet for 6 consecutive runs. If the rule's conditions are met at any point during this recovery period, the count of consecutive unmet runs will reset, requiring the alert to remain unmet for an additional 6 consecutive runs to finally be reported as recovered.
76+
77+
Once a flapping alert is recovered, it cannot be changed to flapping again. Only new alerts with repeated status changes are candidates for the flapping status.
78+
79+
`untracked`
80+
: The rule is disabled, or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the {icon}`boxes_horizontal` icon to expand the **More actions** menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
81+
6882
## Mute alerts [mute-alerts]
6983

7084
If an alert is active or flapping, you can mute it to temporarily suppress future actions. In both **{{stack-manage-app}} > Alerts** and **{{rules-ui}}**, you can open the action menu (…) for the appropriate alert and select **Mute**. To permanently suppress actions for an alert, open the actions menu and select **Mark as untracked**.

extend/contribute/api-docs/organize-annotate.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,11 @@ class FooRequest {
304304

305305
This example shows the "later addition" scenario where `laterAddition` was added after the initial API release, requiring a parameter-level availability annotation with a later version than the API-level availability.
306306

307+
:::::{important}
308+
The `since` field is only available for `stack`. If the API is introduced in multiple major versions (eg: `8.19.0` and `9.1.0`), use the appropriate value in each branch.
309+
:::::
310+
311+
307312
**Deprecation notices** use the `@deprecated` annotation:
308313

309314
```ts
@@ -449,4 +454,4 @@ The annotation system doesn't support "OR" relationships between privileges. Whe
449454
:::
450455
:::
451456

452-
::::
457+
::::

solutions/observability/cicd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ To learn more about the integration of Jenkins with Elastic {{observability}}, s
285285

286286
There are out of the box {{kib}} dashboards that help visualize some metrics for the CI/CD platform.
287287

288-
Using the [Import API](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-dashboards) or the {{kib}} UI, you can [install dashboards](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/DASHBOARDS.md#elastic) that are compatible with version 7.12 or higher.
288+
Using the [Import saved objects API](https://www.elastic.co/docs/api/doc/kibana/operation/operation-post-saved-objects-import) or the {{kib}} UI, you can [install dashboards](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/DASHBOARDS.md#elastic) that are compatible with version 7.12 or higher.
289289

290290
For instance, you can follow the below steps:
291291

solutions/observability/incident-management/view-alerts.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/view-observability-alerts.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-view-alerts.html
5+
applies_to:
6+
stack: all
7+
serverless:
8+
observability: all
59
products:
610
- id: observability
711
- id: cloud-serverless
@@ -50,37 +54,47 @@ From the **Alerts** table, you can click on a specific alert to open the alert d
5054
:screenshot:
5155
:::
5256

57+
To further inspect the rule:
58+
59+
* From the alert detail flyout, click **View rule details**.
60+
* From the **Alerts** table, click the {icon}`boxes_horizontal` icon and select **View rule details**.
61+
62+
To view the alert in the app that triggered it:
63+
64+
* From the alert detail flyout, click **View in app**.
65+
* From the **Alerts** table, click the {icon}`eye` icon.
66+
67+
## Understand alert statuses [observability-view-alerts-understand-statuses]
68+
5369
There are four common alert statuses:
5470

5571
`active`
56-
: The conditions for the rule are met and actions should be generated according to the notification settings.
72+
: The conditions for the rule are met. If the rule has [actions](../../../explore-analyze/alerts-cases/alerts/create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings.
5773

5874
`flapping`
59-
: The alert is switching repeatedly between active and recovered states.
6075

61-
`recovered`
62-
: The conditions for the rule are no longer met and recovery actions should be generated.
76+
: The alert is switching repeatedly between active and recovered states. If the rule has actions that run when the alert status changes states, those actions are suppressed while the alert is flapping.
6377

64-
`untracked`
65-
: The corresponding rule is disabled or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon to expand the *More actions* menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
78+
::::{note}
6679

67-
::::{note}
68-
**Flapping alerts**
69-
70-
The flapping state is possible only if you have enabled alert flapping detection. Go to the **Alerts** page and click **Manage Rules** to navigate to the {{obs-serverless}} **{{rules-app}}** page. Click **Settings** then set the look back window and threshold that are used to determine whether alerts are flapping. For example, you can specify that the alert must change status at least 6 times in the last 10 runs. If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping.
80+
Alert flapping is turned on by default. You can modify the criteria for changing an alert's status to the flapping state by configuring the **Alert flapping detection** settings. To do this, navigate to the **Alerts** page in the main menu, or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). Next, click **Manage Rules**, then **Settings** to open the global rule settings for the space. In the **Alert flapping detection** section, modify the rules' look back window and threshold for alert status changes. For example, you can specify that the alert must change its status at least 6 times in the last 10 runs for it to become a flapping alert.
7181

7282
::::
7383

84+
`recovered`
85+
: The conditions for the rule are no longer met. If the rule has [recovery actions](../../../explore-analyze/alerts-cases/alerts/create-manage-rules.md#defining-rules-actions-details), {{kib}} generates notifications based on the actions' notification settings. Recovery actions only run if the rule's conditions aren't met during the current rule execution, but were in the previous one.
7486

75-
To further inspect the rule:
7687

77-
* From the alert detail flyout, click **View rule details**.
78-
* From the **Alerts** table, click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon and select **View rule details**.
88+
An active alert changes to recovered if the conditions for the rule that generated it are no longer met.
7989

80-
To view the alert in the app that triggered it:
90+
A flapping alert changes to recovered when the rule's conditions are unmet for a specific number of consecutive runs. This number is determined by the **Alert status change threshold** setting, which you can configure under the **Alert flapping detection** settings.
91+
92+
For example, if the threshold requires an alert to change status at least 6 times in the last 10 runs to be considered flapping, then to recover, the rule's conditions must remain unmet for 6 consecutive runs. If the rule's conditions are met at any point during this recovery period, the count of consecutive unmet runs will reset, requiring the alert to remain unmet for an additional 6 consecutive runs to finally be reported as recovered.
8193

82-
* From the alert detail flyout, click **View in app**.
83-
* From the **Alerts** table, click the ![View in app](/solutions/images/serverless-eye.svg "") icon.
94+
Once a flapping alert is recovered, it cannot be changed to flapping again. Only new alerts with repeated status changes are candidates for the flapping status.
95+
96+
`untracked`
97+
: The rule is disabled, or you’ve marked the alert as untracked. To mark the alert as untracked, go to the **Alerts** table, click the {icon}`boxes_horizontal` icon to expand the **More actions** menu, and click **Mark as untracked**. When an alert is marked as untracked, actions are no longer generated. You can choose to move active alerts to this state when you disable or delete rules.
8498

8599

86100
## Customize the alerts table [observability-view-alerts-customize-the-alerts-table]
@@ -98,15 +112,14 @@ You can also use the toolbar buttons in the upper-right to customize the display
98112

99113
## Add alerts to cases [observability-view-alerts-add-alerts-to-cases]
100114

101-
From the **Alerts** table, you can add one or more alerts to a case. Click the ![More actions](/solutions/images/serverless-boxesHorizontal.svg "") icon to add the alert to a new or existing case. You can add an unlimited amount of alerts from any rule type.
115+
From the **Alerts** table, you can add one or more alerts to a case. Click the {icon}`boxes_horizontal` icon to add the alert to a new or existing case. You can add an unlimited amount of alerts from any rule type.
102116

103117
::::{note}
104118
Each case can have a maximum of 1,000 alerts.
105119

106120
::::
107121

108122

109-
110123
### Add an alert to a new case [observability-view-alerts-add-an-alert-to-a-new-case]
111124

112125
To add an alert to a new case:

0 commit comments

Comments
 (0)