Loading page...

Download Karamel

 Windows v0.3

Running Karamel on Windows

Unzip the karamel-X.Y.zip file you downloaded. This creates a folder called karamel-X.Y. Open the folder and double-click on karamel.exe. This will launch the Karamel UI on your default web browser at http://localhost:9090/index.html#

You now need to follow a few simple steps to start the cluster running.

Load a Cluster
Open the clusert definition (YAML file( by clicking on "Load Cluster". Select the file: examples/hadoop.yml from the installation directory.
install-1
You should see the following cluster loaded
The "stack" on the left is NameNodes stack - consisting of the NameNode (hadoop::nn), ResourceManager (hadoop::rm), and the JobHistoryServer (hadoop::jhs). The "stack" on the right is DataNodes stack - consisting of the DataNode (hadoop::dn) and the NodeManager (hadoop::nm).
You can change a stack name by clicking on it and saving the new name. No uppercase or digits are allowed in stacknames. If you have existing VMs running with the same stack names, you should change the stack names - otherwise your existing VMs will be destroyed. This is a convenience feature for people repeatedly deploying and testing stacks (existing VMs are destroyed when new ones are created).
install-2
Launch the Cluster
Click on the "launch" menu item.
install-2
Select your public/private keys.
The OpenSsh keys to be used are selected here, so that you can later ssh to the VMs created directly using the corresponding private key. By default, Karamel will look for a ".ssh" directory in your home directory for "id_rsa.pub/id_rsa" keys. If it doesn't find any, you can click on the "Generate Keys" button and a public/private OpenSsh keypair will be generated and saved in your "/.karamel/" directory. When you are finished, you click on the "EC2 Provider" link to enter your EC2 credentials.
install-2
Enter your EC2 credentials. Press Submit.
Enter your Account-ID (key) and EC2 Account secret-ID (secret key). You have to validate your credentials by clicking on the "validate" button.
install-3 After you have successfully validated your credentials, you can launch the cluster.
install-3
Really Launch the Cluster
This will (1) create the VMs in EC2, (2) install and orchestrate the software installation using Chef and Karamel.
install-4
Pre-Cleaning
The first thing Karamel does is destroy any existing VMs that have stacks with the same name as the stacks you are creating. This can take a couple of minutes. If you want to keep your existing installations, rename the stacks by clicking on the stack name and then saving the new stack name.
install-4
Forking
Then Karamel uses JClouds to fork the VMs. This can take a minute or two.
install-4
Status
After the VMs have been creating, Karamel executes the DAG of tasks for the stack on each VM. The tasks can be in any of the states WAITING, ONGOING, DONE, or FAILED. When all tasks are DONE, you can ssh into the public IP addresses on the page to interact with the services you installed.
install-4
View installation logs while running.
You can view progress by left-clicking on Karamel icon in the Icon-Tray (this will be in the bottom right hand corner of your screen for Windows).
install-5

You can look in the logs to find the IP addresses of the machines that started or in the EC2 console. You can now ssh to the machines started using the private key for the public key you entered earlier. For the EC2 ubuntu instances used in this example, the username by default for the new VMs is "ubuntu".

Using Putty to SSH to nodes created using Karamel

Launch PuTTYgen from the Windows Programs list.

  1. Click Conversions from the PuTTY Key Generator menu and select Import key.
  2. Navigate to the OpenSSH private key generated by Karamel (by default, stored in C:\Users\username\.karamel\.ssh\id_rsa) and click Open.
  3. Under Actions / Save the generated key, select Save private key.
  4. Do not enter a passphrase (unless it is critical that you protect the private key).
  5. Save the private key to some folder as id_rsa.ppk.

Connect to VMs created on EC2. The PuTTYgen tool can be closed and PuTTY launched again.

  1. Enter the remote server Public IP address under Session.
  2. Navigate to Connection > SSH > Auth.
  3. Click Browse... under Authentication parameters / Private key file for authentication.
  4. Locate the id_rsa.ppk private key and click Open.
  5. Finally, click Open again to log into the remote server with key pair authentication.