Skip to content

[MOVED] fix(kms): Package providers in the server distribution#12144

Closed
nevzheng wants to merge 12 commits into
apache:mainfrom
nevzheng:codex/kms-api-12-packaging
Closed

[MOVED] fix(kms): Package providers in the server distribution#12144
nevzheng wants to merge 12 commits into
apache:mainfrom
nevzheng:codex/kms-api-12-packaging

Conversation

@nevzheng

@nevzheng nevzheng commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Moved to Gravitino Enterprise: datastrato/gravitino-enterprise#909. Apache issue #12131 is now limited to the provider-neutral API/SPI and named-source routing.

What changes were proposed in this pull request?

  • Add shaded runtime bundles for AWS KMS, Google Cloud KMS, Azure Key Vault, and Transit.
  • Package them under kms-providers and load that directory from the server launcher.
  • Verify all five factories through artifact checks and a fresh packaged-runtime JVM.
  • Document the provider packaging and discovery contract.

Why are the changes needed?

The provider modules register KmsClientFactory implementations, but the server distribution previously excluded their artifacts. A packaged server with a configured KMS source therefore could not discover its factory.

This work is now tracked in datastrato/gravitino-enterprise#909. The Apache OSS foundation remains #12132 and #12133.

Does this PR introduce any user-facing change?

Yes. Named KMS sources now work in the packaged Gravitino server. No configuration keys change. The four provider bundles add approximately 79 MiB to the unpacked distribution.

How was this patch tested?

  • ./gradlew spotlessApply compileDistribution -PskipWeb=true -x test
  • ./gradlew :api:test :core:test :bundles:aws:test :bundles:gcp:test :bundles:azure:test :bundles:transit:test -PskipITs -PskipDockerTests=true -PskipWeb=true
  • Fresh-JVM discovery of all five factories from the packaged kms-providers directory.
  • git diff --check
  • bash -n bin/gravitino.sh.template

Migration

@github-actions

Copy link
Copy Markdown

Code Coverage Report

Overall Project 68.05% +0.15% 🟢
Files changed 79.72% 🟢

Module Coverage
aliyun 1.72% 🔴
api 48.25% +0.43% 🟢
authorization-common 85.96% 🟢
aws 51.64% +9.61% 🟢
azure 47.32% +44.85% 🟢
catalog-common 9.92% 🔴
catalog-fileset 79.74% 🟢
catalog-glue 66.91% 🟢
catalog-hive 79.4% 🟢
catalog-jdbc-common 45.7% 🟢
catalog-jdbc-doris 81.72% 🟢
catalog-jdbc-mysql 79.33% 🟢
catalog-jdbc-postgresql 83.39% 🟢
catalog-jdbc-starrocks 79.16% 🟢
catalog-kafka 77.01% 🟢
catalog-lakehouse-generic 59.18% 🟢
catalog-lakehouse-hudi 79.1% 🟢
catalog-lakehouse-iceberg 85.86% 🟢
catalog-lakehouse-paimon 84.23% 🟢
catalog-model 77.72% 🟢
cli 44.5% 🟢
client-java 78.27% 🟢
common 51.95% 🟢
core 82.67% -0.41% 🟢
filesystem-hadoop3 77.28% 🟢
flink 0.0% 🔴
flink-common 47.09% 🟢
flink-runtime 0.0% 🔴
gcp 47.02% +32.9% 🟢
hadoop-auth 68.0% 🟢
hadoop-common 12.7% 🔴
hive-metastore-common 53.4% 🟢
iceberg-common 64.65% 🟢
iceberg-rest-server 74.91% 🟢
idp-basic 86.02% 🟢
integration-test-common 0.0% 🔴
jobs 66.17% 🟢
lance-common 20.67% 🔴
lance-rest-server 64.84% 🟢
lineage 53.02% 🟢
optimizer 83.24% 🟢
optimizer-api 21.95% 🔴
server 85.92% 🟢
server-common 76.12% 🟢
spark 28.57% 🔴
spark-common 46.01% 🟢
tencent 69.84% 🟢
transit 90.75% 🟢
trino-connector 40.29% 🟢
Files
Module File Coverage
api KmsApi.java 100.0% 🟢
KmsClient.java 100.0% 🟢
KmsReference.java 100.0% 🟢
KmsAuthenticationException.java 0.0% 🔴
KmsClientFactory.java 0.0% 🔴
KmsConfigurationException.java 0.0% 🔴
KmsKeyProperties.java 0.0% 🔴
aws AwsKmsClient.java 100.0% 🟢
AwsKmsKeyProperties.java 100.0% 🟢
AwsKmsClientFactory.java 93.33% 🟢
azure AzureKeyVaultKmsKeyProperties.java 100.0% 🟢
AzureKeyVaultKmsClientFactory.java 97.37% 🟢
AzureKeyVaultKeyIdentifier.java 96.08% 🟢
AzureKeyVaultKmsClient.java 88.89% 🟢
core KmsConfig.java 100.0% 🟢
KmsClientRegistry.java 98.88% 🟢
GravitinoEnv.java 20.93% 🔴
gcp GoogleCloudKmsKeyMetadata.java 100.0% 🟢
GoogleCloudKmsKeyProperties.java 100.0% 🟢
GoogleCloudKmsSdkMetadataService.java 100.0% 🟢
GoogleCloudKmsClient.java 95.56% 🟢
GoogleCloudKmsClientFactory.java 85.29% 🟢
GoogleCloudKmsMetadataService.java 0.0% 🔴
transit OpenBaoTransitKmsKeyProperties.java 100.0% 🟢
TransitKeyData.java 100.0% 🟢
TransitReadKeyResponse.java 100.0% 🟢
VaultTransitKmsKeyProperties.java 100.0% 🟢
OpenBaoTransitKmsClient.java 97.3% 🟢
OpenBaoTransitKmsClientFactory.java 91.23% 🟢
VaultTransitKmsClientFactory.java 91.23% 🟢
TransitApiClient.java 90.22% 🟢
TransitReadKeyRequest.java 83.33% 🟢
VaultTransitKmsClient.java 82.35% 🟢
FileTokenSupplier.java 81.48% 🟢

@nevzheng nevzheng changed the title [#12131] fix(kms): Package providers in the server distribution [MOVED] fix(kms): Package providers in the server distribution Jul 22, 2026
@nevzheng

Copy link
Copy Markdown
Collaborator Author

Moved to datastrato/gravitino-enterprise#909 under enterprise epic #899. Apache OSS scope remains #12132 and #12133 under #12131.

@nevzheng nevzheng closed this Jul 22, 2026
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.

1 participant