Skip to content

[7.x][DOCS] Adds new snapshot upgrade API #65100

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 17, 2020
Merged

[7.x][DOCS] Adds new snapshot upgrade API #65100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ include::update-datafeed.asciidoc[leveloffset=+2]
include::update-filter.asciidoc[leveloffset=+2]
include::update-job.asciidoc[leveloffset=+2]
include::update-snapshot.asciidoc[leveloffset=+2]
//UPGRADE
include::upgrade-job-model-snapshot.asciidoc[leveloffset=+2]
//VALIDATE
//include::validate-detector.asciidoc[leveloffset=+2]
//include::validate-job.asciidoc[leveloffset=+2]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/ml-apis.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ See also <<ml-df-analytics-apis>>.

[discrete]
[[ml-api-snapshot-endpoint]]
== Model Snapshots
== Model snapshots

* <<ml-delete-snapshot,Delete model snapshot>>
* <<ml-get-snapshot,Get model snapshot info>>
* <<ml-revert-snapshot,Revert model snapshot>>
* <<ml-update-snapshot,Update model snapshot>>

* <<ml-upgrade-job-model-snapshot,Upgrade model snapshot>>

[discrete]
[[ml-api-result-endpoint]]
Expand Down
23 changes: 10 additions & 13 deletions docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[role="xpack"]
[testenv="platinum"]
[[ml-upgrade-job-model-snapshot]]
= Upgrade {anomaly-jobs} Snapshot API
= Upgrade model snapshots API
++++
<titleabbrev>Upgrade job snapshot</titleabbrev>
<titleabbrev>Upgrade model snapshots</titleabbrev>
++++

Upgrades an {anomaly-job} snapshot to the latest major version.
Upgrades an {anomaly-detect} model snapshot to the latest major version.

[[ml-upgrade-job-model-snapshot-request]]
== {api-request-title}

`POST _ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade`
`POST _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_upgrade`

[[ml-upgrade-job-model-snapshot-prereqs]]
== {api-prereq-title}
Expand All @@ -25,14 +25,14 @@ Upgrades an {anomaly-job} snapshot to the latest major version.
[[ml-upgrade-job-model-snapshot-desc]]
== {api-description-title}

Overtime, older snapshot formats are deprecated and removed. {anomaly-jobs} will only
support snapshots that are from the current or previous major version.
Over time, older snapshot formats are deprecated and removed. {anomaly-jobs-cap}
support only snapshots that are from the current or previous major version.

This API provides a means to upgrade a snapshot to the current major version. This
aids in preparing the cluster for an upgrade to the next major version.
This API provides a means to upgrade a snapshot to the current major version.
This aids in preparing the cluster for an upgrade to the next major version.

Only one snapshot per {anomaly-job} can be upgraded at a time and the upgraded snapshot cannot
be the current snapshot of the {anomaly-job}.
Only one snapshot per {anomaly-job} can be upgraded at a time and the upgraded
snapshot cannot be the current snapshot of the {anomaly-job}.

[[ml-upgrade-job-model-snapshot-path-parms]]
== {api-path-parms-title}
Expand All @@ -45,9 +45,6 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]

[[ml-upgrade-job-model-snapshot-path-parms]]
== {api-path-parms-title}

`timeout`::
(Optional, time) Controls the time to wait for the request to complete. The default
value is 30 minutes.
Expand Down