diff --git a/LICENSE.txt b/LICENSE.txt index d6456956733..e601d4382ad 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,202 +1,13 @@ +Source code in this repository is variously licensed under the Apache License +Version 2.0, an Apache compatible license, or the Elastic License. Outside of +the "x-pack" folder, source code in a given file is licensed under the Apache +License Version 2.0, unless otherwise noted at the beginning of the file or a +LICENSE file present in the directory subtree declares a separate license. +Within the "x-pack" folder, source code in a given file is licensed under the +Elastic License, unless otherwise noted at the beginning of the file or a +LICENSE file present in the directory subtree declares a separate license. - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +The build produces two sets of binaries - one set that falls under the Elastic +License and another set that falls under Apache License Version 2.0. The +binaries that contain `-oss` in the artifact name are licensed under the Apache +License Version 2.0. diff --git a/build.gradle b/build.gradle index dbe87e4ef29..0c61eecd85c 100644 --- a/build.gradle +++ b/build.gradle @@ -40,10 +40,9 @@ subprojects { description = "Elasticsearch subproject ${project.path}" } -Path rootPath = rootDir.toPath() -// setup pom license info, but only for artifacts that are part of elasticsearch -configure(subprojects.findAll { it.projectDir.toPath().startsWith(rootPath) }) { - +subprojects { + project.ext.licenseName = 'The Apache Software License, Version 2.0' + project.ext.licenseUrl = 'http://www.apache.org/licenses/LICENSE-2.0.txt' // we only use maven publish to add tasks for pom generation plugins.withType(MavenPublishPlugin).whenPluginAdded { publishing { @@ -55,8 +54,8 @@ configure(subprojects.findAll { it.projectDir.toPath().startsWith(rootPath) }) { node.appendNode('inceptionYear', '2009') Node license = node.appendNode('licenses').appendNode('license') - license.appendNode('name', 'The Apache Software License, Version 2.0') - license.appendNode('url', 'http://www.apache.org/licenses/LICENSE-2.0.txt') + license.appendNode('name', project.licenseName) + license.appendNode('url', project.licenseUrl) license.appendNode('distribution', 'repo') Node developer = node.appendNode('developers').appendNode('developer') @@ -68,7 +67,7 @@ configure(subprojects.findAll { it.projectDir.toPath().startsWith(rootPath) }) { } } plugins.withType(BuildPlugin).whenPluginAdded { - project.licenseFile = project.rootProject.file('LICENSE.txt') + project.licenseFile = project.rootProject.file('licenses/APACHE-LICENSE-2.0.txt') project.noticeFile = project.rootProject.file('NOTICE.txt') } } diff --git a/buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy b/buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy index d0ae4fd4703..a44b9c849d3 100644 --- a/buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy +++ b/buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy @@ -619,6 +619,7 @@ class BuildPlugin implements Plugin { jarTask.metaInf { from(project.licenseFile.parent) { include project.licenseFile.name + rename { 'LICENSE.txt' } } from(project.noticeFile.parent) { include project.noticeFile.name diff --git a/buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy b/buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy index 7b94e31d2b6..28008f4313c 100644 --- a/buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy +++ b/buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy @@ -261,6 +261,7 @@ public class PluginBuildPlugin extends BuildPlugin { if (licenseFile != null) { project.bundlePlugin.from(licenseFile.parentFile) { include(licenseFile.name) + rename { 'LICENSE.txt' } } } File noticeFile = project.pluginProperties.extension.noticeFile diff --git a/distribution/archives/build.gradle b/distribution/archives/build.gradle index 8a0ee07938d..f631bc7558d 100644 --- a/distribution/archives/build.gradle +++ b/distribution/archives/build.gradle @@ -73,7 +73,14 @@ CopySpec archiveFiles(CopySpec modulesFiles, boolean oss) { pluginsDir.getParent() } } - with commonFiles + from(rootProject.projectDir) { + include 'README.textile' + } + from(rootProject.file('licenses')) { + include oss ? 'APACHE-LICENSE-2.0.txt' : 'ELASTIC-LICENSE.txt' + rename { 'LICENSE.txt' } + } + with noticeFile from('../src') { include 'bin/*.exe' diff --git a/distribution/build.gradle b/distribution/build.gradle index f317b2b908d..3dfb30dabee 100644 --- a/distribution/build.gradle +++ b/distribution/build.gradle @@ -303,12 +303,6 @@ configure(subprojects.findAll { ['archives', 'packages'].contains(it.name) }) { } } - commonFiles = copySpec { - from rootProject.projectDir - include 'LICENSE.txt' - include 'README.textile' - } - noticeFile = copySpec { if (project.name == 'integ-test-zip') { from buildServerNotice @@ -364,9 +358,9 @@ subprojects { String licenseText if (oss) { - licenseText = rootProject.file('LICENSE.txt').getText('UTF-8') + licenseText = rootProject.file('licenses/APACHE-LICENSE-2.0.txt').getText('UTF-8') } else { - licenseText = rootProject.file('x-pack/LICENSE.txt').getText('UTF-8') + licenseText = rootProject.file('licenses/ELASTIC-LICENSE.txt').getText('UTF-8') } // license text needs to be indented with a single space licenseText = ' ' + licenseText.replace('\n', '\n ') diff --git a/distribution/packages/build.gradle b/distribution/packages/build.gradle index fd70c961f71..7b53abc422f 100644 --- a/distribution/packages/build.gradle +++ b/distribution/packages/build.gradle @@ -114,11 +114,14 @@ Closure commonPackageConfig(String type, boolean oss) { into('bin') { with binFiles(type, oss) } - with copySpec { - with commonFiles - if (type == 'deb') { - // Deb gets a copyright file instead. - exclude 'LICENSE.txt' + from(rootProject.projectDir) { + include 'README.textile' + } + // Deb gets a copyright file instead. + if (type == 'rpm') { + from(rootProject.file('licenses')) { + include oss ? 'APACHE-LICENSE-2.0.txt' : 'ELASTIC-LICENSE.txt' + rename { 'LICENSE.txt' } } } into('modules') { diff --git a/licenses/APACHE-LICENSE-2.0.txt b/licenses/APACHE-LICENSE-2.0.txt new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/licenses/APACHE-LICENSE-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/x-pack/LICENSE.txt b/licenses/ELASTIC-LICENSE.txt similarity index 100% rename from x-pack/LICENSE.txt rename to licenses/ELASTIC-LICENSE.txt diff --git a/plugins/build.gradle b/plugins/build.gradle index 27655abf534..cf942148dea 100644 --- a/plugins/build.gradle +++ b/plugins/build.gradle @@ -27,7 +27,7 @@ configure(subprojects.findAll { it.parent.path == project.path }) { // for local ES plugins, the name of the plugin is the same as the directory name project.name - licenseFile rootProject.file('LICENSE.txt') + licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt') noticeFile rootProject.file('NOTICE.txt') } } diff --git a/x-pack/README.asciidoc b/x-pack/README.asciidoc deleted file mode 100644 index 17d983be31f..00000000000 --- a/x-pack/README.asciidoc +++ /dev/null @@ -1,120 +0,0 @@ -= Elasticsearch X-Pack - -A set of Elastic's commercial plugins for Elasticsearch: - -- License -- Security -- Watcher -- Monitoring -- Machine Learning -- Graph - -= Setup - -You must checkout `x-pack-elasticsearch` and `elasticsearch` with a specific directory structure. The -`elasticsearch` checkout will be used when building `x-pack-elasticsearch`. The structure is: - -- /path/to/elastic/elasticsearch -- /path/to/elastic/elasticsearch-extra/x-pack-elasticsearch - -== Vault Secret - -The build requires a Vault Secret ID. You can use a GitHub token by following these steps: - -1. Go to https://github.com/settings/tokens -2. Click *Generate new token* -3. Set permissions to `read:org` -4. Copy the token into `~/.elastic/github.token` -5. Set the token's file permissions to `600` - -``` -$ mkdir ~/.elastic -$ vi ~/.elastic/github.token -# Add your_token exactly as it is into the file and save it -$ chmod 600 ~/.elastic/github.token -``` - -If you do not create the token, then you will see something along the lines of this as the failure when trying to build X-Pack: - -``` -* What went wrong: -Missing ~/.elastic/github.token file or VAULT_SECRET_ID environment variable, needed to authenticate with vault for secrets -``` - -=== Offline Mode - -When running the build in offline mode (`--offline`), it will not required to have the vault secret setup. - -== Native Code - -**This is mandatory as tests depend on it** - -Machine Learning requires platform specific binaries, built from https://github.com/elastic/ml-cpp via CI servers. - -= Build - -- Run unit tests: -+ -[source, txt] ------ -gradle clean test ------ - -- Run all tests: -+ -[source, txt] ------ -gradle clean check ------ - -- Run integration tests: -+ -[source, txt] ------ -gradle clean integTest ------ - -- Package X-Pack (without running tests) -+ -[source, txt] ------ -gradle clean assemble ------ - -- Install X-Pack (without running tests) -+ -[source, txt] ------ -gradle clean install ------ - -= Building documentation - -The source files in this repository can be included in either the X-Pack -Reference or the Elasticsearch Reference. - -NOTE: In 5.4 and later, the Elasticsearch Reference includes X-Pack-specific -content that is pulled from this repo. - -To build the Elasticsearch Reference on your local machine, use the `docbldes` -or `docbldesx` build commands defined in -https://github.com/elastic/docs/blob/master/doc_build_aliases.sh - -== Adding Images - -When you include an image in the documentation, specify the path relative to the -location of the asciidoc file. By convention, we put images in an `images` -subdirectory. - -For example to insert `watcher-ui-edit-watch.png` in `watcher/limitations.asciidoc`: - -. Add an `images` subdirectory to the watcher directory if it doesn't already exist. -. In `limitations.asciidoc` specify: -+ -[source, txt] ------ - image::images/watcher-ui-edit-watch.png["Editing a watch"] ------ - -Please note that image names and anchor IDs must be unique within the book, so -do not use generic identifiers. diff --git a/x-pack/README.md b/x-pack/README.md new file mode 100644 index 00000000000..351b14caa38 --- /dev/null +++ b/x-pack/README.md @@ -0,0 +1,5 @@ +# Elastic License Functionality +This directory tree contains files subject to the Elastic License. The files +subject to the Elastic License are grouped in this directory to clearly +separate them from files licensed under the Apache License 2.0. + diff --git a/x-pack/build.gradle b/x-pack/build.gradle index 4838870724b..aa3cc1de17f 100644 --- a/x-pack/build.gradle +++ b/x-pack/build.gradle @@ -5,6 +5,14 @@ import org.elasticsearch.gradle.precommit.LicenseHeadersTask Project xpackRootProject = project +apply plugin: 'nebula.info-scm' +final String licenseCommit +if (version.endsWith('-SNAPSHOT')) { + licenseCommit = xpackRootProject.scminfo.change ?: "master" // leniency for non git builds +} else { + licenseCommit = "v${version}" +} + subprojects { group = 'org.elasticsearch.plugin' ext.xpackRootProject = xpackRootProject @@ -12,35 +20,16 @@ subprojects { // helper method to find the path to a module ext.xpackModule = { String moduleName -> xpackProject("plugin:${moduleName}").path } - plugins.withType(MavenPublishPlugin).whenPluginAdded { - publishing { - publications { - // add license information to generated poms - all { - pom.withXml { XmlProvider xml -> - Node node = xml.asNode() - - Node license = node.appendNode('licenses').appendNode('license') - license.appendNode('name', 'Elastic Commercial Software End User License Agreement') - license.appendNode('url', 'https://www.elastic.co/eula/') - license.appendNode('distribution', 'repo') - - Node developer = node.appendNode('developers').appendNode('developer') - developer.appendNode('name', 'Elastic') - developer.appendNode('url', 'http://www.elastic.co') - } - } - } - } - } + ext.licenseName = 'Elastic License' + ext.licenseUrl = "https://raw.githubusercontent.com/elastic/elasticsearch/${licenseCommit}/licenses/ELASTIC-LICENSE.txt" plugins.withType(BuildPlugin).whenPluginAdded { - project.licenseFile = xpackRootProject.file('LICENSE.txt') + project.licenseFile = rootProject.file('licenses/ELASTIC-LICENSE.txt') project.noticeFile = xpackRootProject.file('NOTICE.txt') } plugins.withType(PluginBuildPlugin).whenPluginAdded { - project.esplugin.licenseFile = xpackRootProject.file('LICENSE.txt') + project.esplugin.licenseFile = rootProject.file('licenses/ELASTIC-LICENSE.txt') project.esplugin.noticeFile = xpackRootProject.file('NOTICE.txt') } }