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.

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

Update: Keyring docs #7989

Merged
merged 4 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions api-specs/Gateway-EE/latest/kong-ee.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12416,6 +12416,32 @@ paths:
recovery_private_key: /path/to/generated/<base64-encoded-contents-of-key.pem>
tags:
- Keyring
/keyring/remove:
post:
summary: Remove key
operationId: post-keyring-remove
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/HTTP401Error'
description: Remove a key from the keyring.
requestBody:
content:
application/json:
schema:
type: object
x-examples:
Example 1:
key: 3Rwvk223
properties:
key:
type: string
description: The key ID
example: 3Rwvk223
description: The request body contains a key ID that can be generated from the `/keyring/generate` endpoint.
tags:
- Keyring
/keyring/export:
post:
summary: Export keyring
Expand Down
2 changes: 2 additions & 0 deletions app/_src/gateway/kong-enterprise/db-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export KONG_KEYRING_STRATEGY=cluster
export KONG_KEYRING_RECOVERY_PUBLIC_KEY=/path/to/generated/cert.pem
```

If you are using a hybrid deployment, you only need this configuration on the control planes, since the data planes don't connect to the database.

All nodes in the Kong cluster should share the same `keyring_enabled` and `keyring_strategy` configuration values.
The generated private key `key.pem` is not required to configure Kong, or to start Kong. Please refer to the [disaster recovery](#disaster-recovery) section for more information on how to use private keys in keyring management.

Expand Down