Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2da06e6

Browse files
authored
Merge pull request magento-commerce/devdocs/pull/2593 from magento-devdocs/hg-mc8217-privatelink
MCLOUD-8217 Azure Private Link update
2 parents 5a32541 + 0d41194 commit 2da06e6

File tree

1 file changed

+50
-30
lines changed

1 file changed

+50
-30
lines changed

src/cloud/project/privatelink-service.md

Lines changed: 50 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -21,56 +21,76 @@ The PrivateLink service integration for {{site.data.var.ece}} projects includes
2121

2222
## Limitations
2323

24-
- Support for PrivateLink is available on Pro plan Production and Staging environments only. It is not available on local or integration environments, or on Starter plan projects.
25-
- You cannot establish SSH connections using PrivateLink. For SSH, use the SSH capabilities. See [Enable SSH keys][].
24+
- Support for PrivateLink is available on Pro Production and Staging environments only. It is not available on local or integration environments, or on Starter projects.
25+
- You cannot establish SSH connections using PrivateLink. For SSH, see [Enable SSH keys][].
2626
- {{site.data.var.ee}} support does not cover troubleshooting AWS PrivateLink issues beyond initial enablement.
2727
- Customers are responsible for costs associated with managing their own VPC.
2828
- You cannot use the HTTPS protocol (port 443) to connect to {{ site.data.var.ece }} over PrivateLink.
2929
- PrivateDNS is not available.
3030

3131
## PrivateLink connection types
3232

33-
The following network diagram shows the PrivateLink connection types available to establish secure communication between your store and external systems hosted outside of the Cloud environment.<br><br>
33+
There are two PrivateLink connection types available—shown in the following network diagram—to establish secure communication between your store and external systems hosted outside of the Cloud environment.
3434

3535
![PrivateLink network diagram]
3636

37-
You must determine the PrivateLink connection type required for your {{site.data.var.ece}} environments:
37+
Choose one of the PrivateLink connection types best suited for your {{site.data.var.ece}} environments:
3838

3939
- **Unidirectional PrivateLink**–Choose this configuration to retrieve data securely from a {{ site.data.var.ece }} store.
4040
- **Bidirectional PrivateLink**–Choose this configuration to establish secure connections to and from systems outside of the {{site.data.var.ece}} environment. The bidirectional option requires two connections:
4141
- A connection between the customer VPC and the Adobe VPC
4242
- A connection between the Adobe VPC and the customer VPC
4343

4444
{:.bs-callout-tip}
45-
Work with your network administrator or Cloud platform provider for help selecting the PrivateLink connection type, or help with VPC setup and administration. Also, see your Cloud platform PrivateLink documentation [AWS PrivateLink][], [Azure Private Link][].
45+
Work with your network administrator or Cloud platform provider for help with selecting the PrivateLink connection type, or help with VPC setup and administration. See Cloud platform PrivateLink documentation: [AWS PrivateLink][] or [Azure Private Link][].
4646

4747
## Request PrivateLink enablement
4848

4949
{:.bs-callout-warning}
50-
Enabling PrivateLink can take up to 5 business days. Providing incomplete, or inaccurate information can delay the process.
50+
Enabling PrivateLink can take up to _five_ business days. Providing incomplete or inaccurate information can delay the process.
5151

5252
### Prerequisites
5353

54-
- {:.fix}A Cloud account (AWS or Azure) in the same region as the {{site.data.var.ece}} instance
55-
- {:.fix}A VPC in the customer environment that hosts the services to connect via PrivateLink. See the AWS or Azure documentation for help with VPC set up or contact your network administrator.
54+
- {:.fix}A Cloud account (AWS or Azure) in the same region as the {{site.data.var.ece}} instance.
55+
- {:.fix}A VPC in the customer environment that hosts the services to connect via PrivateLink. See the AWS or Azure documentation for help with VPC setup or contact your network administrator.
5656
- {:.fix}For bidirectional PrivateLink connections, you must create the endpoint service configuration for your application or service, and create an endpoint in your VPC environment before requesting PrivateLink enablement. See [Set up for bidirectional PrivateLink connections](#set-up-for-bidirectional-privatelink-connections).
57-
- {:.fix}Gather the following data required for PrivateLink enablement:
5857

59-
- **Customer Cloud account number** (AWS or Azure)–Must be in the same region as the {{site.data.var.ece}} instance
60-
- **Cloud region**–Provide the Cloud region where the account is hosted for verification purposes
61-
- **Services and communication ports**–Adobe must open ports to enable service communication between VPCs, for example _Webserver, HTTP port 80_, _SFTP port 2222_
62-
- **Project ID**–Provide the {{site.data.var.ece}} Pro project ID. You can get the Project ID and other project information using the folllowing [Magento Cloud CLI][] command: ```magento-cloud project:info```
63-
- **Connection type**–Specify unidirectional or bidirectional for connection type
64-
- **Endpoint service**–For bidirectional PrivateLink connections, provide the DNS URL for the VPC endpoint service that Adobe must connect to, for example `com.amazonaws.vpce.<cloud-region>.vpce-svc-<service-id>`.
65-
- **Endpoint service access granted**-Provide the Adobe account principal with access to this endpoint service: `arn:aws:iam::402592597372:root`. If access to the endpoint service is not provided, the bidirectional PrivateLink connection to the service in your VPC is **not** added, which delays the setup.
58+
Gather the following data required for PrivateLink enablement:
59+
60+
- {:.fix}**Customer Cloud account number** (AWS or Azure)—Must be in the same region as the {{site.data.var.ece}} instance
61+
- {:.fix}**Cloud region**—Provide the Cloud region where the account is hosted for verification purposes
62+
- {:.fix}**Services and communication ports**—Adobe must open ports to enable service communication between VPCs, for example _Webserver, HTTP port 80_, _SFTP port 2222_
63+
- {:.fix}**Project ID**—Provide the {{site.data.var.ece}} Pro project ID. You can get the Project ID and other project information using the following [Magento Cloud CLI][] command: `magento-cloud project:info`
64+
- {:.fix}**Connection type**—Specify unidirectional or bidirectional for connection type
65+
- {:.fix}**Endpoint service**—For bidirectional PrivateLink connections, provide the DNS URL for the VPC endpoint service that Adobe must connect to, for example: `com.amazonaws.vpce.<cloud-region>.vpce-svc-<service-id>`
66+
- {:.fix}**Endpoint service access granted**—To connect to external service, allow the endpoint service access to the following AWS account principal: `arn:aws:iam::402592597372:root`
67+
68+
{:.bs-callout-warning}
69+
If access to the endpoint service is not provided, then the bidirectional PrivateLink connection to the service in your VPC is **not** added, which delays the setup.
70+
71+
Additional prerequisites specific to Azure Private Link enablement:
72+
73+
- {:.fix}Provide the cluster ID; using SSH, log in to the remote and use the command: `cat /etc/platform_cluster`
74+
75+
- {:.fix}For an external service to connect to your {{site.data.var.ee}} Pro cluster, you need:
76+
77+
- A list of ports on your Pro cluster to expose to the new external Private Endpoint
78+
79+
- A list of Azure subscription IDs for the Private Endpoint connections
80+
81+
- {:.fix}To connect your {{site.data.var.ee}} Pro cluster to an external service, you need:
82+
83+
- A list of resource IDs for the target services. External Private Link service IDs look similar to the following:
84+
85+
```text
86+
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{svcNameID}
87+
```
6688

6789
### Enablement workflow
6890

6991
The following workflow outlines the enablement process for PrivateLink integration with {{site.data.var.ece}}.
7092

71-
1. **Customer** submits a support ticket requesting PrivateLink enablement with the subject line `PrivateLink support for <company>`. Include the [data required for enablement](#prerequisites) in the ticket.
72-
73-
We use the Support ticket to coordinate communication during the enablement process.
93+
1. **Customer** submits a support ticket requesting PrivateLink enablement with the subject line `PrivateLink support for <company>`. Include the [data required for enablement](#prerequisites) in the ticket. Adobe uses the Support ticket to coordinate communication during the enablement process.
7494

7595
1. **Adobe** enables customer account access to the endpoint service in the Adobe VPC.
7696

@@ -111,18 +131,18 @@ The following workflow outlines the enablement process for PrivateLink integrati
111131
You can use the Telnet application to test the connection to the VPC endpoint service.
112132

113133
{:.bs-callout-tip}
114-
For help installing and using Telnet, see [Telnet How-To][] in the Telnet documentation.
134+
For help with installing and using Telnet, see [Telnet How-To][] in the _Telnet_ documentation.
115135

116136
{:.procedure}
117137
To test the connection to the VPC endpoint service:
118138

119-
1. Log in to {{site.data.var.ece}} project, and checkout the Staging or Production environment.
139+
1. Log in to {{site.data.var.ece}}.
120140

121141
```bash
122142
magento-cloud login
123143
```
124144

125-
1. From the project root directory, checkout the environment configured to access the PrivateLink endpoint service.
145+
1. From the project root directory, **checkout** the Staging or Production environment configured to access the PrivateLink endpoint service.
126146

127147
```bash
128148
magento-cloud environment:checkout <environment-id>
@@ -156,26 +176,26 @@ To test the connection to the VPC endpoint service:
156176
```
157177
{:.no-copy}
158178

159-
1. Run the following command to ensure the service is listening on VM:
179+
1. Verify the service is listening on VM.
160180

161181
```bash
162-
netstat -na |grep <port>
182+
netstat -na | grep <port>
163183
```
164184

165-
1. Run the following command to check the packages flow:
185+
1. Check the packages flow.
166186

167187
```bash
168-
tcpdump -i <ethernet interface> -tt -nn port <destination port> and host <source host>
188+
tcpdump -i <ethernet-interface> -tt -nn port <destination-port> and host <source-host>
169189
```
170190

171191
Check the following internal settings to ensure that the configuration is valid:
172192

173193
- Endpoint and endpoint services settings
174194
- NLB settings
175195
- The target groups in NLB and verify they are healthy
176-
- The netcat/curl endpoint URL from each VM ( listed above)
196+
- The netcat/curl endpoint URL from each VM (listed above)
177197

178-
See the following articles for help troubleshooting connection issues:
198+
See the following articles for help with troubleshooting connection issues:
179199

180200
- [AWS: Troubleshooting endpoint service connections][]
181201
- [Amazon: Troubleshooting Azure Private Link connectivity problems][]
@@ -205,7 +225,7 @@ If these resources are not available in the customer VPC, you must sign into you
205225

206226
See your Cloud platform documentation for PrivateLink set up instructions:
207227

208-
- **AWS PrivateLink documentation**
228+
- **AWS PrivateLink documentation**
209229
- [Create a Network Load Balancer][]
210230
- [Create an endpoint service configuration][]
211231
- [Create an interface endpoint][]
@@ -233,7 +253,7 @@ See your Cloud platform documentation for PrivateLink set up instructions:
233253
[Create a Network Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-network-load-balancer.html
234254
[Create an endpoint service configuration]: https://docs.aws.amazon.com/vpc/latest/userguide/create-endpoint-service.html
235255
[Create an interface endpoint]: https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#create-interface-endpoint
236-
[Enable SSH keys]: https://devdocs.magento.com/cloud/before/before-workspace-ssh.html
256+
[Enable SSH keys]: {{site.baseurl}}/cloud/before/before-workspace-ssh.html
237257
[interface endpoint lifecycle]: https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html#vpce-interface-lifecycle
238258
[interface endpoint]: https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html
239259
[Magento Cloud CLI]: {{site.baseurl}}/cloud/reference/cli-ref-topic.html

0 commit comments

Comments
 (0)