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

[Response Ops][Alerting] HTTP Version health API #196690

Merged
merged 9 commits into from
Oct 18, 2024

Conversation

jcger
Copy link
Contributor

@jcger jcger commented Oct 17, 2024

Summary

Closes #195181
Closes #195182

OAS descriptions and HTTP version for GET /api/alerting/_health

@jcger jcger changed the title [Response Ops][Rules] Version health API [Response Ops][Alerting] Version health API Oct 17, 2024
@jcger jcger changed the title [Response Ops][Alerting] Version health API [Response Ops][Alerting] HTTP Version health API Oct 17, 2024
@jcger jcger added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v9.0.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Oct 17, 2024
@jcger jcger marked this pull request as ready for review October 17, 2024 14:02
@jcger jcger requested a review from a team as a code owner October 17, 2024 14:02
@elasticmachine
Copy link
Contributor

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.',
Copy link
Member

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:

  1. The security plugin is enabled.
  2. The xpack.encryptedSavedObjects.encryptionKey config is set in the kibana.yml
  3. 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?

Copy link
Contributor Author

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

Copy link
Member

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.',
Copy link
Member

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?

Copy link
Contributor Author

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

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

jcger added 2 commits October 18, 2024 13:37
…ue-195181-alerting-health-api-versioning' of github.com:jcger/kibana into issue-195181-alerting-health-api-versioning
@jcger jcger enabled auto-merge (squash) October 18, 2024 12:44
@jcger jcger merged commit c1ac722 into elastic:main Oct 18, 2024
39 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11404512840

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 18, 2024
## Summary

Closes elastic#195181
Closes elastic#195182

OAS descriptions and HTTP version for `GET /api/alerting/_health`

(cherry picked from commit c1ac722)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Oct 18, 2024
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.17.0 v9.0.0
Projects
None yet
4 participants