kramasamy closed pull request #2876: Refactoring Nomad documentation and add documentation on running heron via docker on Nomad URL: https://github.com/apache/incubator-heron/pull/2876
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/website/content/docs/operators/deployment/schedulers/nomad-docker.md b/website/content/docs/operators/deployment/schedulers/nomad-docker.md new file mode 100644 index 0000000000..063a4cc993 --- /dev/null +++ b/website/content/docs/operators/deployment/schedulers/nomad-docker.md @@ -0,0 +1,134 @@ +--- +title: Running Heron via Docker Containers on Nomad +--- + +Below are instructions on how to run Heron on Nomad via docker containers. In this mode, Heron executors will run as docker containers on host machines. + +### Requirements + +When setting up your Nomad cluster, the following are required: + +* The [Heron CLI tool](../../../heron-cli) must be installed on each machine used to deploy Heron topologies +* Python 2.7, Java 7 or 8, and [curl](https://curl.haxx.se/) must be installed on every machine in the cluster +* A [ZooKeeper cluster](https://zookeeper.apache.org) +* Docker installed and enabled on every machine +* Each machine must also be able to pull the official Heron docker image from DockerHub or have the image preloaded. + +### Configuring Heron settings + +Before running Heron via Nomad, you'll need to configure some settings. Once you've [installed Heron](../../../../getting-started), all of the configurations you'll need to modify will be in the `~/.heron/conf/nomad` diredctory. + +First, make sure that the `heron.nomad.driver` is set to "docker" in `~/.heron/conf/nomad/scheduler.yaml` e.g. + +```yaml +heron.nomad.driver: "docker" +``` + +You can also adjust which docker image to use for running Heron via the `heron.executor.docker.image` in `~/.heron/conf/nomad/scheduler.yaml` e.g. + +```yaml +heron.executor.docker.image: 'heron/heron:latest' +``` + +You'll need to use a topology uploader to deploy topology packages to nodes in your cluster. You can use one of the following uploaders: + +* The HTTP uploader in conjunction with Heron's [API server](../../../heron-api-server). The Heron API server acts like a file server to which users can upload topology packages. The API server distributes the packages, along with the Heron core package, to the relevant machines. You can also use the API server to submit your Heron topology to Nomad (described [below](#deploying-with-the-api-server)) <!-- TODO: link to upcoming HTTP uploader documentation --> +* [Amazon S3](../../uploaders/s3). Please note that the S3 uploader requires an AWS account. +* [SCP](../../uploaders/scp). Please note that the SCP uploader requires SSH access to nodes in the cluster. + +You can modify the `heron.class.uploader` parameter in `~/.heron/conf/nomad/uploader.yaml` to choose an uploader. + +In addition, you must update the `heron.statemgr.connection.string` parameter in the `statemgr.yaml` file in `~/.heron/conf/nomad` to your ZooKeeper connection string. Here's an example: + +```yaml +heron.statemgr.connection.string: 127.0.0.1:2181 +``` + +Then, update the `heron.nomad.scheduler.uri` parameter in `scheduler.yaml` to the URL of the Nomad server to which you'll be submitting jobs. Here's an example: + +```yaml +heron.nomad.scheduler.uri: http://127.0.0.1:4646 +``` + +## Submitting Heron topologies to the Nomad cluster + +You can submit Heron topologies to a Nomad cluster via the [Heron CLI tool](../../../heron-cli): + +```bash +$ heron submit nomad \ + <topology package path> \ + <topology classpath> \ + <topology CLI args> +``` + +Here's an example: + +```bash +$ heron submit nomad \ + ~/.heron/examples/heron-streamlet-examples.jar \ # Package path + org.apache.heron.examples.api.WindowedWordCountTopology \ # Topology classpath + windowed-word-count # Args passed to topology +``` + +## Deploying with the API server + +The advantage of running the [Heron API Server](../../../heron-api-server) is that it can act as a file server to help you distribute topology package files and submit jobs to Nomad, so that you don't need to modify the configuration files mentioned above. By using Heron’s API Server, you can set configurations such as the URI of ZooKeeper and the Nomad server once and not need to configure each machine from which you want to submit Heron topologies. + +## Running the API server + +You can run the Heron API server on any machine that can be reached by machines in your Nomad cluster via HTTP. Here's a command you can use to run the API server: + +```bash +$ ~/.heron/bin/heron-apiserver \ + --cluster nomad \ + --base-template nomad \ + -D heron.statemgr.connection.string=<ZooKeeper URI> \ + -D heron.nomad.scheduler.uri=<Nomad URI> \ + -D heron.class.uploader=org.apache.heron.uploader.http.HttpUploader \ + --verbose +``` + +You can also run the API server in Nomad itself, but you will need to have a local copy of the Heron API server executable on every machine in the cluster. Here's an example Nomad job for the API server: + +```hcl +job "apiserver" { + datacenters = ["dc1"] + type = "service" + group "apiserver" { + count = 1 + task "apiserver" { + driver = "raw_exec" + config { + command = <heron_apiserver_executable> + args = [ + "--cluster", "nomad", + "--base-template", "nomad", + "-D", "heron.statemgr.connection.string=<zookeeper_uri>", + "-D", "heron.nomad.scheduler.uri=<scheduler_uri>", + "-D", "heron.class.uploader=org.apache.heron.uploader.http.HttpUploader", + "--verbose"] + } + resources { + cpu = 500 # 500 MHz + memory = 256 # 256MB + } + } + } +} +``` + +Make sure to replace the following: + +* `<heron_apiserver_executable>` --- The local path to where the [Heron API server](../../../heron-api-server) executable is located (usually `~/.heron/bin/heron-apiserver`) +* `<zookeeper_uri>` --- The URI for your ZooKeeper cluster +* `<scheduler_uri>` --- The URI for your Nomad server + +## Using the Heron API server to distribute Heron topology packages + +Heron users can upload their Heron topology packages to the Heron API server using the HTTP uploader by modifying the `uploader.yaml` file to including the following: + +```yaml +# uploader class for transferring the topology jar/tar files to storage +heron.class.uploader: org.apache.heron.uploader.http.HttpUploader +heron.uploader.http.uri: http://localhost:9000/api/v1/file/upload +``` diff --git a/website/content/docs/operators/deployment/schedulers/nomad-raw-execs.md b/website/content/docs/operators/deployment/schedulers/nomad-raw-execs.md new file mode 100644 index 0000000000..b362123874 --- /dev/null +++ b/website/content/docs/operators/deployment/schedulers/nomad-raw-execs.md @@ -0,0 +1,216 @@ +--- +title: Running Heron via Raw Execs on Nomad +--- + +Below are instructions on how to to run Heron on Nomad via raw execs. In this mode, Heron executors will run as raw processes on the host machines. + +The advantages of this mode is that it is incredibly lightweight and likely do not require sudo privileges to setup and run. However in this mode, the setup procedure may be a little more complex compared to running via docker since there are more things to consider. Also in resource allocation is considered but not enforced. + +### Requirements + +When setting up your Nomad cluster, the following are required: + +* The [Heron CLI tool](../../../heron-cli) must be installed on each machine used to deploy Heron topologies +* Python 2.7, Java 7 or 8, and [curl](https://curl.haxx.se/) must be installed on every machine in the cluster +* A [ZooKeeper cluster](https://zookeeper.apache.org) + +### Configuring Heron settings + +Before running Heron via Nomad, you'll need to configure some settings. Once you've [installed Heron](../../../../getting-started), all of the configurations you'll need to modify will be in the `~/.heron/conf/nomad` diredctory. + +First, make sure that the `heron.nomad.driver` is set to "raw_exec" in `~/.heron/conf/nomad/scheduler.yaml` e.g. + +```yaml +heron.nomad.driver: "raw_exec" +``` + +You'll need to use a topology uploader to deploy topology packages to nodes in your cluster. You can use one of the following uploaders: + +* The HTTP uploader in conjunction with Heron's [API server](../../../heron-api-server). The Heron API server acts like a file server to which users can upload topology packages. The API server distributes the packages, along with the Heron core package, to the relevant machines. You can also use the API server to submit your Heron topology to Nomad (described [below](#deploying-with-the-api-server)) <!-- TODO: link to upcoming HTTP uploader documentation --> +* [Amazon S3](../../uploaders/s3). Please note that the S3 uploader requires an AWS account. +* [SCP](../../uploaders/scp). Please note that the SCP uploader requires SSH access to nodes in the cluster. + +You can modify the `heron.class.uploader` parameter in `~/.heron/conf/nomad/uploader.yaml` to choose an uploader. + +In addition, you must update the `heron.statemgr.connection.string` parameter in the `statemgr.yaml` file in `~/.heron/conf/nomad` to your ZooKeeper connection string. Here's an example: + +```yaml +heron.statemgr.connection.string: 127.0.0.1:2181 +``` + +Then, update the `heron.nomad.scheduler.uri` parameter in `scheduler.yaml` to the URL of the Nomad server to which you'll be submitting jobs. Here's an example: + +```yaml +heron.nomad.scheduler.uri: http://127.0.0.1:4646 +``` + +You may also want to configure where Heron will store files on your machine if you're running Nomad locally (in `scheduler.yaml`). Here's an example: + +```yaml +heron.scheduler.local.working.directory: ${HOME}/.herondata/topologies/${CLUSTER}/${ROLE}/${TOPOLOGY_ID} +``` + +> Heron uses string interpolation to fill in the missing values for `CLUSTER`, `ROLE`, etc. + +### Distributing Heron core + +The Heron core package needs to be made available for every machine in the cluster to download. You'll need to provide a URI for the Heron core package. Here are the currently supported protocols: + +* `file://` (local FS) +* `http://` (HTTP) + +You can do this in one of several ways: + +* Use the Heron API server to distribute `heron-core.tar.gz` (see [here](../../heron-api-server) for more info) +* Copy `heron-core.tar.gz` onto every node in the cluster +* Mount a network drive to every machine in the cluster that contains +* Upload `heron-core.tar.gz` to an S3 bucket and expose an HTTP endpoint +* Upload `heron-core.tar.gz` to be hosted on a file server and expose an HTTP endpoint + +> A copy of `heron-core.tar.gz` is located at `~/.heron/dist/heron-core.tar.gz` on the machine on which you installed the Heron CLI. + +You'll need to set the URL for `heron-core.tar.gz` in the `client.yaml` configuration file in `~/.heron/conf/nomad`. Here are some examples: + +```yaml +# local filesystem +heron.package.core.uri: file:///path/to/heron/heron-core.tar.gz + +# from a web server +heron.package.core.uri: http://some.webserver.io/heron-core.tar.gz +``` + +## Submitting Heron topologies to the Nomad cluster + +You can submit Heron topologies to a Nomad cluster via the [Heron CLI tool](../../../heron-cli): + +```bash +$ heron submit nomad \ + <topology package path> \ + <topology classpath> \ + <topology CLI args> +``` + +Here's an example: + +```bash +$ heron submit nomad \ + ~/.heron/examples/heron-streamlet-examples.jar \ # Package path + org.apache.heron.examples.api.WindowedWordCountTopology \ # Topology classpath + windowed-word-count # Args passed to topology +``` + +## Deploying with the API server + +The advantage of running the [Heron API Server](../../../heron-api-server) is that it can act as a file server to help you distribute topology package files and submit jobs to Nomad, so that you don't need to modify the configuration files mentioned above. By using Heron’s API Server, you can set configurations such as the URI of ZooKeeper and the Nomad server once and not need to configure each machine from which you want to submit Heron topologies. + +## Running the API server + +You can run the Heron API server on any machine that can be reached by machines in your Nomad cluster via HTTP. Here's a command you can use to run the API server: + +```bash +$ ~/.heron/bin/heron-apiserver \ + --cluster nomad \ + --base-template nomad \ + -D heron.statemgr.connection.string=<ZooKeeper URI> \ + -D heron.nomad.scheduler.uri=<Nomad URI> \ + -D heron.class.uploader=org.apache.heron.uploader.http.HttpUploader \ + --verbose +``` + +You can also run the API server in Nomad itself, but you will need to have a local copy of the Heron API server executable on every machine in the cluster. Here's an example Nomad job for the API server: + +```hcl +job "apiserver" { + datacenters = ["dc1"] + type = "service" + group "apiserver" { + count = 1 + task "apiserver" { + driver = "raw_exec" + config { + command = <heron_apiserver_executable> + args = [ + "--cluster", "nomad", + "--base-template", "nomad", + "-D", "heron.statemgr.connection.string=<zookeeper_uri>", + "-D", "heron.nomad.scheduler.uri=<scheduler_uri>", + "-D", "heron.class.uploader=org.apache.heron.uploader.http.HttpUploader", + "--verbose"] + } + resources { + cpu = 500 # 500 MHz + memory = 256 # 256MB + } + } + } +} +``` + +Make sure to replace the following: + +* `<heron_apiserver_executable>` --- The local path to where the [Heron API server](../../../heron-api-server) executable is located (usually `~/.heron/bin/heron-apiserver`) +* `<zookeeper_uri>` --- The URI for your ZooKeeper cluster +* `<scheduler_uri>` --- The URI for your Nomad server + +## Using the Heron API server to distribute Heron topology packages + +Heron users can upload their Heron topology packages to the Heron API server using the HTTP uploader by modifying the `uploader.yaml` file to including the following: + +```yaml +# uploader class for transferring the topology jar/tar files to storage +heron.class.uploader: org.apache.heron.uploader.http.HttpUploader +heron.uploader.http.uri: http://localhost:9000/api/v1/file/upload +``` + +The [Heron CLI](../../../heron-cli) will take care of the upload. When the topology is starting up, the topology package will be automatically downloaded from the API server. + +## Using the API server to distribute the Heron core package + +Heron users can use the Heron API server to distribute the Heron core package. When running the API server, just add this argument: + +```bash +--heron-core-package-path <path to Heron core> +``` + +Here's an example: + +```bash +$ ~/.heron/bin/heron-apiserver \ + --cluster nomad \ + --base-template nomad \ + --download-hostname 127.0.0.1 \ + --heron-core-package-path ~/.heron/dist/heron-core.tar.gz \ + -D heron.statemgr.connection.string=127.0.0.1:2181 \ + -D heron.nomad.scheduler.uri=127.0.0.1:4647 \ + -D heron.class.uploader=org.apache.heron.uploader.http.HttpUploader \ + --verbose +``` + +Then change the `client.yaml` file in `~/.heron/conf/nomad` to the following: + +```yaml +heron.package.use_core_uri: true +heron.package.core.uri: http://localhost:9000/api/v1/file/download/core +``` + +## Using the API server to submit Heron topologies + +Users can submit topologies using the [Heron CLI](../../../heron-cli) by specifying a service URL to the API server. Here's the format of that command: + +```bash +$ heron submit nomad \ + --service-url=<Heron API server URL> \ + <topology package path> \ + <topology classpath> \ + <topology args> +``` + +Here's an example: + +```bash +$ heron submit nomad \ + --service-url=http://localhost:9000 \ + ~/.heron/examples/heron-streamlet-examples.jar \ + org.apache.heron.examples.api.WindowedWordCountTopology \ + windowed-word-count +``` diff --git a/website/content/docs/operators/deployment/schedulers/nomad.md b/website/content/docs/operators/deployment/schedulers/nomad.md index 81ac421674..1a69b0b93d 100644 --- a/website/content/docs/operators/deployment/schedulers/nomad.md +++ b/website/content/docs/operators/deployment/schedulers/nomad.md @@ -4,209 +4,16 @@ title: Nomad Heron supports [Hashicorp](https://hashicorp.com)'s [Nomad](https://nomadproject.io) as a scheduler. You can use Nomad for either small- or large-scale Heron deployments or to run Heron locally in [standalone mode](../standalone). +> Update: Heron now supports running on Nomad via [raw exec driver](https://www.nomadproject.io/docs/drivers/raw_exec.html) and [docker driver](https://www.nomadproject.io/docs/drivers/docker.html) + ## Nomad setup Setting up a nomad cluster will not be covered here. See the [official Nomad docs](https://www.nomadproject.io/intro/getting-started/install.html) for instructions. -> Heron currently only supports the [raw exec driver](https://www.nomadproject.io/docs/drivers/raw_exec.html) for Nomad. - -When setting up your Nomad cluster, the following are required: - -* The [Heron CLI tool](../../../heron-cli) must be installed on each machine used to deploy Heron topologies -* Python 2.7, Java 7 or 8, and [curl](https://curl.haxx.se/) must be installed on every machine in the cluster -* A [ZooKeeper cluster](https://zookeeper.apache.org) - -## Configuring Heron settings - -Before running Heron via Nomad, you'll need to configure some settings. Once you've [installed Heron](../../../../getting-started), all of the configurations you'll need to modify will be in the `~/.heron/conf/nomad` diredctory. - -First, you'll need to use a topology uploader to deploy topology packages to nodes in your cluster. You can use one of the following uploaders: - -* The HTTP uploader in conjunction with Heron's [API server](../../../heron-api-server). The Heron API server acts like a file server to which users can upload topology packages. The API server distributes the packages, along with the Heron core package, to the relevant machines. You can also use the API server to submit your Heron topology to Nomad (described [below](#deploying-with-the-api-server)) <!-- TODO: link to upcoming HTTP uploader documentation --> -* [Amazon S3](../../uploaders/s3). Please note that the S3 uploader requires an AWS account. -* [SCP](../../uploaders/scp). Please note that the SCP uploader requires SSH access to nodes in the cluster. - -You can modify the `heron.class.uploader` parameter in `~/.heron/conf/nomad/uploader.yaml` to choose an uploader. - -In addition, you must update the `heron.statemgr.connection.string` parameter in the `statemgr.yaml` file in `~/.heron/conf/nomad` to your ZooKeeper connection string. Here's an example: - -```yaml -heron.statemgr.connection.string: 127.0.0.1:2181 -``` - -Then, update the `heron.nomad.scheduler.uri` parameter in `scheduler.yaml` to the URL of the Nomad server to which you'll be submitting jobs. Here's an example: - -```yaml -heron.nomad.scheduler.uri: http://127.0.0.1:4646 -``` - -You may also want to configure where Heron will store files on your machine if you're running Nomad locally (in `scheduler.yaml`). Here's an example: - -```yaml -heron.scheduler.local.working.directory: ${HOME}/.herondata/topologies/${CLUSTER}/${ROLE}/${TOPOLOGY_ID} -``` - -> Heron uses string interpolation to fill in the missing values for `CLUSTER`, `ROLE`, etc. - -## Distributing Heron core - -The Heron core package needs to be made available for every machine in the cluster to download. You'll need to provide a URI for the Heron core package. Here are the currently supported protocols: - -* `file://` (local FS) -* `http://` (HTTP) - -You can do this in one of several ways: - -* Use the Heron API server to distribute `heron-core.tar.gz` (see [here](../../heron-api-server) for more info) -* Copy `heron-core.tar.gz` onto every node in the cluster -* Mount a network drive to every machine in the cluster that contains -* Upload `heron-core.tar.gz` to an S3 bucket and expose an HTTP endpoint -* Upload `heron-core.tar.gz` to be hosted on a file server and expose an HTTP endpoint - -> A copy of `heron-core.tar.gz` is located at `~/.heron/dist/heron-core.tar.gz` on the machine on which you installed the Heron CLI. - -You'll need to set the URL for `heron-core.tar.gz` in the `client.yaml` configuration file in `~/.heron/conf/nomad`. Here are some examples: - -```yaml -# local filesystem -heron.package.core.uri: file:///path/to/heron/heron-core.tar.gz - -# from a web server -heron.package.core.uri: http://some.webserver.io/heron-core.tar.gz -``` - -## Submitting Heron topologies to the Nomad cluster - -You can submit Heron topologies to a Nomad cluster via the [Heron CLI tool](../../../heron-cli): - -```bash -$ heron submit nomad \ - <topology package path> \ - <topology classpath> \ - <topology CLI args> -``` - -Here's an example: - -```bash -$ heron submit nomad \ - ~/.heron/examples/heron-streamlet-examples.jar \ # Package path - org.apache.heron.examples.api.WindowedWordCountTopology \ # Topology classpath - windowed-word-count # Args passed to topology -``` - -## Deploying with the API server - -The advantage of running the [Heron API Server](../../../heron-api-server) is that it can act as a file server to help you distribute topology package files and submit jobs to Nomad, so that you don't need to modify the configuration files mentioned above. By using Heron’s API Server, you can set configurations such as the URI of ZooKeeper and the Nomad server once and not need to configure each machine from which you want to submit Heron topologies. - -## Running the API server - -You can run the Heron API server on any machine that can be reached by machines in your Nomad cluster via HTTP. Here's a command you can use to run the API server: - -```bash -$ ~/.heron/bin/heron-apiserver \ - --cluster nomad \ - --base-template nomad \ - -D heron.statemgr.connection.string=<ZooKeeper URI> \ - -D heron.nomad.scheduler.uri=<Nomad URI> \ - -D heron.class.uploader=org.apache.heron.uploader.http.HttpUploader \ - --verbose -``` - -You can also run the API server in Nomad itself, but you will need to have a local copy of the Heron API server executable on every machine in the cluster. Here's an example Nomad job for the API server: - -```hcl -job "apiserver" { - datacenters = ["dc1"] - type = "service" - group "apiserver" { - count = 1 - task "apiserver" { - driver = "raw_exec" - config { - command = <heron_apiserver_executable> - args = [ - "--cluster", "nomad", - "--base-template", "nomad", - "-D", "heron.statemgr.connection.string=<zookeeper_uri>", - "-D", "heron.nomad.scheduler.uri=<scheduler_uri>", - "-D", "heron.class.uploader=org.apache.heron.uploader.http.HttpUploader", - "--verbose"] - } - resources { - cpu = 500 # 500 MHz - memory = 256 # 256MB - } - } - } -} -``` - -Make sure to replace the following: - -* `<heron_apiserver_executable>` --- The local path to where the [Heron API server](../../../heron-api-server) executable is located (usually `~/.heron/bin/heron-apiserver`) -* `<zookeeper_uri>` --- The URI for your ZooKeeper cluster -* `<scheduler_uri>` --- The URI for your Nomad server - -## Using the Heron API server to distribute Heron topology packages - -Heron users can upload their Heron topology packages to the Heron API server using the HTTP uploader by modifying the `uploader.yaml` file to including the following: - -```yaml -# uploader class for transferring the topology jar/tar files to storage -heron.class.uploader: org.apache.heron.uploader.http.HttpUploader -heron.uploader.http.uri: http://localhost:9000/api/v1/file/upload -``` - -The [Heron CLI](../../../heron-cli) will take care of the upload. When the topology is starting up, the topology package will be automatically downloaded from the API server. - -## Using the API server to distribute the Heron core package - -Heron users can use the Heron API server to distribute the Heron core package. When running the API server, just add this argument: - -```bash ---heron-core-package-path <path to Heron core> -``` - -Here's an example: - -```bash -$ ~/.heron/bin/heron-apiserver \ - --cluster nomad \ - --base-template nomad \ - --download-hostname 127.0.0.1 \ - --heron-core-package-path ~/.heron/dist/heron-core.tar.gz \ - -D heron.statemgr.connection.string=127.0.0.1:2181 \ - -D heron.nomad.scheduler.uri=127.0.0.1:4647 \ - -D heron.class.uploader=org.apache.heron.uploader.http.HttpUploader \ - --verbose -``` - -Then change the `client.yaml` file in `~/.heron/conf/nomad` to the following: - -```yaml -heron.package.use_core_uri: true -heron.package.core.uri: http://localhost:9000/api/v1/file/download/core -``` - -## Using the API server to submit Heron topologies - -Users can submit topologies using the [Heron CLI](../../../heron-cli) by specifying a service URL to the API server. Here's the format of that command: +Instructions on running Heron on Nomad via raw execs are located here: -```bash -$ heron submit nomad \ - --service-url=<Heron API server URL> \ - <topology package path> \ - <topology classpath> \ - <topology args> -``` +[Running Heron via Raw Execs on Nomad](../nomad-raw-execs) -Here's an example: +Instructions on running Heron on Nomad via docker containers are located here: -```bash -$ heron submit nomad \ - --service-url=http://localhost:9000 \ - ~/.heron/examples/heron-streamlet-examples.jar \ - org.apache.heron.examples.api.WindowedWordCountTopology \ - windowed-word-count -``` +[Running Heron via Docker Containers on Nomad](../nomad-docker) \ No newline at end of file ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
