forked from apache/kafka
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MINOR: Fixes to AWS init script for testing
A path was wrong in the script and in the documentation. Author: Roger Hoover <[email protected]> Reviewers: Geoff Anderson <[email protected]>, Ewen Cheslack-Postava <[email protected]> Closes apache#1309 from theduderog/fix_aws_init
- Loading branch information
1 parent
ad31650
commit 694303a
Showing
2 changed files
with
18 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
System Integration & Performance Testing | ||
======================================== | ||
|
||
This directory contains Kafka system integration and performance tests. | ||
This directory contains Kafka system integration and performance tests. | ||
[ducktape](https://github.com/confluentinc/ducktape) is used to run the tests. | ||
(ducktape is a distributed testing framework which provides test runner, | ||
result reporter and utilities to pull up and tear down services.) | ||
(ducktape is a distributed testing framework which provides test runner, | ||
result reporter and utilities to pull up and tear down services.) | ||
|
||
Local Quickstart | ||
---------------- | ||
This quickstart will help you run the Kafka system tests on your local machine. Note this requires bringing up a cluster of virtual machines on your local computer, which is memory intensive; it currently requires around 10G RAM. | ||
For a tutorial on how to setup and run the Kafka system tests, see | ||
For a tutorial on how to setup and run the Kafka system tests, see | ||
https://cwiki.apache.org/confluence/display/KAFKA/tutorial+-+set+up+and+run+Kafka+system+tests+with+ducktape | ||
|
||
* Install Virtual Box from [https://www.virtualbox.org/](https://www.virtualbox.org/) (run `$ vboxmanage --version` to check if it's installed). | ||
|
@@ -30,52 +30,52 @@ https://cwiki.apache.org/confluence/display/KAFKA/tutorial+-+set+up+and+run+Kafk | |
$ # When using Virtualbox, it also works to run: vagrant up | ||
|
||
* Build the desired branch of Kafka | ||
|
||
$ git checkout $BRANCH | ||
$ gradle # (only if necessary) | ||
$ ./gradlew systemTestLibs | ||
|
||
* Run the system tests using ducktape: | ||
|
||
$ ducktape tests/kafkatest/tests | ||
|
||
EC2 Quickstart | ||
-------------- | ||
This quickstart will help you run the Kafka system tests on EC2. In this setup, all logic is run | ||
on EC2 and none on your local machine. | ||
on EC2 and none on your local machine. | ||
|
||
There are a lot of steps here, but the basic goals are to create one distinguished EC2 instance that | ||
will be our "test driver", and to set up the security groups and iam role so that the test driver | ||
can create, destroy, and run ssh commands on any number of "workers". | ||
|
||
As a convention, we'll use "kafkatest" in most names, but you can use whatever name you want. | ||
As a convention, we'll use "kafkatest" in most names, but you can use whatever name you want. | ||
|
||
Preparation | ||
----------- | ||
In these steps, we will create an IAM role which has permission to create and destroy EC2 instances, | ||
In these steps, we will create an IAM role which has permission to create and destroy EC2 instances, | ||
set up a keypair used for ssh access to the test driver and worker machines, and create a security group to allow the test driver and workers to all communicate via TCP. | ||
|
||
* [Create an IAM role](http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html#Using_CreateUser_console). We'll give this role the ability to launch or kill additional EC2 machines. | ||
- Create role "kafkatest-master" | ||
- Role type: Amazon EC2 | ||
- Attach policy: AmazonEC2FullAccess (this will allow our test-driver to create and destroy EC2 instances) | ||
|
||
* If you haven't already, [set up a keypair to use for SSH access](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html). For the purpose | ||
of this quickstart, let's say the keypair name is kafkatest, and you've saved the private key in kafktest.pem | ||
|
||
* Next, create a security group called "kafkatest". | ||
* Next, create a security group called "kafkatest". | ||
- After creating the group, inbound rules: allow SSH on port 22 from anywhere; also, allow access on all ports (0-65535) from other machines in the kafkatest group. | ||
|
||
Create the Test Driver | ||
---------------------- | ||
* Launch a new test driver machine | ||
* Launch a new test driver machine | ||
- OS: Ubuntu server is recommended | ||
- Instance type: t2.medium is easily enough since this machine is just a driver | ||
- Instance details: Most defaults are fine. | ||
- IAM role -> kafkatest-master | ||
- Tagging the instance with a useful name is recommended. | ||
- Tagging the instance with a useful name is recommended. | ||
- Security group -> 'kafkatest' | ||
|
||
|
||
* Once the machine is started, upload the SSH key to your test driver: | ||
|
||
|
@@ -85,7 +85,7 @@ Create the Test Driver | |
* Grab the public hostname/IP (available for example by navigating to your EC2 dashboard and viewing running instances) of your test driver and SSH into it: | ||
|
||
$ ssh -i /path/to/kafkatest.pem [email protected] | ||
|
||
Set Up the Test Driver | ||
---------------------- | ||
The following steps assume you have ssh'd into | ||
|
@@ -99,11 +99,11 @@ the test driver machine. | |
* Get Kafka: | ||
|
||
$ git clone https://git-wip-us.apache.org/repos/asf/kafka.git kafka | ||
|
||
* Install some dependencies: | ||
|
||
$ cd kafka | ||
$ kafka/vagrant/aws/aws-init.sh | ||
$ ./vagrant/aws/aws-init.sh | ||
$ . ~/.bashrc | ||
|
||
* An example Vagrantfile.local has been created by aws-init.sh which looks something like: | ||
|
@@ -133,4 +133,3 @@ the test driver machine. | |
$ ducktape kafkatest/tests | ||
|
||
* To halt your workers without destroying persistent state, run `vagrant halt`. Run `vagrant destroy -f` to destroy all traces of your workers. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters