Commit Graph

17 Commits

Author SHA1 Message Date
Daniel Doubrovkine (dB.) 2abd536f9b
Recommend Docker 3.6.0. (#1427)
Signed-off-by: dblock <dblock@dblock.org>
2021-10-26 09:45:26 -05:00
Daniel Doubrovkine (dB.) e601a68457
Fix windows build (mostly) (#1412)
* Updated developer guide with Windows specifics.

Signed-off-by: dblock <dblock@dblock.org>

* Correct windows task name.

Signed-off-by: dblock <dblock@dblock.org>

* Use Docker desktop installation on Windows.

Signed-off-by: dblock <dblock@dblock.org>

* Locate docker-compose on Windows.

Signed-off-by: dblock <dblock@dblock.org>

* Default docker-compose location.

Signed-off-by: dblock <dblock@dblock.org>
2021-10-22 07:55:41 -04:00
Sergey Nuyanzin 2da858ccb0
[typos] typos in DEVELOPER_GUIDE.md (#1381)
Signed-off-by: snuyanzin <snuyanzin@gmail.com>
2021-10-19 08:45:49 -04:00
Andriy Redko 8ea3364bc5
Modernize and consolidate JDKs usage across all stages of the build. Update JDK-14 requirement, switch to JDK-17 instead (#1368)
* Modernize and consolidate JDKs usage across all stages of the build. Update JDK-14 requirement, switch to JDK-17 instead

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

* Updating phrasing based on review feedback

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

* Fixed runtime Java version usage, it has to be respected when RUNTIME_JAVA_HOME == JAVA_HOME

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

* Addressing review comments

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
2021-10-15 09:04:05 -04:00
CEHENKLE e66b717c98
adding components to DEVELOPER_GUIDE (#1200)
* adding components to DEVELOPER_GUIDE

Signed-off-by: CEHENKLE <henkle@amazon.com>

* small tweaks

Signed-off-by: CEHENKLE <henkle@amazon.com>
2021-09-20 20:59:49 -07:00
Andriy Redko ddb37dea32
Added Eclipse import instructions to DEVELOPER_GUIDE.md (#1215)
Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
2021-09-08 09:05:02 -04:00
Anas Alkouz f37f29c996
Add more instructions how to install/configure git secrets (#1202)
Signed-off-by: Anas Alkouz <aalkouz@amazon.com>

Co-authored-by: Anas Alkouz <aalkouz@amazon.com>
2021-09-02 17:24:12 -04:00
Tianli Feng 652cdbd5af
Clarify JDK requirement in the developer guide (#1153)
* Explicitly point out the JDK 8 requirement is for runtime, but not for compiling.
* Clarify the JAVAx_HOME env variables are for the "backwards compatibility test".
* Add explanation on how the backwards compatibility tests get the OpenSearch distributions for a specific version.
Signed-off-by: Tianli Feng <ftianli@amazon.com>
2021-09-01 14:15:22 -07:00
Daniel Doubrovkine (dB.) 88f17b1822
Cleanup TESTING and DEVELOPER_GUIDE markdowns (#946) 2021-07-12 15:02:56 -05:00
Daniel Doubrovkine (dB.) 5d020170ff
Lower build requirement from Java 14+ to Java 11+ (#940)
* Lower build requirement from Java 14+ to Java 11+

Avoid use of -Werror -Xlint:all, which may change significantly across
java releases (new warnings could be added). Instead, just list the
warnings individually.

Workaround JDK 11 compiler bug (JDK-8209058) that only impacts test fixture
code in the build itself.

Signed-off-by: Robert Muir <rmuir@apache.org>

* Disable warning around -source 7 -release 7 for java version checker

The java version checker triggers some default warnings because it
targets java7:

```
> Task :distribution:tools:java-version-checker:compileJava FAILED
warning: [options] source value 7 is obsolete and will be removed in a future release
warning: [options] target value 7 is obsolete and will be removed in a future release
warning: [options] To suppress warnings about obsolete options, use -Xlint:-options.
error: warnings found and -Werror specified
```

Suppress this warning explicitly for this module.

Signed-off-by: Robert Muir <rmuir@apache.org>

* more java14 -> java11 cleanup

Signed-off-by: Robert Muir <rmuir@apache.org>

Co-authored-by: Robert Muir <rmuir@apache.org>
2021-07-06 11:55:23 -05:00
Rabi Panda ca564fd04f
Enable adding experimental features through sandbox modules (#691)
OpenSearch uses plugins to add new features. A plugin can be included in the distribution by default (as part of *modules* directory) or can be installed optionally from a plugin repository.

This change provides a separate space called *sandbox* inside OpenSearch for the community to easily experiment new ideas and innovate. Ideally, this is where an experimental feature will reside before it can be promoted to the *modules* directory. All the plugins in this module will only be included in the **snapshot distributions**. During assembling distributions, we will check if the following two conditions are met to include the sandbox modules,

* the distribution is a snapshot i.e. the build system property `build.snapshot` is set to true. We use this because it will prevent accidental bundling of these modules in a release distribution.
* the `enable.sandbox` system property is set to true. By default it is set to true. The purpose of adding this extra flag is that we can exclude the modules from snapshots if needed. For example, we may want to run performance tests on snapshots without the sandbox modules.

Signed-off-by: Rabi Panda <adnapibar@gmail.com>
2021-06-22 11:45:18 -05:00
Daniel Doubrovkine (dB.) 6a8e303591
Removed pre-alpha notes. (#815)
Signed-off-by: dblock <dblock@amazon.com>
2021-06-03 14:50:59 -07:00
Daniel Doubrovkine (dB.) b3c8f71e2d
Remove reference to an EC2 instance type. (#812)
* Remove reference to an AWS instance type.

Signed-off-by: dblock <dblock@amazon.com>

* Move auto-TOC to top of doc.

Signed-off-by: dblock <dblock@amazon.com>
2021-06-03 12:01:09 -07:00
Daniel Doubrovkine (dB.) d09249c627
[WIP] Developer guide updates (#595)
* Add detail on how to install Java.

Signed-off-by: dblock <dblock@amazon.com>

* There's no password requirement for the instance.

Signed-off-by: dblock <dblock@amazon.com>

* Explain how to listen on an external IP.

Signed-off-by: dblock <dblock@amazon.com>
2021-04-28 09:39:23 -04:00
Daniel Doubrovkine (dB.) 97698e082c
Cleaned up developer guide, added TOC. (#572)
Signed-off-by: dblock <dblock@amazon.com>
2021-04-21 09:39:31 -07:00
Manivannan Giridharan 05167b1621
Update Developers Guide. (#522)
Fixes Git Clone Link

Signed-off-by: Giridharan Manivannan <giridar123@gmail.com>
2021-04-12 11:31:24 -07:00
CEHENKLE f1f6e7109f
adding two files back in that were lost in the shuffle (#415)
Signed-off-by: CEHENKLE <henkle@amazon.com>
2021-03-19 09:22:10 -05:00