You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: src/cloud/project/privatelink-service.md
+50-30Lines changed: 50 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -21,56 +21,76 @@ The PrivateLink service integration for {{site.data.var.ece}} projects includes
21
21
22
22
## Limitations
23
23
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][].
26
26
- {{site.data.var.ee}} support does not cover troubleshooting AWS PrivateLink issues beyond initial enablement.
27
27
- Customers are responsible for costs associated with managing their own VPC.
28
28
- You cannot use the HTTPS protocol (port 443) to connect to {{ site.data.var.ece }} over PrivateLink.
29
29
- PrivateDNS is not available.
30
30
31
31
## PrivateLink connection types
32
32
33
-
The following network diagram shows the PrivateLink connection types availableto 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.
34
34
35
35
![PrivateLink network diagram]
36
36
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:
38
38
39
39
-**Unidirectional PrivateLink**–Choose this configuration to retrieve data securely from a {{ site.data.var.ece }} store.
40
40
-**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:
41
41
- A connection between the customer VPC and the Adobe VPC
42
42
- A connection between the Adobe VPC and the customer VPC
43
43
44
44
{:.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][].
46
46
47
47
## Request PrivateLink enablement
48
48
49
49
{:.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.
51
51
52
52
### Prerequisites
53
53
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.
56
56
- {:.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:
58
57
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:
The following workflow outlines the enablement process for PrivateLink integration with {{site.data.var.ece}}.
70
92
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.
74
94
75
95
1.**Adobe** enables customer account access to the endpoint service in the Adobe VPC.
76
96
@@ -111,18 +131,18 @@ The following workflow outlines the enablement process for PrivateLink integrati
111
131
You can use the Telnet application to test the connection to the VPC endpoint service.
112
132
113
133
{:.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.
115
135
116
136
{:.procedure}
117
137
To test the connection to the VPC endpoint service:
118
138
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}}.
120
140
121
141
```bash
122
142
magento-cloud login
123
143
```
124
144
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.
0 commit comments