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

[doc][yba] Encryption in transit update #23027

Merged
merged 28 commits into from
Jul 18, 2024
Merged

Conversation

ddhodge
Copy link
Contributor

@ddhodge ddhodge commented Jun 26, 2024

Reorganize and update YBA encryption in transit section
DOC-342
DOC-358

@netlify /preview/yugabyte-platform/security/enable-encryption-in-transit

@ddhodge ddhodge self-assigned this Jun 26, 2024
@ddhodge ddhodge added the area/documentation Documentation needed label Jun 26, 2024
@ddhodge ddhodge added this to In progress in Documentation via automation Jun 26, 2024
Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for infallible-bardeen-164bc9 ready!

Name Link
🔨 Latest commit 4c94b13
🔍 Latest deploy log https://app.netlify.com/sites/infallible-bardeen-164bc9/deploys/66986dd8aac1c90008002ad1
😎 Deploy Preview https://deploy-preview-23027--infallible-bardeen-164bc9.netlify.app/preview/yugabyte-platform/security/enable-encryption-in-transit
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ddhodge ddhodge requested a review from iSignal June 26, 2024 18:10
@ddhodge ddhodge requested a review from aishwarya24 June 26, 2024 20:16
Copy link
Collaborator

@aishwarya24 aishwarya24 left a comment

Choose a reason for hiding this comment

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

some comments

@ddhodge ddhodge requested a review from Vars-07 June 28, 2024 16:24
For more information on connecting to TLS-enabled universes, refer to [Connect to clusters](../../security/enable-encryption-in-transit/#connect-to-clusters).
1. Download the certificate.

- If you are connecting using a YSQL client (such as ysqlsh), click **Actions**, and choose **Download YSQL Cert**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- If you are connecting using a YSQL client (such as ysqlsh), click **Actions**, and choose **Download YSQL Cert**.
- If you are connecting using a YSQL client (such as ysqlsh) and wish to verify the server's identity at the client, click **Actions**, and choose **Download Root CA Cert**. Supply this CA cert to the `ysqlsh` command in the `sslrootca` parameter as [shown here](https://www.yugabyte.com/blog/securing-yugabytedb-client-to-server-encryption/#verification-of-server-certificates) to enable the ysqlsh client to verify the server certificate.

The information here needs a bit of a rewrite. The full story is described here - https://www.yugabyte.com/blog/securing-yugabytedb-client-to-server-encryption/#verification-of-server-certificates

In general, for YSQL clients, the user only needs the CA cert, similar to YSQL. The "YSQL cert" is only required if they have enabled postgres certificate auth as described in https://www.yugabyte.com/blog/securing-yugabytedb-client-to-server-encryption/#verification-of-client-certificates but this is not very common and it requires the user to perform additional steps to enable such auth. I think we can ignore this, if we want we can condense this section ("verification of client certificates") here.

@ddhodge ddhodge requested a review from yushenng July 15, 2024 16:37
Copy link
Contributor

@Vars-07 Vars-07 left a comment

Choose a reason for hiding this comment

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

lgtm!

@ddhodge ddhodge merged commit 4823cd4 into yugabyte:master Jul 18, 2024
2 checks passed
@ddhodge ddhodge deleted the doc_342 branch July 18, 2024 01:31
jasonyb pushed a commit that referenced this pull request Jul 18, 2024
Summary:
 7786cf7 [PLAT-12072][Platform] Implement Task Details Drawer
 95fb188 [PLAT-14225] Implement v2 Group Mapping APIs
 8e33f45 [PLAT-12085]: Modify the confirm modal box depending on the type of edit universe op
 87fe4b8 [doc][yba] add OIDC URI example (#23222)
 c212f4b [docs] Logical replication explore docs sections (#23231)
 0619b50 CDC Docs changes (#23234)
 4823cd4 [doc][yba] Encryption in transit update (#23027)
 c5dd61b [PLAT-14344] Support Premium SSD V2 disks in azure YBA managed provider
 4ca56cf [PLAT-6774] Enable changing RF for existing universe
 4af129f [PLAT-14685] - improvement : Disable Gflags change if gflags belongs to ENHANCED_POSTGRES_COMPATIBILITY group

Test Plan: Jenkins: rebase: pg15-cherrypicks

Reviewers: jason, tfoucher

Tags: #jenkins-ready

Differential Revision: https://phorge.dev.yugabyte.com/D36695
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation needed
Projects
Documentation
In progress
Development

Successfully merging this pull request may close these issues.

None yet

4 participants