feat(egw): encrypt-fields docs#5355
Open
michaelbeaumont wants to merge 4 commits into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
michaelbeaumont
force-pushed
the
feat/egw-encrypt-fields
branch
6 times, most recently
from
0f7f227 to
326f241
Compare
michaelbeaumont
force-pushed
the
feat/egw-encrypt-fields
branch
4 times, most recently
from
2e67592 to
f88919f
Compare
Contributor
|
@michaelbeaumont could you please retarget/rebase this PR to point to |
michaelbeaumont
force-pushed
the
feat/egw-encrypt-fields
branch
from
f88919f to
611bf0d
Compare
Contributor
|
@michaelbeaumont is this ready for doc review? Let me know when I can pick this up. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new Event Gateway encrypt_fields/decrypt_fields policies, including policy reference pages, runnable examples, and an end-to-end how-to that demonstrates encrypting/decrypting specific JSON fields in Kafka message values.
Changes:
- Add new Encrypt fields and Decrypt fields policy pages with example configurations.
- Add a new how-to: Encrypt and decrypt Kafka message fields using a static key and Schema Validation nesting.
- Update Event Gateway landing page and policy entity page to link to the new policies/how-to.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| app/event-gateway/entities/policy.md | Adds the new field-level policies to the policy nesting table. |
| app/_landing_pages/event-gateway.yaml | Adds the new policies + how-to link to the Event Gateway use-case table. |
| app/_how-tos/event-gateway/encrypt-kafka-message-fields-with-event-gateway.md | New end-to-end how-to for encrypting/decrypting specific JSON fields. |
| app/_event_gateway_policies/encrypt/index.md | Fixes Liquid include indentation so it renders correctly. |
| app/_event_gateway_policies/encrypt-fields/index.md | New policy reference page for Encrypt fields. |
| app/_event_gateway_policies/encrypt-fields/examples/encrypt-with-static-key.yml | Adds a static-key example for Encrypt fields. |
| app/_event_gateway_policies/encrypt-fields/examples/encrypt-with-aws.yml | Adds an AWS example for Encrypt fields. |
| app/_event_gateway_policies/decrypt-fields/index.md | New policy reference page for Decrypt fields. |
| app/_event_gateway_policies/decrypt-fields/examples/decrypt-with-static-key.yml | Adds a static-key example for Decrypt fields. |
| app/_event_gateway_policies/decrypt-fields/examples/decrypt-with-aws.yml | Adds an AWS example for Decrypt fields. |
Comment on lines
165
to
+167
| * [Modify Headers](/event-gateway/policies/modify-headers/) | ||
| * [Skip Records](/event-gateway/policies/skip-record/) | ||
| * [Decrypt fields](/event-gateway/policies/encrypt-fields/) |
Comment on lines
+271
to
+275
| [Encryption policy](/event-gateway/policies/encrypt/), [Decryption policy](/event-gateway/policies/decrypt/), | ||
| [Encrypt fields policy](/event-gateway/policies/encrypt-fields/), [Decrypt fields policy](/event-gateway/policies/decrypt-fields/), | ||
| guide: | | ||
| [Encrypt and decrypt Kafka messages](/event-gateway/encrypt-kafka-messages-with-event-gateway/) | ||
| or [encrypt and decrypt Kafka message fields](/event-gateway/encrypt-kafka-message-fields-with-event-gateway/) |
Comment on lines
+30
to
+33
| related_resources: | ||
| - text: Decrypt fields policy | ||
| url: /event-gateway/policies/decrypt_fields/ | ||
| - text: Virtual clusters |
Comment on lines
+13
to
+16
| schema: | ||
| api: konnect/event-gateway | ||
| path: /schemas/EventGatewayDecryptPolicy | ||
|
|
Comment on lines
+256
to
+262
| encrypt_fields: | ||
| - paths: | ||
| - match: "personal.ssn" | ||
| encryption_key: | ||
| type: static | ||
| key: | ||
| name: my-key |
Comment on lines
+24
to
+30
| failure_mode: reject | ||
| encrypt_fields: | ||
| - paths: | ||
| - match: "personal.ssn" | ||
| encryption_key: | ||
| type: aws | ||
| arn: ${key_id} |
Comment on lines
+23
to
+27
| key_sources: | ||
| - type: static | ||
| decrypt_fields: | ||
| paths: | ||
| - match: personal.ssn |
Comment on lines
+1
to
+12
| title: Decrypt fields using an AWS key vault | ||
|
|
||
| description: Decrypt a message field using a specific AWS key vault. | ||
|
|
||
| extended_description: | | ||
| Decrypt a message field using a specific AWS key vault. | ||
|
|
||
| weight: 900 | ||
|
|
||
| requirements: | ||
| - "A corresponding [Encrypt fields policy](/event-gateway/policies/encrypt-fields/examples/encrypt-with-aws/). | ||
| Event Gateway uses the AWS ARN from the Encrypt field policy to find the key for the Decrypt fields policy." |
Comment on lines
+18
to
+22
| key_sources: | ||
| - type: aws | ||
| decrypt_fields: | ||
| paths: | ||
| - match: personal.ssn |
Comment on lines
+1
to
+9
| title: Encrypt fields with AWS Key Vault | ||
|
|
||
| description: Use an AWS Key Vault to encrypt fields of message value. | ||
|
|
||
| weight: 900 | ||
|
|
||
| requirements: | ||
| - "An [AWS KMS key ARN](https://docs.aws.amazon.com/sdk-for-rust/latest/dg/credproviders.html#credproviders-default-credentials-provider-chain)." | ||
| - "A corresponding [field decryption policy](/event-gateway/policies/decrypt-fields/examples/decrypt-with-static-key/)." |
This file contains hidden or 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
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
Documents the new encrypt_fields policy
Preview Links
Checklist
descriptionentry in frontmatter.