Skip to content

Commit fb17328

Browse files
authored
Merge pull request #3728 from ClickHouse/alex-k_endpoint_docs
Private enpoints docs update: removed deprecated step
2 parents 77181c3 + 502a350 commit fb17328

File tree

1 file changed

+1
-73
lines changed

1 file changed

+1
-73
lines changed

docs/cloud/security/aws-privatelink.md

+1-73
Original file line numberDiff line numberDiff line change
@@ -195,83 +195,11 @@ There are various ways to configure DNS. Please set up DNS according to your spe
195195

196196
You need to point "DNS name", taken from [Obtain Endpoint "Service name" ](#obtain-endpoint-service-info) step, to AWS Endpoint network interfaces. This ensures that services/components within your VPC/Network can resolve it properly.
197197

198-
### Add Endpoint ID to ClickHouse Cloud organization {#add-endpoint-id-to-clickhouse-cloud-organization}
199-
200-
#### Option 1: ClickHouse Cloud console {#option-1-clickhouse-cloud-console-1}
201-
202-
To add an endpoint to organization, proceed to the [Add Endpoint ID to service(s) allow list](#add-endpoint-id-to-services-allow-list) step. Adding the `Endpoint ID` using the ClickHouse Cloud console to the services allow list automatically adds it to organization.
203-
204-
To remove an endpoint, open **Organization details -> Private Endpoints** and click the delete button to remove the endpoint.
205-
206-
<Image img={pe_remove_private_endpoint} size="md" alt="Remove Private Endpoint" border/>
207-
208-
#### Option 2: API {#option-2-api-1}
209-
210-
Set the following environment variables before running any commands:
211-
212-
```bash
213-
REGION=<Your region code using the AWS format, for example: us-west-2>
214-
PROVIDER=aws
215-
KEY_ID=<Your ClickHouse key ID>
216-
KEY_SECRET=<Your ClickHouse key secret>
217-
ORG_ID=<Your ClickHouse organization ID>
218-
SERVICE_NAME=<Your ClickHouse service name>
219-
```
220-
221-
Set the `ENDPOINT_ID` environment variable using data from [Create AWS Endpoint](#create-aws-endpoint) step.
222-
223-
To add an endpoint, run:
224-
225-
```bash
226-
cat <<EOF | tee pl_config_org.json
227-
{
228-
"privateEndpoints": {
229-
"add": [
230-
{
231-
"cloudProvider": "aws",
232-
"id": "${ENDPOINT_ID:?}",
233-
"description": "An aws private endpoint",
234-
"region": "${REGION:?}"
235-
}
236-
]
237-
}
238-
}
239-
EOF
240-
241-
curl --silent --user "${KEY_ID:?}:${KEY_SECRET:?}" \
242-
-X PATCH -H "Content-Type: application/json" \
243-
"https://api.clickhouse.cloud/v1/organizations/${ORG_ID:?}" \
244-
-d @pl_config_org.json
245-
```
246-
247-
To remove an endpoint, run:
248-
249-
```bash
250-
cat <<EOF | tee pl_config_org.json
251-
{
252-
"privateEndpoints": {
253-
"remove": [
254-
{
255-
"cloudProvider": "aws",
256-
"id": "${ENDPOINT_ID:?}",
257-
"region": "${REGION:?}"
258-
}
259-
]
260-
}
261-
}
262-
EOF
263-
264-
curl --silent --user "${KEY_ID:?}:${KEY_SECRET:?}" \
265-
-X PATCH -H "Content-Type: application/json" \
266-
"https://api.clickhouse.cloud/v1/organizations/${ORG_ID:?}" \
267-
-d @pl_config_org.json
268-
```
269-
270198
### Add "Endpoint ID" to ClickHouse service allow list {#add-endpoint-id-to-services-allow-list}
271199

272200
#### Option 1: ClickHouse Cloud console {#option-1-clickhouse-cloud-console-2}
273201

274-
To add please navigate to the ClickHouse Cloud console, open the service that you would like to connect via PrivateLink then navigate to **Settings**. Enter the `Endpoint ID` obtained from the [Create AWS Endpoint](#create-aws-endpoint) step. Click "Create endpoint".
202+
To add, please navigate to the ClickHouse Cloud console, open the service that you would like to connect via PrivateLink then navigate to **Settings**. Click **Set up private endpoint** to open private endpoints settings. Enter the `Endpoint ID` obtained from the [Create AWS Endpoint](#create-aws-endpoint) step. Click "Create endpoint".
275203

276204
:::note
277205
If you want to allow access from an existing PrivateLink connection, use the existing endpoint drop-down menu.

0 commit comments

Comments
 (0)