Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clarify PrivateLink Setup #1866

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Clarify PrivateLink Setup #1866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/en/cloud/security/aws-privatelink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ AWS PrivateLink is only available in ClickHouse Cloud Production services. Devel
Before you get started you will need:

1. An AWS account.
1. An API key with the necessary permissions to create and manage private links.
1. A [ClickHouse Cloud API key](https://clickhouse.com/docs/en/cloud/manage/openapi) with the necessary permissions to create and manage private links.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK we have only 2 roles(atm): developer and admin, shall we mention explicitly to create key w/ admin access?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense to me, @konsta-danyliuk , what do you think?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natalyjazzviolin , yep, this seems more straightforward.

@tsolodov, If the Dev key type doesn't have sufficient permissions for Private Links set up, we should include the key type in the doc.


## Steps

Expand Down Expand Up @@ -62,6 +62,12 @@ This command should return something like:
}
```

:::info

Disregard `privateDnsHostname`, this is a placeholder and will be updated in [step 5](http://localhost:3000/docs/en/manage/security/aws-privatelink#5-accessing-an-instance-using-privatelink).

:::

Make a note of the `endpointServiceId` and [move onto step 2](#2-create-a-service-endpoint).

### 2. Create a service endpoint
Expand All @@ -72,6 +78,12 @@ Select **Other endpoint services** and use the `endpointServiceId` you got from

![](./images/aws-privatelink-endpoint-settings.png)

:::info

If you are getting a 'Service name could not be verified.' error, make sure the region in the top right navigation bar matches the region of your service.

:::

Next, select your VPC and subnets:

![Select VPC and subnets](./images/aws-privatelink-select-vpc-and-subnets.png)
Expand Down
Loading