Skip to content

Commit

Permalink
[DOCS] Minor grammatical fixes
Browse files Browse the repository at this point in the history
EAR doc fixes.
  • Loading branch information
shristy committed Jul 13, 2022
1 parent 81998ed commit 5364d9a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions architecture/design/docdb-encryption-at-rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,16 +117,16 @@ While we will eventually support option 1, we currently don't have a mechanism t
# Key Management Service (KMS) Integration

KMS integration would initially be facilitated via the Enterprise Platform solution, where the user would maintain the credentials to their KMS system of choice, and at the universe creation time
we would make appropriate API calls to create a new Universe Key and use that key to provision a new universe with At Rest Encryption enabled. In this section we details the approach we plan on
we would make appropriate API calls to create a new Universe Key and use that key to provision a new universe with At Rest Encryption enabled. In this section, we detail the approach we plan on
taking with some of the KMS system that we would support via Platform.

## Equinix [SmartKey](https://www.equinix.com/services/edge-services/smartkey/). Integration
SmartKey is KMS a offering from Equinix, they provide SDK and API to manage the keys in their platform, Yugabyte platform would integrate with SmartKey via the REST API route and authenticate
SmartKey is a KMS offering from Equinix, they provide SDK and API to manage the keys in their platform, Yugabyte platform would integrate with SmartKey via the REST API route and authenticate
using their API key in order to manage the Keys. We would use the name attribute on the Key to link the universe that the key is generated for. Once the key is generated we would make appropriate RPC
calls to YugabyteDB to enable encryption. We would call their rekey api when the user wants to rekey the universe and update the YugabyteDB nodes in a rolling fashion.

## AWS [Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html)
Amazon offers their KMS solution, we will your their KMS api to manage the keys, And they have the concept of aliases which we would use that to build a relationship between the key and universe.
Amazon offers their KMS solution, we will use their KMS API to manage the keys. And they have the concept of aliases which we would use to build a relationship between the key and universe.
When the key needs to be rotated we would create a new key and update the alias accordingly. And do the update on YugabyteDB nodes in a rolling fashion.

# Implementation Internals
Expand Down

0 comments on commit 5364d9a

Please sign in to comment.