Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 75b8df0

Browse files
Merge pull request #2767 from splunk/urbiz-aws-pl-update
[7245]: AWS PL updates
2 parents b20fb38 + 8db7a8f commit 75b8df0

File tree

5 files changed

+104
-79
lines changed

5 files changed

+104
-79
lines changed

_images/gdi/AWS_PL_region1.jpg

75.1 KB
Loading

_images/gdi/AWS_PL_region1.png

50.2 KB
Loading

_images/gdi/AWS_PL_region2.png

150 KB
Loading

_images/gdi/AWS_PL_region3.png

60.8 KB
Loading

gdi/private-connectivity/aws-privatelink.rst

Lines changed: 104 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,30 @@ Private Connectivity using AWS PrivateLink
99

1010
You can use Amazon Web Services (AWS) PrivateLink to secure your metric and traces traffic from your AWS environment to your Splunk Observability Cloud environment without exposing it to the internet.
1111

12-
AWS PrivateLink connects your Virtual Private Cloud (VPC) to your AWS services, treating them as if they were in your VPC. You can create and use VPC endpoints to securely access AWS services and control the specific API endpoints and sites. To learn more, see the AWS PrivateLink documentation at :new-page:`What is AWS PrivateLink? <https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html>`.
12+
AWS PrivateLink connects your Virtual Private Cloud (VPC) to the AWS-hosted services that you use, treating them as if they were in your VPC. You can create and use VPC endpoints to securely access AWS-hosted services and control the specific API endpoints and sites. To learn more, see the AWS PrivateLink documentation at :new-page:`What is AWS PrivateLink? <https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html>`.
1313

1414
.. note::
1515

1616
To send logs to Splunk Observability Cloud, use :ref:`lo-connect-landing`.
1717

18-
To send logs securely, use :new-page:`Private connectivity in Splunk Cloud Platform <https://docs.splunk.com/Documentation/SplunkCloud/latest/Security/Privateconnectivityenable>`.
19-
20-
The following diagram shows an overview of how AWS PrivateLink for Splunk Observability Cloud works:
21-
22-
.. source in Lucidchart: https://lucid.app/lucidchart/21f1cd02-7b2c-4654-a1b8-18c80a903fee/edit?shared=true&page=0_0&invitationId=inv_2f660037-6a85-4b98-9025-212b16c6b5a2#
23-
24-
.. image:: /_images/gdi/aws-privatelink-schema2.png
25-
:width: 80%
26-
:alt: AWS Private Link schema.
27-
18+
To send logs with AWS PrivateLink see :new-page:`Private connectivity in Splunk Cloud Platform <https://docs.splunk.com/Documentation/SplunkCloud/latest/Security/Privateconnectivityenable>`.
2819

2920
Prerequisites
3021
==================================================
3122

3223
To connect Splunk Observability Cloud to AWS using AWS PrivateLink, you need the following:
3324

34-
* An active AWS account
35-
* A basic understanding of VPC concepts and networking principles
25+
* An active AWS account.
26+
* A basic understanding of VPC concepts and networking principles.
27+
28+
Connect different accounts within or across regions
29+
==============================================================
30+
31+
You can use AWS PrivateLink to connect different accounts within or across AWS regions. The following diagram shows diagram shows an overview of how AWS PrivateLink for Splunk Observability Cloud works:
32+
33+
.. image:: /_images/gdi/AWS_PL_region1.jpg
34+
:width: 80%
35+
:alt: AWS Private Link schema.
3636

3737
.. _aws-privatelink-endpoint-types:
3838

@@ -52,7 +52,42 @@ You can use any of these endpoints with AWS PrivateLink:
5252
AWS PrivateLink availability and service name
5353
==================================================
5454

55-
See the following tables for the AWS PrivateLink endpoint URLs and service names for each AWS region.
55+
See the following sections for information on the available AWS source account regions, AWS PrivateLink endpoint URLs and service names for each AWS region.
56+
57+
.. _aws-source-regions:
58+
59+
AWS source account regions
60+
--------------------------------------------------
61+
62+
See the following list for the supported AWS source account regions. Your AWS account region must be one of these regions:
63+
64+
* US East (N. Virginia) ``us-east-1``
65+
* US East (Ohio) ``us-east-2``
66+
* US West (N. California) ``us-west-1``
67+
* US West (Oregon) ``us-west-2``
68+
* Africa (Cape Town) ``af-south-1``
69+
* Asia Pacific (Hong Kong) ``ap-east-1``
70+
* Asia Pacific (Hyderabad) ``ap-south-2``
71+
* Asia Pacific (Jakarta) ``ap-southeast-3``
72+
* Asia Pacific (Melbourne) ``ap-southeast-4``
73+
* Asia Pacific (Mumbai) ``ap-south-1``
74+
* Asia Pacific (Osaka) ``ap-northeast-3``
75+
* Asia Pacific (Seoul) ``ap-northeast-2``
76+
* Asia Pacific (Singapore) ``ap-southeast-1``
77+
* Asia Pacific (Sydney) ``ap-southeast-2``
78+
* Asia Pacific (Tokyo) ``ap-northeast-1``
79+
* Canada (Central) ``ca-central-1``
80+
* Canada West (Calgary) ``ca-west-1``
81+
* Europe (Frankfurt) ``eu-central-1``
82+
* Europe (Zurich) ``eu-central-2``
83+
* Europe (Ireland) ``eu-west-1``
84+
* Europe (London) ``eu-west-2``
85+
* Europe (Paris) ``eu-west-3``
86+
* Europe (Milan) ``eu-south-1``
87+
* Europe (Stockholm) ``eu-north-1``
88+
* Middle East (Bahrain) ``me-south-1``
89+
* Middle East (UAE) ``me-central-1``
90+
* South America (São Paulo) ``sa-east-1``
5691

5792
.. _aws-privatelink-endpoint-urls:
5893

@@ -186,6 +221,8 @@ AWS PrivateLink service names
186221
- Coming soon
187222
- com.amazonaws.vpce.us-west-2.vpce-svc-0d78b8dec1a837389
188223

224+
.. _aws-privatelink-configure-vpc:
225+
189226
Configure your AWS PrivateLink VPC endpoints
190227
=================================================================
191228

@@ -201,38 +238,57 @@ Follow these steps to create, use, and manage your AWS PrivateLink VPC endpoint:
201238
Step 1: Request to add your AWS Account ID to the allow list
202239
--------------------------------------------------------------------
203240

204-
Reach out to Splunk Customer Support with the following information to include your AWS Account ID to the allow list:
241+
Reach out to :ref:`Splunk Customer Support <support>` with the following information to include your AWS Account ID to the allow list:
205242

206243
* AWS Account ID
207244

208-
* AWS region
209-
210245
* Endpoint type
211246

212247
* Ingest
213248
* API
214249
* Stream
215250

216-
Review the ways you can contact Splunk Customer Support at :ref:`Splunk Observability Cloud support <support>`.
251+
* AWS source account region: It must be one of the regions listed in :ref:`aws-source-regions`.
252+
253+
* Splunk Observability AWS account region: It must be one of the regions listed in :ref:`aws-privatelink-service-names`.
254+
255+
.. note::
256+
257+
* If you're setting up same-region PrivateLink connectivity, your AWS source account region is the same as the Splunk Observability AWS account region.
258+
259+
* If you're setting up cross-region PrivateLink connectivity, your AWS source account region is different from the Splunk Observability AWS account region.
260+
261+
.. caution:: If your workloads are deployed in AWS regions not listed in :ref:`aws-source-regions`, then cross-region PrivateLink connectivity is not supported. In such cases, you should consider setting up VPC peering as described in :ref:`aws-privatelink-vpc-peering`.
217262

218263
.. _aws-privatelink-step2:
219264

220-
Step 2: Verify AWS Account ID is added to allow list
221-
-----------------------------------------------------------
265+
Step 2: Verify your AWS Account ID is added to the allow list
266+
--------------------------------------------------------------------
222267

223268
.. caution:: Wait for Splunk Customer Support's confirmation that your AWS Account ID was added to the allow list before performing these steps. Support might take up to 24 hours.
224269

225270
To verify your AWS Account ID has been allowed, follow these steps:
226271

227-
1. Log in to the AWS Management Console, and open the :guilabel:`Amazon VPC service` in the specific region where you intend to set up AWS PrivateLink.
272+
1. Log in to the AWS Management Console and open the :guilabel:`Amazon VPC service` in the specific region where you intend to set up AWS PrivateLink.
273+
274+
2. On the left navigation pane, navigate to :guilabel:`PrivateLink and Lattice > Endpoints`.
228275

229-
2. On the left navigation pane, select :guilabel:`Endpoints`.
276+
3. Select :guilabel:`Create endpoint`, then :guilabel:`Endpoint services that use NLBs and GWLBs`.
230277

231-
3. Select :guilabel:`Endpoint`, and then :guilabel:`Other endpoint services`.
278+
4. Under :guilabel:`Service Settings`, enter the :guilabel:`Service Name` based on the AWS region where you're configuring the VPC endpoint. Identify the appropriate service name using the :ref:`AWS PrivateLink service names table <aws-privatelink-service-names>`.
232279

233-
4. Enter and verify the service name based on the AWS region where you're configuring the VPC endpoint. Identify the appropriate service name using the :ref:`AWS PrivateLink service names table <aws-privatelink-service-names>`.
280+
5. If you are setting up cross-region PrivateLink connectivity, check the :guilabel:`Enable Cross Region endpoint` checkbox. Based on the service name you used in point 4, select the appropriate Splunk Observability region.
281+
282+
.. image:: /_images/gdi/AWS_PL_region3.png
283+
:width: 80%
284+
:alt: Verify account.
285+
286+
.. caution:: If you are setting up PrivateLink connectivity in the same region do not check the Enable Cross Region endpoint checkbox.
287+
288+
6. Select :strong:`Verify Service`.
234289

235290
* If you see the "Service name verified" message, proceed with :ref:`aws-privatelink-step3`.
291+
236292
* If you see the "Service name could not be verified" error message, your account ID is not yet allowed for the given service name. Reach out to Splunk Customer Support to check the status of your request from :ref:`aws-privatelink-step1`.
237293

238294
.. _aws-privatelink-step3:
@@ -242,48 +298,30 @@ Step 3: Create a VPC endpoint
242298

243299
To create a VPC endpoint, follow these steps:
244300

245-
1. Log in to the AWS Management Console, and open :guilabel:`Amazon VPC service` within the specific region where you intend to set up AWS PrivateLink. If you have a VPC peering configuration, keep in mind the destination region of VPC peering.
246-
247-
2. On the left navigation pane, select :guilabel:`Endpoints`.
248-
249-
3. Select :guilabel:`Create Endpoint`, and then :guilabel:`Other endpoint` services.
301+
1. Under :guilabel:`Network settings` select the VPC where the endpoint will reside.
250302

251-
4. Enter and verify the service name based on the AWS region where you're configuring the VPC endpoint. Identify the appropriate service name using the :ref:`AWS PrivateLink service names table <aws-privatelink-service-names>`.
303+
.. caution:: Under :guilabel:`Additional settings` do not select :guilabel:`Enable DNS name` at this point. Select this option after the VPC endpoint has been successfully created in :ref:`aws-privatelink-step4`.
252304

253-
5. Select the VPC in which you want to create the endpoint.
305+
2. Under :guilabel:`Subnets` select the subnet(s) where the endpoint will reside.
254306

255-
6. Select the subnet or subnets within the VPC where the endpoint will reside. Make sure to select the subnets from the appropriate availability zones.
307+
3. Under :guilabel:`Security groups` select the security group(s) controlling traffic for the endpoint. Make sure to set the outbound rule to HTTPS protocol and the ``443`` port.
256308

257-
7. Set the IP address type to ``IPv4``.
258-
259-
8. Specify the security group controlling traffic for the endpoint. Set the outbound rule to HTTPS protocol and the ``443`` port.
260-
261-
The following image shows the security options for AWS PrivateLink:
262-
263-
.. image:: /_images/gdi/aws-privatelink-secgroups2.png
264-
:width: 80%
265-
:alt: Specify security groups that control traffic.
266-
267-
9. Review the configuration details and select :guilabel:`Create Endpoint`.
268-
269-
10. Before proceeding to :ref:`aws-privatelink-step4`, confirm with Splunk Customer Support that you created the endpoint, that the service name has been verified, and that Support has activated the endpoint urls.
309+
4. Select :guilabel:`Create endpoint`.
270310

271311
.. _aws-privatelink-step4:
272312

273313
Step 4: Modify the endpoint to activate a Private DNS Name
274314
----------------------------------------------------------------
275315

276-
To modify the endpoint to activate a Private DNS Name, follow these steps:
316+
To enable Private DNS Name, follow these steps:
277317

278318
#. Log in to the AWS Management Console.
279319
#. Navigate to the :guilabel:`Amazon VPC service` in the region where you have created the VPC endpoint.
280320
#. On the left navigation pane, select :guilabel:`Endpoints`.
281321
#. Select the VPC endpoint you want to modify.
282-
#. Select :guilabel:`Actions`, and then :guilabel:`Modify Endpoint`.
283-
#. Turn on the private DNS names under the :guilabel:`Modify private DNS name` settings.
284-
#. After the process is completed, select :guilabel:`Save Changes`.
285-
286-
You can now start using the AWS PrivateLink URL mentioned in the :ref:`AWS PrivateLink endpoint URLs table <aws-privatelink-endpoint-urls>`.
322+
#. Under the :guilabel:`Actions` dropdown, select :guilabel:`Modify private DNS name`.
323+
#. Under :guilabel:`Modify private DNS name settings`, check the :guilabel:`Enable private DNS names > Enable for this endpoint` checkbox.
324+
#. Select :guilabel:`Save Changes`.
287325

288326
Delete a VPC endpoint
289327
--------------------------------------------------
@@ -297,11 +335,23 @@ To delete an endpoint, follow these steps:
297335
#. Select the VPC endpoint you want to delete.
298336
#. Confirm the deletion when prompted.
299337

300-
Advanced configuration
338+
.. _aws-privatelink-vpc-peering:
339+
340+
Use AWS PrivateLink with VPC peering
301341
==========================================================================
302342

303-
Use AWS PrivateLink with the Collector
304-
--------------------------------------------------
343+
If the workloads that you're monitoring with Splunk Observability Cloud are not in the :ref:`aws-source-regions` list, follow the steps below:
344+
345+
1. In your AWS account, either use an existing VPC or create a new VPC in one of Splunk Observability's AWS account regions mentioned in the :ref:`aws-privatelink-service-names`.
346+
347+
2. Set up AWS VPC peering between the regions where the workloads are being monitored and the region where the VPC used in step 1 is located.
348+
349+
3. Follow :ref:`aws-privatelink-configure-vpc` to activate the AWS PrivateLink endpoint connection from the region where the VPC used in step 1 is located.
350+
351+
Learn more about VPC Peering in the AWS documentation at :new-page:`Two VPCs peered together <https://docs.aws.amazon.com/vpc/latest/peering/peering-configurations-full-access.html#two-vpcs-full-access>`.
352+
353+
Use AWS PrivateLink with the OpenTelemetry Collector
354+
==========================================================================
305355

306356
To use AWS PrivateLink URLs in your Collector instance, update the necessary variables in your Collector configuration to point to the given endpoint type:
307357

@@ -331,33 +381,8 @@ See all PrivateLink URLs at :ref:`aws-privatelink-endpoint-urls`.
331381

332382
For information about the Collector's environment variables see :ref:`collector-env-var`.
333383

334-
Use AWS PrivateLink with VPC peering
335-
--------------------------------------------------
336-
337-
Examine a scenario where the workloads that you're monitoring with Splunk Observability Cloud are in the AWS ``ap-south-1`` region, and your Splunk Observability Cloud account is in ``us-east-1``. You want to use PrivateLink to ingest observability data, but PrivateLink only works within one AWS region.
338-
339-
In this scenario, carry out the following steps:
340-
341-
#. Ensure that you have a VPC set up in the destination region, in this example ``us-east-1``. If you don't have a VPC in that region, create a new one.
342-
343-
#. Use AWS VPC peering to peer the ``ap-south-1`` and the ``us-east-1`` VPCs together.
344-
345-
#. Activate AWS PrivateLink in the ``us-east-1`` VPC.
346-
347-
Learn more about VPC Peering in the AWS documentation at :new-page:`Two VPCs peered together <https://docs.aws.amazon.com/vpc/latest/peering/peering-configurations-full-access.html#two-vpcs-full-access>`.
348-
349-
.. Next steps
350-
.. ================
351-
352-
.. After you connect Splunk Observability Cloud with AWS, you can use Splunk Observability Cloud to track a series of metrics and analyze your AWS data in real time.
353-
354-
.. - See the AWS official documentation for a list of the available AWS resources.
355-
.. - See :ref:`how to leverage data from integration with AWS <aws-post-install>` for more information.
356-
357384
.. _aws-privatelink-support:
358385

359-
360-
361386
.. raw:: html
362387

363388
<div class="include-start" id="report-issue.rst"></div>

0 commit comments

Comments
 (0)