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.

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

Clarify PrivateLink Setup #1866

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

Conversation

natalyjazzviolin
Copy link
Contributor

This adds clarification for a smoother PrivateLink setup process. So far this:

  • Specifies that a CLickHouse Cloud API key is needed.
  • Calls out that the initial privateDnsHostname is a placeholder.
  • Calls out to check that regions match in the AWS Console for service name verification.

@robot-ch-test-poll1
Copy link

robot-ch-test-poll1 commented Jan 19, 2024

This is an automated comment for commit 9b9cbae with description of existing statuses. It's updated for the latest CI running

✅ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR✅ success
Docs CheckBuilds and tests the documentation✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
VercelThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success

Copy link
Contributor

@tsolodov tsolodov left a comment

Choose a reason for hiding this comment

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

let's update GCP PSC doc using the same notes?

@@ -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?

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants