Skip to content

[DOCS] Add minimal upgrade assistant APIs#213863

Merged
lcawl merged 2 commits intoelastic:mainfrom
lcawl:upgrade-apis
Mar 11, 2025
Merged

[DOCS] Add minimal upgrade assistant APIs#213863
lcawl merged 2 commits intoelastic:mainfrom
lcawl:upgrade-apis

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 11, 2025

Summary

Relates to #206243

This PR includes the upgrade assistant API in the OpenAPI document, since https://www.elastic.co/guide/en/kibana/current/upgrade-assistant-api.html will not exist in the narrative V9 docs.

In the long run, ideally this information would be generated from the code but this is a stop-gap.

Preview

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Feature:Upgrade Assistant v9.0.0 docs backport:version Backport to applied version labels v9.1.0 v8.19.0 v8.18.1 labels Mar 11, 2025
@lcawl lcawl marked this pull request as ready for review March 11, 2025 07:52
@lcawl lcawl requested a review from a team as a code owner March 11, 2025 07:52
@lcawl lcawl merged commit 73c8a51 into elastic:main Mar 11, 2025
9 checks passed
@lcawl lcawl deleted the upgrade-apis branch March 11, 2025 14:49
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

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

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Mar 11, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

💔 Some backports could not be created

Status Branch Result
8.18 Backport failed because of merge conflicts
8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- OpenAPI docs for APM UI APIs (#197946)
9.0

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 213863

Questions ?

Please refer to the Backport tool documentation

@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Mar 11, 2025

💚 All backports created successfully

Status Branch Result
8.x
8.18

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Mar 11, 2025
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 11, 2025
kibanamachine added a commit that referenced this pull request Mar 11, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Add minimal upgrade assistant APIs
(#213863)](#213863)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-11T14:49:17Z","message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v9.1.0","v8.19.0","v8.18.1"],"title":"[DOCS]
Add minimal upgrade assistant
APIs","number":213863,"url":"https://github.com/elastic/kibana/pull/213863","mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.x","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213863","number":213863,"mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 13, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

lcawl added a commit to lcawl/kibana that referenced this pull request Mar 13, 2025
lcawl added a commit that referenced this pull request Mar 13, 2025
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Add minimal upgrade assistant APIs
(#213863)](#213863)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-11T14:49:17Z","message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v9.1.0","v8.19.0","v8.18.1"],"title":"[DOCS]
Add minimal upgrade assistant
APIs","number":213863,"url":"https://github.com/elastic/kibana/pull/213863","mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/213944","number":213944,"state":"OPEN"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213863","number":213863,"mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
lcawl added a commit to lcawl/kibana that referenced this pull request Mar 13, 2025
lcawl added a commit that referenced this pull request Mar 13, 2025
# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS] Add minimal upgrade assistant APIs
(#213863)](#213863)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-03-11T14:49:17Z","message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Feature:Upgrade
Assistant","v9.0.0","docs","backport:version","v9.1.0","v8.19.0","v8.18.1"],"title":"[DOCS]
Add minimal upgrade assistant
APIs","number":213863,"url":"https://github.com/elastic/kibana/pull/213863","mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/213944","number":213944,"state":"OPEN"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213863","number":213863,"mergeCommit":{"message":"[DOCS]
Add minimal upgrade assistant APIs
(#213863)","sha":"73c8a5184f0c0b2f3de786d2ad7de0ec955bd349"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
@kibanamachine kibanamachine added v8.18.0 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Mar 13, 2025
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Mar 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants