Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.

Commit

Permalink
Revamped README
Browse files Browse the repository at this point in the history
  • Loading branch information
tobilg committed Jul 29, 2016
1 parent ac1692c commit 3767276
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .idea/watcherTasks.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A boilerplate for developing Mesos frameworks with JavaScript, based on [mesos-f

The intention of this project is to lower the barrier for Mesos beginners to write a custom framework. That's also the reason why JavaScript was chosen as an implementation language.

[mesos-framework](https://github.com/tobilg/mesos-framework) doen't currently support HA schedulers, but this will probably arrive in the close future. This means that only single instances of the newly created schedulers can be run.
[mesos-framework](https://github.com/tobilg/mesos-framework) doesn't currently support HA schedulers, but this will probably arrive in the close future. This means that only single instances of the newly created schedulers can be run.

## Usage

Expand Down Expand Up @@ -43,7 +43,7 @@ GET /health Returns http status 200 as long the ap

## Scheduler customization

The [mesos-framework](https://github.com/tobilg/mesos-framework) documentation applies for all the possible usages of scheduler (and possible executors). Also, have a look at the [examples](https://github.com/tobilg/mesos-framework/tree/master/examples)!
The [mesos-framework](https://github.com/tobilg/mesos-framework) documentation applies for all the possible usages of the Scheduler (and possible Executor) classes. Also, have a look at the [examples](https://github.com/tobilg/mesos-framework/tree/master/examples)!

The following sub-chapters are a walk-through of the scheduler configuration for this project.

Expand Down Expand Up @@ -77,7 +77,7 @@ The `frameworkTasks` object is a map object, which contains the different kinds

You can define the `priority` in which the task types should be started (lower number is a higher priority). Also, the `instances` property define how many instances of this task shall be started.

The `Mesos.Environment` protobuf can be used to define environment variables that should be used when starting the Docker image.
The [Mesos.Environment](https://github.com/apache/mesos/blob/c6e9ce16850f69fda719d4e32be3f2a2e1d80387/include/mesos/v1/mesos.proto#L1434) protobuf can be used to define environment variables that should be used when starting the Docker image.

```javascript
// The framework tasks
Expand Down Expand Up @@ -147,7 +147,7 @@ var frameworkTasks = {

The `frameworkConfiguration` object defined the basic properties and abilities of the framework. Please specifically have a look at the [scheduler docs](https://github.com/tobilg/mesos-framework/blob/master/README.md#scheduler) to get a complete overview of all usable properties.

As `mesos-framework` is a wrapper around the Master's HTTP APIs, a `masterUrl` needs to be specified. If you use Mesos DNS in your cluster, you don't need to set anything here, because `leader.mesos` will be automatically used to discover the leading Mesos Master.
As [mesos-framework](https://github.com/tobilg/mesos-framework) is a wrapper around the Master's Scheduler and Executor HTTP APIs, a `masterUrl` needs to be specified. If you use Mesos DNS in your cluster, you don't need to set anything here, because `leader.mesos` will be automatically used to discover the leading Mesos Master.

You should definitely customize the `frameworkName` though!

Expand Down Expand Up @@ -194,6 +194,7 @@ WORKDIR ${APP_DIR}
RUN apk add --no-cache git && \
rm -rf ${APP_DIR}/node_modules && \
rm -rf ${APP_DIR}/public/bower_components && \
mkdir -p ${APP_DIR}/logs && \
npm set progress=false && \
npm install --silent && \
npm install bower -g && \
Expand Down

0 comments on commit 3767276

Please sign in to comment.