-
Notifications
You must be signed in to change notification settings - Fork 260
RC: AWS PrivateLink #2150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
cmilesb
wants to merge
5
commits into
main
Choose a base branch
from
DOC-5496
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
RC: AWS PrivateLink #2150
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
--- | ||
Title: Connect to Amazon Web Services PrivateLink | ||
alwaysopen: false | ||
categories: | ||
- docs | ||
- operate | ||
- rc | ||
description: null | ||
linkTitle: AWS PrivateLink | ||
weight: 90 | ||
--- | ||
|
||
[Amazon Web Services (AWS) PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-resources.html) allows you to securely connect your Amazon virtual private cloud(s) (VPCs) to Redis Cloud without using public IP addresses or traversing the public internet. PrivateLink provides private connectivity between VPCs, simplifying your network architecture and reducing exposure to security threats. | ||
|
||
{{< note >}} | ||
Connecting to Redis Cloud with an AWS PrivateLink is available only with Redis Cloud Pro. It is not supported for Redis Cloud Essentials. | ||
{{< /note >}} | ||
|
||
## Considerations and limitations | ||
|
||
You can use PrivateLink as an alternative to [VPC peering]({{< relref "/operate/rc/security/vpc-peering" >}}), or you can enable both for your subscription. | ||
|
||
With AWS PrivateLink, Redis Cloud exposes a VPC endpoint service that you connect to as a consumer from your own VPC. Traffic stays within the AWS network and is isolated from external networks. | ||
|
||
AWS PrivateLink provides the following benefits over VPC Peering: | ||
|
||
- **Improved Security**: PrivateLink exposes the Redis cluster and database(s) as a unidirectional endpoint inside your consumer VPC, thereby avoiding exposing entire VPC subnets to each other and eliminating some possible attack vectors. | ||
- **Network Flexibility**: PrivateLink enables cross-account and cross-VPC connectivity and can be configured even when the Redis Cloud VPC and your consumer VPC have overlapping CIDR/IP ranges. | ||
- **Simplified architecture and low latency**: PrivateLink does not require NAT, internet gateways, or VPNs. It provides simplified network routing, without the need for a network load balancer between the application and the Redis database. | ||
|
||
Be aware of the following limitations when using PrivateLink with Redis Cloud: | ||
- You cannot use the [OSS Cluster API]({{< relref "/operate/rc/databases/create-database#oss-cluster-api" >}}) with PrivateLink. | ||
- Redis Cloud [Bring your Own Cloud]({{< relref "/operate/rc/subscriptions/bring-your-own-cloud" >}}) subscriptions are not supported with PrivateLink. | ||
- Redis Cloud subscriptions with AWS PrivateLink are limited to a maximum of 35 databases. | ||
|
||
## Prerequisites | ||
|
||
Before you can connect to Redis Cloud with an AWS PrivateLink VPC resource endpoint, you must have: | ||
|
||
- A [Redis Cloud Pro database]({{< relref "/operate/rc/databases/create-database/create-pro-database-new" >}}). | ||
- An [AWS VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) with the following: | ||
- A [security group](https://docs.aws.amazon.com/vpc/latest/userguide/creating-security-groups.html) that allows ingress traffic to the following ports: | ||
- The database port range (port 10000-19999) | ||
- The Redis Cloud metrics port (port 8070), if desired | ||
- Subnets in the same region as your Redis Cloud database. | ||
- Permission to create and manage VPC endpoints or Service networks in AWS | ||
|
||
## Set up PrivateLink connection | ||
|
||
To set up a connection to Redis Cloud with an AWS PrivateLink VPC resource endpoint, you need to: | ||
|
||
1. [Associate the Redis Cloud Resource share with one or more AWS principals](#associate-resource-share). | ||
1. [Add a connection](#add-connection) from your consumer account using a VPC resource endpoint or a VPC Lattice service network. | ||
|
||
### Associate Redis Cloud resource share with a principal {#associate-resource-share} | ||
|
||
In this step, you will associate the Redis Cloud resource share with an AWS principal, such as an AWS Account. | ||
|
||
1. From the [Redis Cloud console](https://cloud.redis.io/), select the **Subscriptions** menu and then select your subscription from the list. | ||
|
||
1. Select **Connectivity > PrivateLink** to view the PrivateLink settings. | ||
|
||
1. In the **Resource Share** section, select **Manage Principals** to open the **Manage Principals** window. | ||
|
||
{{<image filename="images/rc/privatelink-resource-share.png" width="80%" alt="The Resource Share section, with the manage principals button." >}} | ||
|
||
{{<image filename="images/rc/privatelink-manage-principals.png" width="80%" alt="The Manage Principals window lets you add and remove principals from the resource share." >}} | ||
|
||
1. Select the **Add** button in the **AWS consumer principals** section to add a principal to the resource share. | ||
|
||
{{<image filename="images/rc/icon-add.png" width="30px" alt="The Add button adds principals to the resource share." >}} | ||
|
||
1. Select the type of principal you want to add from the **Principal type** list. You can choose from the following principal types: | ||
|
||
- AWS account | ||
- [Organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) | ||
- [Organizational unit (OU)](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) | ||
- [Identity and Access Management (IAM) role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) | ||
- [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) | ||
- Service principal | ||
|
||
1. Enter the principal's ID in the **Principal ID** field. You can also add an optional alias in the **AWS principal alias** field. | ||
|
||
{{<image filename="images/rc/privatelink-aws-consumer-principals.png" width="80%" alt="The AWS consumer principals section with an AWS account added as a principal." >}} | ||
|
||
1. Select **Share** to share the resource share with the principal. | ||
|
||
1. After sharing the resource share with the principal, [accept the resource share in the Resource Access Manager](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html) or copy the **Accept resource share** command and run it with the AWS CLI. | ||
|
||
After you accept the resource share, the Redis Cloud console will show the resource share as **Accepted**. | ||
|
||
{{<image filename="images/rc/privatelink-resource-share-accepted.png" width="80%" alt="The Resource Share section, with the resource share accepted." >}} | ||
|
||
You can add additional principals to the resource share at any time. | ||
|
||
### Add a connection {#add-connection} | ||
|
||
In this step, you will add a connection from your consumer account using a VPC resource endpoint or a VPC lattice service network. | ||
|
||
From the **Connectivity > PrivateLink** tab in your Redis Cloud subscription, open the **Add connection** section. | ||
|
||
{{<image filename="images/rc/privatelink-add-connection.png" width="80%" alt="The Add connection section." >}} | ||
|
||
Here, choose whether you want to connect to Redis using a **Resource endpoint** or a **Service network**. | ||
|
||
{{< multitabs id="privatelink-connection-type" | ||
tab1="Resource endpoint" | ||
tab2="Service network" >}} | ||
|
||
You can connect with a VPC resource endpoint through the AWS Console or with the AWS CLI. | ||
|
||
#### AWS Console | ||
|
||
Follow the guide to [create a VPC resource endpoint in the AWS console](https://docs.aws.amazon.com/vpc/latest/privatelink/use-resource-endpoint.html#create-resource-endpoint-aws) with the following settings: | ||
|
||
- **Type**: Select **Resources**. | ||
- **Resource configurations**: Select the configuration with the same Resource Configuration ID as the one shown in the Redis Cloud console. | ||
- **VPC**: Select your VPC from the list. | ||
- **Subnets**: Select the subnets to create endpoint network resources in. | ||
- **Security groups**: Select any security groups you want to associate with the resource endpoint, including the security group that allows access to the necessary ports, as described in the [prerequisites](#prerequisites) | ||
|
||
#### AWS CLI | ||
|
||
To use the AWS CLI to add a VPC resource endpoint, select **Copy** under the **AWS CLI Command** to save the command to your clipboard. Enter the saved command in a terminal shell to create the resource endpoint and replace the following parameters with your own values: | ||
|
||
- `<vpc id>`: The ID of your VPC | ||
- `<subnet ids>`: The IDs of the subnets to create endpoint network resources in | ||
- `<security group ids>`: The IDs of any security groups you want to associate with the resource endpoint, including the security group that allows access to the necessary ports, as described in the [prerequisites](#prerequisites) | ||
|
||
-tab-sep- | ||
|
||
You can connect with an existing [VPC lattice service network](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html) through the AWS Console or with the AWS CLI. | ||
|
||
#### AWS Console | ||
|
||
Follow the guide to [Manage resource configuration associations](https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-resource-config-association) for your service network. Select the configuration with the same Resource Configuration ID as the one shown in the Redis Cloud console. | ||
|
||
#### AWS CLI | ||
|
||
To use the AWS CLI to connect to an already existing service network, select **Copy** under the **AWS CLI Command** to save the command to your clipboard. Enter the saved command in a terminal shell to connect to the service network and replace `<service network id>` with the ID of your service network. | ||
|
||
{{< /multitabs >}} | ||
|
||
After you've connected to Redis Cloud with a VPC resource endpoint or a VPC lattice service network, download the **Discovery script** and run it in your consumer account to discover the database endpoints. | ||
|
||
After you've connected to your database, you can view the connection details in the Redis Cloud console in your subscription's **Connectivity > PrivateLink** tab. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cmilesb Instead of saying that it securely connects between VPCs, I'd prefer to say here something along the lines of PrivateLink allows service providers (i.e. Redis) to securely expose specific services without exposing the entire service provider and consumer VPCs to each other (as is the case with VPC peering/TGW for example). AWS do this by having a representation of the service (resource) in the consumer VPC and the consumer uses that local representation as if the resource was in the consumer VPC. Indeed not needing to care about deployment CIDRs is another benefit as a result of that. Not sure how to phrase it clearly but that is the idea.