Add requirements and examples

Alexandre Chapellon
1 parent 1eb42502f1
Showing 1 changed file with 22 additions and 1 deletions Show diff stats
README.md
@@ -4,19 +4,40 @@ This ansible playbook allows one to easily deploy an Alfresco benchmark infrastr
  
 ## Requirements
  
+### Software requirement
+
 The playbook has been written and tested with Ansible 2.2. Some additionnal modules have been added to the playbook:
  
  * ansible-xml by cmprescott (requires python-lxml on remote end)
  * selenium
  
+### Architectural requirement
+
+This playbook doesn't deploy SSH keys so please make sure you're using it on nodes that already have the needed SSH keys.
 At the moment the target hosts need to have direct acces to internet as we are using public repos.
  
+Also all names used in the inventory file need to be fully qualified DNS names resolvable by all hosts.
+
 ## How to use:
  
-Edit the _inventory_ file and add your hosts to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark).
+Edit the _inventory_ file and add your (FQDN) hostnames to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark).
+
+To start using the playbook simply start it with:
  
+```
+$ ansible-playbook -i inventory alfbm.yml
+```
+
+If you're loging in as a normal user and need to "sudo", use the command bellow:
+
+```
+$ ansible-playbook -i inventory alfbm.yml -b -K
+```
 ## TODO
  
  * Make it possible to download software from the Ansible machine instead of target machine (in case target cannot access internet).
  * Allow Oracle JDK usage
  * RedHat like environments
+ * Selenium install tasks for systemd enabled OS
+ * Allow non-key based play of the book
+
...	...	@@ -4,19 +4,40 @@ This ansible playbook allows one to easily deploy an Alfresco benchmark infrastr
4	4
5	5	## Requirements
6	6
	7	+### Software requirement
	8	+
7	9	The playbook has been written and tested with Ansible 2.2. Some additionnal modules have been added to the playbook:
8	10
9	11	* ansible-xml by cmprescott (requires python-lxml on remote end)
10	12	* selenium
11	13
	14	+### Architectural requirement
	15	+
	16	+This playbook doesn't deploy SSH keys so please make sure you're using it on nodes that already have the needed SSH keys.
12	17	At the moment the target hosts need to have direct acces to internet as we are using public repos.
13	18
	19	+Also all names used in the inventory file need to be fully qualified DNS names resolvable by all hosts.
	20	+
14	21	## How to use:
15	22
16		-Edit the _inventory_ file and add your hosts to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark).
	23	+Edit the _inventory_ file and add your (FQDN) hostnames to the appropriate section. If you don't understand the roles of each server, you should probably start reading [Derek Huley's documentation](https://github.com/AlfrescoBenchmark/alfresco-benchmark/tree/master/docs) about the [Alfresco benchmark framework](https://github.com/AlfrescoBenchmark).
	24	+
	25	+To start using the playbook simply start it with:
17	26
	27	+```
	28	+$ ansible-playbook -i inventory alfbm.yml
	29	+```
	30	+
	31	+If you're loging in as a normal user and need to "sudo", use the command bellow:
	32	+
	33	+```
	34	+$ ansible-playbook -i inventory alfbm.yml -b -K
	35	+```
18	36	## TODO
19	37
20	38	* Make it possible to download software from the Ansible machine instead of target machine (in case target cannot access internet).
21	39	* Allow Oracle JDK usage
22	40	* RedHat like environments
	41	+ * Selenium install tasks for systemd enabled OS
	42	+ * Allow non-key based play of the book
	43	+
...	...