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

Docs for snapshots as simple archives #86261

Merged
merged 14 commits into from
May 30, 2022
Merged

Conversation

ywelsch
Copy link
Contributor

@ywelsch ywelsch commented Apr 28, 2022

Adds documentation for the new snapshots as archive feature.

Relates #81210

@ywelsch ywelsch mentioned this pull request Apr 28, 2022
32 tasks
@ywelsch ywelsch added :Search/Search Search-related issues that do not fall into other categories >docs General docs changes labels May 10, 2022
@ywelsch ywelsch marked this pull request as ready for review May 10, 2022 09:30
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Search Meta label for search team labels May 10, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (Team:Search)

@ywelsch ywelsch requested a review from debadair May 10, 2022 09:30
@debadair
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs

@ywelsch
Copy link
Contributor Author

ywelsch commented May 16, 2022

@elasticmachine update branch

@ywelsch
Copy link
Contributor Author

ywelsch commented May 16, 2022

@debadair can you give this a look? Thank you.

@ywelsch ywelsch requested a review from javanna May 18, 2022 08:15
@ywelsch ywelsch added the v8.3.0 label May 30, 2022
Copy link
Member

@javanna javanna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a couple of questions, LGTM otherwise

or to rehydrate parts of it. Access to the data is expected to be infrequent,
and can therefore happen with limited performance and query capabilities.

For this, {es} now has the ability to access older snapshot repositories
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: remove "now"?

- <<ip,`ip` type>>
- <<geo-point,`geo_point` type>>
- <<date,`date` types>>: the date `format` setting on date fields is supported
in so far as it behaves similarly across these versions. In case it 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.

what do you mean with "is supported in so far as it behaves similarly across these versions"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have changed the meaning of various custom date formats / date literals across versions (e.g. year of era becomes week-based year), see https://www.elastic.co/guide/en/elasticsearch/reference/7.17/migrate-to-java-time.html#java-time-migration-incompatible-date-formats

Perhaps I could link to the above for additional context, as well as limit the scope of the problem to "custom date formats".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good to expand a bit, thanks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you mean "is supported as long as it behaves similarly across versions"?

can't make sense of the mapping, it falls back to a lightweight import of
the mapping where the original mapping is stored in the _meta section of
the imported index's mapping, and relies on the user to put the relevant
mapping parts manually in place.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this is enough guidance for users to solve problems when importing the mappings. what's your thinking?

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 can clarify the process a bit more (e.g. user can inspect the original mapping using get mappings API, and use put mappings API to add selected portions back to index). Additionally I would like to ask users to report failures to auto-import mapping to us (but with the expectation that we will treat it as low-priority items to be fixed).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds great, I was also wondering if users know what you mean with "_meta" section. I would have to look it up myself :)

@ywelsch ywelsch changed the base branch from master to 8.3 May 30, 2022 09:26
@ywelsch ywelsch changed the base branch from 8.3 to master May 30, 2022 09:26
@ywelsch
Copy link
Contributor Author

ywelsch commented May 30, 2022

The release highlight changelog (cea2469) seems to have been deleted by our automation. I will add it for the backport to 8.3 branch and mark that backport PR then as release highlight.

@ywelsch ywelsch requested a review from javanna May 30, 2022 09:30
be manually put in place using the <<indices-put-mapping,update mapping>> API,
copying and adapting relevant sections of the legacy mapping to work with the
current {es} version. While auto-import is expected to work in most cases,
failures of doing so should be raised with the Elastic team for future
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link to open an issue?

- <<ip,`ip` type>>
- <<geo-point,`geo_point` type>>
- <<date,`date` types>>: the date `format` setting on date fields is supported
in so far as it behaves similarly across these versions. In case it 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.

do you mean "is supported as long as it behaves similarly across versions"?

this field can be updated on legacy indices so that it can be changed by a
user if need be.
- <<keyword-field-type,`keyword` type>>: the `normalizer` setting on keyword
fields is supported in so far as it behaves similarly across these versions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here too "is supported as long as..."

In case it is not, this field can be updated on legacy indices if need be.
- <<text-field-type,`text` type>>: scoring capabilities are limited, and all
queries return constant scores that are equal to 1.0. The `analyzer`
settings on text fields are supported in so far as they behave similarly
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

supported as long as ?

@ywelsch ywelsch merged commit 46b386b into elastic:master May 30, 2022
@ywelsch
Copy link
Contributor Author

ywelsch commented May 30, 2022

Thanks @javanna!

ywelsch added a commit to ywelsch/elasticsearch that referenced this pull request May 30, 2022
Adds documentation for the new snapshots as archive feature.

Relates elastic#81210
ywelsch added a commit that referenced this pull request May 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team v8.3.0 v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants