-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Response Ops][Alerting] HTTP Version health API #196690
[Response Ops][Alerting] HTTP Version health API #196690
Conversation
…ting-health-api-versioning
Pinging @elastic/response-ops (Team:ResponseOps) |
export const healthFrameworkResponseBodySchema = schema.object({ | ||
is_sufficiently_secure: schema.boolean({ | ||
meta: { | ||
description: 'If false, security is enabled but TLS is not.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To my understanding the is_sufficiently_secure
is calculated from the following:
- The security plugin is enabled.
- The
xpack.encryptedSavedObjects.encryptionKey
config is set in thekibana.yml
- The API Keys are enabled in Elasticsearch.
Should we be more explicit or more high level? I am not sure how TLS is related to the above. Wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did just copy what the current description is in https://www.elastic.co/docs/api/doc/kibana/operation/operation-getalertinghealth and if we both don't exactly know I'd leave it as it is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok!
has_permanent_encryption_key: schema.boolean({ | ||
meta: { | ||
description: | ||
'If false, the encrypted saved object plugin does not have a permanent encryption key.', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: What about "If false, the xpack.encryptedSavedObjects.encryptionKey
config is not set"? or If false, the encryption key is not set
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll use the latter to avoid mentioning implementation details
💚 Build Succeeded
Metrics [docs]
History
|
…ue-195181-alerting-health-api-versioning' of github.com:jcger/kibana into issue-195181-alerting-health-api-versioning
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11404512840 |
## Summary Closes elastic#195181 Closes elastic#195182 OAS descriptions and HTTP version for `GET /api/alerting/_health` (cherry picked from commit c1ac722)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…6878) # Backport This will backport the following commits from `main` to `8.x`: - [[Response Ops][Alerting] HTTP Version health API (#196690)](#196690) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Julian Gernun","email":"17549662+jcger@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-18T13:19:40Z","message":"[Response Ops][Alerting] HTTP Version health API (#196690)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/195181\r\nCloses https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions and HTTP version for `GET /api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","backport:prev-minor"],"title":"[Response Ops][Alerting] HTTP Version health API","number":196690,"url":"https://github.com/elastic/kibana/pull/196690","mergeCommit":{"message":"[Response Ops][Alerting] HTTP Version health API (#196690)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/195181\r\nCloses https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions and HTTP version for `GET /api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196690","number":196690,"mergeCommit":{"message":"[Response Ops][Alerting] HTTP Version health API (#196690)\n\n## Summary\r\n\r\nCloses https://github.com/elastic/kibana/issues/195181\r\nCloses https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions and HTTP version for `GET /api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5"}}]}] BACKPORT--> Co-authored-by: Julian Gernun <17549662+jcger@users.noreply.github.com>
Summary
Closes #195181
Closes #195182
OAS descriptions and HTTP version for
GET /api/alerting/_health