Skip to content

Commit

Permalink
docs: ingress-kong README added
Browse files Browse the repository at this point in the history
Signed-off-by: Mattia Lavacca <[email protected]>
  • Loading branch information
mlavacca committed Sep 28, 2023
1 parent f796a07 commit c6d8515
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions pkg/i2gw/providers/ingresskong/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Ingress Kong Provider

The project supports translating ingress-kong specific annotations.

Current supported annotations:

- `konghq.com/methods`: If specified, the values of this annotation are used to
perform method matching on the associated ingress rules. Multiple methods can
be specified by separating values with commas. Example: `konghq.com/methods: "POST,GET"`.
- `konghq.com/headers.*`: If specified, the values of this annotation are used to
perform header matching on the associated ingress rules. The header name is specified
in the annotation key after `.`, and the annotations value can contain multiple
header values separated by commas. All the header values for a specific header
name are intended to be ORed. Example: `konghq.com/headers.x-routing: "alpha,bravo"`.

If you are reliant on any annotations not listed above, please open an issue.

0 comments on commit c6d8515

Please sign in to comment.