Add CMEK support in Firebase CLI for Firestore databases #7479
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jinyangtang
force-pushed
the
jt-firestore-cmek-support
branch
from
2027667
to
3385e56
Compare
joehan
approved these changes
Jul 26, 2024
| @@ -25,6 +25,10 @@ export const command = new Command("firestore:databases:create <database>") | |||
| "--point-in-time-recovery <enablement>", | |||
| "Whether to enable the PITR feature on this database, for example 'ENABLED' or 'DISABLED'. Default is 'DISABLED'", | |||
| ) | |||
| .option( | |||
| "--kms-key-name <kmsKeyName>", | |||
| "The resource ID of a Cloud KMS key. If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch.", | |||
There was a problem hiding this comment.
Can you add a TODO with a buganizer link to clean this message up once its open to all?
There was a problem hiding this comment.
Sure, have added.
| const databaseResp: types.DatabaseResp = await api.createDatabase( | ||
| options.project, | ||
| database, | ||
| options.location, | ||
| type, | ||
| deleteProtectionState, | ||
| pointInTimeRecoveryEnablement, | ||
| cmekConfig, |
There was a problem hiding this comment.
Optional: Create database has 7 args - consider switching this to a parameter object (ie https://go/tott/550)
There was a problem hiding this comment.
Have switched to a param object, thanks
|
Could you add a CHANGELOG entry for this? |
jinyangtang
force-pushed
the
jt-firestore-cmek-support
branch
from
abe465c
to
39533ac
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This lets Firebase CLI create a CMEK (Customer-managed encryption keys) Firestore database and view the key associated with a CMEK database.
--kms-key-nameoption to create a CMEK database. (No change for Update because we currently don't support update a CMEK database's key)Kms Key NameandActive Key Versionsfor CMEK databases.Scenarios Tested
kms-key-nameprovided, a CMEK database is created--kms-key-nameis misspelled--kms-key-nameis provided with an empty value--kms-key-nameoptionKms Key NameandActive Key VersionrowsKms Key NamewhenActive Key Versionis not available from backend yet right after database creation (it needs 10min to populate)Kms Key NameandActive Key VersionrowsSample Commands
firebase firetore:databases:create <database># as before, to create a non-CMEK databasefirebase firetore:databases:create <database> --kms-key-name <key>