Skip to content

Commit 43a2a55

Browse files
authored
Merge pull request #8 from aramase/add-readyz-healthz
add more details for livez and readyz
2 parents fecf9a7 + a0405db commit 43a2a55

File tree

1 file changed

+6
-3
lines changed
  • keps/sig-auth/3299-kms-v2-improvements

1 file changed

+6
-3
lines changed

keps/sig-auth/3299-kms-v2-improvements/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -539,10 +539,13 @@ No.
539539

540540
###### How does this feature react if the API server and/or etcd is unavailable?
541541

542-
- This feature is part of API server. The feature is unavailable if API server is unavailable.
543-
- ETCD data encryption with external kms-plugin is unavailable
542+
- This feature is part of API server. The feature is unavailable if API server is unavailable. ETCD data encryption with external kms-plugin will be unavailable.
544543
- If the API server is unavailable, clients will be unable to create/get data that's stored in etcd. There will be no requests from the API server to the kms-plugin.
545-
- If the `EncryptionConfiguration` configured in the API server is not valid and the API server is restarted, it'll fail health check (same behavior as today).
544+
- If the `EncryptionConfiguration` file configured in the control plane node is not valid:
545+
- API server when restarted will fail at startup as it's unable to load the EncryptionConfig. This behavior is consistent with the KMS v1 API. The encryption configuration needs to be fixed to allow the API server to start properly.
546+
- If the KMS plugin is unavailable:
547+
- API server when restarted will fail health check as it's unable to connect to the KMS plugin. The `/livez` and `/readyz` endpoints will show a `failed` health check for the kms provider. This behavior is consistent with the KMS v1 API. Refer to [docs](https://kubernetes.io/docs/reference/using-api/health-checks/) for the health API endpoints and how to exclude individual endpoints from causing the API server to fail health check.
548+
- To resolve the issue, the kms plugin must be fixed to be available. The logs in the kms-plugin should be indicative of the issue.
546549

547550
## Implementation History
548551

0 commit comments

Comments
 (0)