Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Vault sync endpoint #8373

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Fix: Vault sync endpoint #8373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12526,6 +12526,33 @@ paths:
$ref: '#/components/responses/HTTP401Error'
tags:
- Keyring
/keyring/vault/sync:
post:
summary: Synchronize Vault keyring
operationId: post-keyring-vault-sync
responses:
'204':
description: No Content
description: |
Kong reads the keyring material from Vault when the Kong process starts.
Any changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint.
This allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Optional token for Vault synchronization.
example: "example-token"
examples:
Example 1:
value:
token: "example-token"
tags:
- Keyring
/tags:
get:
summary: List all tags
Expand Down
27 changes: 27 additions & 0 deletions api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12112,6 +12112,33 @@ paths:
$ref: '#/components/responses/HTTP401Error'
tags:
- Keyring
/keyring/vault/sync:
post:
summary: Synchronize Vault keyring
operationId: post-keyring-vault-sync
responses:
'204':
description: No Content
description: |
Kong reads the keyring material from Vault when the Kong process starts.
Any changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint.
This allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Optional token for Vault synchronization.
example: "example-token"
examples:
Example 1:
value:
token: "example-token"
tags:
- Keyring
/tags:
get:
summary: List all tags
Expand Down
27 changes: 27 additions & 0 deletions api-specs/Gateway-EE/3.8/kong-ee.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12677,6 +12677,33 @@ paths:
$ref: '#/components/responses/HTTP401Error'
tags:
- Keyring
/keyring/vault/sync:
post:
summary: Synchronize Vault keyring
operationId: post-keyring-vault-sync
responses:
'204':
description: No Content
description: |
Kong reads the keyring material from Vault when the Kong process starts.
Any changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint.
This allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Optional token for Vault synchronization.
example: "example-token"
examples:
Example 1:
value:
token: "example-token"
tags:
- Keyring
/tags:
get:
summary: List all tags
Expand Down
27 changes: 27 additions & 0 deletions api-specs/Gateway-EE/3.9/kong-ee.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12802,6 +12802,33 @@ paths:
$ref: '#/components/responses/HTTP401Error'
tags:
- Keyring
/keyring/vault/sync:
post:
summary: Synchronize Vault keyring
operationId: post-keyring-vault-sync
responses:
'204':
description: No Content
description: |
Kong reads the keyring material from Vault when the Kong process starts.
Any changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint.
This allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Optional token for Vault synchronization.
example: "example-token"
examples:
Example 1:
value:
token: "example-token"
tags:
- Keyring
/tags:
get:
summary: List all tags
Expand Down
27 changes: 27 additions & 0 deletions api-specs/Gateway-EE/latest/kong-ee.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12677,6 +12677,33 @@ paths:
$ref: '#/components/responses/HTTP401Error'
tags:
- Keyring
/keyring/vault/sync:
post:
summary: Synchronize Vault keyring
operationId: post-keyring-vault-sync
responses:
'204':
description: No Content
description: |
Kong reads the keyring material from Vault when the Kong process starts.
Any changes to the Vault KV store are not reflected on the Kong node until Kong syncs with Vault via the `/keyring/vault/sync` Admin API endpoint.
This allows Kong to receive a Vault token with a low TTL, as the list and read operation only occur once.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Optional token for Vault synchronization.
example: "example-token"
examples:
Example 1:
value:
token: "example-token"
tags:
- Keyring
/tags:
get:
summary: List all tags
Expand Down
Loading