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

Commit

Permalink
Website content change (#1226)
Browse files Browse the repository at this point in the history
  • Loading branch information
@objmagic
objmagic authored Aug 8, 2016
1 parent a21744d commit 5642000
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 47 deletions.
9 changes: 4 additions & 5 deletions website/content/docs/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,13 @@ To check Heron is successfully installed, run:

```bash
$ heron version
heron.build.version : 0.14.1
heron.build.time : Tue May 24 22:44:01 PDT 2016
heron.build.timestamp : 1464155053000
heron.build.version : 0.14.2
heron.build.time : Sat Aug 6 12:35:47 PDT 2016
heron.build.timestamp : 1470512147000
heron.build.host : ${HOSTNAME}
heron.build.user : ${USERNAME}
heron.build.git.revision : be87b09f348e0ed05f45503340a2245a4ef68a35
heron.build.git.revision : 26bb4096130a05f9799510bbce6c37a69a7342ef
heron.build.git.status : Clean
INFO: Elapsed time: 0.001s.
```

## Step 2 --- Launch an example topology
Expand Down
71 changes: 34 additions & 37 deletions website/content/docs/operators/deployment/schedulers/aurora-local-setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
title: Setting up Heron with Aurora Cluster Locally on Linux
---

It is possible to setup a Heron with a locally running Apache Aurora cluster.
It is possible to setup Heron with a locally running Apache Aurora cluster.
This is a step by step guide on how to configure and setup all the necessary
components.

## Setting Up Apache Aurora Cluster locally

You first need to setup Apache Aurora locally. More detailed description of the
You first need to setup Apache Aurora locally. More detailed description of the
following steps can be found in [A local Cluster with Vagrant](http://aurora.apache.org/documentation/latest/getting-started/vagrant/)

### Step 1: Install VirtualBox and Vagrant

Download and install VirtualBox and Vagrant in your machine. If vagrant is successfully
Download and install VirtualBox and Vagrant on your machine. If vagrant is successfully
installed in your machine the following command should list several common commands
for this tool

Expand All @@ -37,35 +37,35 @@ $ cd aurora

### Step 3: Starting Local Aurora Cluster

To start the local cluster all you have to do is execute the following command. It will install all the needed dependencies like Apache Mesos and Zookeeper in the VM.
To start the local cluster all you have to do is execute the following command. It will install all the needed dependencies like Apache Mesos and Zookeeper in the VM.

```bash
$ vagrant up
```

Additionally to get rid of some of the warning messages that you get during up command execute the following command
Additionally to get rid of some of the warning messages that you get during up command execute the following command

```bash
$ vagrant plugin install vagrant-vbguest
```

You can verify that the Aurora cluster is properly running by opening the following links in your web-browser
You can verify that the Aurora cluster is properly running by opening the following links in your web-browser

* Scheduler - http://192.168.33.7:8081
* Observer - http://192.168.33.7:1338
* Mesos Master - http://192.168.33.7:5050
* Mesos Agent - http://192.168.33.7:5051

If you go into http://192.168.33.7:8081/scheduler you can notice that the name of the default cluster that is setup in aurora is
If you go into http://192.168.33.7:8081/scheduler you can notice that the name of the default cluster that is setup in aurora is
named `devcluster` this will be important to note when submitting typologies from heron.

![Heron topology](/img/aurora-local-cluster-start.png)

## Installing Heron within VM

Now that the Aurora cluster is setup you need to install heron within the cluster VM in order to be able to get the Heron
Now that the Aurora cluster is setup you need to install heron within the cluster VM in order to be able to get the Heron
deployment working. Since this is a fresh VM instance you will have to install the basic software such as "unzip" and set
the JAVA_HOME path as an environmental variable ( Just need to add this to .bashrc file). After you have the basic stuff
the JAVA_HOME path as an environmental variable ( Just need to add this to .bashrc file). After you have the basic stuff
working follow the following steps to install Heron in the VM. You can ssh into the VM with the following command

```bash
Expand All @@ -74,18 +74,18 @@ $ vagrant ssh

### Step 1.a : Download installation script files

You can download the script files that match your Linux distribution from
https://github.com/twitter/heron/releases/tag/0.14.1
You can download the script files that match your Linux distribution from
https://github.com/twitter/heron/releases/tag/0.14.2

For example for the 0.14.1 release the files you need to download For Ubuntu will be the following.
For example for the 0.14.2 release the files you need to download For Ubuntu will be the following.

* `heron-client-install-0.14.1-ubuntu.sh`
* `heron-tools-install-0.14.1-ubuntu.sh`
* `heron-client-install-0.14.2-ubuntu.sh`
* `heron-tools-install-0.14.2-ubuntu.sh`

Optionally - You want need the following for the steps in the blog post

* `heron-api-install-0.14.1-ubuntu.sh`
* `heron-core-0.14.1-ubuntu.tar.gz`
* `heron-api-install-0.14.2-ubuntu.sh`
* `heron-core-0.14.2-ubuntu.tar.gz`

### Step 1.b: Execute the client and tools shell scripts

Expand All @@ -102,7 +102,7 @@ Heron is now installed!
Make sure you have "/home/vagrant/bin" in your path.
```

After this you need to add the path "/home/vagrant/bin". You can just execute the following command
After this you need to add the path "/home/vagrant/bin". You can just execute the following command
or add it to the end of .bashrc file ( which is more convenient ).

```bash
Expand All @@ -123,12 +123,12 @@ node is minimum. Because of this it is sufficient to use a single Zookeeper node
if you have an Zookeeper instance running for some other task you can simply use that.
Since Apache Aurora already uses an Zookeeper instance you can directly use that instance
to execute State Manager tasks of Heron. First you need to configure Heron to work with
the Zookeeper instance. You can find meanings of each attribute in [Setting Up ZooKeeper
State Manager] (../../statemanagers/zookeeper). Configurations for State manager are
the Zookeeper instance. You can find meanings of each attribute in [Setting Up ZooKeeper
State Manager] (../../statemanagers/zookeeper). Configurations for State manager are
located in the directory `/home/vagrant/.heron/conf/aurora`.
Open the file `statemgr.yaml` using vim ( or some other text editor you prefer )
and add/edit the file to include the following.

Open the file `statemgr.yaml` using vim ( or some other text editor you prefer )
and add/edit the file to include the following.

```yaml
# local state manager class for managing state in a persistent fashion
Expand Down Expand Up @@ -157,8 +157,8 @@ heron.statemgr.zookeeper.retry.interval.ms: 10000
```
## Creating Paths in Zookeeper
Next you need to create some paths within Zookeeper since some of the paths
Next you need to create some paths within Zookeeper since some of the paths
are not created by Heron automatically. So you need to create them manually.
Since Aurora installation already installed Zookeeper, you can use the Zookeeper
cli to create the manual paths.
Expand Down Expand Up @@ -216,8 +216,8 @@ heron.package.core.uri: file:///home/vagrant/.heron/dist/heron-core.tar.gz

### Important Step: Change folder name `aurora` to `devcluster`

Next you need to change the folder name of `/home/vagrant/.heron/conf/aurora` to
`/home/vagrant/.heron/conf/devcluster`. This is because the name of your aurora
Next you need to change the folder name of `/home/vagrant/.heron/conf/aurora` to
`/home/vagrant/.heron/conf/devcluster`. This is because the name of your aurora
cluster is `devcluster` as you noted in a previous step. You can do this with the
following commands

Expand All @@ -238,24 +238,24 @@ Now you should be able to see the topology in the Aurora UI ( http://192.168.33.

![Heron topology](/img/aurora-local-topology-submitted.png)

### Understanding the parameters
### Understanding the parameters


below is a brief explanation on some of the important parameters that are used in this command. the first
parameter `devcluster/heronuser/devel` defines cluster, role and env ( env can have values `prod | devel | test | staging` ).
The cluster is the name of the aurora cluster which is `devcluster` in our case. You can give something like your
name for the role name and for env you need to choose from one of the env values.
name for the role name and for env you need to choose from one of the env values.

`--config-path` points to the config folder. the program will automatically look for a folder with the cluster name.
`--config-path` points to the config folder. the program will automatically look for a folder with the cluster name.
This is why you had to change the name of the aurora conf folder to devcluster.

Now that everything is working you need to perform one last step to be able to see the typologies that you can see in Aurora UI in Heron UI.

## Associating new Aurora cluster into Heron UI

Heron UI uses information that is gets from the heron tracker when displaying the information in the heron UI interface.
So in-order to allow the Heron UI to show Aurora cluster information you need to modify configuration of the Heron tracker
so that it can identify the Aurora Cluster.
So in-order to allow the Heron UI to show Aurora cluster information you need to modify configuration of the Heron tracker
so that it can identify the Aurora Cluster.

Heron Tracker configurations are located at `/home/vagrant/.herontools/conf` the configuration file is named `heron_tracker.yaml`.
By default you should see the following in the file
Expand All @@ -276,8 +276,8 @@ statemgrs:
```

You can see that there already two entries. Before, you had to create paths in Zookeeper for `/heron/topologies` this is
because the entry named `localzk` in this file. If you remove this you will not need to create that path in Zookeeper.
Now all you have to is to add a new entry for the aurora cluster into this file ( lets comment out `localzk` ).
because the entry named `localzk` in this file. If you remove this you will not need to create that path in Zookeeper.
Now all you have to is to add a new entry for the aurora cluster into this file ( lets comment out `localzk` ).
Then the file would look like below.

```yaml
Expand Down Expand Up @@ -310,6 +310,3 @@ $ heron-ui
```

![Heron topology](/img/heron-ui-topology-submitted.png)



18 changes: 13 additions & 5 deletions website/content/docs/upgrade-storm-to-heron.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,26 @@ Once the script is downloaded, run it while setting the `--user` and
`--maven` flags:

```bash
$ chmod +x heron-api-install-0.13.2-PLATFORM.sh
$ ./heron-api-install-0.13.2-PLATFORM.sh --user --maven
$ chmod +x heron-api-install-0.14.2-PLATFORM.sh
$ ./heron-api-install-0.14.2-PLATFORM.sh --user --maven
Heron API installer
-------------------

# Binary package at HEAD (@)
- [Commit](https://github.com/twitter/heron/commit/)
Installing jars to local maven repo.
tar xfz /var/folders/8r/x6dwcnkn4p9_rgwvq_3jg6y00000gn/T/heron.XXXX.EnJDpZNb/heron-api.tar.gz
-C /var/folders/8r/x6dwcnkn4p9_rgwvq_3jg6y00000gn/T/heron.XXXX.EnJDpZNb

Heron API is now installed!

See https://twitter.github.io/heron/docs/getting-started.html to start a new project!
See http://heronstreaming.io/docs/getting-started for how to use Heron.

heron.build.version : '0.14.2'
heron.build.time : Sat Aug 6 12:35:47 PDT 2016
heron.build.timestamp : 1470512147000
heron.build.host : ${HOSTNAME}
heron.build.user : ${USERNAME}
heron.build.git.revision : 26bb4096130a05f9799510bbce6c37a69a7342ef
heron.build.git.status : Clean
```

The Heron API will now be installed in your local [Maven
Expand Down

0 comments on commit 5642000

Please sign in to comment.