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

Documents saved objects bulk delete API #141164

Merged
merged 3 commits into from
Sep 22, 2022

Conversation

TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Sep 20, 2022

Resolves #141143

Adds public documentation for the saved objects bulkDelete API.

Checklist

Delete any items that are not applicable to this PR.

  • Documentation was added for features that require explanation or tutorials (this PR)

@TinaHeiligers TinaHeiligers added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Saved Objects docs v8.5.0 labels Sep 20, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@github-actions
Copy link

Documentation preview:

@TinaHeiligers TinaHeiligers added the release_note:skip Skip the PR/issue when compiling release notes label Sep 20, 2022
Copy link
Contributor Author

@TinaHeiligers TinaHeiligers left a comment

Choose a reason for hiding this comment

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

Self review

+
TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: _"Unable to delete saved object that exists in multiple namespaces, use the `force` option to delete it anyway"_
+
WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes <<legacy-url-aliases, legacy url aliases>> that reference the object. These requests are batched to minimise the impact but they can place a heavy load on {kib}. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete opertation.
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'm not too sure how much detail to go into about potential performance issues but felt it better to add something as a warning.

Make sure you limit the number of objects that ...

I'm pretty sure folks are going to ask what limit we propose but we honestly cannot say. In this particular case, it's one of "It depends"(™)

Copy link
Contributor

Choose a reason for hiding this comment

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

feels to me like this is sufficient, I suspect it's less likely that end-users using the APIs would delete thousands of SO's in batches.

@TinaHeiligers TinaHeiligers requested a review from a team September 20, 2022 22:33
docs/api/saved-objects/bulk_delete.asciidoc Outdated Show resolved Hide resolved
docs/api/saved-objects/bulk_delete.asciidoc Outdated Show resolved Hide resolved
+
TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: _"Unable to delete saved object that exists in multiple namespaces, use the `force` option to delete it anyway"_
+
WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes <<legacy-url-aliases, legacy url aliases>> that reference the object. These requests are batched to minimise the impact but they can place a heavy load on {kib}. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete opertation.
Copy link
Contributor

Choose a reason for hiding this comment

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

feels to me like this is sufficient, I suspect it's less likely that end-users using the APIs would delete thousands of SO's in batches.

TinaHeiligers and others added 2 commits September 21, 2022 07:44
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
@TinaHeiligers TinaHeiligers added backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.6.0 and removed backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.5.0 labels Sep 22, 2022
@TinaHeiligers TinaHeiligers merged commit 8bfe338 into elastic:main Sep 22, 2022
@TinaHeiligers TinaHeiligers deleted the kbn-141143-bulkDelete-docs branch September 22, 2022 14:06
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 22, 2022
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
(cherry picked from commit 8bfe338)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.5

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 Sep 22, 2022
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
(cherry picked from commit 8bfe338)

Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
jloleysens added a commit to jloleysens/kibana that referenced this pull request Sep 22, 2022
* main: (33 commits)
  Fix Next and Previous button on step screenshot carousel. (elastic#141422)
  [journeys] add a short delay after loading data (elastic#141437)
  skip failing test suite (elastic#140797)
  skip failing test suite (elastic#138776)
  Documents saved objects bulk delete API (elastic#141164)
  [Response Ops][Alerting] Defining default action params on connector type (elastic#141226)
  [ML] Explain Log Rate Spikes: Adds jest tests for query_utils/buildBaseFilterCriteria. (elastic#141213)
  [APM] Fix search bar suggestions (elastic#141101)
  close popover on click (elastic#141272)
  [Fleet] Update to use savedObjects bulkDelete for package policy delete (elastic#141276)
  [Security Solution][Endpoint][Response Actions] Do fuzzy search on given usernames for Actions Log (elastic#141239)
  [Graph] Fix guidance panel appearing for a moment when saving Graph (elastic#141228)
  [Fleet] Add experimental data stream features support to simplified package policy API (elastic#141288)
  Shameless copy of the retryTransientEsErrors from fleet (elastic#141246)
  [Security Solution][Fix]-Issue with disabled dataProvider (elastic#140735)
  Changing triggers actions ui routes to internal (elastic#141149)
  skip flaky test suit elastic#141356
  [SharedUX] Removing TODOs from KibanaPageTemplate (elastic#141043)
  [dashboard controls] skip failing test on cloud (elastic#141291)
  [Synthetics] unskip edit_monitor api integration tests (elastic#141277)
  ...
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) docs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.5.0 v8.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for bulkDelete saved objects repository API
4 participants