Skip to content

Commit

Permalink
Merge pull request #460 from mesos/docs/0.7.0
Browse files Browse the repository at this point in the history
Docs/0.7.0
  • Loading branch information
Phil Winder committed Jan 15, 2016
2 parents 003e8e7 + 5cb1fd2 commit dff51cb
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 17 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.7.0] - [15 January 2016]

### Features
- [Update to minimesos 0.5.0+](https://github.com/mesos/elasticsearch/issues/421)
- [Upgrade to elasticsearch 2.1.1](https://github.com/mesos/elasticsearch/issues/415)
- [Allow a user to specify his own http/transport ports](https://github.com/mesos/elasticsearch/issues/413)
- [Manual horizontal scaling](https://github.com/mesos/elasticsearch/issues/403)
- Networking overhaul. Now uses standard ES zen for clustering.

### Bugs

- [shouldNotLoseDataWhenScalingDown system test occasionally fails](https://github.com/mesos/elasticsearch/issues/447)
- [Minimesos hostnames do not point to running containers](https://github.com/mesos/elasticsearch/issues/445)
- [Fix Jenkins system test failures](https://github.com/mesos/elasticsearch/issues/436)
- [Option to use IP addresses instead of hostname](https://github.com/mesos/elasticsearch/issues/418)
- [Documentation](https://github.com/mesos/elasticsearch/issues/417)
- [Jitpack cannot build jar beacuse of docker build](https://github.com/mesos/elasticsearch/issues/408)

### Refactoring

- [Remove dependency on ES Zookeeper](https://github.com/mesos/elasticsearch/issues/439)
- [Sanity check for framework registration before getting cluster state](https://github.com/mesos/elasticsearch/issues/410)

## [0.6.0] - [09 November 2015]

### Features
Expand Down
24 changes: 8 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@
- Fault tolerance ✓
- Customised ES configuration ✓
- Configurable data directory ✓
- Scale cluster horizontally ✓
- Snapshot and restore ✓

[Future]

- High availability (master, indexer, replica)
- Upgrading configuration
- Scale cluster horizontally
- Scale cluster vertically
- Upgrade
- Rollback
- Snapshot and restore

### Blocked features

Expand All @@ -59,7 +59,7 @@

- Local environment (Docker-machine) ✓
- Rapid code + test (Mini Mesos) ✓
- Build automation (Gradle) ✓
- Build automation (Gradle and Jenkins) ✓

### User tools

Expand All @@ -76,8 +76,9 @@ We recommend that users install via marathon, using a docker container.

This framework requires:

* A running [Mesos](http://mesos.apache.org) cluster
* A running [Mesos](http://mesos.apache.org) cluster on version 0.25.0
* The use of <a href="https://github.com/mesosphere/marathon">Marathon</a> is strongly recommended to provide resiliency against scheduler failover.
* That the slaves have routable IP addresses. The ES ports are exposed on the slaves, so that the ES cluster can discover each other. Please double check that your slaves are routable.

## Users Guide

Expand Down Expand Up @@ -201,12 +202,6 @@ Usage: (Options preceded by an asterisk are required) [options]
--webUiPort
TCP port for web ui interface.
Default: 31100
--zookeeperFrameworkTimeout
The timeout for connecting to zookeeper for the framework (ms).
Default: 20000
--zookeeperFrameworkUrl
Zookeeper urls for the framework in the format zk://IP:PORT,IP:PORT,...)
Default: <empty string>
--zookeeperMesosTimeout
The timeout for connecting to zookeeper for Mesos (ms).
Default: 20000
Expand Down Expand Up @@ -237,8 +232,8 @@ Please note that the framework password file must only contain the password (no
### Using JAR files instead of docker images
It is strongly recommended that you use the containerized version of Mesos Elasticsearch. This ensures that all dependencies are met. Limited support is available for the jar version, since many issues are due to OS configuration. However, if you can't or don't want to use containers, use the raw JAR files in the following way:
0. Requirements: Java 8, Apache Mesos.
1. Read through the developer documentation and build the jars.
2. Copy the `./scheduler/build/libs/elasticsearch-mesos-scheduler-$VERSION.jar to all slaves in cluster. (The executor jar is inside and hosted by the scheduler jar)
1. Download the JAR from jitpack. Replace the version with your required version: https://jitpack.io/com/github/mesos/elasticsearch/scheduler/7a5e30e9b2/scheduler-7a5e30e9b2.jar
2. Copy the `scheduler-$VERSION.jar to all slaves in cluster. (The executor jar is inside and hosted by the scheduler jar)
3. Set the CLI parameter frameworkUseDocker to false. Set the javaHome CLI parameter if necessary.
4. Run the jar file manually, or use marathon. Normal command line parameters apply. For example:
```
Expand Down Expand Up @@ -296,10 +291,7 @@ Query Browser allows you to examine data stored on individual Elasticsearch node

### Known issues

- Issue [#388](https://github.com/mesos/elasticsearch/issues/388): When in jars mode, the executor is unable to communicate with the cluster unless the adapter is named eth0.
- Issue [#188](https://github.com/mesos/elasticsearch/issues/188): Database data IS NOT persisted to disk. Data storage is wholly reliant on cluster redundancy. This means that the framework is not yet recommended for production use.
- Issue [#177](https://github.com/mesos/elasticsearch/issues/177#issuecomment-135367451): Executors keep running if the scheduler is killed unless the DCOS CLI is used.
- Issue [#93](https://github.com/mesos/elasticsearch/issues/93): Despite the gui, horizontal scaling is not yet implemented.

## Developers Guide

Expand Down Expand Up @@ -329,7 +321,7 @@ $ ./gradlew build buildDockerImage system-test:main
$ docker-machine create -d virtualbox --virtualbox-memory 4096 --virtualbox-cpu-count 2 mesos-es
$ eval $(docker-machine env mesos-es)
$ sudo route delete 172.17.0.0/16; sudo route -n add 172.17.0.0/16 $(docker-machine ip mesos-es)
$ ./gradlew buildDockerImage system-test:main
$ ./gradlew build buildDockerImage system-test:main
```

### System test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public class Configuration {
private String elasticsearchPorts = ""; // Defaults to Mesos specified ports.

// **** FRAMEWORK
private String version = "0.6.0";
private String version = "0.7.0";
@Parameter(names = {FRAMEWORK_NAME}, description = "The name given to the framework.", validateWith = CLIValidators.NotEmptyString.class)
private String frameworkName = "elasticsearch";
@Parameter(names = {EXECUTOR_NAME}, description = "The name given to the executor task.", validateWith = CLIValidators.NotEmptyString.class)
Expand Down

0 comments on commit dff51cb

Please sign in to comment.