Skip to content

Commit e819ecc

Browse files
committed
Merge branch '8.x' into 8.0
2 parents 9b75851 + 8d41c01 commit e819ecc

27 files changed

+8871
-8
lines changed

Dockerfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# syntax=docker/dockerfile:1
2-
ARG PYVER=3.11.9
3-
ARG ALPTAG=3.20
4-
FROM python:${PYVER}-alpine${ALPTAG} as builder
2+
ARG PYVER=3.12.9
3+
ARG ALPTAG=3.21
4+
FROM python:${PYVER}-alpine${ALPTAG} AS builder
55

66
# Add the community repo for access to patchelf binary package
77
ARG ALPTAG
@@ -39,6 +39,6 @@ COPY --from=builder curator_build /curator/
3939
RUN mkdir /.curator
4040

4141
USER nobody:nobody
42-
ENV LD_LIBRARY_PATH /curator/lib:$LD_LIBRARY_PATH
42+
ENV LD_LIBRARY_PATH=/curator/lib:\$LD_LIBRARY_PATH
4343
ENTRYPOINT ["/curator/curator"]
4444

docs/asciidoc/about.asciidoc

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
[[about]]
2+
= About
3+
4+
[partintro]
5+
--
6+
7+
Elasticsearch Curator helps you curate, or manage, your Elasticsearch indices
8+
and snapshots by:
9+
10+
1. Obtaining the full list of indices (or snapshots) from the cluster, as the
11+
_actionable list_
12+
2. Iterate through a list of user-defined <<filters,filters>> to progressively
13+
remove indices (or snapshots) from this _actionable list_ as needed.
14+
3. Perform various <<actions,actions>> on the items which remain in the
15+
_actionable list._
16+
17+
Learn More:
18+
19+
* <<about-origin,Origin>>
20+
* <<about-features,Features>>
21+
* <<about-cli,Command-Line Interface (CLI)>>
22+
* <<about-api,Application Program Interface (API)>>
23+
* <<license,License>>
24+
* <<site-corrections,Site Corrections>>
25+
* <<about-contributing,Contributing>>
26+
--
27+
28+
[[about-origin]]
29+
== Origin
30+
31+
Curator was first called
32+
https://logstash.jira.com/browse/LOGSTASH-211[`clearESindices.py`]. Its sole
33+
function was to delete indices. It was almost immediately renamed to
34+
https://logstash.jira.com/browse/LOGSTASH-211[`logstash_index_cleaner.py`].
35+
After a time it was briefly relocated under the
36+
https://github.com/elastic/logstash[logstash] repository as
37+
`expire_logs`, at which point it began to gain new functionality. Soon
38+
thereafter, Jordan Sissel was hired by Elastic (then still Elasticsearch), as
39+
was the original author of Curator. Not long after that it became Elasticsearch
40+
Curator and is now hosted at https://github.com/elastic/curator
41+
42+
Curator now performs many operations on your Elasticsearch indices, from delete
43+
to snapshot to shard allocation routing.
44+
45+
[[about-features]]
46+
== Features
47+
48+
Curator allows for many different operations to be performed to both indices and
49+
snapshots, including:
50+
51+
* Add or remove indices (or both!) from an <<alias,alias>>
52+
* Change shard routing <<allocation,allocation>>
53+
* <<close,Close>> indices
54+
* <<create_index,Create index>>
55+
* <<delete_indices,Delete indices>>
56+
* <<delete_snapshots,Delete snapshots>>
57+
* <<open,Open>> closed indices
58+
* <<forcemerge,forceMerge>> indices
59+
* <<reindex,reindex>> indices, including from remote clusters
60+
* Change the number of <<replicas,replicas>> per shard for indices
61+
* <<rollover,rollover>> indices
62+
* Take a <<snapshot,snapshot>> (backup) of indices
63+
* <<restore,Restore>> snapshots
64+
* <<shrink,Shrink>> indices
65+
66+
[[about-cli]]
67+
== Command-Line Interface (CLI)
68+
69+
Curator has always been a command-line tool. This site provides the
70+
documentation for how to use Curator on the command-line.
71+
72+
TIP: Learn more about <<command-line,the command-line interface>>.
73+
74+
[[about-api]]
75+
== Application Program Interface (API)
76+
77+
Curator ships with both an API and CLI tool. The API, or Application Program
78+
Interface, allows you to write your own scripts to accomplish similar goals--or
79+
even new and different things--with the same code that Curator uses.
80+
81+
The API documentation is not on this site, but is available at
82+
http://curator.readthedocs.io/. The Curator API is built using the
83+
http://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html[Elasticsearch
84+
Python API].
85+
86+
[[license]]
87+
== License
88+
89+
Copyright (c) {copyright_years} Elasticsearch <http://elastic.co>
90+
91+
Licensed under the Apache License, Version 2.0 (the "License");
92+
you may not use this file except in compliance with the License.
93+
You may obtain a copy of the License at
94+
95+
http://www.apache.org/licenses/LICENSE-2.0
96+
97+
Unless required by applicable law or agreed to in writing, software
98+
distributed under the License is distributed on an "AS IS" BASIS,
99+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
100+
See the License for the specific language governing permissions and
101+
limitations under the License.
102+
103+
104+
[[site-corrections]]
105+
== Site Corrections
106+
107+
All documentation on this site allows for quick correction submission.
108+
109+
To do this, use the "Edit" link to the right on any page.
110+
111+
* You will need to log in with your GitHub account.
112+
* Make your corrections or additions to the documentation.
113+
* Please use the option to "Create a new branch for this commit and start a pull
114+
request."
115+
* Please make sure you have signed our
116+
http://www.elastic.co/contributor-agreement/[Contributor License Agreement]. We
117+
are not asking you to assign copyright to us, but to give us the right to
118+
distribute your code (even documentation corrections) without restriction. We
119+
ask this of all contributors in order to assure our users of the origin and
120+
continuing existence of the code. You only need to sign the CLA once. If you are
121+
uncomfortable with this, feel free to submit a
122+
https://github.com/elastic/curator/issues[GitHub Issue] with your suggested
123+
correction instead.
124+
* Changes will be reviewed and merged, if acceptable.
125+
126+
[[about-contributing]]
127+
== Contributing
128+
129+
We welcome contributions and bug fixes to Curator's API and CLI.
130+
131+
We are grateful for the many
132+
https://github.com/elastic/curator/blob/master/CONTRIBUTORS[contributors] who
133+
have helped Curator become what it is today.
134+
135+
Please read through our
136+
https://github.com/elastic/curator/blob/master/CONTRIBUTING.md[contribution]
137+
guide, and the Curator
138+
https://github.com/elastic/curator/blob/master/README.rst[readme] document.
139+
140+
A brief overview of the steps
141+
142+
* fork the repo
143+
* make changes in your fork
144+
* add tests to cover your changes (if necessary)
145+
* run tests
146+
* sign the http://elastic.co/contributor-agreement/[CLA]
147+
* send a pull request!
148+
149+
TIP: To submit documentation fixes for this site, see
150+
<<site-corrections,Site Corrections>>

0 commit comments

Comments
 (0)