Commit graph

32 commits

Author SHA1 Message Date
Lisa Cawley
d9c6b679da
[8.17] [DOCS] More links to new API site (#119380) (#119419)
* [DOCS] More links to new API site (#119380)

* Fix example test failure
2025-01-01 10:06:07 +11:00
Parker Timmins
1072f2bbab
Add interval based SLM scheduling (#110847)
Add the ability to schedule an SLM policies with a time unit interval schedule rather than a cron job schedule. For example, an slm policy can be created with the argument "schedule":"30m". This will create a policy that will run 30 minutes after the policy modification_date. It will then run again every time another 30 minutes has passed. Every time the policy is changed, the next snapshot will be re-scheduled to run one interval after the new modification date.
2024-08-22 21:15:29 -05:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/setup/restart-cluster.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/sql/endpoints/translate.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
Pablo Alcantar Morales
0ca5dc2eac
fix incorrect TESTRESPONSE definition (#95508)
`TESTRESPONSE` definitions have to be escaped to properly override the value
coming from the response.
2023-04-24 18:16:25 +02:00
James Rodewig
a48060313a
[DOCS] Remove soft limit for snapshot repositories (#80745)
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit.
2021-11-16 12:24:18 -05:00
James Rodewig
659e0d3fd3
[DOCS] Overhaul snapshot and restore docs (#79081)
Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

* Adds info about supported ESS snapshot repository types
* Adds docs for Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates explanations of the snapshot process
* Incorporates SLM into the snapshot tutorial
* Removes duplicate "back up a cluster" pages
2021-11-15 12:45:07 -05:00
James Rodewig
f56a0f4b66
[DOCS] Remove testenv annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00
James Rodewig
d65ed5649a
[DOCS] Clarify max_count only counts successful snapshot attempts (#79749)
The create SLM policy API's `max_count` parameter limits the number of
snapshots for a policy. Only successful snapshot attempts count toward
this limit. Failed snapshot attempts do not.
2021-10-26 17:22:50 -04:00
Stef Nestor
e0cb0beb73
[DOCS] Fix SLM status response (#78584)
The get SLM status API will only return one of three statuses: `RUNNING`, `STOPPING`, or `STOPPED`.

This corrects the docs to remove the `STARTED` status and document the `RUNNING` status.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-10-04 09:41:17 -04:00
James Rodewig
1c355bfda9
[DOCS] Reuse snapshot config in put SLM policy API docs (#76712)
Updates the put SLM policy API's `config` parameter to reuse the create snapshot API's request body parameters.
Previously, the `config` parameter was missing the `feature_states` parameter. This change should keep the two docs in sync.
2021-08-20 08:29:16 -04:00
James Rodewig
7b64caee16
[DOCS] Clarify when SLM deletes expired snapshots (#73155)
Changes:
* Removes an error in the create SLM policy API's `schedule` parameter
  def. `schedule` is not used to delete expired snapshots.

* Updates the `expire_after` parameter def to mention the
  `slm.retention_schedule` cluster setting.
2021-05-17 10:02:08 -04:00
Pierre Grimaud
3c44dfec60
[DOCS] Fix typos (#72227) 2021-04-26 12:40:38 -04:00
James Rodewig
5c75d004fa
[DOCS] Replace put with create or update in API names (#70330)
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-15 14:49:44 -04:00
James Rodewig
330e537fac
[DOCS] Fix SLM security privilege wording (#68238) 2021-01-29 16:48:14 -05:00
James Rodewig
e795ab965a
[DOCS] Fix API titles (#67475) 2021-01-13 15:15:37 -05:00
Armin Braun
1990e24e8e
Document Recommended Maximum Repository Size in SLM Docs (#64485)
Just adding a short note on reasonable sizing limits.
2020-11-02 17:20:20 +01:00
James Rodewig
1ea83359bb
[DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
James Rodewig
2774cd6938
[DOCS] Swap [float] for [discrete] (#60124)
Changes instances of `[float]` in our docs for `[discrete]`.

Asciidoctor prefers the `[discrete]` tag for floating headings:
https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 11:48:22 -04:00
James Rodewig
786104eef7
[DOCS] Update snapshot/restore and SLM docs for data streams (#58513)
Updates the existing snapshot/restore and SLM docs to make them
aware of data streams.
2020-07-13 08:34:42 -04:00
James Rodewig
31b89ac083
[DOCS] Fix error in stop SLM API docs (#58747) 2020-06-30 09:55:59 -04:00
Lisa Cawley
8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
debadair
1412e80266
[DOCS] Extract the cron docs from Watcher docs and add to the API conventions. (#56313)
* [DOCS] Promote cron expressions info from Watcher to a separate topic.

* Fix table error

* Fixed xref

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Incorporated review feedback

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-05-12 15:32:47 -07:00
Théophile Helleboid - chtitux
44b5c25501
SLM PUT: add precision on date math support in indices parameter (#55203)
It was not clear for me that `indices` parameter supports date math expression.

I think it may be worth to add the precision in the documentation.
2020-05-08 15:05:14 -06:00
debadair
f7cd772402
[DOCS] Align with ILM changes. (#55953)
* [DOCS] Align with ILM changes.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Incorporated review comments.
2020-05-08 01:06:16 -07:00
István Zoltán Szabó
760d28be53
[DOCS] Adds missing space and a relevant link to the slm execute API page (#55917)
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-04-29 15:46:45 +02:00
William Brafford
92c8a73348
Deprecate disabling basic-license features (#54816)
We believe there's no longer a need to be able to disable basic-license
features completely using the "xpack.*.enabled" settings. If users don't
want to use those features, they simply don't need to use them. Having
such features always available lets us build more complex features that
assume basic-license features are present.

This commit deprecates settings of the form "xpack.*.enabled" for
basic-license features, excluding "security", which is a special case.
It also removes deprecated settings from integration tests and unit
tests where they're not directly relevant; e.g. monitoring and ILM are
no longer disabled in many integration tests.
2020-04-17 09:18:55 -04:00
Lisa Cawley
16c7edeeee
[DOCS] Collapses sections in put snapshot lifecycle policy API (#54834) 2020-04-06 12:10:47 -07:00
Lee Hinman
b03647e593
Add xpack/basic scope to SLM documentation (#51711)
This adds the required

```
[role="xpack"]
[testenv="basic"]
```

To the top of the SLM documentation

Relates to #51678
2020-01-30 16:17:50 -07:00
debadair
0fed96eebc [DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-22 20:44:19 -08:00
Deb Adair
6f3581173b Revert "[DOCS] Align with ILM API docs (#48705)"
This reverts commit ec9437832d.
2020-01-21 22:32:40 -08:00
debadair
ec9437832d
[DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-21 19:58:17 -08:00