cloudstore-developers

Update README

4/17/2015 10:23:47 AM

Changes

README.md 89(+89 -0)

README.txt 100(+76 -24)

Details

diff --git a/bin/config.aws.ini b/bin/config.aws.ini
index d730cc9..44c0f2d 100644
--- a/bin/config.aws.ini
+++ b/bin/config.aws.ini
@@ -12,7 +12,6 @@ jmeter_url = http://cloudscale.xlab.si/jmeter/jmeter_master.tar.gz
 region = eu-west-1
 aws_access_key_id = <your access key>
 aws_secret_access_key = <your secret access key>
-region = eu-west-1
 availability_zones = eu-west-1a
 
 [EC2]
diff --git a/bin/config.openstack.ini b/bin/config.openstack.ini
index 57c541b..bcecb18 100644
--- a/bin/config.openstack.ini
+++ b/bin/config.openstack.ini
@@ -1,5 +1,4 @@
 [SHOWCASE]
-autoscalable = no
 host = localhost
 frontend_instances_id = cloudscale
 

README.md 89(+89 -0)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ed8d7c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,89 @@
+## Distributed JMeter
+Distributed JMeter application is a load generator application which was developed for CloudScale project, but it can be
+ used independently from CloudScale project. For generating the load it uses the opensource software Apache JMeter.
+Distributed JMeter can be deployed on AWS or OpenStack. For more information how to do it, see below.
+
+You can read more about CloudScale project on: http://www.cloudscale-project.eu
+
+## Configs
+
+Settings in config files are separated into sections for easier understanding.
+
+### Amazon Web Services
+
+**[SHOWCASE]**
+
+```autoscalable``` - It's value ```yes``` or ```no``` tells application if showcase is deployed in autoscalable mode. This is important for getting the data from AWS.
+```host``` - The host name where showcase is deployed. Showcase must be deployed on ```/showcase-1-a``` path
+```frontend_instances_id``` - The name of frontend instances of showcase. It is used for getting data from showcase instances.
+
+**[SCENARIO]**
+
+```num_threads``` - The number of threads that we want to simulate. One JMeter instance can handle 2000 VU.
+```ips``` - IP addresses of instances to deploy JMeter on. Leave empty to not use this setting.
+```jmeter_url``` - URL to JMeter distribution. You can download JMeter and modify it, upload it somewhere and replace existing URL with yours. Otherwise leave as it is.
+
+**[AWS]**
+
+```region``` - The region name where to deploy application.
+```aws_access_key_id``` - Your AWS access key.
+```aws_secret_access_key``` - Your AWS secret key.
+```availability_zones``` - Availability zones for region.
+
+**[EC2]**
+
+```instance_type``` - EC2 instance type for distributed JMeter
+```remote_user``` - Virtual Machine user name for SSH access
+```ami_id``` - Amazon Machine Image ID to provision VM from.
+```key_name``` - Only the name of SSH key for connecting to VM.
+```key_pair``` - Path to SSH key for connecting to VM. It is auto-generated.
+
+**[RDS]**
+
+```identifiers``` - Name of VM for RDS database.
+
+### OpenStack
+
+**[SHOWCASE]**
+
+```host``` - The host name where showcase is deployed. Showcase must be deployed on ```/showcase-1-a``` path
+```frontend_instances_id``` - The name of frontend instances of showcase. It is used for getting data from showcase instances.
+
+**[SCENARIO]**
+
+```num_threads``` - The number of threads that we want to simulate. One JMeter instance can handle 2000 VU.
+```instance_names``` - Name of instances on OpenStack to deploy distributed JMeter on.
+```jmeter_url``` - URL to JMeter distribution. You can download JMeter and modify it, upload it somewhere and replace existing URL with yours. Otherwise leave as it is.
+
+**[OPENSTACK]**
+
+```user``` - User for authentication to OpenStack.
+```pwd``` - Password for user for authentication to OpenStack.
+```tenant``` - Tenant name.
+```url``` - URL to your OpenStack authentication.
+```image``` - Image name to use for VM.
+```instance_type``` - Flavor name to use with VM.
+```key_name``` - The name of SSH key on OpenStack.
+```key_pair_path``` - Path to SSH key.
+```remote_user``` - Username to use for SSH on VM.
+
+## Usage
+
+### Amazon Web Services
+To run distributed JMeter on AWS edit ```bin/config.aws.ini``` file and run:
+
+```
+$ python run.py aws config.aws.ini scenarios/cloudscale-max.jmx
+```
+
+from ```bin/``` directory.
+
+### OpenStack
+
+To run distributed JMeter on OpenStack edit ```bin/config.openstack.ini``` file and run:
+
+```
+$ python run.py openstack config.openstack.ini scenarios/cloudscale-max.jmx
+```
+
+from ```bin/``` directory.

README.txt 100(+76 -24)

diff --git a/README.txt b/README.txt
index 2bc961f..86a49cd 100644
--- a/README.txt
+++ b/README.txt
@@ -2,42 +2,94 @@
 Distributed JMeter
 ==================
 
-Distributed JMeter provides such and such and so and so. You might find
-it most useful for tasks involving <x> and also <y>. Typical usage
-often looks like this::
+Distributed JMeter application is a load generator application which was developed for CloudScale project, but it can be
+ used independently from CloudScale project. For generating the load it uses the opensource software Apache JMeter.
+Distributed JMeter can be deployed on AWS or OpenStack. For more information how to do it, see below.
 
-    #!/usr/bin/env python
+You can read more about CloudScale project on: http://www.cloudscale-project.eu
 
-    from towelstuff import location
-    from towelstuff import utils
+Configs
+=======
 
-    if utils.has_towel():
-        print "Your towel is located:", location.where_is_my_towel()
+Settings in config files are separated into sections for easier understanding.
 
-(Note the double-colon and 4-space indent formatting above.)
+Amazon Web Services
+-------------------
+[SHOWCASE]
 
-Paragraphs are separated by blank lines. *Italics*, **bold**,
-and ``monospace`` look like this.
+```autoscalable``` - It's value ```yes``` or ```no``` tells application if showcase is deployed in autoscalable mode. This is important for getting the data from AWS.
+```host``` - The host name where showcase is deployed. Showcase must be deployed on ```/showcase-1-a``` path
+```frontend_instances_id``` - The name of frontend instances of showcase. It is used for getting data from showcase instances.
 
+[SCENARIO]
 
-A Section
-=========
+```num_threads``` - The number of threads that we want to simulate. One JMeter instance can handle 2000 VU.
+```ips``` - IP addresses of instances to deploy JMeter on. Leave empty to not use this setting.
+```jmeter_url``` - URL to JMeter distribution. You can download JMeter and modify it, upload it somewhere and replace existing URL with yours. Otherwise leave as it is.
+
+[AWS]
+
+```region``` - The region name where to deploy application.
+```aws_access_key_id``` - Your AWS access key.
+```aws_secret_access_key``` - Your AWS secret key.
+```availability_zones``` - Availability zones for region.
+
+[EC2]
+
+```instance_type``` - EC2 instance type for distributed JMeter
+```remote_user``` - Virtual Machine user name for SSH access
+```ami_id``` - Amazon Machine Image ID to provision VM from.
+```key_name``` - Only the name of SSH key for connecting to VM.
+```key_pair``` - Path to SSH key for connecting to VM. It is auto-generated.
+
+[RDS]
+```identifiers``` - Name of VM for RDS database.
+
+OpenStack
+---------
+[SHOWCASE]
 
-Lists look like this:
+```host``` - The host name where showcase is deployed. Showcase must be deployed on ```/showcase-1-a``` path
+```frontend_instances_id``` - The name of frontend instances of showcase. It is used for getting data from showcase instances.
+
+[SCENARIO]
+
+```num_threads``` - The number of threads that we want to simulate. One JMeter instance can handle 2000 VU.
+```instance_names``` - Name of instances on OpenStack to deploy distributed JMeter on.
+```jmeter_url``` - URL to JMeter distribution. You can download JMeter and modify it, upload it somewhere and replace existing URL with yours. Otherwise leave as it is.
+
+[OPENSTACK]
+
+```user``` - User for authentication to OpenStack.
+```pwd``` - Password for user for authentication to OpenStack.
+```tenant``` - Tenant name.
+```url``` - URL to your OpenStack authentication.
+```image``` - Image name to use for VM.
+```instance_type``` - Flavor name to use with VM.
+```key_name``` - The name of SSH key on OpenStack.
+```key_pair_path``` - Path to SSH key.
+```remote_user``` - Username to use for SSH on VM.
+
+Usage
+=========
 
-* First
+Amazon Web Services
+-------------------
+To run distributed JMeter on AWS edit ```bin/config.aws.ini``` file and run:
 
-* Second. Can be multiple lines
-but must be indented properly.
+```
+$ python run.py aws config.aws.ini scenarios/cloudscale-max.jmx
+```
 
-A Sub-Section
--------------
+from ```bin/``` directory.
 
-Numbered lists look like you'd expect:
+OpenStack
+---------
 
-1. hi there
+To run distributed JMeter on OpenStack edit ```bin/config.openstack.ini``` file and run:
 
-2. must be going
+```
+$ python run.py openstack config.openstack.ini scenarios/cloudscale-max.jmx
+```
 
-Urls are http://like.this and links can be
-written `like this <http://www.example.com/foo/bar>`_.
+from ```bin/``` directory.