Add KMS encryption to YAML pipeline
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead. - [ ] Update
CHANGES.mdwith noteworthy changes. - [ ] If this contribution is large, please file an Apache Individual Contributor License Agreement.
See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.
Summary of Changes
Hello @tarun-google, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a critical security enhancement to Beam YAML pipelines by integrating Google Cloud Key Management Service (KMS). It provides a robust mechanism for encrypting sensitive configuration parameters, such as database credentials, directly within YAML definitions. These encrypted values are then automatically decrypted at runtime using a specified KMS key, ensuring that confidential information is never exposed in plaintext throughout the pipeline's lifecycle. This significantly elevates the security and compliance of data processing workflows defined using Beam YAML.
Highlights
- KMS Integration for YAML Pipelines: Introduced a new
kms.pymodule and integrated Google Cloud Key Management Service (KMS) to allow decryption of sensitive configuration values directly within Beam YAML pipelines. - YAML Schema and Preprocessing Updates: The
pipeline.schema.yamlnow supports anencryptionblock within transform definitions, specifying a KMS key and fields to be decrypted. A newpreprocess_encryptionfunction inyaml_transform.pyhandles the automatic decryption of these fields at runtime. - Enhanced Security for Sensitive Data: This feature enables users to store sensitive information, such as database credentials, in an encrypted format within their YAML files, significantly improving the security posture by preventing plaintext exposure.
- New Example and Dependencies: A new example YAML pipeline (
write_to_jdbc.yaml) demonstrates the usage of KMS encryption for database credentials. Thegoogle-cloud-kmslibrary has been added as a dependency for GCP-related functionalities. - Comprehensive Unit Tests: Dedicated unit tests have been added for the KMS decryption logic and the YAML preprocessing of encrypted fields, ensuring robustness and correctness of the new functionality.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.