You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Merge remote-tracking branch 'es/ccr' into ccr_security
* es/ccr: (78 commits)
Upgrade to Lucene-7.4-snapshot-6705632810 (#30519)
add version compatibility from 6.4.0 after backport, see #30319 (#30390)
Security: Simplify security index listeners (#30466)
Add proper longitude validation in geo_polygon_query (#30497)
Remove Discovery.AckListener.onTimeout() (#30514)
Build: move generated-resources to build (#30366)
Reindex: Fold "with all deps" project into reindex (#30154)
Isolate REST client single host tests (#30504)
Solve Gradle deprecation warnings around shadowJar (#30483)
SAML: Process only signed data (#30420)
Remove BWC repository test (#30500)
Build: Remove xpack specific run task (#30487)
AwaitsFix IntegTestZipClientYamlTestSuiteIT#indices.split tests
Enable soft-deletes in v6.4
LLClient: Add setJsonEntity (#30447)
[CCR] Read changes from Lucene instead of translog (#30120)
Expose CommonStatsFlags directly in IndicesStatsRequest. (#30163)
Silence IndexUpgradeIT test failures. (#30430)
Bump Gradle heap to 1792m (#30484)
[docs] add warning for read-write indices in force merge documentation (#28869)
...
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+90-1
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ We enjoy working with contributors to get their code accepted. There are many ap
41
41
Note that it is unlikely the project will merge refactors for the sake of refactoring. These
42
42
types of pull requests have a high cost to maintainers in reviewing and testing with little
43
43
to no tangible benefit. This especially includes changes generated by tools. For example,
44
-
converting all generic interface instances to use the diamond operator.
44
+
converting all generic interface instances to use the diamond operator.
45
45
46
46
The process for contributing to any of the [Elastic repositories](https://github.com/elastic/) is similar. Details for individual projects can be found below.
47
47
@@ -209,6 +209,95 @@ Before submitting your changes, run the test suite to make sure that nothing is
209
209
./gradlew check
210
210
```
211
211
212
+
### Project layout
213
+
214
+
This repository is split into many top level directories. The most important
215
+
ones are:
216
+
217
+
#### `docs`
218
+
Documentation for the project.
219
+
220
+
#### `distribution`
221
+
Builds our tar and zip archives and our rpm and deb packages.
222
+
223
+
#### `libs`
224
+
Libraries used to build other parts of the project. These are meant to be
225
+
internal rather than general purpose. We have no plans to
226
+
[semver](https://semver.org/) their APIs or accept feature requests for them.
227
+
We publish them to maven central because they are dependencies of our plugin
228
+
test framework, high level rest client, and jdbc driver but they really aren't
229
+
general purpose enough to *belong* in maven central. We're still working out
230
+
what to do here.
231
+
232
+
#### `modules`
233
+
Features that are shipped with Elasticsearch by default but are not built in to
234
+
the server. We typically separate features from the server because they require
235
+
permissions that we don't believe *all* of Elasticsearch should have or because
236
+
they depend on libraries that we don't believe *all* of Elasticsearch should
237
+
depend on.
238
+
239
+
For example, reindex requires the `connect` permission so it can perform
240
+
reindex-from-remote but we don't believe that the *all* of Elasticsearch should
241
+
have the "connect". For another example, Painless is implemented using antlr4
242
+
and asm and we don't believe that *all* of Elasticsearch should have access to
243
+
them.
244
+
245
+
#### `plugins`
246
+
Officially supported plugins to Elasticsearch. We decide that a feature should
247
+
be a plugin rather than shipped as a module because we feel that it is only
248
+
important to a subset of users, especially if it requires extra dependencies.
249
+
250
+
The canonical example of this is the ICU analysis plugin. It is important for
251
+
folks who want the fairly language neutral ICU analyzer but the library to
252
+
implement the analyzer is 11MB so we don't ship it with Elasticsearch by
253
+
default.
254
+
255
+
Another example is the `discovery-gce` plugin. It is *vital* to folks running
256
+
in [GCP](https://cloud.google.com/) but useless otherwise and it depends on a
257
+
dozen extra jars.
258
+
259
+
#### `qa`
260
+
Honestly this is kind of in flux and we're not 100% sure where we'll end up.
261
+
Right now the directory contains
262
+
* Tests that require multiple modules or plugins to work
263
+
* Tests that form a cluster made up of multiple versions of Elasticsearch like
264
+
full cluster restart, rolling restarts, and mixed version tests
265
+
* Tests that test the Elasticsearch clients in "interesting" places like the
266
+
`wildfly` project.
267
+
* Tests that test Elasticsearch in funny configurations like with ingest
268
+
disabled
269
+
* Tests that need to do strange things like install plugins that thrown
270
+
uncaught `Throwable`s or add a shutdown hook
271
+
But we're not convinced that all of these things *belong* in the qa directory.
272
+
We're fairly sure that tests that require multiple modules or plugins to work
273
+
should just pick a "home" plugin. We're fairly sure that the multi-version
274
+
tests *do* belong in qa. Beyond that, we're not sure. If you want to add a new
275
+
qa project, open a PR and be ready to discuss options.
276
+
277
+
#### `server`
278
+
The server component of Elasticsearch that contains all of the modules and
279
+
plugins. Right now things like the high level rest client depend on the server
280
+
but we'd like to fix that in the future.
281
+
282
+
#### `test`
283
+
Our test framework and test fixtures. We use the test framework for testing the
284
+
server, the plugins, and modules, and pretty much everything else. We publish
285
+
the test framework so folks who develop Elasticsearch plugins can use it to
286
+
test the plugins. The test fixtures are external processes that we start before
287
+
running specific tests that rely on them.
288
+
289
+
For example, we have an hdfs test that uses mini-hdfs to test our
290
+
repository-hdfs plugin.
291
+
292
+
#### `x-pack`
293
+
Commercially licensed code that integrates with the rest of Elasticsearch. The
294
+
`docs` subdirectory functions just like the top level `docs` subdirectory and
295
+
the `qa` subdirectory functions just like the top level `qa` subdirectory. The
296
+
`plugin` subdirectory contains the x-pack module which runs inside the
297
+
Elasticsearch process. The `transport-client` subdirectory contains extensions
298
+
to Elasticsearch's standard transport client to work properly with x-pack.
299
+
300
+
212
301
Contributing as part of a class
213
302
-------------------------------
214
303
In general Elasticsearch is happy to accept contributions that were created as
0 commit comments