Skip to content

Commit 3e9cf0a

Browse files
authored
Merge branch 'main' into security_comms
2 parents 1fe942a + 5858ecb commit 3e9cf0a

20 files changed

+787
-761
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
1. Go to the deployment.
2+
2. On the **Security** page, under **Traffic filters** select **Apply filter**.
3+
3. Choose the filter you want to apply and select **Apply filter**.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2+
2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the **Deployments** page to view all of your deployments.
3+
3. Under the **Features** tab, open the **Traffic filters** page.
4+
4. Select **Create filter**.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
If you need to remove a rule set, you must first remove any associations with deployments.
2+
3+
To delete a rule set with all its rules:
4+
5+
1. [Remove any deployment associations](/deploy-manage/security/gcp-private-service-connect-traffic-filters.md#remove-filter-deployment).
6+
2. From the **Account** menu, select **Traffic filters**.
7+
3. Find the rule set you want to edit.
8+
4. Select the **Remove** icon. The icon is inactive if there are deployments assigned to the rule set.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:::{tip}
2+
Elastic recommends that you use Kubernetes network policies over IP traffic filters for {{eck}}. This is because, in containerized environments like Kubernetes, IP addresses are usually dynamic, making network policies a more robust option.
3+
:::
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
1. From the **Account** menu, select **Traffic filters**.
2+
2. Find the rule set you want to edit.
3+
3. Select the **Edit** icon.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
If you want to remove any traffic restrictions from a deployment or delete a rule set, you’ll need to remove any rule set associations first. To remove an association through the UI:
2+
3+
1. Go to the deployment.
4+
2. On the **Security** page, under **Traffic filters** select **Remove**.

deploy-manage/security/aws-privatelink-traffic-filters.md

Lines changed: 55 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ mapped_urls:
99

1010
# AWS PrivateLink traffic filters
1111

12-
Traffic filtering, to only AWS PrivateLink connections, is one of the security layers available in {{ecloud}}. It allows you to limit how your deployments can be accessed.
12+
Traffic filtering to only AWS PrivateLink connections is one of the security layers available in {{ech}}. It allows you to limit how your deployments can be accessed.
13+
14+
Refer to [](/deploy-manage/security/traffic-filtering.md) to learn more about traffic filtering in {{ech}}, and how traffic filter rules work.
1315

1416
AWS PrivateLink establishes a secure connection between two AWS Virtual Private Clouds (VPCs). The VPCs can belong to separate accounts, i.e. a service provider and its service consumers. AWS routes the PrivateLink traffic within the AWS data center and never exposes it to the public internet. In such a configuration, {{ecloud}} is the third-party service provider and the customers are service consumers.
1517

@@ -46,7 +48,7 @@ Transport client is not supported over PrivateLink connections.
4648

4749
PrivateLink Service is set up by Elastic in all supported AWS regions under the following service names:
4850

49-
::::{dropdown} AWS Public Regions
51+
::::{dropdown} AWS public regions
5052
| **Region** | **VPC Service Name** | **Private hosted zone domain name** | **AZ Names (AZ IDs)** |
5153
| --- | --- | --- | --- |
5254
| af-south-1 | `com.amazonaws.vpce.af-south-1.vpce-svc-0d3d7b74f60a6c32c` | `vpce.af-south-1.aws.elastic-cloud.com` | `af-south-1a` (`afs1-az1`), `af-south-1b` (`afs1-az2`), `af-south-1c` (`afs1-az3`) |
@@ -74,7 +76,7 @@ PrivateLink Service is set up by Elastic in all supported AWS regions under the
7476
::::
7577

7678

77-
::::{dropdown} GovCloud Regions
79+
::::{dropdown} GovCloud regions
7880
| **Region** | **VPC Service Name** | **Private hosted zone domain name** |
7981
| --- | --- | --- |
8082
| us-gov-east-1 (GovCloud) | `com.amazonaws.vpce.us-gov-east-1.vpce-svc-0bba5ffa04f0cb26d` | `vpce.us-gov-east-1.aws.elastic-cloud.com` |
@@ -93,11 +95,11 @@ The process of setting up the PrivateLink connection to your clusters is split b
9395
| | 5. Interact with your deployments over PrivateLink. |
9496

9597

96-
## Ensure your VPC endpoint is in all availability zones supported by {{ecloud}} on the region for the VPC service [ec-aws-vpc-overlapping-azs]
98+
## Ensure your VPC is in all availability zones [ec-aws-vpc-overlapping-azs]
99+
100+
Ensure your VPC endpoint is in all availability zones supported by {{ecloud}} on the region for the VPC service.
97101

98-
::::{note}
99102
Ensuring that your VPC is in all supported {{ecloud}} availability zones for a particular region avoids potential for a traffic imbalance. That imbalance may saturate some coordinating nodes and underutilize others in the deployment, eventually impacting performance. Enabling all supported {{ecloud}} zones ensures that traffic is balanced optimally.
100-
::::
101103

102104

103105
You can find the zone name to zone ID mapping with AWS CLI:
@@ -150,18 +152,28 @@ The mapping will be different for your region. Our production VPC Service for `u
150152

151153
3. Test the connection.
152154

153-
Find out the endpoint of your deployment. You can do that by selecting **Copy endpoint** in the Cloud UI. It looks something like `my-deployment-d53192.es.us-east-1.aws.found.io`. `my-deployment-d53192` is an alias, and `es` is the product you want to access within your deployment.
155+
Find out the endpoint of your deployment. You can do that by selecting **Copy endpoint** in the Cloud UI. It looks something like:
156+
157+
```
158+
my-deployment-d53192.es.us-east-1.aws.found.io
159+
```
160+
161+
where `my-deployment-d53192` is an alias, and `es` is the product you want to access within your deployment.
154162
155163
To access your {{es}} cluster over PrivateLink:
156164
157165
* If you have a [custom endpoint alias](/deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md) configured, you can use the custom endpoint URL to connect.
158166
* Alternatively, use the following URL structure:
159167
160-
`https://{{alias}}.{product}.{{private_hosted_zone_domain_name}}`
168+
```
169+
https://{{alias}}.{product}.{{private_hosted_zone_domain_name}}
170+
```
161171
162172
For example:
163173
164-
`https://my-deployment-d53192.es.vpce.us-east-1.aws.elastic-cloud.com`
174+
```text
175+
https://my-deployment-d53192.es.vpce.us-east-1.aws.elastic-cloud.com
176+
```
165177
166178
167179
::::{tip}
@@ -171,9 +183,12 @@ The mapping will be different for your region. Our production VPC Service for `u
171183
172184
You can test the AWS console part of the setup with a following curl (substitute the region and {{es}} ID with your cluster):
173185
186+
Request:
174187
```sh
175188
$ curl -v https://my-deployment-d53192.es.vpce.us-east-1.aws.elastic-cloud.com
176-
..
189+
```
190+
Response:
191+
```sh
177192
* Server certificate:
178193
* subject: CN=*.us-east-1.aws.elastic-cloud.com
179194
* SSL certificate verify ok.
@@ -196,9 +211,9 @@ Follow these high-level steps to add private link rules to your deployments.
196211
4. [Access the deployment over a private link](/deploy-manage/security/aws-privatelink-traffic-filters.md#ec-access-the-deployment-over-private-link).
197212
198213
199-
### Finding your VPC endpoint ID [ec-find-your-endpoint]
214+
### Find your VPC endpoint ID [ec-find-your-endpoint]
200215
201-
Having trouble finding your VPC endpoint ID? You can find it in the AWS console.
216+
You can find your VPC endpoint ID in the AWS console:
202217
203218
:::{image} /deploy-manage/images/cloud-ec-private-link-endpoint-id.png
204219
:alt: VPC Endpoint ID
@@ -210,21 +225,20 @@ Having trouble finding your VPC endpoint ID? You can find it in the AWS console.
210225
211226
Once you know your VPC endpoint ID you can create a private link traffic filter rule set.
212227
213-
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
214-
2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the **Deployments** page to view all of your deployments.
215-
3. Under the **Features** tab, open the **Traffic filters** page.
216-
4. Select **Create filter**.
217-
5. Select **Private link endpoint**.
218-
6. Create your rule set, providing a meaningful name and description.
219-
7. Select the region for the rule set.
220-
8. Enter your VPC endpoint ID.
221-
9. Select if this rule set should be automatically attached to new deployments.
228+
229+
:::{include} _snippets/create-filter.md
230+
:::
231+
1. Select **Private link endpoint**.
232+
2. Create your rule set, providing a meaningful name and description.
233+
3. Select the region for the rule set.
234+
4. Enter your VPC endpoint ID.
235+
5. Select if this rule set should be automatically attached to new deployments.
222236
223237
::::{note}
224238
Each rule set is bound to a particular region and can be only assigned to deployments in the same region.
225239
::::
226240
227-
10. (Optional) You can [claim your VPC endpoint ID](/deploy-manage/security/claim-traffic-filter-link-id-ownership-through-api.md), so that no other organization is able to use it in a traffic filter ruleset.
241+
6. (Optional) You can [claim your VPC endpoint ID](/deploy-manage/security/claim-traffic-filter-link-id-ownership-through-api.md), so that no other organization is able to use it in a traffic filter ruleset.
228242
229243
The next step is to [associate the rule set](/deploy-manage/security/aws-privatelink-traffic-filters.md#ec-associate-traffic-filter-private-link-rule-set) with your deployments.
230244
@@ -233,10 +247,8 @@ The next step is to [associate the rule set](/deploy-manage/security/aws-private
233247
234248
To associate a private link rule set with your deployment:
235249
236-
1. Go to the deployment.
237-
2. On the **Security** page, under **Traffic filters** select **Apply filter**.
238-
3. Choose the filter you want to apply and select **Apply filter**.
239-
250+
:::{include} _snippets/associate-filter.md
251+
:::
240252
241253
### Access the deployment over a PrivateLink [ec-access-the-deployment-over-private-link]
242254
@@ -247,11 +259,19 @@ Use the alias you’ve set up as CNAME DNS record to access your deployment.
247259
::::
248260
249261
250-
If your deployment alias is `my-deployment-12ab9b` and it is located in `us-east-1` region you can access it under `https://my-deployment-12ab9b.es.vpce.us-east-1.aws.elastic-cloud.com`.
262+
If your deployment alias is `my-deployment-12ab9b` and it is located in `us-east-1` region you can access it at the following URL:
263+
264+
```
265+
https://my-deployment-12ab9b.es.vpce.us-east-1.aws.elastic-cloud.com
266+
```
251267
268+
Request:
252269
```sh
253270
$ curl -u 'username:password' -v https://my-deployment-d53192.es.vpce.us-east-1.aws.elastic-cloud.com
254-
..
271+
```
272+
273+
Response:
274+
```
255275
< HTTP/1.1 200 OK
256276
..
257277
```
@@ -271,28 +291,15 @@ The settings `xpack.fleet.agents.fleet_server.hosts` and `xpack.fleet.outputs` t
271291

272292
You can edit a rule set name or to change the VPC endpoint ID.
273293

274-
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
275-
2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the **Deployments** page to view all of your deployments.
276-
3. Under the **Features** tab, open the **Traffic filters** page.
277-
4. Find the rule set you want to edit.
278-
5. Select the **Edit** icon.
279-
294+
:::{include} _snippets/edit-ruleset.md
295+
:::
280296

281297
### Delete a PrivateLink rule set [ec-delete-traffic-filter-private-link-rule-set]
282298

283-
If you need to remove a rule set, you must first remove any associations with deployments.
284-
285-
To delete a rule set with all its rules:
286-
287-
1. [Remove any deployment associations](/deploy-manage/security/aws-privatelink-traffic-filters.md#ec-remove-association-traffic-filter-private-link-rule-set).
288-
2. Under the **Features** tab, open the **Traffic filters** page.
289-
3. Find the rule set you want to edit.
290-
4. Select the **Remove** icon. The icon is inactive if there are deployments assigned to the rule set.
291-
292-
293-
### Remove a PrivateLink rule set association from your deployment [ec-remove-association-traffic-filter-private-link-rule-set]
299+
:::{include} _snippets/delete-ruleset.md
300+
:::
294301

295-
To remove an association through the UI:
302+
### Remove a PrivateLink rule set association from your deployment [remove-filter-deployment]
296303

297-
1. Go to the deployment.
298-
2. On the **Security** page, under **Traffic filters** select **Remove**.
304+
:::{include} _snippets/remove-filter.md
305+
:::

0 commit comments

Comments
 (0)