[DOCS] Adds information about version compatibility headers #77096
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
debadair
added
>docs
elasticmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
rjernst
reviewed
Sep 1, 2021
| update applications before upgrading {es}, | ||
| having to coordinate the necessary changes can be an impediment to upgrading. | ||
|
|
||
| To enable an application to continue to function without modification after an upgrade, |
There was a problem hiding this comment.
I think we should be more clear the functionality (semantics) are not necessarily maintained, the compatibility is with the syntax of rest request/response.
debadair
commented
Sep 2, 2021
lockewritesdocs
approved these changes
Sep 3, 2021
| that impact how you interact with {es}. | ||
| While we recommend that you monitor the deprecation log and | ||
| update applications before upgrading {es}, | ||
| having to coordinate the necessary changes can be an impediment to upgrading. |
There was a problem hiding this comment.
Suggested change
| having to coordinate the necessary changes can be an impediment to upgrading. | |
| implementing the necessary changes can be an impediment to upgrading. |
There was a problem hiding this comment.
"having to coordinate" feels imprecise, thought that might be the intention given that we're talking about all the things that need to happen for an upgrade.
There was a problem hiding this comment.
It was deliberate. Using the compatibility headers enables you to decouple the implementation and deployment of app updates from the upgrade process.
Co-authored-by: Adam Locke <[email protected]>
debadair
added a commit
to debadair/elasticsearch
that referenced
this pull request
Sep 3, 2021
…77096) * [DOCS] Adds information about version compatibility * Clarified that the behavior is not guaranteed to be the same * Update docs/reference/api-conventions.asciidoc * Update docs/reference/api-conventions.asciidoc * Update docs/reference/api-conventions.asciidoc Co-authored-by: Adam Locke <[email protected]> Co-authored-by: Adam Locke <[email protected]>
debadair
added a commit
that referenced
this pull request
Sep 3, 2021
…77279) * [DOCS] Adds information about version compatibility * Clarified that the behavior is not guaranteed to be the same * Update docs/reference/api-conventions.asciidoc * Update docs/reference/api-conventions.asciidoc * Update docs/reference/api-conventions.asciidoc Co-authored-by: Adam Locke <[email protected]> Co-authored-by: Adam Locke <[email protected]> Co-authored-by: Adam Locke <[email protected]>
wjp719
added a commit
to wjp719/elasticsearch
that referenced
this pull request
Sep 4, 2021
* master: (128 commits) Mute DieWithDignityIT (elastic#77283) Fix randomization in MlNodeShutdownIT (elastic#77281) Add target_node_name for REPLACE shutdown type (elastic#77151) [DOCS] Adds information about version compatibility headers (elastic#77096) Fix template equals when mappings are wrapped (elastic#77008) Fix TextFieldMapper Retaining a Reference to its Builder (elastic#77251) Move die with dignity to be a test module (elastic#77136) Update task names for rest compatiblity (elastic#75267) [ML] adjusting bwc serialization for elastic#77256 (elastic#77257) Move `index.hidden` from Static to Dynamic settings (elastic#77218) Handle cgroups v2 in `OsProbe` (elastic#77128) Choose postings format from FieldMapper instead of MappedFieldType (elastic#77234) Add segment sorter for data streams (elastic#75195) Update skip after backport (elastic#77212) [ML] adding new defer_definition_decompression parameter to put trained model API (elastic#77189) [ML] Fix bug in inference stats persister for when feature reset is called Only check replicas in cancelling existing recoveries. (elastic#60564) Format `AbstractFilteringTestCase` (elastic#77217) [DOCS] Fixes line breaks. (elastic#77248) Convert 'routing' values in REST API tests to strings ... # Conflicts: # server/src/main/java/org/elasticsearch/cluster/metadata/DataStream.java
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the API conventions to include information about the version compatibility headers.
Provides a place for the Upgrade Assistant to link to: elastic/kibana#110469