roryqi commented on code in PR #12489:
URL: https://github.com/apache/gravitino/pull/12489#discussion_r3805600439
##########
docs/gravitino-server-config.md:
##########
@@ -486,6 +488,42 @@ server, are documented with those services. See
| `gravitino.job.stagingDirKeepTimeInMs` | How long in milliseconds a finished
job's staging files are kept. Use at least 10 minutes outside testing. |
`604800000` (7 days) |
| `gravitino.job.statusPullIntervalInMs` | Interval in milliseconds between
job status polls. Use at least 1 minute outside testing. |
`300000` (5 minutes) |
+### Key Management
+
+The server talks to KMS instances you name in `gravitino.conf`. Each name is
one configured
+instance. Each instance names the `KmsClientFactory` class the server
constructs. Two names may
+share one class, which is how you run more than one AWS or Azure vault.
+
+The list is empty by default, and then the server has no KMS clients. Naming a
provider without a
+`className`, or with a class the server cannot construct as a
`KmsClientFactory`, fails startup.
+Client construction validates local configuration only; the first call to the
provider is a later
+key inspection, not startup.
+
+| Configuration Item | Description
| Default Value |
+|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| `gravitino.kms.providers` | Comma-separated KMS instance
names, with no spaces after commas. Each name must match
`[A-Za-z0-9][A-Za-z0-9_-]*` and cannot contain `.`. Duplicates fail startup. |
(empty) |
+| `gravitino.kms.provider.<name>.className` | Required factory class name for
that instance. The class must have a no-arg constructor and implement
`KmsClientFactory`. | (none) |
+| `gravitino.kms.provider.<name>.<key>` | Any other property under that
name is passed to that factory. Nested dots in `<key>` are allowed, as in
`endpoint.region`. | (none) |
+
+Every name in `providers` needs a matching `.className`. A
`gravitino.kms.provider.<name>.*` key
+for a name that is not in the list, or any other `gravitino.kms.*` key, fails
startup.
+
+Callers name the instance and the key. They do not send `className`. The
server already constructed
+the factory for `aws-prod` at startup.
+
+```text
+# conf/gravitino.conf
+gravitino.kms.providers = aws-prod,aws-dr,azure-eu
+
+gravitino.kms.provider.aws-prod.className =
org.apache.gravitino.encryption.kms.aws.AwsKmsClientFactory
Review Comment:
Could u give a better class name?
This class name will make the user feel that the code contains the
AwsKmsClientFactory.
Actually, user need to implement his kms client factory.
From my side, it may be better to use AwsCustomKmsClientFactory.
It would be better to add some words tell users how to implement a custom
kms client factory briefly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
